lightspeed_pos 0.1.0 → 0.6.0

data/lib/lightspeed/customer.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'resource'
+
+module Lightspeed
+  class Customer < Lightspeed::Resource
+    alias_method :archive, :destroy
+
+    fields(
+      customerID: :id,
+      firstName: :string,
+      lastName: :string,
+      dob: :timestamp,
+      archived: :boolean,
+      title: :string,
+      company: :string,
+      companyRegistrationNumber: :string,
+      vatNumber: :string,
+      createTime: :timestamp,
+      timeStamp: :timestamp,
+      creditAccountID: :id,
+      customerTypeID: :id,
+      discountID: :id,
+      taxCategoryID: :id,
+      Contact: :hash,
+      CreditAccount: :hash,
+      CustomerType: :hash,
+      Discount: :hash,
+      Note: :hash,
+      TaxCategory: :hash,
+      CustomFieldValues: :hash
+    )
+
+  end
+end
+

data/lib/lightspeed/customers.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require_relative 'collection'
+
+require_relative 'customer'
+
+module Lightspeed
+  class Customers < Lightspeed::Collection
+    alias_method :archive, :destroy
+  end
+end

data/lib/lightspeed/employee.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require_relative 'resource'
+
+module Lightspeed
+  class Employee < Lightspeed::Resource
+    fields(
+      employeeID: :id,
+      firstName: :string,
+      lastName: :string,
+      accessPin: :string,
+      lockOut: :boolean,
+      archived: :boolean,
+      contactID: :integer,
+      clockInEmployeeHoursID: :integer,
+      employeeRoleID: :integer,
+      limitToShopID: :integer,
+      lastShopID: :integer,
+      lastSaleID: :integer,
+      lastRegisterID: :integer,
+      timeStamp: :datetime,
+      Contact: :hash,
+      EmployeeRole: :hash,
+      EmployeeRights: :hash
+    )
+  end
+end

data/lib/lightspeed/employees.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'collection'
+
+require_relative 'employee'
+
+module Lightspeed
+  class Employees < Lightspeed::Collection
+  end
+end

data/lib/lightspeed/error.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module Lightspeed
+  class Error < Exception
+    class BadRequest < Lightspeed::Error; end # 400
+
+    class Unauthorized < Lightspeed::Error; end # 401
+
+    class NotAuthorized < Lightspeed::Error; end # 403
+
+    class NotFound < Lightspeed::Error; end # 404
+
+    class InternalServerError < Lightspeed::Error; end # 500
+
+    class Throttled < Lightspeed::Error; end # 503
+  end
+end

data/lib/lightspeed/image.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+require_relative 'resource'
+
+require_relative 'item'
+require_relative 'item_matrix'
+
+module Lightspeed
+  class Image < Lightspeed::Resource
+    fields(
+      imageID: :id,
+      description: :string,
+      filename: :string,
+      baseImageURL: :string,
+      publicID: :string, # part of the file path; not a Lightspeed ID
+      itemID: :id,
+      itemMatrixID: :id,
+      Item: :hash,
+      ItemMatrix: :hash
+    )
+
+    relationships :Item, :ItemMatrix
+
+    def url
+      "#{baseImageURL}#{publicID}"
+    end
+
+    def base_path
+      if context.is_a?(Lightspeed::Item) ||
+         context.is_a?(Lightspeed::ItemMatrix)
+        "#{context.base_path}/#{resource_name}/#{id}"
+      else
+        super
+      end
+    end
+  end
+end

data/lib/lightspeed/images.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative 'collection'
+
+require_relative 'image'
+
+module Lightspeed
+  class Images < Lightspeed::Collection
+    def base_path
+      if context.is_a?(Lightspeed::Item) ||
+         context.is_a?(Lightspeed::ItemMatrix)
+        "#{context.base_path}/#{resource_name}"
+      else
+        super
+      end
+    end
+  end
+end

data/lib/lightspeed/inventories.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'collection'
+
+require_relative 'inventory'
+
+module Lightspeed
+  class Inventories < Lightspeed::Collection
+  end
+end

data/lib/lightspeed/inventory.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require_relative 'resource'
+
+require_relative 'item'
+
+module Lightspeed
+  class Inventory < Lightspeed::Resource
+    fields(
+      inventoryID: :integer
+    )
+    relationships :Item
+  end
+end

data/lib/lightspeed/item.rb

@@ -1,26 +1,63 @@
-require 'lightspeed/base'
+# frozen_string_literal: true
 
-module Lightspeed
-  class Item < Lightspeed::Base
-    attr_accessor :systemSku, :defaultCost, :avgCost, :discountable, :tax,
-      :archived, :itemType, :description, :modelYear, :upc, :ean, :customSku,
-      :manufacturerSku, :createTime, :timeStamp,
+require_relative 'resource'
+
+require_relative 'item_matrix'
+require_relative 'category'
+require_relative 'images'
+require_relative 'prices'
 
-      # Association keys
-      :categoryID, :taxClassID, :departmentID, :itemMatrixID, :manufacturerID, :seasonID,
-      :defaultVendorID, :itemECommerceID,
+module Lightspeed
+  class Item < Lightspeed::Resource
+    alias_method :archive, :destroy
 
-      # Embedded
-      :ItemMatrix, :ItemAttributes, :ItemShops, :Prices, :Note
+    fields(
+      itemID: :id,
+      systemSku: :string,
+      defaultCost: :decimal,
+      avgCost: :decimal,
+      discountable: :boolean,
+      tax: :boolean,
+      archived: :boolean,
+      itemType: :string,
+      description: :string,
+      modelYear: :integer,
+      upc: :string,
+      ean: :string,
+      customSku: :string,
+      manufacturerSku: :string,
+      createTime: :datetime,
+      timeStamp: :datetime,
+      categoryID: :id,
+      taxClassID: :id,
+      departmentID: :id,
+      itemMatrixID: :id,
+      manufacturerID: :id,
+      seasonID: :id,
+      defaultVendorID: :id,
+      itemECommerceID: :id,
+      # Category: :hash,
+      TaxClass: :hash,
+      Department: :hash,
+      ItemAttributes: :hash,
+      # ItemMatrix: :hash,
+      # Images: :hash,
+      Manufacturer: :hash,
+      Note: :hash,
+      ItemECommerce: :hash,
+      ItemShops: :hash,
+      ItemComponents: :hash,
+      ItemShelfLocations: :hash,
+      ItemVendorNums: :hash,
+      CustomFieldValues: :hash,
+      Prices: :hash,
+      Tags: :hash
+    )
 
-    def self.id_field
-      "itemID"
-    end
+    relationships :ItemMatrix, :Category, :Images, DefaultVendor: :Vendor
 
-    # FUNFACT: ItemMatrix data is returned during an `update` request,
-    # but not during a `find` request.
-    def item_matrix
-      @ItemMatrix ||= owner.item_matrices.find(itemMatrixID) # rubocop:disable VariableName
+    def prices
+      @prices ||= Lightspeed::Prices.new(self.Prices)
     end
   end
 end

data/lib/lightspeed/item_attribute_set.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative 'resource'
+
+module Lightspeed
+  class ItemAttributeSet < Lightspeed::Resource
+    fields(
+      itemAttributeSetID: :id,
+      name: :string,
+      attributeName1: :string,
+      attributeName2: :string,
+      attributeName3: :string
+    )
+  end
+end

data/lib/lightspeed/item_attribute_sets.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require_relative 'collection'
+
+require_relative 'item_attribute_set'
+
+module Lightspeed
+  class ItemAttributeSets < Lightspeed::Collection
+  end
+end

data/lib/lightspeed/item_matrices.rb

@@ -1,8 +1,11 @@
-require 'lightspeed/item_matrix'
-require 'lightspeed/account_resources'
+# frozen_string_literal: true
+
+require_relative 'collection'
+
+require_relative 'item_matrix'
 
 module Lightspeed
-  class ItemMatrices < AccountResources
+  class ItemMatrices < Lightspeed::Collection
     def self.resource_name
       "ItemMatrix"
     end

data/lib/lightspeed/item_matrix.rb

@@ -1,17 +1,57 @@
+# frozen_string_literal: true
+
+require_relative 'resource'
+
+require_relative 'item_attribute_set'
+require_relative 'category'
+require_relative 'items'
+
 module Lightspeed
-  class ItemMatrix < Lightspeed::Base
-    attr_accessor :description, :tax, :defaultCost, :itemType, :modelYear, :archived,
-      :timeStamp
+  class ItemMatrix < Lightspeed::Resource
+    fields(
+      itemMatrixID: :id,
+      description: :string,
+      tax: :boolean,
+      defaultCost: :decimal,
+      itemType: :string,
+      modelYear: :integer,
+      archived: :boolean,
+      timeStamp: :datetime,
+      itemAttributeSetID: :id,
+      manufacturerID: :id,
+      categoryID: :id,
+      defaultVendorID: :id,
+      taxClassID: :id,
+      seasonID: :id,
+      departmentID: :id,
+      itemECommerceID: :id,
+      itemAttributeSet: :hash,
+      Manufacturer: :hash,
+      Category: :hash,
+      TaxClass: :hash,
+      Season: :hash,
+      Department: :hash,
+      ItemECommerce: :hash,
+      Images: :hash,
+      Items: :hash,
+      CustomFieldValues: :hash,
+      Prices: :hash
+    )
+
+    relationships :ItemAttributeSet, :Category, :Items
 
-    # Association keys
-    attr_accessor :itemAttributeSetID, :manufacturerID, :categoryID, :defaultVendorID,
-      :taxClassID, :seasonID, :departmentID, :itemECommerceID
+    # overrides
 
-    # Embedded
-    attr_accessor :Prices
+    def self.collection_name
+      'ItemMatrices'
+    end
+
+    def singular_path_parent
+      account
+    end
 
-    def self.id_field
-      "itemMatrixID"
+    def prices
+      @prices ||= Lightspeed::Prices.new(self.Prices)
     end
   end
 end

data/lib/lightspeed/items.rb

@@ -1,12 +1,11 @@
-require 'lightspeed/item'
-require 'lightspeed/account_resources'
+# frozen_string_literal: true
+
+require_relative 'collection'
+
+require_relative 'item'
 
 module Lightspeed
-  class Items < Lightspeed::AccountResources
+  class Items < Lightspeed::Collection
     alias_method :archive, :destroy
-
-    def self.resource_name
-      "Item"
-    end
   end
 end

data/lib/lightspeed/order.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative 'resource'
+
+module Lightspeed
+  class Order < Lightspeed::Resource
+    alias_method :archive, :destroy
+
+    fields(
+      orderID: :id,
+      orderedDate: :timestamp,
+      receivedDate: :timestamp,
+      arrivalDate: :timestamp,
+      shipInstructions: :integer,
+      stockInstructions: :integer,
+      shipCost: :decimal,
+      otherCost: :decimal,
+      complete: :boolean,
+      archived: :boolean,
+      discount: :boolean,
+      totalDiscount: :decimal,
+      totalQuantity: :decimal,
+      vendorID: :id,
+      noteID: :id,
+      shopID: :id,
+      Vendor: :hash,
+      Note: :hash,
+      Shop: :hash,
+      OrderLines: :hash,
+      CustomFieldValues: :hash,
+      timeStamp: :timestamp
+    )
+
+  end
+end
+