perka 1.0.pre

data/lib/perka/model/bounce_back_target.rb

@@ -0,0 +1,33 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/yield_management_target'
+
+module Perka
+  module Model 
+
+    class BounceBackTarget < YieldManagementTarget
+
+      PROPERTY_NAMES = [
+
+        # Returns the minutes-of-day that the bounceback window closes.
+        :local_open_end_at,
+
+        # Returns the minutes-of-day that the bounceback window opens.
+        :local_open_start_at,
+
+        # Returns the maximum number of times a customer may redeem the bounce-back 
+        # coupon within any given bounce-back window. This property is separate 
+        # from the maximum number of times the associated Coupon may be redeemed. 
+        # The default value is <code>1</code>. A value of <code>0</code> allows 
+        # unlimited use of the bounce-back offer.
+        :redemption_count_per_window,
+
+        # Returns the minutes-of-day that the bounceback window closes.
+        :redemption_days
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+
+    end
+  end
+end

data/lib/perka/model/canned_email_outbound_message.rb

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

data/lib/perka/model/clerk.rb

@@ -0,0 +1,41 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/abstract_user'
+
+module Perka
+  module Model 
+
+    # A Clerk represents either an employee identity or a role identity used by 
+    # the validator app. <p> Two distinct classes of Clerks exist: <ul> <li>Named 
+    # clerks, representing a user authorized to perform actions at zero or more 
+    # locations <li>Anonymous clerks, representing an access role for a single location 
+    # </ul> A named clerk must downgrade to an anonymous clerk in order to perform 
+    # validations at a single location. This avoids the need to store any particular 
+    # user's credentials in the validator app.
+    class Clerk < AbstractUser
+
+      PROPERTY_NAMES = [
+        :email,
+        :unconfirmed_email,
+
+        # The <entityReference payloadName='merchant'> Merchant</entityReference> 
+        # that owns the clerk account.
+        :merchant,
+
+        # The locations that the clerk is allowed to interact with.
+        :merchant_locations,
+
+        # Indicates if the Clerk is an anonymous role account used by a validator 
+        # application at a single location.
+        :anonymous
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+      require 'perka/model/merchant'
+      TYPE_MAP = {
+        :merchant => Perka::Model::Merchant
+      }
+
+    end
+  end
+end

data/lib/perka/model/composite_target.rb

@@ -0,0 +1,22 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/coupon_target'
+
+module Perka
+  module Model 
+
+    # A <entityReference payloadName='couponTarget'> CouponTarget</entityReference> 
+    # that acts as a union or intersection of other <entityReference payloadName='couponTarget'> 
+    # CouponTarget</entityReference> objects.
+    class CompositeTarget < CouponTarget
+
+      PROPERTY_NAMES = [
+        :operation,
+        :children
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+
+    end
+  end
+end

data/lib/perka/model/console_message.rb

@@ -0,0 +1,16 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/outbound_message'
+
+module Perka
+  module Model 
+
+    # Test implementation of OutboundMessage for text messages intended for console 
+    # output for debugging.
+    class ConsoleMessage < OutboundMessage
+
+
+
+    end
+  end
+end

data/lib/perka/model/coupon.rb

@@ -0,0 +1,52 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/base_entity_global'
+
+module Perka
+  module Model 
+
+    # Represents a specific offer extended to a merchant's customer base.
+    class Coupon < BaseEntityGlobal
+
+      PROPERTY_NAMES = [
+        :summary,
+        :redemption_limit,
+
+        # The CouponVisibilites that control where and to whom the Coupon is available.
+        :coupon_visibilities,
+
+        # The parent CouponCampaign that aggregates related Coupons.
+        :coupon_campaign,
+
+        # The short perk icon name (e.g. <code>unicorn</code>).
+        :image_name,
+
+        # This property doesn't represent a single instance in time (i.e. a number 
+        # of milliseconds past the epoch in UTC time). Instead, this value must 
+        # be interpreted using the user's local timezone. For example, if the exact 
+        # instant stored in this value is noon UTC time on such-and-such a day, 
+        # this value should be interpreted to mean noon on that same date in the 
+        # user's local timezone.
+        :local_begins_at,
+
+        # See note on #getLocalBeginsAt() on how to interpret this.
+        :local_ends_at,
+        :notify_minutes_before,
+        :perk_id,
+        :url,
+
+        # Indicates whether or not the Coupon will be actively pushed to customer 
+        # devices, or if it is a passive coupon.
+        :push_enabled,
+        :title
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+      require 'perka/model/coupon_campaign'
+      TYPE_MAP = {
+        :coupon_campaign => Perka::Model::CouponCampaign
+      }
+
+    end
+  end
+end

data/lib/perka/model/coupon_campaign.rb

@@ -0,0 +1,26 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/base_entity_global'
+
+module Perka
+  module Model 
+
+    # A CouponCampaign defines a relationship between what a merchant thinks of 
+    # as a coupon and the collection of Coupon objects that implement the behavior. 
+    # In general, a campaign consists of Coupons that span a non-contiguous set 
+    # of time ranges, but that are otherwise identical in configuration.
+    class CouponCampaign < BaseEntityGlobal
+
+      PROPERTY_NAMES = [
+        :coupons,
+
+        # Retains the original <code>RRULE</code> string used to construct the campaign.
+        :rrule,
+        :title
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+
+    end
+  end
+end

data/lib/perka/model/coupon_redemption.rb

@@ -0,0 +1,26 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/base_entity_global'
+
+module Perka
+  module Model 
+
+    class CouponRedemption < BaseEntityGlobal
+
+      PROPERTY_NAMES = [
+        :coupon,
+        :visit,
+        :redeemed_at
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+      require 'perka/model/visit'
+      require 'perka/model/coupon'
+      TYPE_MAP = {
+        :visit => Perka::Model::Visit,
+        :coupon => Perka::Model::Coupon
+      }
+
+    end
+  end
+end

data/lib/perka/model/coupon_target.rb

@@ -0,0 +1,30 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/base_entity_global'
+
+module Perka
+  module Model 
+
+    # The CustomerClass hierarchy defines memberships rules that have been defined 
+    # by a Merchant.
+    class CouponTarget < BaseEntityGlobal
+
+      PROPERTY_NAMES = [
+        :merchant,
+
+        # An optional child-to-parent relationship that allows behaviors to be aggregated 
+        # together.
+        :parent
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+      require 'perka/model/merchant'
+      require 'perka/model/composite_target'
+      TYPE_MAP = {
+        :merchant => Perka::Model::Merchant,
+        :parent => Perka::Model::CompositeTarget
+      }
+
+    end
+  end
+end

data/lib/perka/model/coupon_visibility.rb

@@ -0,0 +1,29 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/base_entity_global'
+
+module Perka
+  module Model 
+
+    class CouponVisibility < BaseEntityGlobal
+
+      PROPERTY_NAMES = [
+        :merchant_location,
+        :coupon,
+        :coupon_target,
+        :coupon_target_type
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+      require 'perka/model/merchant_location'
+      require 'perka/model/coupon_target'
+      require 'perka/model/coupon'
+      TYPE_MAP = {
+        :merchant_location => Perka::Model::MerchantLocation,
+        :coupon_target => Perka::Model::CouponTarget,
+        :coupon => Perka::Model::Coupon
+      }
+
+    end
+  end
+end

data/lib/perka/model/customer.rb

@@ -0,0 +1,41 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/abstract_user'
+
+module Perka
+  module Model 
+
+    # A Customer is someone who visits a <entityReference payloadName='merchantLocation'> 
+    # MerchantLocation</entityReference> and engages in a retail transaction.
+    class Customer < AbstractUser
+
+      PROPERTY_NAMES = [
+        :avatar_url,
+        :customer_devices,
+
+        # The integrator that created the Customer object.
+        :managed_by,
+        :rewards,
+        :sms_messages,
+        :social_service_subscriptions,
+        :tier_traversals,
+
+        # You probably want #getLastVisit().
+        :visits,
+        :waiting_merchant_location,
+        :waiting_name_since,
+        :specials_messaging_enabled,
+        :email
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+      require 'perka/model/merchant_location'
+      require 'perka/model/integrator_user'
+      TYPE_MAP = {
+        :waiting_merchant_location => Perka::Model::MerchantLocation,
+        :managed_by => Perka::Model::IntegratorUser
+      }
+
+    end
+  end
+end

data/lib/perka/model/customer_device.rb

@@ -0,0 +1,23 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/base_entity_global'
+
+module Perka
+  module Model 
+
+    # Represents a smartphone device associated with a specific Customer.
+    class CustomerDevice < BaseEntityGlobal
+
+      PROPERTY_NAMES = [
+        :customer
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+      require 'perka/model/customer'
+      TYPE_MAP = {
+        :customer => Perka::Model::Customer
+      }
+
+    end
+  end
+end

data/lib/perka/model/endpoint_description.rb

@@ -0,0 +1,49 @@
+# Generated File - DO NOT EDIT
+
+require 'flatpack_core'
+
+module Perka
+  module Model 
+
+    # Describes an <code>HTTP</code> request endpoint.
+    class EndpointDescription < Flatpack::Core::BaseHasUuid
+
+      PROPERTY_NAMES = [
+
+        # Describes any query parameters for the endpoint.
+        :query_parameters,
+
+        # The expected entity type for the request. Generally, the <code>HTTP POST</code> 
+        # body.
+        :entity,
+
+        # Describes any parameters embedded in #getPath().
+        :path_parameters,
+        :doc_string,
+
+        # Return the role names that are allowed to access the endpoint. A <code>null</code> 
+        # value means that all roles are allowed, while a zero-length value means 
+        # that no roles are allowed.
+        :role_names,
+
+        # The HTTP method used to access the endpoint.
+        :method,
+
+        # The expected contents for the HTTP response.
+        :return_type,
+
+        # The path used to access the endpoint.
+        :path
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+      require 'perka/model/type'
+      require 'perka/model/type'
+      TYPE_MAP = {
+        :entity => Perka::Model::Type,
+        :return_type => Perka::Model::Type
+      }
+
+    end
+  end
+end

data/lib/perka/model/entity_annotation.rb

@@ -0,0 +1,33 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/base_entity_global'
+
+module Perka
+  module Model 
+
+    # Allows integrators to associate an arbitrary JSON object with a persistent 
+    # entity. Any instance of an EntityAnnotation is specific to a particular IntegratorUser 
+    # and multiple integrators may annotate the same entity. <p> When a request 
+    # is made to the API server by an integrator or by any other user that is managed 
+    # by an integrator, any EntityAnnotations associated with objects in the returned 
+    # payload will be included as extra data.
+    class EntityAnnotation < BaseEntityGlobal
+
+      PROPERTY_NAMES = [
+
+        # The target entity for the annotation.
+        :entity,
+
+        # The custom data which may be any JSON value.
+        :annotation
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+      require 'perka/model/base_entity_global'
+      TYPE_MAP = {
+        :entity => Perka::Model::BaseEntityGlobal
+      }
+
+    end
+  end
+end

data/lib/perka/model/entity_description.rb

@@ -0,0 +1,31 @@
+# Generated File - DO NOT EDIT
+
+require 'flatpack_core'
+
+module Perka
+  module Model 
+
+    # A description of an entity type.
+    class EntityDescription < Flatpack::Core::BaseHasUuid
+
+      PROPERTY_NAMES = [
+
+        # Indicates that instance of the the type may be persisted by the server. 
+        # This hint can be used to reduce payload sizes by transmitting only mutated 
+        # properties.
+        :persistent,
+        :doc_string,
+        :supertype,
+        :properties,
+        :type_name
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+      require 'perka/model/entity_description'
+      TYPE_MAP = {
+        :supertype => Perka::Model::EntityDescription
+      }
+
+    end
+  end
+end

data/lib/perka/model/everybody_target.rb

@@ -0,0 +1,15 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/coupon_target'
+
+module Perka
+  module Model 
+
+    # The simplest of all targets that includes all customers.
+    class EverybodyTarget < CouponTarget
+
+
+
+    end
+  end
+end

data/lib/perka/model/feedback_item.rb

@@ -0,0 +1,28 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/base_entity_global'
+
+module Perka
+  module Model 
+
+    # Feedback left by a Customer after a Visit has been completed.
+    class FeedbackItem < BaseEntityGlobal
+
+      PROPERTY_NAMES = [
+        :visit,
+        :rating,
+        :customer_name,
+        :feedback,
+        :signed,
+        :visit_uuid
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+      require 'perka/model/visit'
+      TYPE_MAP = {
+        :visit => Perka::Model::Visit
+      }
+
+    end
+  end
+end

data/lib/perka/model/first_visit_target.rb

@@ -0,0 +1,16 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/coupon_target'
+
+module Perka
+  module Model 
+
+    # A Customer is a member of the class if they have no confirmed visits to any 
+    # of the Merchant's locations.
+    class FirstVisitTarget < CouponTarget
+
+
+
+    end
+  end
+end

data/lib/perka/model/idle_customer_target.rb

@@ -0,0 +1,20 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/list_target'
+
+module Perka
+  module Model 
+
+    # The customers whose last confirmed visit was more than some number of days 
+    # ago.
+    class IdleCustomerTarget < ListTarget
+
+      PROPERTY_NAMES = [
+        :idle_days
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+
+    end
+  end
+end

data/lib/perka/model/integrator_user.rb

@@ -0,0 +1,16 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/abstract_user'
+
+module Perka
+  module Model 
+
+    # An identity that represents an external API consumer. The IntegratorUser is 
+    # mainly used to obtain access tokens to act as other users.
+    class IntegratorUser < AbstractUser
+
+
+
+    end
+  end
+end

data/lib/perka/model/internal_user.rb

@@ -0,0 +1,15 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/abstract_user'
+
+module Perka
+  module Model 
+
+    # Represents a Perka customer service representative.
+    class InternalUser < AbstractUser
+
+
+
+    end
+  end
+end

data/lib/perka/model/like_to_unlock_target.rb

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

data/lib/perka/model/list_target.rb

@@ -0,0 +1,17 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/coupon_target'
+
+module Perka
+  module Model 
+
+    # A base type for customer classes that restrict a CouponVisibility to a list 
+    # of Customers. This base type is appropriate for memberships that do not change 
+    # on a frequent basis or ones that are computationally-intensive to compute.
+    class ListTarget < CouponTarget
+
+
+
+    end
+  end
+end

data/lib/perka/model/merchant.rb

@@ -0,0 +1,42 @@
+# Generated File - DO NOT EDIT
+
+require 'perka/model/base_entity_global'
+
+module Perka
+  module Model 
+
+    # Merchants operate the retail locations that offer a Perka loyalty program.
+    class Merchant < BaseEntityGlobal
+
+      PROPERTY_NAMES = [
+        :last_action_at,
+        :program_tiers,
+        :visit_expiration_minutes,
+        :merchant_locations,
+        :loyalty_type,
+
+        # A list of Clerks, which are limited to acting on specific locations.
+        :clerks,
+        :merchant_state,
+        :headline,
+        :merchant_capabilities,
+        :merchant_users,
+        :notes,
+
+        # Points-based merchants will define one or more catalog items for which 
+        # points can be redeemed.
+        :points_catalog_items,
+
+        # Points-based merchants may offer a signup bonus to new customers for signing 
+        # up.
+        :points_signup_bonus,
+        :terms,
+        :sales_demo,
+        :name
+      ]
+      attr_accessor *PROPERTY_NAMES
+
+
+    end
+  end
+end