constantcontact 1.1.2 → 1.2.0

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

@@ -0,0 +1,31 @@
+#
+# registrant_promo_code.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+  module Components
+    module EventSpot
+      class RegistrantPromoCode < Component
+        attr_accessor :total_discount, :promo_code_info
+
+        # Factory method to create a RegistrantPromoCode object from a hash
+        # @param [Hash] props - hash of properties to create object from
+        # @return [RegistrantPromoCode]
+        def self.create(props)
+          obj = RegistrantPromoCode.new
+          props.each do |key, value|
+            key = key.to_s
+            if key == 'promo_code_info'
+              obj.send("#{key}=", Components::EventSpot::RegistrantPromoCodeInfo.create(value))
+            else
+              obj.send("#{key}=", value) if obj.respond_to? key
+            end
+          end if props
+          obj
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+#
+# registrant_promo_code_info.rb
+# ConstantContact
+#
+# Copyright (c) 2013 Constant Contact. All rights reserved.
+
+module ConstantContact
+  module Components
+    module EventSpot
+      class RegistrantPromoCodeInfo < Component
+        attr_accessor :code_name, :code_type, :discount_amount, :discount_scope, :discount_type, :redemption_count
+
+        # Factory method to create a RegistrantPromoCode object from a hash
+        # @param [Hash] props - hash of properties to create object from
+        # @return [RegistrantPromoCodeInfo]
+        def self.create(props)
+          obj = RegistrantPromoCodeInfo.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/registrant_section.rb

@@ -10,23 +10,23 @@ module ConstantContact
       class RegistrantSection < Component
         attr_accessor :label, :fields
 
-        # Factory method to create an event RegistrantSection object from a hash
+        # Factory method to create a RegistrantSection object from a hash
         # @param [Hash] props - hash of properties to create object from
-        # @return [Campaign]
+        # @return [RegistrantSection]
         def self.create(props)
-          section = RegistrantSection.new
+          obj = RegistrantSection.new
           props.each do |key, value|
             key = key.to_s
             if key == 'fields'
               value ||= []
-              section.fields = value.collect do |field|
+              obj.fields = value.collect do |field|
                 Components::EventSpot::RegistrantField.create(field)
               end
             else
-              section.send("#{key}=", value) if section.respond_to? key
+              obj.send("#{key}=", value) if obj.respond_to? key
             end
           end if props
-          section
+          obj
         end
       end
     end

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

@@ -1,26 +1,28 @@
 #
-# fee.rb
+# sale_item.rb
 # ConstantContact
 #
 # Copyright (c) 2013 Constant Contact. All rights reserved.
 
 module ConstantContact
   module Components
-    class SaleItem < Component
-      attr_accessor :id, :amount, :promo_type, :fee_period_type, :type, :name, :quantity
+    module EventSpot
+      class SaleItem < Component
+        attr_accessor :id, :amount, :promo_type, :fee_period_type, :type, :name, :quantity
 
-      # Factory method to create an event Fee object from a hash
-      # @param [Hash] props - hash of properties to create object from
-      # @return [Campaign]
-      def self.create(props)
-        item = SaleItem.new
-        if props
-          props.each do |key, value|
-            key = key.to_s
-            item.send("#{key}=", value) if item.respond_to? key
+        # Factory method to create a SaleItem object from a hash
+        # @param [Hash] props - hash of properties to create object from
+        # @return [SaleItem]
+        def self.create(props)
+          obj = SaleItem.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
-        item
       end
     end
   end

data/lib/constantcontact/services/event_spot_service.rb

@@ -58,20 +58,6 @@ module ConstantContact
         end
 
 
-        # Delete an EventSpot event
-        # @param [String] access_token - Constant Contact OAuth2 access token
-        # @param [Integer] event - Valid event id
-        # @return [Boolean]
-        def delete_event(access_token, event)
-          event_id = get_id_for(event)
-          url = Util::Config.get('endpoints.base_url') +
-                sprintf(Util::Config.get('endpoints.event'), event_id)
-          url = build_url(url)
-          response = RestClient.delete(url, get_headers(access_token))
-          response.code == 204
-        end
-
-
         # Update a specific EventSpot event
         # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [Event] event - Event to be updated
@@ -120,8 +106,8 @@ module ConstantContact
         # Create a new event fee
         # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [Integer] event - Valid event id
-        # @param [Fee] fee - Event fee to be created
-        # @return [Fee]
+        # @param [EventFee] fee - Event fee to be created
+        # @return [EventFee]
         def add_fee(access_token, event, fee)
           event_id = get_id_for(event)
           url = Util::Config.get('endpoints.base_url') +
@@ -129,14 +115,14 @@ module ConstantContact
           url = build_url(url)
           payload = fee.to_json
           response = RestClient.post(url, payload, get_headers(access_token))
-          Components::Fee.create(JSON.parse(response.body))
+          Components::EventFee.create(JSON.parse(response.body))
         end
 
 
-        # Get a set of event fees
+        # Get an array of event fees
         # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [Integer] event - Valid event id
-        # @return [ResultSet<Fee>]
+        # @return [Array<EventFee>]
         def get_fees(access_token, event)
           event_id = get_id_for(event)
           url = Util::Config.get('endpoints.base_url') +
@@ -147,7 +133,7 @@ module ConstantContact
           body = JSON.parse(response.body)
           
           fees = body.collect do |fee|
-            Components::Fee.create(fee)
+            Components::EventFee.create(fee)
           end
         end
 
@@ -156,7 +142,7 @@ module ConstantContact
         # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [Integer] event - Valid event id
         # @param [Integer] fee - Valid fee id
-        # @return [Fee]
+        # @return [EventFee]
         def get_fee(access_token, event, fee)
           event_id  = get_id_for(event)
           fee_id    = get_id_for(fee)
@@ -165,7 +151,7 @@ module ConstantContact
           url = build_url(url)
 
           response = RestClient.get(url, get_headers(access_token))
-         fee = Components::Fee.create(JSON.parse(response.body))
+         fee = Components::EventFee.create(JSON.parse(response.body))
         end
 
 
@@ -173,10 +159,10 @@ module ConstantContact
         # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [Integer] event - Valid event id
         # @param [Integer] fee - Valid fee id
-        # @return [Fee]
+        # @return [EventFee]
         def update_fee(access_token, event, fee)
           event_id  = get_id_for(event)
-          if fee.kind_of?(ConstantContact::Components::Fee)
+          if fee.kind_of?(ConstantContact::Components::EventFee)
             fee_id = fee.id
           elsif fee.kind_of?(Hash)
             fee_id = fee['id']
@@ -190,7 +176,7 @@ module ConstantContact
           payload = fee.to_json
 
           response = RestClient.put(url, payload, get_headers(access_token))
-         fee = Components::Fee.create(JSON.parse(response.body))
+         fee = Components::EventFee.create(JSON.parse(response.body))
         end
 
 
@@ -198,7 +184,7 @@ module ConstantContact
         # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [Integer] event - Valid event id
         # @param [Integer] fee - Valid fee id
-        # @return [Fee]
+        # @return [Boolean]
         def delete_fee(access_token, event, fee)
           event_id  = get_id_for(event)
           fee_id    = get_id_for(fee)
@@ -236,18 +222,255 @@ module ConstantContact
         # @param [String] access_token - Constant Contact OAuth2 access token
         # @param [Integer] event - Valid event id
         # @param [Integer] registrant - Valid fee id
-        # @return [Fee]
+        # @return [Registrant]
         def get_registrant(access_token, event, registrant)
           event_id      = get_id_for(event)
           registrant_id  = get_id_for(registrant)
           url = Util::Config.get('endpoints.base_url') +
-                sprintf(Util::Config.get('endpoints.event_fee'), event_id, registrant_id)
+                sprintf(Util::Config.get('endpoints.event_registrant'), event_id, registrant_id)
+          url = build_url(url)
+
+          response = RestClient.get(url, get_headers(access_token))
+          Components::Registrant.create(JSON.parse(response.body))
+        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)
+          url = Util::Config.get('endpoints.base_url') + 
+                sprintf(Util::Config.get('endpoints.event_items'), event_id)
+          url = build_url(url)
+          response = RestClient.get(url, get_headers(access_token))
+
+          event_items = []
+          JSON.parse(response.body).each do |event_item|
+            event_items << Components::EventItem.create(event_item)
+          end
+
+          event_items
+        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)
+          url = Util::Config.get('endpoints.base_url') + 
+                sprintf(Util::Config.get('endpoints.event_item'), event_id, item_id)
+          url = build_url(url)
+          response = RestClient.get(url, get_headers(access_token))
+          Components::EventItem.create(JSON.parse(response.body))
+        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)
+          url = Util::Config.get('endpoints.base_url') +
+                sprintf(Util::Config.get('endpoints.event_items'), event_id)
+          url = build_url(url)
+          payload = event_item.to_json
+          response = RestClient.post(url, payload, get_headers(access_token))
+          Components::EventItem.create(JSON.parse(response.body))
+        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)
+          url = Util::Config.get('endpoints.base_url') +
+                sprintf(Util::Config.get('endpoints.event_item'), event_id, item_id)
+          url = build_url(url)
+          response = RestClient.delete(url, get_headers(access_token))
+          response.code == 204
+        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)
+          url = Util::Config.get('endpoints.base_url') +
+                sprintf(Util::Config.get('endpoints.event_item'), event_id, event_item.id)
+          url = build_url(url)
+          payload = event_item.to_json
+          response = RestClient.put(url, payload, get_headers(access_token))
+          Components::EventItem.create(JSON.parse(response.body))
+        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)
+          url = Util::Config.get('endpoints.base_url') + 
+                sprintf(Util::Config.get('endpoints.event_item_attributes'), event_id, item_id)
+          url = build_url(url)
+          response = RestClient.get(url, get_headers(access_token))
+
+          event_item_attributes = []
+          JSON.parse(response.body).each do |event_item_attribute|
+            event_item_attributes << Components::EventItemAttribute.create(event_item_attribute)
+          end
+
+          event_item_attributes
+        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)
+          url = Util::Config.get('endpoints.base_url') + 
+                sprintf(Util::Config.get('endpoints.event_item_attribute'), event_id, item_id, attribute_id)
+          url = build_url(url)
+          response = RestClient.get(url, get_headers(access_token))
+          Components::EventItemAttribute.create(JSON.parse(response.body))
+        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)
+          url = Util::Config.get('endpoints.base_url') +
+                sprintf(Util::Config.get('endpoints.event_item_attributes'), event_id, item_id)
+          url = build_url(url)
+          payload = event_item_attribute.to_json
+          response = RestClient.post(url, payload, get_headers(access_token))
+          Components::EventItemAttribute.create(JSON.parse(response.body))
+        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)
+          url = Util::Config.get('endpoints.base_url') +
+                sprintf(Util::Config.get('endpoints.event_item_attribute'), event_id, item_id, attribute_id)
+          url = build_url(url)
+          response = RestClient.delete(url, get_headers(access_token))
+          response.code == 204
+        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)
+          url = Util::Config.get('endpoints.base_url') +
+                sprintf(Util::Config.get('endpoints.event_item'), event_id, item_id, event_item_attribute.id)
+          url = build_url(url)
+          payload = event_item_attribute.to_json
+          response = RestClient.put(url, payload, get_headers(access_token))
+          Components::EventItemAttribute.create(JSON.parse(response.body))
+        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)
+          url = Util::Config.get('endpoints.base_url') + 
+                sprintf(Util::Config.get('endpoints.event_promocodes'), event_id)
           url = build_url(url)
+          response = RestClient.get(url, get_headers(access_token))
+
+          promocodes = []
+          JSON.parse(response.body).each do |promocode|
+            promocodes << Components::Promocode.create(promocode)
+          end
+
+          promocodes
+        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)
+          url = Util::Config.get('endpoints.base_url') + 
+                sprintf(Util::Config.get('endpoints.event_promocode'), event_id, promocode_id)
+          url = build_url(url)
           response = RestClient.get(url, get_headers(access_token))
-         registrant = Components::Registrant.create(JSON.parse(response.body))
+          Components::Promocode.create(JSON.parse(response.body))
+        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)
+          url = Util::Config.get('endpoints.base_url') +
+                sprintf(Util::Config.get('endpoints.event_promocodes'), event_id)
+          url = build_url(url)
+          payload = promocode.to_json
+          response = RestClient.post(url, payload, get_headers(access_token))
+          Components::Promocode.create(JSON.parse(response.body))
+        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)
+          url = Util::Config.get('endpoints.base_url') +
+                sprintf(Util::Config.get('endpoints.event_promocode'), event_id, promocode_id)
+          url = build_url(url)
+          response = RestClient.delete(url, get_headers(access_token))
+          response.code == 204
         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)
+          url = Util::Config.get('endpoints.base_url') +
+                sprintf(Util::Config.get('endpoints.event_promocode'), event_id, promocode.id)
+          url = build_url(url)
+          payload = promocode.to_json
+          response = RestClient.put(url, payload, get_headers(access_token))
+          Components::Promocode.create(JSON.parse(response.body))
+        end
+
+
       end
     end
   end