constantcontact-ruby 2.2.0

data/lib/constantcontact/components/contacts/contact.rb

@@ -0,0 +1,92 @@
+#
+# contact.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+  module Components
+    class Contact < Component
+
+      attr_accessor :id, :status, :first_name, :middle_name, :last_name, :confirmed, :email_addresses,
+                    :prefix_name, :job_title, :addresses, :company_name, :home_phone,
+                    :work_phone, :cell_phone, :fax, :custom_fields, :lists,
+                    :source_details, :notes, :source
+
+
+      # Factory method to create a Contact object from a json string
+      # @param [Hash] props - properties to create object from
+      # @return [Contact]
+      def self.create(props)
+        obj = Contact.new
+        if props
+          props.each do |key, value|
+            if key == 'email_addresses'
+              if value
+                obj.email_addresses = []
+                value.each do |email_address|
+                  obj.email_addresses << Components::EmailAddress.create(email_address)
+                end
+              end
+            elsif key == 'addresses'
+              if value
+                obj.addresses = []
+                value.each do |address|
+                  obj.addresses << Components::Address.create(address)
+                end
+              end
+            elsif key == 'notes'
+              if value
+                obj.notes = []
+                value.each do |note|
+                  obj.notes << Components::Note.create(note)
+                end
+              end
+            elsif key == 'custom_fields'
+              if value
+                obj.custom_fields = []
+                value.each do |custom_field|
+                  obj.custom_fields << Components::CustomField.create(custom_field)
+                end
+              end
+            elsif key == 'lists'
+              if value
+                obj.lists = []
+                value.each do |contact_list|
+                  obj.lists << Components::ContactList.create(contact_list)
+                end
+              end
+            else
+              obj.send("#{key}=", value) if obj.respond_to? key
+            end
+          end
+        end
+        obj
+      end
+
+      # Setter
+      # @param [ContactList] contact_list
+      def add_list(contact_list)
+        @lists = [] if @lists.nil?
+        @lists << contact_list
+      end
+
+
+      # Setter
+      # @param [EmailAddress] email_address
+      def add_email(email_address)
+        @email_addresses = [] if @email_addresses.nil?
+        @email_addresses << email_address
+      end
+
+
+      # Setter
+      # @param [Address] address
+      def add_address(address)
+        @addresses = [] if @addresses.nil?
+        @addresses << address
+      end
+
+    end
+  end
+end

data/lib/constantcontact/components/contacts/contact_list.rb

@@ -0,0 +1,26 @@
+#
+# contact_list.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+  module Components
+    class ContactList < Component
+      attr_accessor :id, :name, :status, :contact_count
+
+      # Factory method to create a ContactList object from a json string
+      # @param [Hash] props - properties to create object from
+      # @return [ContactList]
+      def self.create(props)
+        obj = ContactList.new
+        if props
+          props.each do |key, value|
+            obj.send("#{key}=", value) if obj.respond_to? key
+          end
+        end
+        obj
+      end
+    end
+  end
+end

data/lib/constantcontact/components/contacts/custom_field.rb

@@ -0,0 +1,26 @@
+#
+# custom_field.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+  module Components
+    class CustomField < Component
+      attr_accessor :name, :value
+
+      # Factory method to create a CustomField object from a json string
+      # @param [Hash] props - properties to create object from
+      # @return [CustomField]
+      def self.create(props)
+        obj = CustomField.new
+        if props
+          props.each do |key, value|
+            obj.send("#{key}=", value) if obj.respond_to? key
+          end
+        end
+        obj
+      end
+    end
+  end
+end

data/lib/constantcontact/components/contacts/email_address.rb

@@ -0,0 +1,33 @@
+#
+# email_address.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+  module Components
+    class EmailAddress < Component
+      attr_accessor :id, :status, :confirm_status, :opt_in_source, :opt_in_date, :opt_out_date, :email_address
+
+      # Class constructor
+      # @param [String] email_address
+      # @return [EmailAddress]
+      def initialize(email_address = nil)
+        @email_address = email_address if email_address
+      end
+
+      # Factory method to create an EmailAddress object from a json string
+      # @param [Hash] props - properties to create object from
+      # @return [EmailAddress]
+      def self.create(props)
+        obj = EmailAddress.new
+        if props
+          props.each do |key, value|
+            obj.send("#{key}=", value) if obj.respond_to? key
+          end
+        end
+        obj
+      end
+    end
+  end
+end

data/lib/constantcontact/components/contacts/note.rb

@@ -0,0 +1,26 @@
+#
+# note.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+  module Components
+    class Note < Component
+      attr_accessor :id, :note, :created_date, :modified_date
+
+      # Factory method to create a Note object from a json string
+      # @param [String] props - properties to create object from
+      # @return Note
+      def self.create(props)
+        note = Note.new
+        if props
+          props.each do |key, value|
+            note.send("#{key}=", value)
+          end
+        end
+        note
+      end
+    end
+  end
+end

data/lib/constantcontact/components/email_marketing/campaign.rb

@@ -0,0 +1,83 @@
+#
+# campaign.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+  module Components
+    class Campaign < Component
+      attr_accessor :id, :name, :subject, :status, :from_name, :from_email, :reply_to_email, :template_type,
+                    :created_date, :modified_date, :last_run_date, :next_run_date,
+                    :is_permission_reminder_enabled, :permission_reminder_text,
+                    :is_view_as_webpage_enabled, :view_as_web_page_text, :view_as_web_page_link_text,
+                    :greeting_salutations, :greeting_name, :greeting_string, :email_content, :text_content,
+                    :message_footer, :tracking_summary, :email_content_format, :style_sheet, :sent_to_contact_lists,
+                    :click_through_details, :permalink_url
+
+
+      # Factory method to create a Campaign object from an array
+      # @param [Hash] props - properties to create object from
+      # @return [Campaign]
+      def self.create(props)
+        campaign = Campaign.new
+        if props
+          props.each do |key, value|
+            if key == 'message_footer'
+              campaign.message_footer = Components::MessageFooter.create(value)
+            elsif key == 'tracking_summary'
+              campaign.tracking_summary = Components::TrackingSummary.create(value)
+            elsif key == 'sent_to_contact_lists'
+              if value
+                campaign.sent_to_contact_lists = []
+                value.each do |sent_to_contact_list|
+                  campaign.sent_to_contact_lists << Components::ContactList.create(sent_to_contact_list)
+                end
+              end
+            elsif key == 'click_through_details'
+              if value
+                campaign.click_through_details = []
+                value.each do |click_through_details|
+                  campaign.click_through_details << Components::ClickThroughDetails.create(click_through_details)
+                end
+              end
+            else
+              campaign.send("#{key}=", value) if campaign.respond_to? key
+            end
+          end
+        end
+        campaign
+      end
+
+
+      # Factory method to create a Campaign object from an array
+      # @param [Hash] props - hash of initial properties to set
+      # @return [Campaign]
+      def self.create_summary(props)
+        campaign = Campaign.new
+        if props
+          props.each do |key, value|
+            campaign.send("#{key}=", value) if campaign.respond_to? key
+          end
+        end
+        campaign
+      end
+
+
+      # Add a contact list to set of lists associated with this email
+      # @param [Mixed] contact_list - Contact list id, or ContactList object
+      def add_list(contact_list)
+        if contact_list.instance_of?(ContactList)
+          list = contact_list
+        elsif contact_list.to_i.to_s == contact_list
+          list = ContactList.new(contact_list)
+        else
+          raise Exceptions::IllegalArgumentException, sprintf(Util::Config.get('errors.id_or_object'), 'ContactList')
+        end
+
+        @sent_to_contact_lists << list
+      end
+
+    end
+  end
+end

data/lib/constantcontact/components/email_marketing/campaign_preview.rb

@@ -0,0 +1,29 @@
+#
+# campaign_preview.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+  module Components
+    class CampaignPreview < Component
+      attr_accessor :from_email, :preview_email_content, :preview_text_content, 
+                    :reply_to_email, :subject 
+
+
+      # Factory method to create a CampaignPreview object from an array
+      # @param [Hash] props - properties to create object from
+      # @return [CampaignPreview]
+      def self.create(props)
+        obj = CampaignPreview.new
+        if props
+          props.each do |key, value|
+            obj.send("#{key}=", value) if obj.respond_to? key
+          end
+        end
+        obj
+      end
+
+    end
+  end
+end

data/lib/constantcontact/components/email_marketing/click_through_details.rb

@@ -0,0 +1,27 @@
+#
+# click_through_details.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+  module Components
+    class ClickThroughDetails < Component
+      attr_accessor :url, :url_uid, :click_count
+
+
+      # Factory method to create an ClickThroughDetails object from an array
+      # @param [Hash] props - properties to create object from
+      # @return [ClickThroughDetails]
+      def self.create(props)
+        obj = ClickThroughDetails.new
+        if props
+          props.each do |key, value|
+            obj.send("#{key}=", value) if obj.respond_to? key
+          end
+        end
+        obj
+      end
+    end
+  end
+end

data/lib/constantcontact/components/email_marketing/message_footer.rb

@@ -0,0 +1,29 @@
+#
+# message_footer.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+  module Components
+    class MessageFooter < Component
+      attr_accessor :city, :state, :country, :organization_name, :address_line_1,
+                    :address_line_2, :address_line_3, :international_state,
+                    :postal_code, :include_forward_email, :forward_email_link_text,
+                    :include_subscribe_link, :subscribe_link_text
+
+      # Factory method to create a MessageFooter object from an array
+      # @param [Hash] props - properties to create object from
+      # @return [MessageFooter]
+      def self.create(props)
+        obj = MessageFooter.new
+        if props
+          props.each do |key, value|
+            obj.send("#{key}=", value) if obj.respond_to? key
+          end
+        end
+        obj
+      end
+    end
+  end
+end

data/lib/constantcontact/components/email_marketing/schedule.rb

@@ -0,0 +1,27 @@
+#
+# schedule.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+  module Components
+    class Schedule < Component
+      attr_accessor :id, :scheduled_date
+
+
+      # Factory method to create a Schedule object from an array
+      # @param [Hash] props - properties to create object from
+      # @return [Schedule]
+      def self.create(props)
+        obj = Schedule.new
+        if props
+          props.each do |key, value|
+            obj.send("#{key}=", value) if obj.respond_to? key
+          end
+        end
+        obj
+      end
+    end
+  end
+end

data/lib/constantcontact/components/email_marketing/test_send.rb

@@ -0,0 +1,45 @@
+#
+# test_send.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+  module Components
+    class TestSend < Component
+      attr_accessor :format, :personal_message, :email_addresses
+
+
+      # Factory method to create a TestSend object from an array
+      # @param [Hash] props - properties to create object from
+      # @return [TestSend]
+      def self.create(props)
+        obj = TestSend.new
+        if props
+          props.each do |key, value|
+            if key == 'email_addresses'
+              if value
+                obj.email_addresses = []
+                value.each do |email_address|
+                  obj.email_addresses << email_address
+                end
+              end
+            else
+              obj.send("#{key}=", value) if obj.respond_to? key
+            end
+          end
+        end
+        obj
+      end
+
+
+      # Add an email address to the set of addresses to send the test send too
+      # @param [String] email_address
+      def add_email(email_address)
+        @email_addresses = [] if @email_addresses.nil?
+        @email_addresses << email_address
+      end
+
+    end
+  end
+end

data/lib/constantcontact/components/event_spot/contact.rb

@@ -0,0 +1,27 @@
+#
+# contact.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+  module Components
+    module EventSpot
+      class Contact < Component
+        attr_accessor :email_address, :name, :organization_name, :phone_number
+
+        # Factory method to create an event host Contact object from a hash
+        # @param [Hash] props - hash of properties to create object from
+        # @return [Campaign]
+        def self.create(props)
+          obj = Contact.new
+          props.each do |key, value|
+            key = key.to_s
+            obj.send("#{key}=", value) if obj.respond_to? key
+          end if props
+          obj
+        end
+      end
+    end
+  end
+end

data/lib/constantcontact/components/event_spot/event.rb

@@ -0,0 +1,69 @@
+#
+# event.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+  module Components
+    class Event < Component
+      attr_accessor :active_date, :address, :are_registrants_public, :cancelled_date, :contact, :created_date,
+                    :currency_type, :deleted_date, :description, :end_date, :google_analytics_key, :google_merchant_id,
+                    :id, :is_calendar_displayed, :is_checkin_available, :is_home_page_displayed,
+                    :is_listed_in_external_directory, :is_map_displayed, :is_virtual_event, :location, :meta_data_tags,
+                    :name, :notification_options, :online_meeting, :payable_to, :payment_address, :payment_options,
+                    :paypal_account_email, :registration_url, :start_date, :status, :theme_name, :time_zone_description,
+                    :time_zone_id, :title, :total_registered_count, :track_information, :twitter_hash_tag, :type,
+                    :updated_date
+
+      # Factory method to create an Event object from a hash
+      # @param [Hash] props - hash of properties to create object from
+      # @return [Event]
+      def self.create(props)
+        obj = Event.new
+        if props
+          props.each do |key, value|
+            key = key.to_s
+            if key == 'address'
+              obj.address = Components::EventSpot::EventAddress.create(value)
+            elsif key == 'contact'
+              obj.contact = Components::EventSpot::Contact.create(value)
+            elsif key == 'notification_options'
+              value ||= []
+              obj.notification_options = value.collect{|option| Components::EventSpot::NotificationOption.create(option) }
+            elsif key == 'online_meeting'
+              obj.online_meeting = Components::EventSpot::OnlineMeeting.create(value)
+            elsif key == 'payment_adress'
+              obj.payment_adress = Components::EventSpot::PaymentAddress.create(value)
+            elsif key == 'track_information'
+              value ||= []
+              obj.track_information = Components::EventSpot::EventTrack.create(value)
+            else
+              obj.send("#{key}=", value) if obj.respond_to?("#{key}=")
+            end
+          end
+        end
+        obj
+      end
+
+      # Factory method to create a summary Event object from a hash
+      # @param [Hash] props - hash of properties to create object from
+      # @return [Event]
+      def self.create_summary(props)
+        obj = Event.new
+        if props
+          props.each do |key, value|
+            key = key.to_s
+            if key == 'address'
+              obj.address = Components::EventSpot::EventAddress.create(value)
+            else
+              obj.send("#{key}=", value) if obj.respond_to?("#{key}=")
+            end
+          end
+        end
+        obj
+      end
+    end
+
+  end
+end

data/lib/constantcontact/components/event_spot/event_address.rb

@@ -0,0 +1,29 @@
+#
+# event_address.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+  module Components
+    module EventSpot
+      class EventAddress < Component
+        attr_accessor :city, :country, :country_code, :latitude, :line1, :line2, :line3, :longitude, :postal_code,
+                      :state, :state_code
+
+        # Factory method to create an EventAddress object from a json string
+        # @param [Hash] props - properties to create object from
+        # @return [EventAddress]
+        def self.create(props)
+          obj = EventAddress.new
+          if props
+            props.each do |key, value|
+              obj.send("#{key}=", value) if obj.respond_to? key
+            end
+          end
+          obj
+        end
+      end
+    end
+  end
+end

data/lib/constantcontact/components/event_spot/event_fee.rb

@@ -0,0 +1,27 @@
+#
+# event_fee.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+  module Components
+    class EventFee < Component
+      attr_accessor :early_fee, :fee, :fee_scope, :id, :label, :late_fee
+
+      # Factory method to create an event Fee object from a hash
+      # @param [Hash] props - hash of properties to create object from
+      # @return [EventFee]
+      def self.create(props)
+        obj = EventFee.new
+        if props
+          props.each do |key, value|
+            key = key.to_s
+            obj.send("#{key}=", value) if obj.respond_to? key
+          end
+        end
+        obj
+      end
+    end
+  end
+end

data/lib/constantcontact/components/event_spot/event_item.rb

@@ -0,0 +1,36 @@
+#
+# event_item.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+  module Components
+    class EventItem < Component
+      attr_accessor :attributes, :default_quantity_available, :default_quantity_total, :description,
+                    :id, :name, :per_registrant_limit, :price, :show_quantity_available
+
+      # Factory method to create an EventItem object from a hash
+      # @param [Hash] props - properties to create object from
+      # @return [EventItem]
+      def self.create(props)
+        obj = EventItem.new
+        if props
+          props.each do |key, value|
+            if key == 'attributes'
+              if value
+                obj.attributes = []
+                value.each do |attribute|
+                  obj.attributes << Components::EventItemAttribute.create(attribute)
+                end
+              end
+            else
+              obj.send("#{key}=", value) if obj.respond_to? key
+            end
+          end
+        end
+        obj
+      end
+    end
+  end
+end

data/lib/constantcontact/components/event_spot/event_item_attribute.rb

@@ -0,0 +1,26 @@
+#
+# event_item_attribute.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+  module Components
+    class EventItemAttribute < Component
+      attr_accessor :id, :name, :quantity_available, :quantity_total
+
+      # Factory method to create an EventItemAttribute object from a hash
+      # @param [Hash] props - properties to create object from
+      # @return [EventItemAttribute]
+      def self.create(props)
+        obj = EventItemAttribute.new
+        if props
+          props.each do |key, value|
+            obj.send("#{key}=", value) if obj.respond_to? key
+          end
+        end
+        obj
+      end
+    end
+  end
+end