bigcommerce 1.0.0.beta → 1.0.1

data/lib/bigcommerce/resource_actions.rb

@@ -24,27 +24,27 @@ module Bigcommerce
         get path.build, params
       end
 
-      def find(resource_id)
-        fail ArgumentError if resource_id.nil?
-        get path.build(resource_id)
+      def find(resource_id, params = {})
+        raise ArgumentError if resource_id.nil?
+        get path.build(resource_id), params
       end
 
-      def create(params)
+      def create(params = {})
         post path.build, params
       end
 
-      def update(resource_id, params)
-        fail ArgumentError if resource_id.nil?
+      def update(resource_id, params = {})
+        raise 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)
+      def destroy(resource_id, params = {})
+        raise ArgumentError if resource_id.nil?
+        delete path.build(resource_id), params
       end
 
-      def destroy_all
-        delete path.build
+      def destroy_all(params = {})
+        delete path.build, params
       end
     end
   end

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

@@ -8,24 +8,22 @@ module Bigcommerce
 
     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
+    property :count
 
-    def self.count
-      get 'blog/posts/count'
+    def self.count(params = {})
+      get 'blog/posts/count', params
     end
   end
 end

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

@@ -6,12 +6,11 @@ module Bigcommerce
   class BlogTag < Resource
     include Bigcommerce::Request.new 'blog/tags'
 
-    property :id
     property :tag
     property :post_ids
 
-    def self.all
-      get path.build
+    def self.all(params = {})
+      get path.build, params
     end
   end
 end

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

@@ -14,8 +14,8 @@ module Bigcommerce
     property :forward
     property :url
 
-    def self.count
-      get 'redirects/count'
+    def self.count(params = {})
+      get 'redirects/count', params
     end
   end
 end

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

@@ -1,3 +1,6 @@
+require 'jwt'
+require 'securerandom'
+
 # Customer
 # Identity and account details for customers shopping at a Bigcommerce store.
 # https://developer.bigcommerce.com/api/stores/v2/customers
@@ -22,9 +25,26 @@ module Bigcommerce
     property :notes
     property :addresses
     property :tax_exempt_category
+    property :accepts_marketing
+
+    def self.count(params = {})
+      get 'customers/count', params
+    end
+
+    # Generate a token that can be used to log the customer into the storefront.
+    # This requires your app to have the store_v2_customers_login scope and to
+    # be installed in the store.
+    def login_token(config: Bigcommerce.config)
+      payload = {
+        'iss' => config.client_id,
+        'iat' => Time.now.to_i,
+        'jti' => SecureRandom.uuid,
+        'operation' => 'customer_login',
+        'store_hash' => config.store_hash,
+        'customer_id' => id
+      }
 
-    def self.count
-      get 'customers/count'
+      JWT.encode(payload, config.client_secret, 'HS256')
     end
   end
 end

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

@@ -8,6 +8,7 @@ module Bigcommerce
 
     property :id
     property :customer_id
+    property :form_fields
     property :first_name
     property :address_type
     property :count
@@ -21,14 +22,13 @@ module Bigcommerce
     property :country
     property :country_iso2
     property :phone
-    property :adderss_type
 
-    def self.count_all
-      get 'customers/addresses/count'
+    def self.count_all(params = {})
+      get 'customers/addresses/count', params
     end
 
-    def self.count(customer_id)
-      get "customers/#{customer_id}/addresses/count"
+    def self.count(customer_id, params = {})
+      get "customers/#{customer_id}/addresses/count", params
     end
   end
 end

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

@@ -14,8 +14,8 @@ module Bigcommerce
     property :category_access
     property :discount_rules
 
-    def self.count
-      get 'customer_groups/count'
+    def self.count(params = {})
+      get 'customer_groups/count', params
     end
   end
 end

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

@@ -6,7 +6,8 @@ module Bigcommerce
   class Country < Resource
     include Bigcommerce::ResourceActions.new(
       uri: 'countries/%d',
-      disable: [:create, :update, :destroy, :destroy_all])
+      disable: %i[create update destroy destroy_all]
+    )
 
     property :id
     property :count
@@ -15,8 +16,8 @@ module Bigcommerce
     property :country_iso3
     property :states
 
-    def self.count
-      get 'countries/count'
+    def self.count(params = {})
+      get 'countries/count', params
     end
   end
 end

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

@@ -6,7 +6,8 @@ module Bigcommerce
   class State < Resource
     include Bigcommerce::SubresourceActions.new(
       uri: 'countries/%d/states/%d',
-      disable: [:create, :update, :destroy, :destroy_all])
+      disable: %i[create update destroy destroy_all]
+    )
 
     property :id
     property :count
@@ -14,12 +15,12 @@ module Bigcommerce
     property :state_abbreviation
     property :country_id
 
-    def self.count(country_id)
-      get "countries/#{country_id}/states/count"
+    def self.count(country_id, params = {})
+      get "countries/#{country_id}/states/count", params
     end
 
-    def self.count_all
-      get 'countries/states/count'
+    def self.count_all(params = {})
+      get 'countries/states/count', params
     end
   end
 end

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

@@ -0,0 +1,21 @@
+# Banner
+# HTML element on webpages to advertise discounts or other content relevant to shoppers.
+# https://developer.bigcommerce.com/api/stores/v2/banners
+
+module Bigcommerce
+  class Banner < Resource
+    include Bigcommerce::ResourceActions.new uri: 'banners/%d'
+
+    property :id
+    property :name
+    property :content
+    property :page
+    property :catorbrandid
+    property :location
+    property :date_created
+    property :date_type
+    property :date_from
+    property :date_to
+    property :status
+  end
+end

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

@@ -23,8 +23,8 @@ module Bigcommerce
     property :restricted_to
     property :shipping_methods
 
-    def self.count
-      get 'coupons/count'
+    def self.count(params = {})
+      get 'coupons/count', params
     end
   end
 end

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

@@ -0,0 +1,25 @@
+# Gift Certificates
+# Code that can be applied by customers to their order to provide full or partial payment.
+# https://developer.bigcommerce.com/api/stores/v2/gift_certificates
+
+module Bigcommerce
+  class GiftCertificates < Resource
+    include Bigcommerce::ResourceActions.new uri: 'gift_certificates/%d'
+
+    property :id
+    property :customer_id
+    property :order_id
+    property :code
+    property :to_name
+    property :to_email
+    property :from_name
+    property :from_email
+    property :amount
+    property :balance
+    property :status
+    property :template
+    property :message
+    property :purchase_date
+    property :expiry_date
+  end
+end

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

@@ -7,64 +7,66 @@ module Bigcommerce
     include Bigcommerce::ResourceActions.new uri: 'orders/%d'
 
     property :id
-    property :count
+    property :status
+    property :coupons
+    property :products
+    property :status_id
+    property :total_tax
+    property :ip_address
+    property :is_deleted
+    property :currency_id
     property :customer_id
+    property :items_total
+    property :staff_notes
     property :date_created
-    property :date_modified
     property :date_shipped
-    property :status_id
-    property :status
-    property :subtotal_ex_tax
-    property :subtotal_inc_tax
+    property :order_source
     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 :currency_code
+    property :date_modified
+    property :ebay_order_id
+    property :geoip_country
     property :items_shipped
+    property :total_inc_tax
     property :payment_method
-    property :payment_provider_id
     property :payment_status
+    property :billing_address
+    property :coupon_discount
+    property :discount_amount
+    property :external_source
+    property :is_email_opt_in
     property :refunded_amount
+    property :subtotal_ex_tax
+    property :credit_card_type
+    property :customer_message
     property :order_is_digital
-    property :store_credit_amount
-    property :gift_certificate_amount
-    property :ip_address
-    property :geoip_country
+    property :subtotal_inc_tax
+    property :handling_cost_tax
+    property :shipping_cost_tax
+    property :wrapping_cost_tax
+    property :base_handling_cost
+    property :base_shipping_cost
+    property :base_wrapping_cost
     property :geoip_country_iso2
-    property :currency_id
-    property :currency_code
-    property :currency_exchange_rate
+    property :shipping_addresses
     property :default_currency_id
+    property :payment_provider_id
+    property :store_credit_amount
+    property :handling_cost_ex_tax
+    property :shipping_cost_ex_tax
+    property :wrapping_cost_ex_tax
     property :default_currency_code
-    property :staff_notes
-    property :customer_message
-    property :discount_amount
-    property :coupon_discount
+    property :handling_cost_inc_tax
+    property :shipping_cost_inc_tax
+    property :wrapping_cost_inc_tax
+    property :currency_exchange_rate
     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
+    property :gift_certificate_amount
+    property :handling_cost_tax_class_id
+    property :shipping_cost_tax_class_id
+    property :wrapping_cost_tax_class_id
+    property :count
 
     def self.count(params = {})
       get 'orders/count', params

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

@@ -6,15 +6,15 @@ module Bigcommerce
   class OrderCoupon < Resource
     include Bigcommerce::SubresourceActions.new(
       uri: 'orders/%d/coupons/%d',
-      disable: [:create, :update, :destroy, :destroy_all])
+      disable: %i[create update destroy destroy_all]
+    )
 
     property :id
-    property :coupon_id
-    property :order_id
     property :code
-    property :amount
-    property :type
     property :type
+    property :amount
     property :discount
+    property :order_id
+    property :coupon_id
   end
 end

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

@@ -6,18 +6,19 @@ module Bigcommerce
   class OrderMessage < Resource
     include Bigcommerce::SubresourceActions.new(
       uri: 'orders/%d/messages/%d',
-      disable: [:create, :update, :destroy, :destroy_all])
+      disable: %i[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 :message
+    property :subject
+    property :customer
+    property :order_id
+    property :staff_id
     property :is_flagged
+    property :customer_id
     property :date_created
-    property :customer
   end
 end

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

@@ -6,59 +6,60 @@ module Bigcommerce
   class OrderProduct < Resource
     include Bigcommerce::SubresourceActions.new(
       uri: 'orders/%d/products/%d',
-      disable: [:create, :update, :destroy, :destroy_all])
+      disable: %i[create update destroy destroy_all]
+    )
 
     property :id
-    property :order_id
-    property :product_id
-    property :order_address_id
-    property :name
     property :sku
+    property :name
     property :type
-    property :count
-    property :base_price
-    property :price_ex_tax
-    property :price_inc_tax
+    property :weight
+    property :order_id
+    property :quantity
     property :price_tax
+    property :return_id
+    property :total_tax
+    property :base_price
     property :base_total
+    property :event_date
+    property :event_name
+    property :product_id
+    property :is_refunded
+    property :ebay_item_id
+    property :price_ex_tax
     property :total_ex_tax
+    property :option_set_id
+    property :price_inc_tax
+    property :refund_amount
     property :total_inc_tax
-    property :total_tax
-    property :weight
-    property :quantity
+    property :wrapping_name
+    property :cost_price_tax
     property :base_cost_price
-    property :cost_price_inc_tax
+    property :product_options
+    property :order_address_id
+    property :quantity_shipped
+    property :wrapping_message
+    property :applied_discounts
     property :cost_price_ex_tax
-    property :cost_price_tax
-    property :is_refunded
-    property :refund_amount
-    property :return_id
-    property :wrapping_name
+    property :wrapping_cost_tax
     property :base_wrapping_cost
+    property :bin_picking_number
+    property :cost_price_inc_tax
+    property :configurable_fields
+    property :ebay_transaction_id
+    property :fixed_shipping_cost
+    property :is_bundled_product
     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
+    property :count
 
-    def self.count(order_id)
-      get "orders/#{order_id}/products/count"
+    def self.count(order_id, params = {})
+      get "orders/#{order_id}/products/count", params
     end
 
-    def self.count_all
-      get 'orders/products/count'
+    def self.count_all(params = {})
+      get 'orders/products/count', params
     end
   end
 end