constantcontact 1.1.2 → 1.2.0

data/README.md

@@ -9,7 +9,7 @@ Installation
 ====
 Via bundler:
 ```ruby
-gem 'constantcontact', '~> 1.1.0'
+gem 'constantcontact', '~> 1.2.0'
 ```
 Otherwise:
 ```bash
@@ -127,4 +127,4 @@ Create a my_view.erb with the following code:
 
 The first time you access the action in browser you should see the "Click to authorize" link.
 Follow the link, go through all the Constant Contact steps required 
-and then you will be redirected back to your action and you should see the list of contacts.
+and then you will be redirected back to your action and you should see the list of contacts.

data/constantcontact.gemspec

@@ -5,7 +5,7 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |s|
   s.name = "constantcontact"
-  s.version = '1.1.2'
+  s.version = '1.2.0'
   s.platform = Gem::Platform::RUBY
   s.authors = ["ConstantContact"]
   s.homepage = "http://www.constantcontact.com"

data/lib/constantcontact.rb

@@ -49,8 +49,11 @@ module ConstantContact
     autoload :TrackingSummary, 'constantcontact/components/tracking/tracking_summary'
     autoload :VerifiedEmailAddress, 'constantcontact/components/account/verified_email_address'
     autoload :Event, 'constantcontact/components/event_spot/event'
-    autoload :Fee, 'constantcontact/components/event_spot/fee'
+    autoload :EventFee, 'constantcontact/components/event_spot/event_fee'
     autoload :Registrant, 'constantcontact/components/event_spot/registrant'
+    autoload :EventItem, 'constantcontact/components/event_spot/event_item'
+    autoload :EventItemAttribute, 'constantcontact/components/event_spot/event_item_attribute'
+    autoload :Promocode, 'constantcontact/components/event_spot/promocode'
     autoload :LibrarySummary, 'constantcontact/components/library/info/library_summary'
     autoload :UploadStatus, 'constantcontact/components/library/info/upload_status'
     autoload :MoveResults, 'constantcontact/components/library/info/move_results'
@@ -58,12 +61,22 @@ module ConstantContact
     autoload :LibraryFile, 'constantcontact/components/library/file/library_file'
 
     module EventSpot
+      autoload :EventAddress, 'constantcontact/components/event_spot/event_address'
       autoload :Contact, 'constantcontact/components/event_spot/contact'
       autoload :NotificationOption, 'constantcontact/components/event_spot/notification_option'
+      autoload :OnlineMeeting, 'constantcontact/components/event_spot/online_meeting'
+      autoload :PaymentAddress, 'constantcontact/components/event_spot/payment_address'
+      autoload :PaymentSummary, 'constantcontact/components/event_spot/payment_summary'
       autoload :Guest, 'constantcontact/components/event_spot/guest'
+      autoload :GuestSection, 'constantcontact/components/event_spot/guest_section'
       autoload :EventTrack, 'constantcontact/components/event_spot/event_track'
-      autoload :RegistrantSection, 'constantcontact/components/event_spot/registrant_section'
+      autoload :RegistrantFee, 'constantcontact/components/event_spot/registrant_fee'
       autoload :RegistrantField, 'constantcontact/components/event_spot/registrant_field'
+      autoload :RegistrantOrder, 'constantcontact/components/event_spot/registrant_order'
+      autoload :RegistrantPromoCode, 'constantcontact/components/event_spot/registrant_promo_code'
+      autoload :RegistrantPromoCodeInfo, 'constantcontact/components/event_spot/registrant_promo_code_info'
+      autoload :RegistrantSection, 'constantcontact/components/event_spot/registrant_section'
+      autoload :SaleItem, 'constantcontact/components/event_spot/sale_item'
     end
   end
 

data/lib/constantcontact/api.rb

@@ -621,25 +621,16 @@ module ConstantContact
     # Cancel an event
     # @param [String] access_token - Constant Contact OAuth2 access token
     # @param [Event] event - Event to cancel
-    # @return [Activity]
+    # @return [Event]
     def cancel_event(access_token, event)
       Services::EventSpotService.cancel_event(access_token, event)
     end
 
 
-    # Delete an event
-    # @param [String] access_token - Constant Contact OAuth2 access token
-    # @param [Event] event - Event fee corresponds to
-    # @return [Activity]
-    def delete_event(access_token, event)
-      Services::EventSpotService.delete_event(access_token, event)
-    end
-
-
     # Get a list of event fees
     # @param [String] access_token - Constant Contact OAuth2 access token
     # @param [Event] event - Event to get fees of
-    # @return [Activity]
+    # @return [<Array>EventFee]
     def get_event_fees(access_token, event)
       Services::EventSpotService.get_fees(access_token, event)
     end
@@ -648,8 +639,8 @@ module ConstantContact
     # Get an event fee
     # @param [String] access_token - Constant Contact OAuth2 access token
     # @param [Event] event - Event fee corresponds to
-    # @param [Fee] fee - Fee to retrieve
-    # @return [Activity]
+    # @param [EventFee] fee - Fee to retrieve
+    # @return [EventFee]
     def get_event_fee(access_token, event, fee)
       Services::EventSpotService.get_fee(access_token, event, fee)
     end
@@ -659,7 +650,7 @@ module ConstantContact
     # @param [String] access_token - Constant Contact OAuth2 access token
     # @param [Event] event - Event fee corresponds to
     # @param [Hash] fee - Fee details
-    # @return [Activity]
+    # @return [EventFee]
     def add_event_fee(access_token, event, fee)
       Services::EventSpotService.add_fee(access_token, event, fee)
     end
@@ -668,8 +659,8 @@ module ConstantContact
     # Update an event fee
     # @param [String] access_token - Constant Contact OAuth2 access token
     # @param [Event] event - Event fee corresponds to
-    # @param [Fee] fee - Fee details
-    # @return [Activity]
+    # @param [EventFee] fee - Fee details
+    # @return [EventFee]
     def update_event_fee(access_token, event, fee)
       Services::EventSpotService.update_fee(access_token, event, fee)
     end
@@ -678,17 +669,17 @@ module ConstantContact
     # Delete an event fee
     # @param [String] access_token - Constant Contact OAuth2 access token
     # @param [Event] event - Event fee corresponds to
-    # @param [Fee] fee - Fee details
-    # @return [Activity]
+    # @param [EventFee] fee - Fee details
+    # @return [Boolean]
     def delete_event_fee(access_token, event, fee)
       Services::EventSpotService.delete_fee(access_token, event, fee)
     end
 
 
-    # Get a list of event registrants
+    # Get a set of event registrants
     # @param [String] access_token - Constant Contact OAuth2 access token
     # @param [Event] event - Event fee corresponds to
-    # @return [Activity]
+    # @return [ResultSet<Registrant>]
     def get_event_registrants(access_token, event)
       Services::EventSpotService.get_registrants(access_token, event)
     end
@@ -698,12 +689,164 @@ module ConstantContact
     # @param [String] access_token - Constant Contact OAuth2 access token
     # @param [Event] event - Event registrant corresponds to
     # @param [Registrant] registrant - registrant details
-    # @return [Activity]
+    # @return [Registrant]
     def get_event_registrant(access_token, event, registrant)
       Services::EventSpotService.get_registrant(access_token, event, registrant)
     end
 
 
+    # Get an array of event items for an individual event
+    # @param [String] access_token - Constant Contact OAuth2 access token
+    # @param [Integer] event_id - event id to retrieve items for
+    # @return [Array<EventItem>]
+    def get_event_items(access_token, event_id)
+      Services::EventSpotService.get_event_items(access_token, event_id)
+    end
+
+
+    # Get an individual event item
+    # @param [String] access_token - Constant Contact OAuth2 access token
+    # @param [Integer] event_id - id of event to retrieve item for
+    # @param [Integer] item_id - id of item to be retrieved
+    # @return [EventItem]
+    def get_event_item(access_token, event_id, item_id)
+      Services::EventSpotService.get_event_item(access_token, event_id, item_id)
+    end
+
+
+    # Create a new event item for an event
+    # @param [String] access_token - Constant Contact OAuth2 access token
+    # @param [Integer] event_id - id of event to be associated with the event item
+    # @param [EventItem] event_item - event item to be created
+    # @return [EventItem]
+    def add_event_item(access_token, event_id, event_item)
+      Services::EventSpotService.add_event_item(access_token, event_id, event_item)
+    end
+
+
+    # Delete a specific event item for an event
+    # @param [String] access_token - Constant Contact OAuth2 access token
+    # @param [Integer] event_id - id of event to delete an event item for
+    # @param [Integer] item_id - id of event item to be deleted
+    # @return [Boolean]
+    def delete_event_item(access_token, event_id, item_id)
+      Services::EventSpotService.delete_event_item(access_token, event_id, item_id)
+    end
+
+
+    # Update a specific event item for an event
+    # @param [String] access_token - Constant Contact OAuth2 access token
+    # @param [Integer] event_id - id of event associated with the event item
+    # @param [EventItem] event_item - event item to be updated
+    # @return [EventItem]
+    def update_event_item(access_token, event_id, event_item)
+      Services::EventSpotService.update_event_item(access_token, event_id, event_item)
+    end
+
+
+    # Get an array of attributes for an individual event item
+    # @param [String] access_token - Constant Contact OAuth2 access token
+    # @param [Integer] event_id - event id to retrieve item for
+    # @param [Integer] item_id - event item id to retrieve attributes for
+    # @return [Array<EventItemAttribute>]
+    def get_event_item_attributes(access_token, event_id, item_id)
+      Services::EventSpotService.get_event_item_attributes(access_token, event_id, item_id)
+    end
+
+
+    # Get an individual event item attribute
+    # @param [String] access_token - Constant Contact OAuth2 access token
+    # @param [Integer] event_id - id of event to retrieve item for
+    # @param [Integer] item_id - id of item to retrieve attribute for
+    # @param [Integer] attribute_id - id of attribute to be retrieved
+    # @return [EventItemAttribute]
+    def get_event_item_attribute(access_token, event_id, item_id, attribute_id)
+      Services::EventSpotService.get_event_item_attribute(access_token, event_id, item_id, attribute_id)
+    end
+
+
+    # Create a new event item attribute for an event item
+    # @param [String] access_token - Constant Contact OAuth2 access token
+    # @param [Integer] event_id - id of event to be associated with the event item attribute
+    # @param [Integer] item_id - id of event item to be associated with the event item attribute
+    # @param [EventItemAttribute] event_item_attribute - event item attribute to be created
+    # @return [EventItemAttribute]
+    def add_event_item_attribute(access_token, event_id, item_id, event_item_attribute)
+      Services::EventSpotService.add_event_item_attribute(access_token, event_id, item_id, event_item_attribute)
+    end
+
+
+    # Delete a specific event item for an event
+    # @param [String] access_token - Constant Contact OAuth2 access token
+    # @param [Integer] event_id - id of event to delete an event item attribute for
+    # @param [Integer] item_id - id of event item to delete an event item attribute for
+    # @param [Integer] attribute_id - id of attribute to be deleted
+    # @return [Boolean]
+    def delete_event_item_attribute(access_token, event_id, item_id, attribute_id)
+      Services::EventSpotService.delete_event_item_attribute(access_token, event_id, item_id, attribute_id)
+    end
+
+
+    # Update a specific event item attribute for an event item
+    # @param [String] access_token - Constant Contact OAuth2 access token
+    # @param [Integer] event_id - id of event associated with the event item
+    # @param [Integer] item_id - id of event item associated with the event item attribute
+    # @param [EventItemAttribute] event_item_attribute - event item to be updated
+    # @return [EventItemAttribute]
+    def update_event_item_attribute(access_token, event_id, item_id, event_item_attribute)
+      Services::EventSpotService.update_event_item_attribute(access_token, event_id, item_id, event_item_attribute)
+    end
+
+
+    # Get an array of promocodes for an individual event
+    # @param [String] access_token - Constant Contact OAuth2 access token
+    # @param [Integer] event_id - event id to retrieve promocodes for
+    # @return [Array<Promocode>]
+    def get_promocodes(access_token, event_id)
+      Services::EventSpotService.get_promocodes(access_token, event_id)
+    end
+
+
+    # Get an individual promocode
+    # @param [String] access_token - Constant Contact OAuth2 access token
+    # @param [Integer] event_id - id of event to retrieve item for
+    # @param [Integer] promocode_id - id of item to be retrieved
+    # @return [Promocode]
+    def get_promocode(access_token, event_id, promocode_id)
+      Services::EventSpotService.get_promocode(access_token, event_id, promocode_id)
+    end
+
+
+    # Create a new promocode for an event
+    # @param [String] access_token - Constant Contact OAuth2 access token
+    # @param [Integer] event_id - id of event to be associated with the promocode
+    # @param [Promocode] promocode - promocode to be created
+    # @return [Promocode]
+    def add_promocode(access_token, event_id, promocode)
+      Services::EventSpotService.add_promocode(access_token, event_id, promocode)
+    end
+
+
+    # Delete a specific promocode for an event
+    # @param [String] access_token - Constant Contact OAuth2 access token
+    # @param [Integer] event_id - id of event to delete a promocode for
+    # @param [Integer] promocode_id - id of promocode to be deleted
+    # @return [Boolean]
+    def delete_promocode(access_token, event_id, promocode_id)
+      Services::EventSpotService.delete_promocode(access_token, event_id, promocode_id)
+    end
+
+
+    # Update a specific promocode for an event
+    # @param [String] access_token - Constant Contact OAuth2 access token
+    # @param [Integer] event_id - id of event associated with the promocode
+    # @param [Promocode] promocode - promocode to be updated
+    # @return [Promocode]
+    def update_promocode(access_token, event_id, promocode)
+      Services::EventSpotService.update_promocode(access_token, event_id, promocode)
+    end
+
+
     # Retrieve MyLibrary usage information
     # @param [String] access_token - Constant Contact OAuth2 access token
     # @return [LibrarySummary]

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

@@ -8,18 +8,18 @@ module ConstantContact
   module Components
     module EventSpot
       class Contact < Component
-        attr_accessor :id, :name, :email_address, :phone_number, :organization_name
+        attr_accessor :email_address, :name, :organization_name, :phone_number
 
-        # Factory method to create an event Fee object from a hash
+        # 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)
-          contact = Contact.new
+          obj = Contact.new
           props.each do |key, value|
             key = key.to_s
-            contact.send("#{key}=", value) if contact.respond_to? key
+            obj.send("#{key}=", value) if obj.respond_to? key
           end if props
-          contact
+          obj
         end
       end
     end

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

@@ -7,57 +7,63 @@
 module ConstantContact
   module Components
     class Event < Component
-      attr_accessor :id, :type, :name, :title, :status, :description, :active_date, :start_date, :end_date,
-                    :deleted_date, :created_date, :modified_date, :time_zone_id, :location, :currency_type,
-                    :is_checkin_available, :total_registered_count, :registration_url, :theme_name,
-                    :is_virtual_event, :notification_options, :is_home_page_displayed, :is_map_displayed,
-                    :is_calendar_displayed, :is_listed_in_external_directory, :are_registrants_public,
-                    :track_information, 
-                    :contact, :address
+      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 [Campaign]
+      # @return [Event]
       def self.create(props)
-        event = Event.new
+        obj = Event.new
         if props
           props.each do |key, value|
             key = key.to_s
             if key == 'address'
-              event.address = Components::Address.create(value)
+              obj.address = Components::EventSpot::EventAddress.create(value)
             elsif key == 'contact'
-              event.contact = Components::EventSpot::Contact.create(value)
+              obj.contact = Components::EventSpot::Contact.create(value)
             elsif key == 'notification_options'
               value ||= []
-              event.notification_options = value.collect{|notification| Components::EventSpot::NotificationOption.create notification }
+              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 ||= []
-              event.track_information = Components::EventSpot::EventTrack.create value
+              obj.track_information = Components::EventSpot::EventTrack.create(value)
             else
-              event.send("#{key}=", value) if event.respond_to?("#{key}=")
+              obj.send("#{key}=", value) if obj.respond_to?("#{key}=")
             end
           end
         end
-        event
+        obj
       end
-      
-      # Factory method to create an summary Event object from a hash
+
+      # Factory method to create a summary Event object from a hash
       # @param [Hash] props - hash of properties to create object from
-      # @return [Campaign]
+      # @return [Event]
       def self.create_summary(props)
-        event = Event.new
+        obj = Event.new
         if props
           props.each do |key, value|
             key = key.to_s
             if key == 'address'
-              event.address = Components::Address.create(value)
+              obj.address = Components::EventSpot::EventAddress.create(value)
             else
-              event.send("#{key}=", value) if event.respond_to?("#{key}=")
+              obj.send("#{key}=", value) if obj.respond_to?("#{key}=")
             end
           end
         end
-        event
+        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