bigcommerce 0.10.0 → 1.0.0.beta

data/examples/products/bulk_pricing_rule.rb

@@ -0,0 +1,47 @@
+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
+
+@product = Bigcommerce::Product.all[0]
+
+# Create a products bulk pricing rule
+@bulk_pricing_rule = Bigcommerce::BulkPricingRule.create(
+  @product.id,
+  min: 1,
+  max: 5,
+  type: 'price',
+  type_value: 2
+)
+puts @bulk_pricing_rule
+
+# List bulk pricing rules
+puts Bigcommerce::BulkPricingRule.all(@product.id)
+
+# Get a product bulk pricing rule
+puts Bigcommerce::BulkPricingRule.find(@product.id, @bulk_pricing_rule.id)
+
+# Get a count of bulk pricing rules
+puts Bigcommerce::BulkPricingRule.count(@product.id)
+
+# Get a count of all bulk pricing rules for all products
+puts Bigcommerce::BulkPricingRule.count_all
+
+# Update a bulk pricing rule
+puts Bigcommerce::BulkPricingRule.update(
+  @product.id,
+  @bulk_pricing_rule.id,
+  min: 2,
+  type: 'price',
+  type_value: 2
+)
+
+# Delete a product bulk pricing rule
+puts Bigcommerce::BulkPricingRule.destroy(@product.id, @bulk_pricing_rule.id)
+
+# Delete multiple bulk pricing rules
+# puts Bigcommerce::BulkPricingRule.destroy(@product.id)

data/examples/products/category.rb

@@ -0,0 +1,37 @@
+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 categories
+@categories = Bigcommerce::Category.all
+puts @categories
+
+# Get a category
+@category = @categories[0]
+puts Bigcommerce::Category.find(@category.id)
+
+# Get a count of categories
+puts Bigcommerce::Category.count
+
+# Create a category
+@category = Bigcommerce::Category.create(
+  name: SecureRandom.hex
+)
+puts @category
+
+# Update a category
+puts Bigcommerce::Category.update(
+  @category.id,
+  name: 'Foobar'
+)
+
+# Delete a category
+puts Bigcommerce::Category.destroy(@category.id)
+
+# Delete all categories
+# Bigcommerce::Category.destroy_all

data/examples/products/configurable_field.rb

@@ -0,0 +1,29 @@
+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
+
+@product = Bigcommerce::Product.all[0]
+
+# List configurable fields
+@configurable_fields = Bigcommerce::ConfigurableField.all(@product.id)
+puts @configurable_fields
+
+# Get a configurable field
+@configurable_field = @configurable_fields[0]
+puts Bigcommerce::ConfigurableField.all(@product.id, @configurable_field.id)
+
+# Get a count of configurable fields
+puts Bigcommerce::ConfigurableField.count(@product.id)
+
+# Get a count of all configurable fields for all products
+puts Bigcommerce::ConfigurableField.count(@product.id)
+
+# Delete a configurable field
+puts Bigcommerce::ConfigurableField.destroy(@product.id, @configurable_field.id)
+
+# Delete multiple configurable fields
+# puts Bigcommerce::ConfigurableField.destroy_all(@product.id)

data/examples/products/custom_field.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
+
+@product = Bigcommerce::Product.all[0]
+
+# Create a custom field
+@custom_field = Bigcommerce::CustomField.create(
+  @product.id,
+  name: SecureRandom.hex,
+  text: SecureRandom.hex
+)
+puts @custom_field
+
+# List custom fields
+puts Bigcommerce::CustomField.all(@product.id)
+
+# Get a custom field
+puts Bigcommerce::CustomField.find(@product.id, @custom_field.id)
+
+# Get a count of custom fields
+puts Bigcommerce::CustomField.count(@product.id)
+
+# Get a count of custom fields for all products
+puts Bigcommerce::CustomField.count_all
+
+# Update a custom field
+puts Bigcommerce::CustomField.update(
+  @product.id,
+  @custom_field.id,
+  name: ':)',
+  text: ':)'
+)
+
+# Delete a custom field
+puts Bigcommerce::CustomField.destroy(@product.id, @custom_field.id)
+
+# Delete multiple custom fields
+# puts Bigcommerce::CustomField.destroy_all(@product.id)

data/examples/products/google_product_search_mapping.rb

@@ -0,0 +1,12 @@
+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
+
+@product = Bigcommerce::Product.all[0]
+
+# List Google product search mappings
+puts Bigcommerce::GoogleProductSearchMapping.all(@product.id)

data/examples/products/option.rb

@@ -0,0 +1,37 @@
+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
+
+# Create an option
+@option = Bigcommerce::Option.create(
+  name: SecureRandom.hex,
+  type: 'CS'
+)
+puts @option
+
+# List options
+puts Bigcommerce::Option.all
+
+# Get an option
+puts Bigcommerce::Option.find(@option.id)
+
+# Get a count of options
+puts Bigcommerce::Option.count
+
+# Update an option
+puts Bigcommerce::Option.update(
+  @option.id,
+  name: ':)',
+  type: 'CS'
+)
+
+# Delete an option
+puts Bigcommerce::Option.destroy(@option.id)
+
+# Delete all options
+# Bigcommerce::Option.destroy_all

data/examples/products/option_set.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
+
+# Create an option set
+@option_set = Bigcommerce::OptionSet.create(
+  name: SecureRandom.hex
+)
+puts @option_set
+
+# List option sets
+puts Bigcommerce::OptionSet.all
+
+# Get an option set
+puts Bigcommerce::OptionSet.find(@option_set.id)
+
+# Get a count of option sets
+puts Bigcommerce::OptionSet.count
+
+# Update an option set
+puts Bigcommerce::OptionSet.update(
+  @option_set.id,
+  name: ':)'
+)
+
+# Delete an option set
+puts Bigcommerce::OptionSet.destroy(@option_set.id)
+
+# Delete all option sets
+# Bigcommerce::OptionSet.destroy_all

data/examples/products/option_set_option.rb

@@ -0,0 +1,50 @@
+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
+
+@option_set = Bigcommerce::OptionSet.create(
+  name: SecureRandom.hex
+)
+
+@option = Bigcommerce::Option.create(
+  name: SecureRandom.hex,
+  type: 'CS'
+)
+
+# Create an option set option
+@option_set_option = Bigcommerce::OptionSetOption.create(
+  @option_set.id,
+  option_id: @option.id,
+  display_name: SecureRandom.hex,
+  sort_order: 1,
+  is_required: true
+)
+puts @option_set_option
+
+# List option set options
+puts Bigcommerce::OptionSetOption.all(@option_set.id)
+
+puts Bigcommerce::OptionSetOption.count(@option_set.id)
+
+# Get an option set option
+puts Bigcommerce::OptionSetOption.find(@option_set.id, @option_set_option.id)
+
+# Update an option set option
+puts Bigcommerce::OptionSetOption.update(
+  @option_set.id,
+  @option_set_option.id,
+  display_name: 'Pick a color...',
+  sort_order: 2,
+  is_required: false
+)
+
+# Delete an option set option
+puts Bigcommerce::OptionSetOption.destroy(@option_set.id, @option_set_option.id)
+
+# Delete multiple option set options
+# puts Bigcommerce::OptionSetOption.destroy_all(@option_set.id)

data/examples/products/option_value.rb

@@ -0,0 +1,43 @@
+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
+
+@option = Bigcommerce::Option.create(
+  name: SecureRandom.hex,
+  type: 'CS'
+)
+
+# Create an option value
+@option_value = Bigcommerce::OptionValue.create(
+  @option.id,
+  label: SecureRandom.hex,
+  sort_order: 0,
+  value: '#FFFFFF'
+)
+puts @option_value
+
+# List option values
+puts Bigcommerce::OptionValue.all(@option.id)
+
+# Get an option value
+puts Bigcommerce::OptionValue.find(@option.id, @option_value.id)
+
+# Update an option value
+puts Bigcommerce::OptionValue.update(
+  @option.id,
+  @option_value.id,
+  label: SecureRandom.hex,
+  sort_order: 0,
+  value: '#000000'
+)
+
+# Delete an option value
+puts Bigcommerce::OptionValue.destroy(@option.id, @option_value.id)
+
+# Delete multiple option values
+# puts Bigcommerce::OptionValue.destroy_all(@option.id)

data/examples/products/product.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 products
+@products = Bigcommerce::Product.all
+puts @products
+
+# Get a product
+@product = @products[0]
+puts Bigcommerce::Product.find(@product.id)
+
+# Get products count
+puts Bigcommerce::Product.count
+
+# Create a product
+@category = Bigcommerce::Category.all[0]
+@product = Bigcommerce::Product.create(
+  name: SecureRandom.hex,
+  type: 'physical',
+  description: SecureRandom.hex,
+  price: '19.95',
+  categories: [@category.id],
+  availability: 'available',
+  weight: '0.5'
+)
+puts @product
+
+# Update a product
+puts Bigcommerce::Product.update(
+  @product.id,
+  custom_url: '/foo-bar/'
+)
+
+# Delete a product
+puts Bigcommerce::Product.destroy(@product.id)
+
+# Delete all products
+# puts Bigcommerce::Product.destroy_all

data/examples/products/product_image.rb

@@ -0,0 +1,42 @@
+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
+
+@product = Bigcommerce::Product.all[0]
+
+# List product images
+@product_images = Bigcommerce::ProductImage.all(@product.id)
+puts @product_images
+
+# Get a count of product images
+puts Bigcommerce::ProductImage.count(@product.id)
+
+# Get a count of all product images for all products
+puts Bigcommerce::ProductImage.count_all
+
+# Create a product image
+@product_image = Bigcommerce::ProductImage.create(
+  @product.id,
+  image_file: 'http://i.imgur.com/Z5aV28x.gif'
+)
+puts @product_image
+
+# Get a product image
+puts Bigcommerce::ProductImage.find(@product.id, @product_image.id)
+
+# Update a product image
+puts Bigcommerce::ProductImage.update(
+  @product.id,
+  @product_image.id,
+  image_file: 'http://i.imgur.com/4Dl6Y9d.gif'
+)
+
+# Delete a product image
+puts Bigcommerce::ProductImage.destroy(@product.id, @product_image.id)
+
+# Delete all product images
+# puts Bigcommerce::ProductImage.destroy_all(@product.id)

data/examples/products/product_option.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
+
+@product = Bigcommerce::Product.all[0]
+
+# List product options
+@product_options = Bigcommerce::ProductOption.all(@product.id)
+puts @product_options
+
+# Get a product option
+@product_option = @product_options[0]
+puts Bigcommerce::ProductOption.find(@product.id, @product_option.id)