flex_commerce_api 0.6.57

data/app/models/payment_address_verification.rb

@@ -0,0 +1,13 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce payment address verification model
+  #
+  # This model provides access to the flex commerce address verification service
+  #
+  #
+  #
+  class PaymentAddressVerification < FlexCommerceApi::ApiBase
+
+  end
+end

data/app/models/payment_process.rb

@@ -0,0 +1,13 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce PaymentProcess model
+  #
+  # This model provides access to the flex commerce "process order" resource
+  #
+  #
+  #
+  class PaymentProcess < FlexCommerceApi::ApiBase
+
+  end
+end

data/app/models/payment_provider.rb

@@ -0,0 +1,15 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce PaymentProvider model
+  #
+  # This model provides access to the flex commerce PaymentProvider which is used to
+  # define a payment gateway and provide instructions to the front end application
+  # on how to set up the gateway in a browser (i.e. redirect to paypal etc..)
+  #
+  #
+  #
+  class PaymentProvider < FlexCommerceApi::ApiBase
+
+  end
+end

data/app/models/payment_transaction.rb

@@ -0,0 +1,13 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce Order Transaction model
+  #
+  # This model provides access to the flex commerce order transaction
+  #
+  #
+  #
+  class PaymentTransaction < FlexCommerceApi::ApiBase
+
+  end
+end

data/app/models/product.rb

@@ -0,0 +1,99 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce Product model
+  #
+  # This model provides access to the flex commerce products.
+  # As managing the products is the job of the administration panel, this
+  # model is read only.
+  #
+  # It is used much like an active record model.
+  #
+  # Examples:
+  #
+  #
+  #
+  #   # Fetching all products
+  #
+  #   FlexCommerce::Product.all #fetches all products(actually the first page in case there are thousands)
+  #
+  #   # Pagination
+  #
+  #   FlexCommerce::Product.paginate(page:2).all # Fetches page 2 of products.
+  #   The page size is predefined on the server side
+  #
+  #   # Finding products
+  #
+  #   FlexCommerce::Product.find("my-product-slug") # Finds the product with this unique id
+  #
+  #   # Finding nested variants of the product
+  #
+  #   FlexCommerce::Product.find("my-product-slug").variants
+  #
+  #
+  class Product < FlexCommerceApi::ApiBase
+    # @method find
+    # @param [String] spec
+    # Finds a product
+    # @return [FlexCommerce::Product] product The product
+    # @raise [FlexCommerceApi::Error::NotFound] If not found
+
+    # @method all
+    # Returns all products
+    # @return [FlexCommerce::Product[]] An array of products or an empty array
+
+    # @method paginate
+    # Paginates the list of products by a preset page size
+    # @param [Hash] options The options to paginate with
+    # @param options [Numeric|String] :page The page to fetch
+
+    # @method variants
+    # Provides a list of associated variants
+    # @return [FlexCommerce::Variant[]]
+
+    # @TODO Document other popular methods that we will support
+
+    has_many :variants, class_name: "::FlexCommerce::Variant"
+    has_many :asset_files, class_name: "::FlexCommerce::AssetFile"
+    has_many :bundles, class_name: "::FlexCommerce::Bundle"
+    has_many :bundle_group, class_name: "::FlexCommerce::BundleGroup"
+    has_many :slugs, class_name: "::FlexCommerce::Slug"
+    has_one :template_definition, class_name: "::FlexCommerce::TemplateDefinition"
+    has_one :template, class_name: "::FlexCommerce::Template"
+
+    # TODO Decide where sku really comes from - its in the variant but not at product level like in matalan direct appears to be
+    def sku
+      reference
+    end
+    self.query_builder = ::FlexCommerceApi::JsonApiClientExtension::Builder
+    class << self
+      def_delegators :_new_scope, :temp_search
+      def path(params, *args)
+        if params[:filter] && params[:filter].key?(:category_id) && params[:filter].key?(:category_tree_id)
+          category_tree_id = params[:filter].delete(:category_tree_id)
+          category_id = params[:filter].delete(:category_id)
+          params.delete(:filter) if params[:filter].empty?
+          "category_trees/#{category_tree_id}/categories/#{category_id}/products"
+        else
+          super
+        end
+      end
+    end
+
+    def current_max_price
+      variants.map(&:current_price).max
+    end
+
+    def current_min_price
+      variants.map(&:current_price).min
+    end
+
+    # Relationship accessors
+    def add_asset_files(asset_files)
+      self.class.requestor.custom("relationships/asset_files", {request_method: :post}, {id: id, data: asset_files.map(&:as_relation)})
+    end
+
+
+    # End of relationship accessors
+  end
+end

data/app/models/product_asset_file.rb

@@ -0,0 +1,12 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce Product asset file model
+  #
+  # This model provides access to the flex commerce product asset files.
+  #
+  #
+  class ProductAssetFile < FlexCommerceApi::ApiBase
+    belongs_to :product, class_name: "FlexCommerce::Product"
+  end
+end

data/app/models/promotion.rb

@@ -0,0 +1,19 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce Promotion model
+  #
+  # This model provides access to the flex commerce promotion
+  #
+  class Promotion < FlexCommerceApi::ApiBase
+    # This adds the ability to call archive method on Promotion
+    # 
+    # @usage FlexCommerce::Promotion.find(<id>).archive
+    custom_endpoint :archive, on: :member, request_method: :patch
+
+    # This adds the ability to call unarchive method on Promotion
+    # 
+    # @usage FlexCommerce::Promotion.find(<id>).unarchive
+    custom_endpoint :unarchive, on: :member, request_method: :patch
+  end
+end

data/app/models/promotion_qualifying_product_exclusion.rb

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

data/app/models/redirect.rb

@@ -0,0 +1,14 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce Redirect model
+  #
+  # This model provides access to the flex commerce redirect
+  #
+  class Redirect < FlexCommerceApi::ApiBase
+
+    def self.find_by_path(source_path: )
+      where(source_path: source_path).first
+    end
+  end
+end

data/app/models/refund.rb

@@ -0,0 +1,14 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce Refund model
+  #
+  # This model provides access to the flex commerce refund
+  #
+  #
+  #
+  class Refund < FlexCommerceApi::ApiBase
+    belongs_to :order
+
+  end
+end

data/app/models/remote_address.rb

@@ -0,0 +1,22 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce RemoteAddress model
+  #
+  # This model provides access to the flex commerce remote addresses
+  #
+  # It is used much like an active record model.
+  #
+  # Examples:
+  #
+  #
+  #
+  #   # Fetching all addresses for a customer account
+  #
+  #   customer_account.addresses.all #fetches all addresses(actually the first page in case there are thousands)
+  #
+  #
+  class RemoteAddress < FlexCommerceApi::ApiBase
+
+  end
+end

data/app/models/remote_line_item.rb

@@ -0,0 +1,11 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce RemoteLineItem model
+  #
+  # This model provides access to the flex commerce remote order's line_items.
+  #
+  class RemoteLineItem < FlexCommerceApi::ApiBase
+
+  end
+end

data/app/models/remote_order.rb

@@ -0,0 +1,15 @@
+require "flex_commerce_api/api_base"
+
+module FlexCommerce
+  #
+  # A flex commerce Order model
+  #
+  # This model provides access to the flex commerce remote order
+  #
+  #
+  #
+  class RemoteOrder < FlexCommerceApi::ApiBase
+
+  end
+
+end

data/app/models/remote_shipping_method.rb

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

data/app/models/report.rb

@@ -0,0 +1,18 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce Report model
+  #
+  # This model provides access to the Shift Reports feature.
+  #
+  # It is used much like an active record model.
+  #
+  # Examples:
+  #
+  #   # Fetch all reports, paginated
+  #   FlexCommerce::Report.all
+  #
+  class Report < FlexCommerceApi::ApiBase
+    has_many :invocations, class_name: "::FlexCommerce::ReportInvocation"
+  end
+end

data/app/models/report_invocation.rb

@@ -0,0 +1,18 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce Report Invocation model
+  #
+  # This model provides access to the Shift Report Invocations feature.
+  #
+  # It is used much like an active record model.
+  #
+  # Examples:
+  #
+  #   # List the invocations of the first report
+  #   FlexCommerce::Report.first.invocations
+  #
+  class ReportInvocation < FlexCommerceApi::ApiBase
+    has_one :report, class_name: "::FlexCommerce::Report"
+  end
+end

data/app/models/retail_store.rb

@@ -0,0 +1,18 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce RetailStore model
+  #
+  # This model provides access to the Shift Retail Stores feature.
+  #
+  # It is used much like an active record model.
+  #
+  # Examples:
+  #
+  #   # Fetch all retail stores
+  #   FlexCommerce::RetailStore.all
+  #
+  class RetailStore < FlexCommerceApi::ApiBase
+    has_many :slugs, class_name: "::FlexCommerce::Slug"
+  end
+end

data/app/models/role.rb

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

data/app/models/search_suggestion.rb

@@ -0,0 +1,17 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce SearchSuggestion model
+  #
+  # This model provides access to the Shift Suggestive Search feature.
+  #
+  # It is used much like an active record model.
+  #
+  # Examples:
+  #
+  #   # Fetch words matching the suggestion 'sh'
+  #   FlexCommerce::SearchSuggestion.where(q: “sh”).all
+  #
+  class SearchSuggestion < FlexCommerceApi::ApiBase
+  end
+end

data/app/models/section.rb

@@ -0,0 +1,9 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce section
+  #
+  class Section < FlexCommerceApi::ApiBase
+    has_many :components, class_name: "::FlexCommerce::Component"
+  end
+end

data/app/models/session.rb

@@ -0,0 +1,8 @@
+require "flex_commerce_api/api_base"
+
+module FlexCommerce
+  class Session < FlexCommerceApi::ApiBase
+    has_one :role, class_name: "::FlexCommerce::Role"
+    has_one :user_profile, class_name: "::FlexCommerce::UserProfile"
+  end
+end

data/app/models/shipping_method.rb

@@ -0,0 +1,26 @@
+require "flex_commerce_api/api_base"
+module FlexCommerce
+  #
+  # A flex commerce OrderShippingMethod model
+  #
+  # This model provides access to the flex commerce order shipping methods
+  #
+  # It is used much like an active record model.
+  #
+  # Examples:
+  #
+  #
+  #
+  #   # Fetching all order shipping methods for a customer account
+  #
+  #   FlexCommerce::ShippingMethod.all #fetches all order shipping methods(actually the first page in case there are thousands)
+  #
+  #
+  class ShippingMethod < FlexCommerceApi::ApiBase
+
+    # @method all
+    # Returns all order shipping methods
+    # @return [FlexCommerce::OrderShippingMethod[]] An array of order shipping methods or an empty array
+
+  end
+end

data/app/models/slug.rb

@@ -0,0 +1,19 @@
+require "flex_commerce_api/api_base"
+
+module FlexCommerce
+  #
+  # A flex commerce Slug model
+  #
+  # This model provides access to flex commerce slugs
+  #
+  # It is used much like an active record model.
+  #
+  # Examples:
+  #
+  #   # Fetching a slug
+  #   FlexCommerce::Slug.find(computed_slug:'some-computed-slug')
+  #
+  class Slug < FlexCommerceApi::ApiBase
+    has_one :resource
+  end
+end