bigcommerce 0.10.0 → 1.0.0.beta

data/lib/bigcommerce/resource_actions.rb

@@ -0,0 +1,51 @@
+module Bigcommerce
+  class ResourceActions < Module
+    attr_reader :options
+
+    def initialize(options = {})
+      @options = options
+      tap do |mod|
+        mod.define_singleton_method :_options do
+          mod.options
+        end
+      end
+    end
+
+    def included(base)
+      base.send(:include, Request.new(options[:uri]))
+      base.extend(ClassMethods)
+      options[:disable_methods] ||= []
+      methods = ClassMethods.public_instance_methods & options[:disable_methods]
+      methods.each { |name| base.send(:remove_method, name) }
+    end
+
+    module ClassMethods
+      def all(params = {})
+        get path.build, params
+      end
+
+      def find(resource_id)
+        fail ArgumentError if resource_id.nil?
+        get path.build(resource_id)
+      end
+
+      def create(params)
+        post path.build, params
+      end
+
+      def update(resource_id, params)
+        fail ArgumentError if resource_id.nil?
+        put path.build(resource_id), params
+      end
+
+      def destroy(resource_id)
+        fail ArgumentError if resource_id.nil?
+        delete path.build(resource_id)
+      end
+
+      def destroy_all
+        delete path.build
+      end
+    end
+  end
+end

data/lib/bigcommerce/resources/content/blog_post.rb

@@ -0,0 +1,31 @@
+# Blog Post
+# Content entries in the store's blog.
+# https://developer.bigcommerce.com/api/stores/v2/blog/posts
+
+module Bigcommerce
+  class BlogPost < Resource
+    include Bigcommerce::ResourceActions.new uri: 'blog/posts/%d'
+
+    property :id
+    property :url
+    property :count
+    property :preview_url
+    property :body
+    property :tags
+    property :summary
+    property :title
+    property :content
+    property :author
+    property :author_url
+    property :is_published
+    property :published_date
+    property :published_at
+    property :meta_description
+    property :meta_keywords
+    property :thumbnail_path
+
+    def self.count
+      get 'blog/posts/count'
+    end
+  end
+end

data/lib/bigcommerce/resources/content/blog_tag.rb

@@ -0,0 +1,17 @@
+# Blog Tag
+# Index of tags used on the store's blog.
+# https://developer.bigcommerce.com/api/stores/v2/blog/tags
+
+module Bigcommerce
+  class BlogTag < Resource
+    include Bigcommerce::Request.new 'blog/tags'
+
+    property :id
+    property :tag
+    property :post_ids
+
+    def self.all
+      get path.build
+    end
+  end
+end

data/lib/bigcommerce/resources/content/redirect.rb

@@ -0,0 +1,21 @@
+# Redirect
+# Redirects are used to create custom URL paths that map to resources on the
+# storefront (such as products, categories, brands, etc.) or manually defined
+# static URLs.
+# https://developer.bigcommerce.com/api/stores/v2/redirects
+
+module Bigcommerce
+  class Redirect < Resource
+    include Bigcommerce::ResourceActions.new uri: 'redirects/%d'
+
+    property :id
+    property :count
+    property :path
+    property :forward
+    property :url
+
+    def self.count
+      get 'redirects/count'
+    end
+  end
+end

data/lib/bigcommerce/resources/customers/customer.rb

@@ -0,0 +1,30 @@
+# Customer
+# Identity and account details for customers shopping at a Bigcommerce store.
+# https://developer.bigcommerce.com/api/stores/v2/customers
+
+module Bigcommerce
+  class Customer < Resource
+    include Bigcommerce::ResourceActions.new uri: 'customers/%d'
+
+    property :id
+    property :_authentication
+    property :count
+    property :company
+    property :first_name
+    property :last_name
+    property :email
+    property :phone
+    property :date_created
+    property :date_modified
+    property :store_credit
+    property :registration_ip_address
+    property :customer_group_id
+    property :notes
+    property :addresses
+    property :tax_exempt_category
+
+    def self.count
+      get 'customers/count'
+    end
+  end
+end

data/lib/bigcommerce/resources/customers/customer_address.rb

@@ -0,0 +1,34 @@
+# Customer Address
+# Postal addresses belonging to a customer.
+# https://developer.bigcommerce.com/api/stores/v2/customers/addresses
+
+module Bigcommerce
+  class CustomerAddress < Resource
+    include Bigcommerce::SubresourceActions.new uri: 'customers/%d/addresses/%d'
+
+    property :id
+    property :customer_id
+    property :first_name
+    property :address_type
+    property :count
+    property :last_name
+    property :company
+    property :street_1
+    property :street_2
+    property :city
+    property :state
+    property :zip
+    property :country
+    property :country_iso2
+    property :phone
+    property :adderss_type
+
+    def self.count_all
+      get 'customers/addresses/count'
+    end
+
+    def self.count(customer_id)
+      get "customers/#{customer_id}/addresses/count"
+    end
+  end
+end

data/lib/bigcommerce/resources/customers/customer_group.rb

@@ -0,0 +1,21 @@
+# Customer Group
+# Groups of customers who share the same level of access and discounts
+# at a store.
+# https://developer.bigcommerce.com/api/stores/v2/customer_groups
+
+module Bigcommerce
+  class CustomerGroup < Resource
+    include Bigcommerce::ResourceActions.new uri: 'customer_groups/%d'
+
+    property :id
+    property :name
+    property :count
+    property :is_default
+    property :category_access
+    property :discount_rules
+
+    def self.count
+      get 'customer_groups/count'
+    end
+  end
+end

data/lib/bigcommerce/resources/geography/country.rb

@@ -0,0 +1,22 @@
+# Country
+# Countries and territories, identified by their ISO 3166 country codes.
+# https://developer.bigcommerce.com/api/stores/v2/countries
+
+module Bigcommerce
+  class Country < Resource
+    include Bigcommerce::ResourceActions.new(
+      uri: 'countries/%d',
+      disable: [:create, :update, :destroy, :destroy_all])
+
+    property :id
+    property :count
+    property :country
+    property :country_iso2
+    property :country_iso3
+    property :states
+
+    def self.count
+      get 'countries/count'
+    end
+  end
+end

data/lib/bigcommerce/resources/geography/state.rb

@@ -0,0 +1,25 @@
+# State
+# States and subdivisions belonging to countries.
+# https://developer.bigcommerce.com/api/stores/v2/countries/states
+
+module Bigcommerce
+  class State < Resource
+    include Bigcommerce::SubresourceActions.new(
+      uri: 'countries/%d/states/%d',
+      disable: [:create, :update, :destroy, :destroy_all])
+
+    property :id
+    property :count
+    property :state
+    property :state_abbreviation
+    property :country_id
+
+    def self.count(country_id)
+      get "countries/#{country_id}/states/count"
+    end
+
+    def self.count_all
+      get 'countries/states/count'
+    end
+  end
+end

data/lib/bigcommerce/resources/marketing/coupon.rb

@@ -0,0 +1,30 @@
+# Coupon
+# Category or product discounts that can be applied to orders for customers
+# who enter a given code.
+# https://developer.bigcommerce.com/api/stores/v2/coupons
+
+module Bigcommerce
+  class Coupon < Resource
+    include Bigcommerce::ResourceActions.new uri: 'coupons/%d'
+
+    property :id
+    property :name
+    property :type
+    property :count
+    property :amount
+    property :min_purchase
+    property :expires
+    property :enabled
+    property :code
+    property :applies_to
+    property :num_uses
+    property :max_uses
+    property :max_uses_per_customer
+    property :restricted_to
+    property :shipping_methods
+
+    def self.count
+      get 'coupons/count'
+    end
+  end
+end

data/lib/bigcommerce/resources/orders/order.rb

@@ -0,0 +1,73 @@
+# Order
+# Purchases from a store.
+# https://developer.bigcommerce.com/api/stores/v2/orders
+
+module Bigcommerce
+  class Order < Resource
+    include Bigcommerce::ResourceActions.new uri: 'orders/%d'
+
+    property :id
+    property :count
+    property :customer_id
+    property :date_created
+    property :date_modified
+    property :date_shipped
+    property :status_id
+    property :status
+    property :subtotal_ex_tax
+    property :subtotal_inc_tax
+    property :subtotal_tax
+    property :base_shipping_cost
+    property :shipping_cost_ex_tax
+    property :shipping_cost_inc_tax
+    property :shipping_cost_tax
+    property :shipping_cost_tax_class_id
+    property :base_handling_cost
+    property :handling_cost_ex_tax
+    property :handling_cost_inc_tax
+    property :handling_cost_tax
+    property :handling_cost_tax_class_id
+    property :base_wrapping_cost
+    property :wrapping_cost_ex_tax
+    property :wrapping_cost_inc_tax
+    property :wrapping_cost_tax
+    property :wrapping_cost_tax_class_id
+    property :total_ex_tax
+    property :total_inc_tax
+    property :total_tax
+    property :items_total
+    property :items_shipped
+    property :payment_method
+    property :payment_provider_id
+    property :payment_status
+    property :refunded_amount
+    property :order_is_digital
+    property :store_credit_amount
+    property :gift_certificate_amount
+    property :ip_address
+    property :geoip_country
+    property :geoip_country_iso2
+    property :currency_id
+    property :currency_code
+    property :currency_exchange_rate
+    property :default_currency_id
+    property :default_currency_code
+    property :staff_notes
+    property :customer_message
+    property :discount_amount
+    property :coupon_discount
+    property :shipping_address_count
+    property :is_deleted
+    property :ebay_order_id
+    property :billing_address
+    property :order_source
+    property :external_source
+    property :products
+    property :shipping_addresses
+    property :coupons
+
+    def self.count(params = {})
+      get 'orders/count', params
+    end
+  end
+end

data/lib/bigcommerce/resources/orders/order_coupon.rb

@@ -0,0 +1,20 @@
+# Order Coupon
+# Coupons applied to an order.
+# https://developer.bigcommerce.com/api/stores/v2/orders/coupons
+
+module Bigcommerce
+  class OrderCoupon < Resource
+    include Bigcommerce::SubresourceActions.new(
+      uri: 'orders/%d/coupons/%d',
+      disable: [:create, :update, :destroy, :destroy_all])
+
+    property :id
+    property :coupon_id
+    property :order_id
+    property :code
+    property :amount
+    property :type
+    property :type
+    property :discount
+  end
+end

data/lib/bigcommerce/resources/orders/order_message.rb

@@ -0,0 +1,23 @@
+# Order Message
+# Messages associated with an order.
+# https://developer.bigcommerce.com/api/stores/v2/orders/messages
+
+module Bigcommerce
+  class OrderMessage < Resource
+    include Bigcommerce::SubresourceActions.new(
+      uri: 'orders/%d/messages/%d',
+      disable: [:create, :update, :destroy, :destroy_all])
+
+    property :id
+    property :order_id
+    property :staff_id
+    property :customer_id
+    property :type
+    property :subject
+    property :message
+    property :status
+    property :is_flagged
+    property :date_created
+    property :customer
+  end
+end

data/lib/bigcommerce/resources/orders/order_product.rb

@@ -0,0 +1,64 @@
+# Order Product
+# Product line items associated with an order.
+# https://developer.bigcommerce.com/api/stores/v2/orders/products
+
+module Bigcommerce
+  class OrderProduct < Resource
+    include Bigcommerce::SubresourceActions.new(
+      uri: 'orders/%d/products/%d',
+      disable: [:create, :update, :destroy, :destroy_all])
+
+    property :id
+    property :order_id
+    property :product_id
+    property :order_address_id
+    property :name
+    property :sku
+    property :type
+    property :count
+    property :base_price
+    property :price_ex_tax
+    property :price_inc_tax
+    property :price_tax
+    property :base_total
+    property :total_ex_tax
+    property :total_inc_tax
+    property :total_tax
+    property :weight
+    property :quantity
+    property :base_cost_price
+    property :cost_price_inc_tax
+    property :cost_price_ex_tax
+    property :cost_price_tax
+    property :is_refunded
+    property :refund_amount
+    property :return_id
+    property :wrapping_name
+    property :base_wrapping_cost
+    property :wrapping_cost_ex_tax
+    property :wrapping_cost_inc_tax
+    property :wrapping_cost_tax
+    property :wrapping_message
+    property :quantity_shipped
+    property :event_name
+    property :event_date
+    property :fixed_shipping_cost
+    property :ebay_item_id
+    property :ebay_transaction_id
+    property :option_set_id
+    property :parent_order_product_id
+    property :is_bundled_product, from: :'is_bundled_product '
+    property :bin_picking_number
+    property :applied_discounts
+    property :product_options
+    property :configurable_fields
+
+    def self.count(order_id)
+      get "orders/#{order_id}/products/count"
+    end
+
+    def self.count_all
+      get 'orders/products/count'
+    end
+  end
+end