bigcommerce 0.10.0 → 1.0.0.beta

data/examples/customers/customer_group.rb

@@ -0,0 +1,35 @@
+require 'bigcommerce'
+require 'securerandom'
+
+Bigcommerce.configure do |config|
+  config.store_hash = ENV['BC_STORE_HASH']
+  config.client_id = ENV['BC_CLIENT_ID']
+  config.access_token = ENV['BC_ACCESS_TOKEN']
+end
+
+# List all customer groups
+puts Bigcommerce::CustomerGroup.all
+
+# Get a customer group
+puts Bigcommerce::CustomerGroup.find(1)
+
+# Get a count of all customer groups
+puts Bigcommerce::CustomerGroup.count
+
+# Create a customer group
+@customer_group = Bigcommerce::CustomerGroup.create(
+  name: "Customer Group #{SecureRandom.hex}"
+)
+puts @customer_group
+
+# Update a customer group
+puts Bigcommerce::CustomerGroup.update(
+  @customer_group.id,
+  name: "Customer_group #{SecureRandom.hex}"
+)
+
+# Delete a customer group
+puts Bigcommerce::CustomerGroup.destroy(@customer_group.id)
+
+# Delete all customer groups
+# puts Bigcommerce::CustomerGroup.destroy_all

data/examples/exception_handling.rb

@@ -0,0 +1,50 @@
+require 'bigcommerce'
+
+Bigcommerce.configure do |config|
+  config.store_hash = ENV['BC_STORE_HASH']
+  config.client_id = ENV['BC_CLIENT_ID']
+  config.access_token = ENV['BC_ACCESS_TOKEN']
+end
+
+# rubocop:disable MethodLength, Metrics/AbcSize:
+def bc_handle_exception(&block)
+  # Below is a list of all the errors we will throw
+  block.call
+rescue Bigcommerce::BadRequest => e
+  puts e.inspect
+rescue Bigcommerce::Unauthorized => e
+  puts e.inspect
+rescue Bigcommerce::Forbidden => e
+  puts e.inspect
+rescue Bigcommerce::NotFound => e
+  puts e.inspect
+rescue Bigcommerce::MethodNotAllowed => e
+  puts e.inspect
+rescue Bigcommerce::NotAccepted => e
+  puts e.inspect
+rescue Bigcommerce::TimeOut => e
+  puts e.inspect
+rescue Bigcommerce::ResourceConflict => e
+  puts e.inspect
+rescue Bigcommerce::TooManyRequests => e
+  puts e.inspect
+rescue Bigcommerce::InternalServerError => e
+  puts e.inspect
+rescue Bigcommerce::BadGateway => e
+  puts e.inspect
+rescue Bigcommerce::ServiceUnavailable => e
+  puts e.inspect
+rescue Bigcommerce::GatewayTimeout => e
+  puts e.inspect
+rescue Bigcommerce::BandwidthLimitExceeded => e
+  puts e.inspect
+rescue => e
+  puts "Some other Error #{e.inspect}"
+end
+
+Bigcommerce::HttpError::ERRORS.each do |k, v|
+  bc_handle_exception do
+    # This will be your request that you want to protect from exceptions
+    fail v, k
+  end
+end

data/examples/geography/country.rb

@@ -0,0 +1,16 @@
+require 'bigcommerce'
+
+Bigcommerce.configure do |config|
+  config.store_hash = ENV['BC_STORE_HASH']
+  config.client_id = ENV['BC_CLIENT_ID']
+  config.access_token = ENV['BC_ACCESS_TOKEN']
+end
+
+# List countries
+puts Bigcommerce::Country.all(page: 1)
+
+# Get a country
+puts Bigcommerce::Country.find(226)
+
+# Get a count of countries
+puts Bigcommerce::Country.count

data/examples/geography/state.rb

@@ -0,0 +1,19 @@
+require 'bigcommerce'
+
+Bigcommerce.configure do |config|
+  config.store_hash = ENV['BC_STORE_HASH']
+  config.client_id = ENV['BC_CLIENT_ID']
+  config.access_token = ENV['BC_ACCESS_TOKEN']
+end
+
+# List countries
+puts Bigcommerce::State.all(226)
+
+# Get a country
+puts Bigcommerce::State.find(226, 10)
+
+# Get a count of countries
+puts Bigcommerce::State.count(226)
+
+# Get a count of all states for all countries
+puts Bigcommerce::State.count_all

data/examples/marketing/coupon.rb

@@ -0,0 +1,44 @@
+require 'bigcommerce'
+require 'securerandom'
+
+Bigcommerce.configure do |config|
+  config.store_hash = ENV['BC_STORE_HASH']
+  config.client_id = ENV['BC_CLIENT_ID']
+  config.access_token = ENV['BC_ACCESS_TOKEN']
+end
+
+# List coupons
+@coupons = Bigcommerce::Coupon.all
+puts @coupons
+
+# Get a coupon
+puts Bigcommerce::Coupon.find(@coupons[0].id)
+
+# Get a count of coupons
+puts Bigcommerce::Coupon.count
+
+# Create a coupon
+@coupon = Bigcommerce::Coupon.create(
+  name: SecureRandom.hex,
+  code: SecureRandom.hex,
+  type: 'per_item_discount',
+  amount: 5,
+  applies_to: {
+    entity: 'categories',
+    ids: [0]
+  }
+)
+puts @coupon
+
+# Update a coupon
+puts Bigcommerce::Coupon.update(
+  @coupon.id,
+  name: SecureRandom.hex,
+  amount: 10
+)
+
+# Delete a coupon
+puts Bigcommerce::Coupon.destroy(@coupon.id)
+
+# Delete all coupons
+# puts Bigcommerce::Coupon.destroy_all

data/examples/orders/order.rb

@@ -0,0 +1,53 @@
+require 'bigcommerce'
+
+Bigcommerce.configure do |config|
+  config.store_hash = ENV['BC_STORE_HASH']
+  config.client_id = ENV['BC_CLIENT_ID']
+  config.access_token = ENV['BC_ACCESS_TOKEN']
+end
+
+# List orders
+@orders = Bigcommerce::Order.all
+puts @orders
+
+# Get an order
+@order = @orders[0]
+puts Bigcommerce::Order.find(@order.id)
+
+# Get a count of orders
+puts Bigcommerce::Order.count
+
+# Create an order
+@order = Bigcommerce::Order.create(
+  billing_address: {
+    first_name: 'Karl',
+    last_name: 'The Fog',
+    street_1: '685 Market St.',
+    city: 'San Francisco',
+    state: 'California',
+    zip: '94019',
+    country: 'United States',
+    email: 'test@example.com'
+  },
+  products: [
+    {
+      product_id: 34,
+      quantity: 2
+    }
+  ]
+)
+puts @order
+
+# Update an order
+puts Bigcommerce::Order.update(
+  @order.id,
+  billing_address: {
+    last_name: 'TheFog'
+  }
+)
+
+# Delete an order
+puts Bigcommerce::Order.destroy(@order.id)
+
+# Delete all orders
+# puts Bigcommerce::Order.destroy_all

data/examples/orders/order_coupon.rb

@@ -0,0 +1,17 @@
+require 'bigcommerce'
+
+Bigcommerce.configure do |config|
+  config.store_hash = ENV['BC_STORE_HASH']
+  config.client_id = ENV['BC_CLIENT_ID']
+  config.access_token = ENV['BC_ACCESS_TOKEN']
+end
+
+@order = Bigcommerce::Order.all[0]
+
+# List order coupons
+@order_coupons = Bigcommerce::OrderCoupon.all(@order.id)
+puts @order_coupons
+
+# Get an order coupon
+@order_coupon = @order_coupons[0]
+puts Bigcommerce::OrderCoupon.find(@order.id, @order_coupon.id)

data/examples/orders/order_message.rb

@@ -0,0 +1,17 @@
+require 'bigcommerce'
+
+Bigcommerce.configure do |config|
+  config.store_hash = ENV['BC_STORE_HASH']
+  config.client_id = ENV['BC_CLIENT_ID']
+  config.access_token = ENV['BC_ACCESS_TOKEN']
+end
+
+@order = Bigcommerce::Order.all[0]
+
+# List order messages
+@order_messages = Bigcommerce::OrderMessage.all(@order.id)
+puts @order_messages
+
+# Get an order message
+@order_message = @order_messages[0]
+puts Bigcommerce::OrderMessage.find(@order.id, @order_message.id)

data/examples/orders/order_product.rb

@@ -0,0 +1,23 @@
+require 'bigcommerce'
+
+Bigcommerce.configure do |config|
+  config.store_hash = ENV['BC_STORE_HASH']
+  config.client_id = ENV['BC_CLIENT_ID']
+  config.access_token = ENV['BC_ACCESS_TOKEN']
+end
+
+@order = Bigcommerce::Order.all[0]
+
+# List order products
+@order_products = Bigcommerce::OrderProduct.all(@order.id)
+puts @order_products
+
+# Get an order product
+@order_product = @order_products[0]
+puts Bigcommerce::OrderProduct.find(@order.id, @order_product.id)
+
+# Get a count of order products
+puts Bigcommerce::OrderProduct.count(@order.id)
+
+# Get a count of all order products for all orders
+puts Bigcommerce::OrderProduct.count_all

data/examples/orders/order_shipping_address.rb

@@ -0,0 +1,23 @@
+require 'bigcommerce'
+
+Bigcommerce.configure do |config|
+  config.store_hash = ENV['BC_STORE_HASH']
+  config.client_id = ENV['BC_CLIENT_ID']
+  config.access_token = ENV['BC_ACCESS_TOKEN']
+end
+
+@order = Bigcommerce::Order.all[0]
+
+# List order shipping address
+@order_shipping_addresses = Bigcommerce::OrderShippingAddress.all(@order.id)
+puts @order_shipping_addresses
+
+# Get an order shipping address
+@order_shipping_address = @order_shipping_addresses[0]
+puts Bigcommerce::OrderShippingAddress.find(@order.id, @order_shipping_address.id)
+
+# Get a count of order shipping addresses
+puts Bigcommerce::OrderShippingAddress.count(@order.id)
+
+# Get a count of all order shipping addresses for all order
+puts Bigcommerce::OrderShippingAddress.count_all

data/examples/orders/order_status.rb

@@ -0,0 +1,15 @@
+require 'bigcommerce'
+
+Bigcommerce.configure do |config|
+  config.store_hash = ENV['BC_STORE_HASH']
+  config.client_id = ENV['BC_CLIENT_ID']
+  config.access_token = ENV['BC_ACCESS_TOKEN']
+end
+
+# List order statuses
+@order_statuses = Bigcommerce::OrderStatus.all
+puts @order_statuses
+
+# Get an order status
+@order_status = @order_statuses[0]
+puts Bigcommerce::OrderStatus.find(@order_status.id)

data/examples/orders/order_tax.rb

@@ -0,0 +1,17 @@
+require 'bigcommerce'
+
+Bigcommerce.configure do |config|
+  config.store_hash = ENV['BC_STORE_HASH']
+  config.client_id = ENV['BC_CLIENT_ID']
+  config.access_token = ENV['BC_ACCESS_TOKEN']
+end
+
+@order = Bigcommerce::Order.find(109)
+
+# List order taxes
+@order_taxes = Bigcommerce::OrderTax.all(@order.id)
+puts @order_taxes
+
+# Get an order tax
+@order_tax = @order_taxes[0]
+puts Bigcommerce::OrderTax.find(@order.id, @order_tax.id)

data/examples/orders/shipment.rb

@@ -0,0 +1,57 @@
+require 'bigcommerce'
+
+Bigcommerce.configure do |config|
+  config.store_hash = ENV['BC_STORE_HASH']
+  config.client_id = ENV['BC_CLIENT_ID']
+  config.access_token = ENV['BC_ACCESS_TOKEN']
+end
+
+@order = Bigcommerce::Order.all[0]
+
+# Create a shipment
+@order_product = Bigcommerce::OrderProduct.all(@order.id)[0]
+
+@order_address = Bigcommerce::OrderShippingAddress.all(@order.id)[0]
+
+@shipment = Bigcommerce::Shipment.create(
+  @order.id,
+  tracking_number: 'ups12345',
+  comments: 'Notes about the shipment',
+  order_address_id: @order_address.id,
+  items: [
+    {
+      order_product_id: @order_product.id,
+      quantity: 1
+    }
+  ]
+)
+puts @shipment
+
+# List shipments
+@shipments = Bigcommerce::Shipment.all(@order.id)
+puts @shipments
+
+# Get a shipment
+@shipment = @shipments[0]
+puts Bigcommerce::Shipment.find(@order.id, @shipment.id)
+
+# Get a count of shipments
+puts Bigcommerce::Shipment.count(@order.id)
+
+# Get a count of all shipments for all orders
+puts Bigcommerce::Shipment.count_all
+
+# Update a shipment
+puts Bigcommerce::Shipment.update(
+  @order.id,
+  @shipment.id,
+  tracking_number: 'fedex1245',
+  comments: 'Notes about the shipment',
+  order_address_id: @order_address.id
+)
+
+# Delete a shipment
+puts Bigcommerce::Shipment.destroy(@order.id, @shipment.id)
+
+# Delete multiple shipments
+# puts Bigcommerce::Shipment.destroy_all(@order.id)

data/examples/payments/payment_method.rb

@@ -0,0 +1,10 @@
+require 'bigcommerce'
+
+Bigcommerce.configure do |config|
+  config.store_hash = ENV['BC_STORE_HASH']
+  config.client_id = ENV['BC_CLIENT_ID']
+  config.access_token = ENV['BC_ACCESS_TOKEN']
+end
+
+# List payment methods
+puts Bigcommerce::PaymentMethod.all

data/examples/products/brand.rb

@@ -0,0 +1,36 @@
+require 'bigcommerce'
+require 'securerandom'
+
+Bigcommerce.configure do |config|
+  config.store_hash = ENV['BC_STORE_HASH']
+  config.client_id = ENV['BC_CLIENT_ID']
+  config.access_token = ENV['BC_ACCESS_TOKEN']
+end
+
+# List brands
+puts Bigcommerce::Brand.all(page: 2)
+
+# Get a brand
+puts Bigcommerce::Brand.find(10)
+
+# Get a count of brands
+puts Bigcommerce::Brand.count
+
+# Create a brand
+@brand = Bigcommerce::Brand.create(
+  name: SecureRandom.hex,
+  page_title: "Title #{SecureRandom.hex}"
+)
+puts @brand
+
+# Update a brand
+puts Bigcommerce::Brand.update(
+  @brand.id,
+  name: 'Foobar'
+)
+
+# Delete a brand
+puts Bigcommerce::Brand.destroy(@brand.id)
+
+# Delete all brands
+# Bigcommerce::Brand.destroy_all