perka 1.0.pre

data/lib/perka/model/merchant_capability.rb

@@ -0,0 +1,16 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/base_entity_global'
+
+module Perka
+  module Model 
+
+    # Describes a limitation placed upon a Merchant. This type associates a Merchant, 
+    # a Type, and a integral count describing the actual limit.
+    class MerchantCapability < BaseEntityGlobal
+
+
+
+    end
+  end
+end

data/lib/perka/model/merchant_device.rb

@@ -0,0 +1,29 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/base_entity_global'
+
+module Perka
+  module Model 
+
+    # Represents a device running the Merchant Validator app.
+    class MerchantDevice < BaseEntityGlobal
+
+      PROPERTY_NAMES = [
+        :merchant_location,
+        :serial_number,
+        :make,
+        :os_version,
+        :platform,
+        :model,
+        :identifier
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+      require 'perka/model/merchant_location'
+      TYPE_MAP = {
+        :merchant_location => Perka::Model::MerchantLocation
+      }
+
+    end
+  end
+end

data/lib/perka/model/merchant_location.rb

@@ -0,0 +1,46 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/base_entity_global'
+
+module Perka
+  module Model 
+
+    # Represents a single physical location operated by a Merchant where Customers 
+    # can participate in a Perka loyalty program.
+    class MerchantLocation < BaseEntityGlobal
+
+      PROPERTY_NAMES = [
+        :phone,
+        :merchant,
+        :timezone,
+
+        # The named Clerks which are allowed to operate on the MerchantLocation. 
+        # This relationship is owned by the Clerk object.
+        :clerks,
+
+        # Used to implicitly concatenate the <code>address</code> and <code>address2</code> 
+        # fields in a friendly format.
+        :combined_address,
+        :coupon_visibilities,
+        :distance_in_meters,
+        :latitude,
+        :longitude,
+        :merchant_devices,
+        :neighborhood_name,
+        :resolved_facebook_id,
+        :sms_id,
+        :street_address,
+        :geo_location
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+      require 'perka/model/street_address'
+      require 'perka/model/merchant'
+      TYPE_MAP = {
+        :street_address => Perka::Model::StreetAddress,
+        :merchant => Perka::Model::Merchant
+      }
+
+    end
+  end
+end

data/lib/perka/model/merchant_user.rb

@@ -0,0 +1,29 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/abstract_user'
+
+module Perka
+  module Model 
+
+    # Represents a business owner or manager who is allowed to modify the associated 
+    # <entityReference payloadName='merchant'> Merchant</entityReference> object.
+    class MerchantUser < AbstractUser
+
+      PROPERTY_NAMES = [
+        :email,
+        :unconfirmed_email,
+        :merchant,
+        :weekly_email_enabled,
+        :sms_messages,
+        :outbound_messages
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+      require 'perka/model/merchant'
+      TYPE_MAP = {
+        :merchant => Perka::Model::Merchant
+      }
+
+    end
+  end
+end

data/lib/perka/model/nobody_target.rb

@@ -0,0 +1,15 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/coupon_target'
+
+module Perka
+  module Model 
+
+    # A simple target that disallows all customers.
+    class NobodyTarget < CouponTarget
+
+
+
+    end
+  end
+end

data/lib/perka/model/outbound_message.rb

@@ -0,0 +1,14 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/base_entity_global'
+
+module Perka
+  module Model 
+
+    class OutboundMessage < BaseEntityGlobal
+
+
+
+    end
+  end
+end

data/lib/perka/model/parameter_description.rb

@@ -0,0 +1,29 @@
+# Generated File - DO NOT EDIT
+
+require 'flatpack_core'
+
+module Perka
+  module Model 
+
+    # Describes a path or query parameter in <entityReference payloadName='endpointDescription'> 
+    # EndpointDescription</entityReference>.
+    class ParameterDescription < Flatpack::Core::BaseHasUuid
+
+      PROPERTY_NAMES = [
+        :doc_string,
+        :endpoint,
+        :name,
+        :type
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+      require 'perka/model/type'
+      require 'perka/model/endpoint_description'
+      TYPE_MAP = {
+        :type => Perka::Model::Type,
+        :endpoint => Perka::Model::EndpointDescription
+      }
+
+    end
+  end
+end

data/lib/perka/model/participation_target.rb

@@ -0,0 +1,34 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/list_target'
+
+module Perka
+  module Model 
+
+    # Classifies customers based on their performance within the <entityReference 
+    # payloadName='program'> Program</entityReference> associated with a <entityReference 
+    # payloadName='programType'> ProgramType</entityReference>.
+    class ParticipationTarget < ListTarget
+
+      PROPERTY_NAMES = [
+
+        # The program type for which punches should be found.
+        :program_type,
+        :metric,
+
+        # The comparison value.
+        :threshold,
+
+        # A moving window used to filter the statistics.
+        :window_days
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+      require 'perka/model/program_type'
+      TYPE_MAP = {
+        :program_type => Perka::Model::ProgramType
+      }
+
+    end
+  end
+end

data/lib/perka/model/physical_redemption_target.rb

@@ -0,0 +1,17 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/coupon_target'
+
+module Perka
+  module Model 
+
+    # A CouponTarget that is always redeemable, but never visible to the customer. 
+    # This target exists to allow a merchant to redeem a Perka Coupon if the customer 
+    # has some kind of physical artifact (e.g. a mailer).
+    class PhysicalRedemptionTarget < CouponTarget
+
+
+
+    end
+  end
+end

data/lib/perka/model/points_activity.rb

@@ -0,0 +1,34 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/base_entity_global'
+
+module Perka
+  module Model 
+
+    # Represents activity in a points-based loyalty program.
+    class PointsActivity < BaseEntityGlobal
+
+      PROPERTY_NAMES = [
+        :visit,
+        :credit,
+        :current_total,
+
+        # The number of points that were redeemed
+        :charge,
+        :next_activity,
+        :redeemed
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+      require 'perka/model/points_catalog_item'
+      require 'perka/model/points_activity'
+      require 'perka/model/visit'
+      TYPE_MAP = {
+        :redeemed => Perka::Model::PointsCatalogItem,
+        :next_activity => Perka::Model::PointsActivity,
+        :visit => Perka::Model::Visit
+      }
+
+    end
+  end
+end

data/lib/perka/model/points_activity_confirmation.rb

@@ -0,0 +1,24 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/abstract_reward_confirmation'
+
+module Perka
+  module Model 
+
+    # Represents activity in a points-based loyalty program.
+    class PointsActivityConfirmation < AbstractRewardConfirmation
+
+      PROPERTY_NAMES = [
+
+        # Catalog items that are being redeemed.
+        :points_catalog_items,
+
+        # The total dollar amount spent during the transaction.
+        :money_spent
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+
+    end
+  end
+end

data/lib/perka/model/points_catalog_item.rb

@@ -0,0 +1,41 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/base_entity_global'
+
+module Perka
+  module Model 
+
+    # Defines a good or service offered by a merchant using a points-based loyalty 
+    # program.
+    class PointsCatalogItem < BaseEntityGlobal
+
+      PROPERTY_NAMES = [
+
+        # The merchant that owns the item.
+        :merchant,
+
+        # A longer text description of the item, including any terms and conditions.
+        :terms,
+
+        # The time at which the catalog item will no longer be available for redemption.
+        :expires_at,
+
+        # The number of points required to redeem the item.
+        :points_required,
+
+        # A short label for describing the item.
+        :label,
+
+        # An optional icon name used when rendering the catalog item.
+        :icon
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+      require 'perka/model/merchant'
+      TYPE_MAP = {
+        :merchant => Perka::Model::Merchant
+      }
+
+    end
+  end
+end

data/lib/perka/model/program.rb

@@ -0,0 +1,35 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/base_entity_global'
+
+module Perka
+  module Model 
+
+    # Program is a basic buy n(punchesNeeded) of x(purchasedItem), and get a free 
+    # y(freeItem) when a customer has reached a certain ProgramTier.
+    class Program < BaseEntityGlobal
+
+      PROPERTY_NAMES = [
+        :program_tier,
+        :program_type,
+        :free_item,
+        :punches_needed,
+        :image_name,
+        :perk_id,
+        :terms,
+        :punches_needed_prefix,
+        :punches_needed_suffix,
+        :purchased_item
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+      require 'perka/model/program_tier'
+      require 'perka/model/program_type'
+      TYPE_MAP = {
+        :program_tier => Perka::Model::ProgramTier,
+        :program_type => Perka::Model::ProgramType
+      }
+
+    end
+  end
+end

data/lib/perka/model/program_tier.rb

@@ -0,0 +1,30 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/base_entity_global'
+
+module Perka
+  module Model 
+
+    # A program tier defines additional benefits for customers with a certain minimum 
+    # visit count.
+    class ProgramTier < BaseEntityGlobal
+
+      PROPERTY_NAMES = [
+        :merchant,
+        :programs,
+        :tier_traversals,
+        :additional_perks,
+        :points_multiplier,
+        :visits_needed,
+        :name
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+      require 'perka/model/merchant'
+      TYPE_MAP = {
+        :merchant => Perka::Model::Merchant
+      }
+
+    end
+  end
+end

data/lib/perka/model/program_type.rb

@@ -0,0 +1,27 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/base_entity_global'
+
+module Perka
+  module Model 
+
+    # A ProgramType defines a single kind of offer made by the Merchant. For example, 
+    # a Merchant may have two ProgramTypes, one for coffee sales and another for 
+    # sandwich sales. Because Customers are offered increasingly better perks as 
+    # they return over time, a single ProgramType is used to aggregate multiple 
+    # <entityReference payloadName='program'> Program</entityReference> objects 
+    # that have a fan-out based on <entityReference payloadName='programTier'> ProgramTier</entityReference>.
+    class ProgramType < BaseEntityGlobal
+
+      PROPERTY_NAMES = [
+        :expires_at,
+        :stamp_id,
+        :name,
+        :expires_in
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+
+    end
+  end
+end

data/lib/perka/model/property.rb

@@ -0,0 +1,65 @@
+# Generated File - DO NOT EDIT
+
+require 'flatpack_core'
+
+module Perka
+  module Model 
+
+    # An immutable view of a property that should be serialized.
+    class Property < Flatpack::Core::BaseHasUuid
+
+      PROPERTY_NAMES = [
+        :doc_string,
+
+        # The payload name of the type that defines the property.
+        :enclosing_type_name,
+
+        # Returns the role names that are allowed to get the property. A value containing 
+        # a single asterisk means that all roles may access the property.
+        :getter_role_names,
+
+        # When a new value is assigned to the current property in some instance, 
+        # the implied property of the new value should also be updated with the 
+        # current instance.
+        :implied_property,
+
+        # Return the role names that are allowed to set this property. A value containing 
+        # a single asterisk means that all roles may set the property.
+        :setter_role_names,
+
+        # Returns <code>true</code> if the Property should be included only during 
+        # a deep traversal.
+        :deep_traversal_only,
+
+        # Returns <code>true</code> if the referred entity's owner should also be 
+        # considered an owner of the entity that defines the Property.
+        :inherit_principal,
+
+        # If <code>true</code>, non-null properties that contain the property type's 
+        # default value will not be serialized. For example, integer properties 
+        # whose values are <code>0</code> will not be serialized.
+        :suppress_default_value,
+
+        # Returns the json payload name of the Property, which may differ from the 
+        # bean name if a JsonProperty annotation has been applied to the getter.
+        :name,
+
+        # A simplified description of the property's type.
+        :type,
+
+        # Returns <code>true</code> if an entity Property's properties should be 
+        # emitted into the owning entity's properties.
+        :embedded
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+      require 'perka/model/type'
+      require 'perka/model/property'
+      TYPE_MAP = {
+        :type => Perka::Model::Type,
+        :implied_property => Perka::Model::Property
+      }
+
+    end
+  end
+end

data/lib/perka/model/punch_reward_confirmation.rb

@@ -0,0 +1,43 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/abstract_reward_confirmation'
+
+module Perka
+  module Model 
+
+    # Represents an award of some number of punches on a punchcard.
+    class PunchRewardConfirmation < AbstractRewardConfirmation
+
+      PROPERTY_NAMES = [
+
+        # An instance of a <entityReference payloadName='program'> Program</entityReference> 
+        # that the punches should be applied to.
+        :program,
+        :program_type,
+
+        # The number of punches to be applied to the punchcard.
+        :punches_earned,
+
+        # This property is only present when a <entityReference payloadName='punchRewardConfirmation'> 
+        # PunchRewardConfirmation</entityReference> is returned by the server to 
+        # represent past customer interactions. Normally, a <entityReference payloadName='punchRewardConfirmation'> 
+        # PunchRewardConfirmation</entityReference> is a member of a <entityReference 
+        # payloadName='rewardGrant'> RewardGrant</entityReference> or <entityReference 
+        # payloadName='visitConfirmation'> VisitConfirmation</entityReference> which 
+        # will provide a contextual <entityReference payloadName='visit'> Visit</entityReference>.
+        :visit
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+      require 'perka/model/program'
+      require 'perka/model/visit'
+      require 'perka/model/program_type'
+      TYPE_MAP = {
+        :program => Perka::Model::Program,
+        :visit => Perka::Model::Visit,
+        :program_type => Perka::Model::ProgramType
+      }
+
+    end
+  end
+end

data/lib/perka/model/push_message.rb

@@ -0,0 +1,17 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/outbound_message'
+
+module Perka
+  module Model 
+
+    # An implementation of outbound message corresponding to a message being sent 
+    # over a platform push notification system (e.g. C2DM for Android or APS for 
+    # iOS)
+    class PushMessage < OutboundMessage
+
+
+
+    end
+  end
+end

data/lib/perka/model/redemption_coupon_confirmation.rb

@@ -0,0 +1,26 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/abstract_reward_confirmation'
+
+module Perka
+  module Model 
+
+    # Represents the redemption of a <entityReference payloadName='coupon'> Coupon</entityReference>.
+    class RedemptionCouponConfirmation < AbstractRewardConfirmation
+
+      PROPERTY_NAMES = [
+
+        # The coupon that is being redeemed during the associated <entityReference 
+        # payloadName='visit'> Visit</entityReference>.
+        :coupon
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+      require 'perka/model/coupon'
+      TYPE_MAP = {
+        :coupon => Perka::Model::Coupon
+      }
+
+    end
+  end
+end

data/lib/perka/model/redemption_reward_confirmation.rb

@@ -0,0 +1,26 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/abstract_reward_confirmation'
+
+module Perka
+  module Model 
+
+    # Represents the redemption of a completed punchcard.
+    class RedemptionRewardConfirmation < AbstractRewardConfirmation
+
+      PROPERTY_NAMES = [
+
+        # The <entityReference payloadName='reward'> Reward</entityReference> that 
+        # represents a specific instance of a completed punchcard.
+        :reward
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+      require 'perka/model/reward'
+      TYPE_MAP = {
+        :reward => Perka::Model::Reward
+      }
+
+    end
+  end
+end

data/lib/perka/model/reward.rb

@@ -0,0 +1,38 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/base_entity_global'
+
+module Perka
+  module Model 
+
+    # A punchcard that a customer has filled or is in the process of filling. These 
+    # objects represent an aggregated view of the effects of applying <entityReference 
+    # payloadName='punchRewardConfirmation'> PunchRewardConfirmation</entityReference>. 
+    # A Reward may be redeemed once it has been activated.
+    class Reward < BaseEntityGlobal
+
+      PROPERTY_NAMES = [
+        :customer,
+        :merchant,
+        :program,
+        :punches_earned,
+        :reward_advancements,
+        :activated_at,
+        :redeemed_at,
+        :transferred_at,
+        :type
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+      require 'perka/model/merchant'
+      require 'perka/model/program'
+      require 'perka/model/customer'
+      TYPE_MAP = {
+        :merchant => Perka::Model::Merchant,
+        :program => Perka::Model::Program,
+        :customer => Perka::Model::Customer
+      }
+
+    end
+  end
+end

data/lib/perka/model/reward_advancement.rb

@@ -0,0 +1,30 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/base_entity_global'
+
+module Perka
+  module Model 
+
+    # Represents partial progress towards completing a Reward (i.e. some number 
+    # of punches). These objects represent the aggregated effects of applying a 
+    # <entityReference payloadName='punchRewardConfirmation'> PunchRewardConfirmation</entityReference>.
+    class RewardAdvancement < BaseEntityGlobal
+
+      PROPERTY_NAMES = [
+        :punches_earned,
+        :reward,
+        :visit,
+        :transfer
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+      require 'perka/model/reward'
+      require 'perka/model/visit'
+      TYPE_MAP = {
+        :reward => Perka::Model::Reward,
+        :visit => Perka::Model::Visit
+      }
+
+    end
+  end
+end