flex_commerce_api 0.6.57

data/app/models/container_coupon.rb

@@ -0,0 +1,12 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce ContainerCoupon model
+  #
+  #
+  class ContainerCoupon < FlexCommerceApi::ApiBase
+    has_one :promotion, class_name: "FlexCommerce::Promotion"
+    belongs_to :order, class_name: "FlexCommerce::Order"
+
+  end
+end

data/app/models/country.rb

@@ -0,0 +1,11 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce Country model
+  #
+  #
+  #
+  class Country < FlexCommerceApi::ApiBase
+
+  end
+end

data/app/models/coupon.rb

@@ -0,0 +1,18 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce Coupon model
+  #
+  # A coupon can be created with a cart id the path
+  #
+  # It is used much like an active record model.
+  #
+  # Examples:
+  #
+  # FlexCommerce::Coupon.create(coupon_code: "coupon1", path: { cart_id: current_cart.id })
+  #
+  class Coupon < FlexCommerceApi::ApiBase
+    belongs_to :cart, class_name: "FlexCommerce::Cart"
+
+  end
+end

data/app/models/customer_account.rb

@@ -0,0 +1,96 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce Customer Account model
+  #
+  # This model provides access to the flex commerce customer account and associated cart.
+  # It is used much like an active record model.
+  #
+  # Examples:
+  #
+  #
+  #
+  #   # Creating an account
+  #
+  #   FlexCommerce::CustomerAccount.create #creates and returns a new account ready for use
+  #
+  #   # Fetching its cart
+  #
+  #   account.cart
+  #
+  #   # Finding an account
+  #
+  #   FlexCommerce::CustomerAccount.find(<<customer_account_id>>) # Finds the account with this unique id
+  #
+  #
+  class CustomerAccount < FlexCommerceApi::ApiBase
+    # @method find
+    # @param [String] spec
+    # Finds an account
+    # @return [FlexCommerce::CustomerAccount] customer_account The customer account
+    # @raise [FlexCommerceApi::Error::NotFound] If not found
+
+    # @method cart
+    # Provides access to the customers cart
+    # @return FlexCommerce::Cart
+
+    # @TODO Document other popular methods that we will support
+
+    has_one :cart, class_name: "::FlexCommerce::Cart"
+    has_many :addresses, class_name: "::FlexCommerce::Address"
+    has_many :customer_segments, class_name: "::FlexCommerce::CustomerSegment"
+    has_many :notes, class_name: "::FlexCommerce::Note"
+    has_many :orders, class_name: "::FlexCommerce::RemoteOrder"
+    has_one :password_recovery, class_name: "::FlexCommerce::PasswordRecovery"
+
+    property :email, type: :string
+    property :reference, type: :string
+    property :password, type: :string
+
+
+    def self.authenticate(attributes = {})
+      FlexCommerce::CustomerAccountAuthentication.create(attributes).customer_account
+    rescue ::FlexCommerceApi::Error::NotFound
+      nil
+    end
+
+    def self.find_by_email(email)
+      requestor.custom("email:#{URI.encode_www_form_component(email)}", {request_method: :get}, {}).first
+    rescue ::FlexCommerceApi::Error::NotFound
+      nil
+    end
+
+    def self.find_by_reference(reference)
+      requestor.custom("reference:#{reference}", {request_method: :get}, {}).first
+    rescue ::FlexCommerceApi::Error::NotFound
+      nil
+    end
+
+    # Find customer account by password reset token provided in email's link
+    # Used in reset password scenario
+    def self.find_by_token(token)
+      requestor.custom("token:#{token}", {request_method: :get}, {}).first
+    rescue ::FlexCommerceApi::Error::NotFound
+      nil
+    end
+
+    def generate_token(attributes)
+      ::FlexCommerce::PasswordRecovery.create(attributes.merge(customer_account_id: id))
+    end
+
+    def reset_password(attributes)
+      password_recovery.id = nil # because it is singletone resource, otherwise id is injected into path
+      password_recovery.update(attributes.merge(customer_account_id: id))
+      password_recovery
+    end
+
+    def orders
+      return super if relationships[:orders].key?("data")
+      get_related(:orders)
+    end
+
+    def create_note(attributes = {})
+      ::FlexCommerce::Note.create(attributes.merge(attached_to_id: self.id, attached_to_type: self.class.name.demodulize))
+    end
+  end
+end

data/app/models/customer_account_authentication.rb

@@ -0,0 +1,5 @@
+module FlexCommerce
+  class CustomerAccountAuthentication < FlexCommerceApi::ApiBase
+
+  end
+end

data/app/models/customer_segment.rb

@@ -0,0 +1,6 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  class CustomerSegment < FlexCommerceApi::ApiBase
+    has_many :customer_segment_members
+  end
+end

data/app/models/customer_segment_member.rb

@@ -0,0 +1,6 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  class CustomerSegmentMember < FlexCommerceApi::ApiBase
+    has_one :customer_segment
+  end
+end

data/app/models/data_attribute.rb

@@ -0,0 +1,6 @@
+require "flex_commerce_api/api_base"
+
+module FlexCommerce
+  class DataAttribute < FlexCommerceApi::ApiBase
+  end
+end

data/app/models/data_store_record.rb

@@ -0,0 +1,9 @@
+require "flex_commerce_api/api_base"
+
+module FlexCommerce
+  class DataStoreRecord < FlexCommerceApi::ApiBase
+    def self.table_name
+      'generic_data_store/records'
+    end
+  end
+end

data/app/models/data_store_type.rb

@@ -0,0 +1,9 @@
+require "flex_commerce_api/api_base"
+
+module FlexCommerce
+  class DataStoreType < FlexCommerceApi::ApiBase
+    def self.table_name
+      'generic_data_store/record_types'
+    end
+  end
+end

data/app/models/discount_summary.rb

@@ -0,0 +1,12 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce discount summary model
+  #
+  # This model is used by the Cart model as an association so is not
+  # usable directly on the API as there is no corresponding URL
+  #
+  #
+  class DiscountSummary < FlexCommerceApi::ApiBase
+  end
+end

data/app/models/email.rb

@@ -0,0 +1,5 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  class Email < FlexCommerceApi::ApiBase
+  end
+end

data/app/models/ewis_opt_in.rb

@@ -0,0 +1,8 @@
+require "flex_commerce_api/api_base"
+  module FlexCommerce
+
+  # A flex commerce Email When In Stock (EWIS) model
+
+    class EwisOptIn < FlexCommerceApi::ApiBase
+    end
+end

data/app/models/external_url.rb

@@ -0,0 +1,6 @@
+require "flex_commerce_api/api_base"
+
+module FlexCommerce
+  class ExternalUrl < FlexCommerceApi::ApiBase
+  end
+end

data/app/models/free_shipping_promotion.rb

@@ -0,0 +1,12 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex Free Shipping Promotion summary model
+  #
+  # This model is used by the Cart model as an association so is not
+  # usable directly on the API as there is no corresponding URL
+  #
+  #
+  class FreeShippingPromotion < FlexCommerceApi::ApiBase
+  end
+end

data/app/models/import.rb

@@ -0,0 +1,6 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  class Import < FlexCommerceApi::ApiBase
+    has_many :import_entries, class_name: "FlexCommerce::ImportEntry"
+  end
+end

data/app/models/import_entry.rb

@@ -0,0 +1,6 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  class ImportEntry < FlexCommerceApi::ApiBase
+    belongs_to :import, class_name: "FlexCommerce::Import"
+  end
+end

data/app/models/line_item.rb

@@ -0,0 +1,34 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce LineItem model
+  #
+  # This model provides access to the flex commerce cart's line_items.
+  # This model allows you to create a line_item, update its contents, delete a line_item or list the line items for a specific cart.
+  #
+  # It is used much like an active record model.
+  #
+  # Examples:
+  #
+  #
+  #
+  #   # Creating a line item for a specific cart
+  #
+  #   FlexCommerce::LineItem.create container: cart, item: variant, unit_quantity: 3 #creates and returns a new line item ready for use
+  #
+  class LineItem < FlexCommerceApi::ApiBase
+
+    # @method item
+    # The item (either a variant or a bundle)
+    # @return [FlexCommerce::Variant|FlexCommerce::Bundle]
+
+    # @TODO Document other popular methods that we will support
+
+    has_one :item
+    belongs_to :cart, class_name: "::FlexCommerce::Cart"
+
+
+    # note: only embedded in order responses, not carts
+    has_many :line_item_discounts, class_name: "::FlexCommerce::LineItemDiscount"
+  end
+end

data/app/models/line_item_discount.rb

@@ -0,0 +1,7 @@
+require "flex_commerce_api/api_base"
+
+module FlexCommerce
+  class LineItemDiscount < FlexCommerceApi::ApiBase
+    has_one :promotion, class_name: "::FlexCommerce::Promotion"
+  end
+end

data/app/models/markdown_price.rb

@@ -0,0 +1,11 @@
+require "flex_commerce_api/api_base"
+
+module FlexCommerce
+  class MarkdownPrice < FlexCommerceApi::ApiBase
+    belongs_to :variant
+
+    def active?
+      Time.now.between?(start_at, end_at)
+    end
+  end
+end

data/app/models/menu.rb

@@ -0,0 +1,36 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce Menu model
+  #
+  # This model provides access to the flex commerce menus.
+  # As managing the menus is the job of the administration panel, this
+  # model is read only.
+  #
+  # It is used much like an active record model.
+  #
+  # Examples:
+  #
+  #
+  #
+  #   # Fetching all menus
+  #
+  #   FlexCommerce::Menu.all #fetches all menus(actually the first page in case there are thousands)
+  #
+  #   # Finding a specific menu
+  #
+  #   FlexCommerce::Menu.find("my-menu-reference") # Finds the menu with this unique id
+  #
+  #   # Finding nested menu items of the menu (See MenuItem class for what you can do with this including getting nested menu items)
+  #
+  #   FlexCommerce::Menu.find("my-product-slug").menu_items
+  #
+  #
+  class Menu < FlexCommerceApi::ApiBase
+    has_many :menu_items
+    # This model has a path attribute so path can no longer be used to modify the path
+    def self.path(params = nil, record = nil)
+      super(params.nil? ? nil : params.except("path"), record)
+    end
+  end
+end

data/app/models/menu_item.rb

@@ -0,0 +1,7 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  class MenuItem < FlexCommerceApi::ApiBase
+    belongs_to :menu, class_name: "::FlexCommerce::Menu"
+    has_many :menu_items
+  end
+end

data/app/models/menu_item_item.rb

@@ -0,0 +1,5 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  class MenuItemItem < FlexCommerceApi::ApiBase
+  end
+end

data/app/models/note.rb

@@ -0,0 +1,18 @@
+require "flex_commerce_api/api_base"
+  #
+  # A flex commerce Note model
+  #
+  # This model provides access to flex commerce notes
+  #
+  # It is used much like an active record model.
+  #
+  # Examples:
+  #
+  #   # Fetching notes for a specific customer account
+  #   FlexCommerce::Note.where(customer_account_id: 1).all
+  #
+module FlexCommerce
+  class Note < FlexCommerceApi::ApiBase
+    # @TODO Document popular methods that we will support
+  end
+end

data/app/models/order.rb

@@ -0,0 +1,38 @@
+require "flex_commerce_api/api_base"
+
+module FlexCommerce
+  #
+  # A flex commerce Order model
+  #
+  # This model provides access to the flex commerce order
+  #
+  #
+  #
+  class Order < FlexCommerceApi::ApiBase
+    has_many :transactions, class_name: "::FlexCommerce::OrderTransaction"
+    has_many :line_items, class_name: "::FlexCommerce::LineItem"
+    has_many :coupons, class_name: "::FlexCommerce::ContainerCoupon"
+    has_one :shipping_promotion, class_name: "::FlexCommerce::Promotion"
+    has_one :shipping_address, class_name: "::FlexCommerce::Address"
+    has_one :billing_address, class_name: "::FlexCommerce::Address"
+
+    def self.path(params = nil, record = nil)
+      if params && params[:filter] && (customer_id = params[:filter].delete(:customer_account_id))
+        File.join("customer_accounts/%d" % customer_id, super)
+      else
+        super
+      end
+    end
+
+  end
+
+  def self.create(attributes = {})
+    super(attributes.merge(extra_attributes))
+  end
+
+  def self.extra_attributes
+    extras = {}
+    extras.merge!(test: true) if FlexCommerceApi.config.order_test_mode
+    extras
+  end
+end

data/app/models/password_recovery.rb

@@ -0,0 +1,20 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce Password Recovery model
+  #
+  # This model provides access to the flex commerce customer account password recovery functionality.
+  # It is used much like an active record model.
+
+  class PasswordRecovery < FlexCommerceApi::ApiBase
+    belongs_to :customer_account, class_name: "::FlexCommerce::CustomerAccount"
+
+    def self.path(params, *args)
+      # Since it is singletone resource, use singular name in path and remove id
+      params.delete(:id)
+      path = super.gsub(table_name, resource_name)
+      params.delete(:customer_account_id)
+      path
+    end
+  end
+end