mailup 1.1.0

data/lib/mailup/console/recipient.rb

@@ -0,0 +1,69 @@
+module MailUp
+  module Console
+    class Recipient
+      attr_accessor :api
+
+      def initialize(api)
+          @api = api
+      end
+
+      # Update a recipient with the specified details into address book.
+      # 
+      # @param [Hash] recipient A hash of recipient attributes:
+      # @option recipient [String] :Name of the recipient (required).
+      # @option recipient [String] :Email of the recipient (required).
+      # @option recipient [String] :MobilePrefix of the recipient.
+      # @option recipient [String] :MobileNumber of the recipient.
+      # @option recipient [Array] :Fields to include.
+      #
+      # @return [JSON] The updated Recipient object with the following attributes:
+      #   * idRecipient [Integer]
+      #   * Name [String]
+      #   * Email [String]
+      #   * MobilePrefix [String]
+      #   * MobileNumber [String]
+      #   * Fields [Array]
+      #
+      # @see http://help.mailup.com/display/mailupapi/Console+methods+v1.1#Consolemethodsv1.1-UpdateRecipientDetail
+      # 
+      # @example
+      #
+      #   recipient = {
+      #     :Name => "Joe Public",
+      #     :Email => "joe@public.com"
+      #   }
+      #   updated_recipient = mailup.console.recipient.update(recipient)
+      #   updated_recipient.Name
+      #   => "Joe Public"
+      #
+      def update(recipient)
+        @api.put("#{@api.path}/Recipient/Detail", body: recipient)
+      end
+      
+      # Retrieve recipient dynamic field definitions.
+      # 
+      # @return [JSON] Results and data including:
+      #   * IsPaginated [Boolean]
+      #   * Items [Array<Hash>]
+      #   * PageNumber [Integer]
+      #   * PageSize [Integer]
+      #   * Skipped [Integer]
+      #   * TotalElementsCount [Integer]
+      #
+      # @see http://help.mailup.com/display/mailupapi/Console+methods+v1.1#Consolemethodsv1.1-GetDynamicFields
+      # 
+      # @example
+      #
+      #   fields = mailup.console.recipient.fields
+      #   fields.size
+      #   => 10
+      #   fields['Items'].first['Description']
+      #   => "Field description..."
+      #
+      def fields
+        @api.get("#{@api.path}/Recipient/DynamicFields")
+      end
+      
+    end
+  end
+end

data/lib/mailup/console/user.rb

@@ -0,0 +1,77 @@
+module MailUp
+  module Console
+    class User
+      attr_accessor :api
+
+      def initialize(api)
+          @api = api
+      end
+
+      # Retrieve the admin console lists for the current user.
+      # 
+      # @param [Hash] params Optional params or filters:
+      # @option params [Integer] :pageNumber The page number to return.
+      # @option params [Integer] :pageSize The number of results to per page.
+      # @option params [String] :filterby A filtering expression.
+      # @option params [String] :orderby The sorting condition for the results.
+      #
+      # @return [JSON] Results and data including:
+      #   * IsPaginated [Boolean]
+      #   * Items [Array<Hash>]
+      #   * PageNumber [Integer]
+      #   * PageSize [Integer]
+      #   * Skipped [Integer]
+      #   * TotalElementsCount [Integer]
+      #
+      # @see http://help.mailup.com/display/mailupapi/Console+methods+v1.1#Consolemethodsv1.1-GetConsoleListsByUser
+      #
+      # @example
+      #
+      #   lists = mailup.console.user.lists
+      #   lists = mailup.console.user.lists
+      #   lists['TotalElementsCount']
+      #   => 10
+      #   lists['Items'].first['Name']
+      #   => "Test List"
+      #
+      #   lists = mailup.console.user.lists(pageNumber: 0, pageSize: 250)
+      #
+      def lists(params = {})
+        @api.get("#{@api.path}/User/Lists", params: params)
+      end
+      
+      # Retrieve the email messages (cloned and not cloned) for the current user.
+      # 
+      # @param [Hash] params Optional params or filters:
+      # @option params [Integer] :pageNumber The page number to return.
+      # @option params [Integer] :pageSize The number of results to per page.
+      # @option params [String] :filterby A filtering expression.
+      # @option params [String] :orderby The sorting condition for the results.
+      #
+      # @return [JSON] Results and data including:
+      #   * IsPaginated [Boolean]
+      #   * Items [Array<Hash>]
+      #   * PageNumber [Integer]
+      #   * PageSize [Integer]
+      #   * Skipped [Integer]
+      #   * TotalElementsCount [Integer]
+      #
+      # @see http://help.mailup.com/display/mailupapi/Console+methods+v1.1#Consolemethodsv1.1-GetMailMessagesByUser
+      #
+      # @example
+      #
+      #   emails = mailup.console.user.emails
+      #   emails['TotalElementsCount']
+      #   => 10
+      #   emails['Items'].first['Subject']
+      #   => "Test Subject"
+      #
+      #   emails = mailup.console.user.emails(pageNumber: 0, pageSize: 1)
+      #
+      def emails(params={})
+        @api.get("#{@api.path}/User/Emails", params: params)
+      end
+
+    end
+  end
+end

data/lib/mailup/errors.rb

@@ -0,0 +1,18 @@
+module MailUp
+  class Error < StandardError
+  end
+  class BadRequest < Error
+  end
+  class ClientError < Error
+  end
+  class NotFound < Error
+  end
+  class ServerError < Error
+  end
+  class TooManyRequests < Error
+  end
+  class Unauthorized < Error
+  end
+  class Unavailable < Error
+  end
+end

data/lib/mailup/public/base.rb

@@ -0,0 +1,18 @@
+module MailUp
+  module Public
+    class Base
+      attr_accessor :api
+
+      def initialize(api) # :nodoc:
+          @api = api
+          @api.path = "/API/v#{MailUp::API_VERSION}/Rest/PublicService.svc"
+      end
+
+      # Resource nodes
+      def console
+        Console.new @api
+      end
+
+    end
+  end
+end

data/lib/mailup/public/console.rb

@@ -0,0 +1,75 @@
+module MailUp
+  module Public
+    class Console
+      attr_accessor :api
+
+      def initialize(api)
+          @api = api
+      end
+
+      # Create a new trial console.
+      # 
+      # @param [Hash] account A hash of account attributes.
+      # @option params [String] :NameAndSurname The company name.
+      # @option params [String] :Email The email address for the trial account.
+      # @option params [String] :Company The company name.
+      # @option params [String] :Language The account language.
+      # @option params [Boolean] :IsUSA Is this a US account?
+      # @option params [Boolean] :RegisterToNewsletter Does this account accept marketing?
+      #
+      # @return [JSON] The trial console including:
+      #   * Hash [String]
+      #   * Id [Integer]
+      #
+      # @see http://help.mailup.com/display/mailupapi/Public+methods+v1.1#Publicmethodsv1.1-RequestNewTrialConsole
+      #
+      # @example
+      #
+      #   account = {
+      #     NameAndSurname: "Joe Public",
+      #     Email: "joe@public.com",
+      #     Company: "ACME",
+      #     PhoneNumber: "15555551212",
+      #     Language: "En",
+      #     IsUSA: true,
+      #     RegisterToNewsletter: true
+      #   }
+      #   trial = mailup.public.console.new(account)
+      #   trial['id']
+      #   => 1329874
+      #
+      def new(account = {})
+        @api.post("#{@api.path}/Console/TrialActivation", body: account)
+      end
+
+      # Retrieve the information about current trial activation status.
+      # 
+      # @param [Hash] account A hash of account attributes.
+      # @option params [String] :Hash The Hash of the trial activation request.
+      # @option params [Integer] :Id The Id of the trial activation request.
+      #
+      # @return [JSON] An activation status object including:
+      #   * Code [Integer]
+      #   * Descriptin [String]
+      #
+      # @see http://help.mailup.com/display/mailupapi/Public+methods+v1.1#Publicmethodsv1.1-RequestTrialConsoleActivationStatus
+      #
+      # @example
+      #
+      #   account = {
+      #     Hash: "1k23hj432jh4kh3j24k",
+      #     Id: "1324"
+      #   }
+      #   status = mailup.public.console.status(account)
+      #   status['Code']
+      #   => 1234
+      #   status['Description']
+      #   => "Status description..."
+      #
+      def status(account = {})
+        @api.post("#{@api.path}/Console/TrialActivationStatus", body: account)
+      end
+
+    end
+  end
+end

data/lib/mailup/stats/base.rb

@@ -0,0 +1,41 @@
+module MailUp
+  module Stats
+    class Base
+      attr_accessor :api
+
+      def initialize(api) # :nodoc:
+          @api = api
+          @api.path = "/API/v#{MailUp::API_VERSION}/Rest/MailStatisticsService.svc"
+      end
+
+      # Create a message object
+      # 
+      # @param [Integer] id The message_id of the message to access.
+      #
+      # @return [MailUp::Stats::Message] 
+      #
+      # @example
+      #
+      #   message = mailup.stats.message(1)
+      #
+      def message(id)
+        Message.new id, @api
+      end
+
+      # Create a recipient object
+      # 
+      # @param [Integer] id The recipient_id of the recipient to access.
+      #
+      # @return [MailUp::Stats::Recipient] 
+      #
+      # @example
+      #
+      #   recipient = mailup.stats.recipient(154)
+      #
+      def recipient(id)
+        Recipient.new id, @api
+      end
+
+    end
+  end
+end

data/lib/mailup/stats/message.rb

@@ -0,0 +1,284 @@
+module MailUp
+  module Stats
+    class Message
+      attr_accessor :api
+
+      def initialize(id, api)
+          @api = api
+          @id = id
+      end
+
+      # Paged list of recipients who received the specified email.
+      #
+      # @param [Hash] params Optional params or filters:
+      # @option params [Integer] :pageNumber The page number to return.
+      # @option params [Integer] :pageSize The number of results to per page.
+      # @option params [String] :filterby A filtering expression.
+      # @option params [String] :orderby The sorting condition for the results.
+      #
+      # @return [JSON] Results and data including:
+      #   * IsPaginated [Boolean]
+      #   * Items [Array<Hash>]
+      #   * PageNumber [Integer]
+      #   * PageSize [Integer]
+      #   * Skipped [Integer]
+      #   * TotalElementsCount [Integer]
+      #
+      # @see http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-ListMessageRecipients
+      #
+      # @example
+      #
+      #   recipients = mailup.stats.message(9).recipients
+      #   recipients['TotalElementsCount']
+      #   => 10
+      #   recipients['Items'].first['Email']
+      #   => "joe@public.com"
+      #
+      def recipients(params = {})
+        @api.get("#{@api.path}/Message/#{@id}/List/Recipients", params: params)
+      end
+      
+      # Count of recipients who received the specified email.
+      #
+      #
+      # @return [Integer] Count of recipients.
+      #
+      # @see http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-CountMessageRecipients
+      #
+      # @example
+      #
+      #   recipients = mailup.stats.message(9).recipients_count
+      #   => 10
+      #
+      def recipients_count
+        @api.get("#{@api.path}/Message/#{@id}/Count/Recipients")
+      end
+      alias_method :received_count, :recipients_count
+      
+      # Paged list of views of the specified email.
+      #
+      # @param [Hash] params Optional params or filters:
+      # @option params [Integer] :pageNumber The page number to return.
+      # @option params [Integer] :pageSize The number of results to per page.
+      # @option params [String] :filterby A filtering expression.
+      # @option params [String] :orderby The sorting condition for the results.
+      #
+      # @return [JSON] Results and data including:
+      #   * IsPaginated [Boolean]
+      #   * Items [Array<Hash>]
+      #   * PageNumber [Integer]
+      #   * PageSize [Integer]
+      #   * Skipped [Integer]
+      #   * TotalElementsCount [Integer]
+      #
+      # @see http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-ListMessageViews
+      #
+      # @example
+      #
+      #   views = mailup.stats.message(9).views
+      #   views['TotalElementsCount']
+      #   => 10
+      #
+      def views(params = {})
+        @api.get("#{@api.path}/Message/#{@id}/List/Views", params: params)
+      end
+      
+      # Count of views of the specified email.
+      #
+      #
+      # @return [Integer] Count of views.
+      #
+      # @see http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-CountMessageViews
+      #
+      # @example
+      #
+      #   views = mailup.stats.message(9).views_count
+      #   => 3453
+      #
+      def views_count
+        @api.get("#{@api.path}/Message/#{@id}/Count/Views")
+      end
+      
+      # Paged list of bounces from the specified email.
+      #
+      # @param [Hash] params Optional params or filters:
+      # @option params [Integer] :pageNumber The page number to return.
+      # @option params [Integer] :pageSize The number of results to per page.
+      # @option params [String] :filterby A filtering expression.
+      # @option params [String] :orderby The sorting condition for the results.
+      #
+      # @return [JSON] Results and data including:
+      #   * IsPaginated [Boolean]
+      #   * Items [Array<Hash>]
+      #   * PageNumber [Integer]
+      #   * PageSize [Integer]
+      #   * Skipped [Integer]
+      #   * TotalElementsCount [Integer]
+      #
+      # @see http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-ListMessageBounces
+      #
+      # @example
+      #
+      #   bounces = mailup.stats.message(9).bounces
+      #   bounces['TotalElementsCount']
+      #   => 10
+      #
+      def bounces(params = {})
+        @api.get("#{@api.path}/Message/#{@id}/List/Bounces", params: params)
+      end
+      
+      # Count of bounces from the specified mail.
+      #
+      #
+      # @return [Integer] Count of bounces.
+      #
+      # @see http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-CountMessageBounces
+      #
+      # @example
+      #
+      #   bounces = mailup.stats.message(9).bounces_count
+      #   => 3453
+      #
+      def bounces_count
+        @api.get("#{@api.path}/Message/#{@id}/Count/Bounces")
+      end
+      
+      # Paged list of unsubscriptions from the specified email.
+      #
+      # @param [Hash] params Optional params or filters:
+      # @option params [Integer] :pageNumber The page number to return.
+      # @option params [Integer] :pageSize The number of results to per page.
+      # @option params [String] :filterby A filtering expression.
+      # @option params [String] :orderby The sorting condition for the results.
+      #
+      # @return [JSON] Results and data including:
+      #   * IsPaginated [Boolean]
+      #   * Items [Array<Hash>]
+      #   * PageNumber [Integer]
+      #   * PageSize [Integer]
+      #   * Skipped [Integer]
+      #   * TotalElementsCount [Integer]
+      #
+      # @see http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-ListMessageUnsubscriptions
+      #
+      # @example
+      #
+      #   unsubs = mailup.stats.message(9).unsubscribes
+      #   unsubs['TotalElementsCount']
+      #   => 10
+      #
+      def unsubscribes(params = {})
+        @api.get("#{@api.path}/Message/#{@id}/List/Unsubscriptions", params: params)
+      end
+      
+      # Count of unsubscriptions from the specified email.
+      #
+      #
+      # @return [Integer] Count of unsubscribes.
+      #
+      # @see http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-CountMessageUnsubscriptions
+      #
+      # @example
+      #
+      #   unsubs = mailup.stats.message(9).unsubscribes_count
+      #   => 234
+      #
+      def unsubscribes_count
+        @api.get("#{@api.path}/Message/#{@id}/Count/Unsubscriptions")
+      end
+      
+      # Paged list of clicks on a link in the specified email.
+      #
+      # @param [Hash] params Optional params or filters:
+      # @option params [Integer] :pageNumber The page number to return.
+      # @option params [Integer] :pageSize The number of results to per page.
+      # @option params [String] :filterby A filtering expression.
+      # @option params [String] :orderby The sorting condition for the results.
+      #
+      # @return [JSON] Results and data including:
+      #   * IsPaginated [Boolean]
+      #   * Items [Array<Hash>]
+      #   * PageNumber [Integer]
+      #   * PageSize [Integer]
+      #   * Skipped [Integer]
+      #   * TotalElementsCount [Integer]
+      #
+      # @see http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-ListMessageClicks
+      #
+      # @example
+      #
+      #   clicks = mailup.stats.message(9).clicks
+      #   clicks['TotalElementsCount']
+      #   => 10
+      #   clicks['Items'].first['Count']
+      #   => 3
+      #
+      def clicks(params = {})
+        @api.get("#{@api.path}/Message/#{@id}/List/Clicks", params: params)
+      end
+      
+      # Count of clicks on a link in the specified email.
+      #
+      #
+      # @return [Integer] Count of bounces.
+      #
+      # @see http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-CountMessageClicks
+      #
+      # @example
+      #
+      #   clicks = mailup.stats.message(9).clicks_count
+      #   => 3453
+      #
+      def clicks_count
+        @api.get("#{@api.path}/Message/#{@id}/Count/Clicks")
+      end
+
+      # Paged list of clicks on a link in the specified email.
+      #
+      # @param [Hash] params Optional params or filters:
+      # @option params [Integer] :pageNumber The page number to return.
+      # @option params [Integer] :pageSize The number of results to per page.
+      # @option params [String] :filterby A filtering expression.
+      # @option params [String] :orderby The sorting condition for the results.
+      #
+      # @return [JSON] Results and data including:
+      #   * IsPaginated [Boolean]
+      #   * Items [Array<Hash>]
+      #   * PageNumber [Integer]
+      #   * PageSize [Integer]
+      #   * Skipped [Integer]
+      #   * TotalElementsCount [Integer]
+      #
+      # @see http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-ListMessageUrlClicks
+      #
+      # @example
+      #
+      #   url_clicks = mailup.stats.message(9).url_clicks
+      #   url_clicks['TotalElementsCount']
+      #   => 10
+      #   url_clicks['Items'].first['Count']
+      #   => 3
+      #
+      def url_clicks(params = {})
+        @api.get("#{@api.path}/Message/#{@id}/List/UrlClicks", params: params)
+      end
+      
+      # Count of clicks on a link in the specified email.
+      #
+      #
+      # @return [Integer] Count of bounces.
+      #
+      # @see http://help.mailup.com/display/mailupapi/Email+statistics+methods+v1.1#Emailstatisticsmethodsv1.1-CountMessageClicks
+      #
+      # @example
+      #
+      #   url_clicks = mailup.stats.message(9).url_clicks_count
+      #   => 3453
+      #
+      def url_clicks_count
+        @api.get("#{@api.path}/Message/#{@id}/Count/UrlClicks")
+      end
+
+    end
+  end
+end