bigcommerce 0.10.0 → 1.0.0.beta

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

@@ -0,0 +1,50 @@
+# Order Shipping Addresses
+# Shipping addresses associated with an order.
+# https://developer.bigcommerce.com/api/stores/v2/orders/shipping_addresses
+
+module Bigcommerce
+  class OrderShippingAddress < Resource
+    include Bigcommerce::SubresourceActions.new(
+      uri: 'orders/%d/shipping_addresses/%d',
+      disable: [:create, :update, :destroy, :destroy_all])
+
+    property :id
+    property :order_id
+    property :count
+    property :first_name
+    property :last_name
+    property :company
+    property :street_1
+    property :street_2
+    property :city
+    property :zip
+    property :country
+    property :country_iso2
+    property :state
+    property :email
+    property :phone
+    property :items_total
+    property :items_shipped
+    property :shipping_method
+    property :base_cost
+    property :cost_ex_tax
+    property :cost_inc_tax
+    property :cost_tax
+    property :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 :shipping_zone_id
+    property :shipping_zone_name
+
+    def self.count(order_id)
+      get "orders/#{order_id}/shipping_addresses/count"
+    end
+
+    def self.count_all
+      get 'orders/shipping_addresses/count'
+    end
+  end
+end

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

@@ -0,0 +1,16 @@
+# Order Status
+# Statuses that can be assigned to orders. Each status represents a state in
+# the fulfilment workflow.
+# https://developer.bigcommerce.com/api/stores/v2/order_statuses
+
+module Bigcommerce
+  class OrderStatus < Resource
+    include Bigcommerce::ResourceActions.new(
+      uri: 'order_statuses/%d',
+      disable: [:create, :update, :destroy, :destroy_all])
+
+    property :id
+    property :name
+    property :order
+  end
+end

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

@@ -0,0 +1,23 @@
+# Order Shipping Addresses
+# Shipping addresses associated with an order.
+# https://developer.bigcommerce.com/api/stores/v2/orders/shipping_addresses
+
+module Bigcommerce
+  class OrderTax < Resource
+    include Bigcommerce::SubresourceActions.new(
+      uri: 'orders/%d/taxes/%d',
+      disable: [:create, :update, :destroy, :destroy_all])
+
+    property :id
+    property :order_id
+    property :order_address_id
+    property :tax_rate_id
+    property :tax_class_id
+    property :name
+    property :tax_class, from: :class
+    property :rate
+    property :priority
+    property :priority_amount
+    property :line_amount
+  end
+end

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

@@ -0,0 +1,30 @@
+# Order Shipment
+# Shipping package consignments tracked from an order.
+# https://developer.bigcommerce.com/api/stores/v2/orders/shipments
+
+module Bigcommerce
+  class Shipment < Resource
+    include Bigcommerce::SubresourceActions.new uri: 'orders/%d/shipments/%d'
+
+    property :id
+    property :order_id
+    property :count
+    property :customer_id
+    property :order_address_id
+    property :date_created
+    property :tracking_number
+    property :shipping_method
+    property :comments
+    property :billing_address
+    property :shipping_address
+    property :items
+
+    def self.count(order_id)
+      get "orders/#{order_id}/shipments/count"
+    end
+
+    def self.count_all
+      get 'orders/shipments/count'
+    end
+  end
+end

data/lib/bigcommerce/resources/payments/payment_method.rb

@@ -0,0 +1,17 @@
+# Payment Method
+# Enabled payment methods.
+# https://developer.bigcommerce.com/api/stores/v2/payments/methods
+
+module Bigcommerce
+  class PaymentMethod < Resource
+    include Bigcommerce::Request.new 'payments/methods'
+
+    property :code
+    property :name
+    property :test_mode
+
+    def self.all(params = {})
+      get path.build, params
+    end
+  end
+end

data/lib/bigcommerce/resources/products/brand.rb

@@ -0,0 +1,23 @@
+# Brand
+# Brand facets for identifying and categorising products according
+# to their manufacturer or company metonym.
+# https://developer.bigcommerce.com/api/stores/v2/brands
+
+module Bigcommerce
+  class Brand < Resource
+    include Bigcommerce::ResourceActions.new uri: 'brands/%d'
+
+    property :id
+    property :name
+    property :count
+    property :page_title
+    property :meta_keywords
+    property :meta_description
+    property :image_file
+    property :search_keywords
+
+    def self.count
+      get 'brands/count'
+    end
+  end
+end

data/lib/bigcommerce/resources/products/bulk_pricing_rule.rb

@@ -0,0 +1,26 @@
+# Bulk Pricing Rule
+# Bulk pricing rules applied to a product.
+# https://developer.bigcommerce.com/api/stores/v2/products/discount_rules
+
+module Bigcommerce
+  class BulkPricingRule < Resource
+    include Bigcommerce::SubresourceActions.new(
+      uri: 'products/%d/discount_rules/%d')
+
+    property :id
+    property :count
+    property :product_id
+    property :min
+    property :max
+    property :type
+    property :type_value
+
+    def self.count(product_id)
+      get "products/#{product_id}/discount_rules/count"
+    end
+
+    def self.count_all
+      get 'products/discount_rules/count'
+    end
+  end
+end

data/lib/bigcommerce/resources/products/category.rb

@@ -0,0 +1,29 @@
+# Category
+# Index of hierarchical categories used to organise and group products.
+# https://developer.bigcommerce.com/api/stores/v2/categories
+
+module Bigcommerce
+  class Category < Resource
+    include Bigcommerce::ResourceActions.new uri: 'categories/%d'
+
+    property :id
+    property :parent_id
+    property :name
+    property :count
+    property :description
+    property :sort_order
+    property :page_title
+    property :meta_keywords
+    property :meta_description
+    property :layout_file
+    property :parent_category_list
+    property :image_file
+    property :is_visible
+    property :search_keywords
+    property :url
+
+    def self.count
+      get 'categories/count'
+    end
+  end
+end

data/lib/bigcommerce/resources/products/configurable_field.rb

@@ -0,0 +1,30 @@
+# Configurable Field
+# Configurable fields associated with a product.
+# https://developer.bigcommerce.com/api/stores/v2/products/configurable_fields
+
+module Bigcommerce
+  class ConfigurableField < Resource
+    include Bigcommerce::SubresourceActions.new(
+      uri: 'products/%d/configurable_fields/%d',
+      disable: [:create, :update])
+
+    property :id
+    property :product_id
+    property :count
+    property :name
+    property :type
+    property :allowed_file_types
+    property :max_size
+    property :select_options
+    property :is_required
+    property :sort_order
+
+    def self.count(product_id)
+      get "products/#{product_id}/configurable_fields/count"
+    end
+
+    def self.count_all
+      get 'products/configurable_fields/count'
+    end
+  end
+end

data/lib/bigcommerce/resources/products/custom_field.rb

@@ -0,0 +1,24 @@
+# Custom Field
+# Custom fields associated with a product.
+# https://developer.bigcommerce.com/api/stores/v2/products/custom_fields
+
+module Bigcommerce
+  class CustomField < Resource
+    include Bigcommerce::SubresourceActions.new(
+      uri: 'products/%d/custom_fields/%d')
+
+    property :id
+    property :product_id
+    property :count
+    property :name
+    property :text
+
+    def self.count(product_id)
+      get "products/#{product_id}/custom_fields/count"
+    end
+
+    def self.count_all
+      get 'products/custom_fields/count'
+    end
+  end
+end

data/lib/bigcommerce/resources/products/google_product_search_mapping.rb

@@ -0,0 +1,26 @@
+# Google Product Search Mapping
+# Google Product Search mappings for a product.
+# https://developer.bigcommerce.com/api/stores/v2/products/googleproductsearch
+
+module Bigcommerce
+  class GoogleProductSearchMapping < Resource
+    include Bigcommerce::Request.new 'products/%d/googleproductsearch'
+
+    property :enabled
+    property :product_id
+    property :category_id
+    property :custom_item
+    property :global_trade_item_number
+    property :manufacturer_part_number
+    property :gender
+    property :age_group
+    property :color
+    property :size
+    property :material
+    property :pattern
+
+    def self.all(product_id)
+      get path.build(product_id)
+    end
+  end
+end

data/lib/bigcommerce/resources/products/option.rb

@@ -0,0 +1,20 @@
+# Option
+# Shared attributes that control value facets on a product.
+# https://developer.bigcommerce.com/api/stores/v2/options
+
+module Bigcommerce
+  class Option < Resource
+    include Bigcommerce::ResourceActions.new uri: 'options/%d'
+
+    property :id
+    property :name
+    property :count
+    property :display_name
+    property :type
+    property :values
+
+    def self.count
+      get 'options/count'
+    end
+  end
+end

data/lib/bigcommerce/resources/products/option_set.rb

@@ -0,0 +1,18 @@
+# Option Set
+# A reusable set of option facets that can be applied to products.
+# https://developer.bigcommerce.com/api/stores/v2/options_sets
+
+module Bigcommerce
+  class OptionSet < Resource
+    include Bigcommerce::ResourceActions.new uri: 'option_sets/%d'
+
+    property :id
+    property :name
+    property :count
+    property :options
+
+    def self.count
+      get 'option_sets/count'
+    end
+  end
+end

data/lib/bigcommerce/resources/products/option_set_option.rb

@@ -0,0 +1,19 @@
+# Option Set Option
+# Options belonging to an option set.
+# https://developer.bigcommerce.com/api/stores/v2/option_sets/options
+
+module Bigcommerce
+  class OptionSetOption < Resource
+    include Bigcommerce::SubresourceActions.new(
+      uri: 'option_sets/%d/options/%d')
+
+    property :id
+    property :option_id
+    property :option_set_id
+    property :display_name
+    property :sort_order
+    property :is_required
+    property :option
+    property :values
+  end
+end

data/lib/bigcommerce/resources/products/option_value.rb

@@ -0,0 +1,15 @@
+# Option Value
+# Values that can be selected for an option.
+# https://developer.bigcommerce.com/api/stores/v2/options/values
+
+module Bigcommerce
+  class OptionValue < Resource
+    include Bigcommerce::SubresourceActions.new uri: 'options/%d/values/%d'
+
+    property :id
+    property :option_id
+    property :label
+    property :sort_order
+    property :value
+  end
+end

data/lib/bigcommerce/resources/products/product.rb

@@ -0,0 +1,97 @@
+# Product
+# Catalog of saleable items in the store.
+# https://developer.bigcommerce.com/api/stores/v2/products
+
+module Bigcommerce
+  class Product < Resource
+    include Bigcommerce::ResourceActions.new uri: 'products/%d'
+
+    property :id
+    property :count
+    property :keyword_filter
+    property :name
+    property :type
+    property :sku
+    property :description
+    property :search_keywords
+    property :availability_description
+    property :price
+    property :cost_price
+    property :retail_price
+    property :sale_price
+    property :calculated_price
+    property :sort_order
+    property :is_visible
+    property :is_featured
+    property :related_products
+    property :inventory_level
+    property :inventory_warning_level
+    property :warranty
+    property :weight
+    property :width
+    property :height
+    property :depth
+    property :fixed_cost_shipping_price
+    property :is_free_shipping
+    property :inventory_tracking
+    property :rating_total
+    property :rating_count
+    property :total_sold
+    property :date_created
+    property :brand_id
+    property :view_count
+    property :page_title
+    property :meta_keywords
+    property :meta_description
+    property :layout_file
+    property :is_price_hidden
+    property :price_hidden_label
+    property :categories
+    property :date_modified
+    property :event_date_field_name
+    property :event_date_type
+    property :event_date_start
+    property :event_date_end
+    property :myob_asset_account
+    property :myob_income_account
+    property :myob_expense_account
+    property :peachtree_gl_account
+    property :condition
+    property :is_condition_shown
+    property :preorder_release_date
+    property :is_preorder_only
+    property :preorder_message
+    property :order_quantity_minimum
+    property :order_quantity_maximum
+    property :open_graph_type
+    property :open_graph_title
+    property :open_graph_description
+    property :is_open_graph_thumbnail
+    property :upc
+    property :date_last_imported
+    property :option_set_id
+    property :tax_class_id
+    property :option_set_display
+    property :bin_picking_number
+    property :custom_url
+    property :availability
+    property :brand
+    property :downloads
+    property :images
+    property :discount_rules
+    property :configurable_fields
+    property :custom_fields
+    property :videos
+    property :skus
+    property :rules
+    property :option_set
+    property :options
+    property :tax_class
+    property :avalara_product_tax_code
+    property :primary_image
+
+    def self.count(params = {})
+      get 'products/count', params
+    end
+  end
+end