Class: BigcommerceOAuthAPI::Client
- Defined in:
- lib/bigcommerce-oauth-api/client.rb
Instance Method Summary collapse
-
#blog_post(id, options = {}) ⇒ Object
gets the post with the given id.
-
#blog_posts(options = {}) ⇒ Object
gets a list of posts.
-
#blog_tags(options = {}) ⇒ Object
gets a list of tags.
-
#brand(id, options = {}) ⇒ Object
gets the brand with the given id.
-
#brands(options = {}) ⇒ Object
gets a list of brands.
-
#brands_count(options = {}) ⇒ Object
returns the number of brands.
-
#categories(options = {}) ⇒ Object
gets a list of categories.
-
#category(id, options = {}) ⇒ Object
gets the category with the given id.
-
#countries(options = {}) ⇒ Object
gets a list of countries.
-
#countries_count(options = {}) ⇒ Object
returns the number of countries.
-
#country(id, options = {}) ⇒ Object
gets the country with the given id.
-
#country_state(country_id, id, options = {}) ⇒ Object
gets the state with the given id for the given country.
-
#country_states(country_id, options = {}) ⇒ Object
gets a list of states for the given country.
-
#country_states_count(country_id, options = {}) ⇒ Object
returns the number of states for the given country.
-
#coupon(id, options = {}) ⇒ Object
gets the coupon with the given id.
-
#coupons(options = {}) ⇒ Object
gets a list of coupons.
-
#coupons_count(options = {}) ⇒ Object
returns the number of coupons.
-
#create_blog_post(options = {}) ⇒ Object
creates a post with the given attributes.
-
#create_brand(options = {}) ⇒ Object
creates a brand with the given attributes.
-
#create_category(options = {}) ⇒ Object
creates a category with the given attributes.
-
#create_coupon(options = {}) ⇒ Object
creates a coupon with the given attributes.
-
#create_customer(options = {}) ⇒ Object
creates a customer with the given attributes.
-
#create_customer_address(customer_id, options = {}) ⇒ Object
creates a address with the given attributes for the given customer.
-
#create_customer_group(options = {}) ⇒ Object
creates a customer_group with the given attributes.
-
#create_hook(options = {}) ⇒ Object
creates a hook with the given attributes.
-
#create_option(options = {}) ⇒ Object
creates a option with the given attributes.
-
#create_option_set(options = {}) ⇒ Object
creates a option_set with the given attributes.
-
#create_option_set_option(option_set_id, options = {}) ⇒ Object
creates a option with the given attributes for the given option_set.
-
#create_option_value(option_id, options = {}) ⇒ Object
creates a value with the given attributes for the given option.
-
#create_order(options = {}) ⇒ Object
creates a order with the given attributes.
-
#create_order_shipment(order_id, options = {}) ⇒ Object
creates a shipment with the given attributes for the given order.
-
#create_product(options = {}) ⇒ Object
creates a product with the given attributes.
-
#create_product_custom_field(product_id, options = {}) ⇒ Object
creates a custom_field with the given attributes for the given product.
-
#create_product_discount_rule(product_id, options = {}) ⇒ Object
creates a discount_rule with the given attributes for the given product.
-
#create_product_image(product_id, options = {}) ⇒ Object
creates a image with the given attributes for the given product.
-
#create_product_rule(product_id, options = {}) ⇒ Object
creates a rule with the given attributes for the given product.
-
#create_product_sku(product_id, options = {}) ⇒ Object
creates a sku with the given attributes for the given product.
-
#create_product_video(product_id, options = {}) ⇒ Object
creates a video with the given attributes for the given product.
-
#create_redirect(options = {}) ⇒ Object
creates a redirect with the given attributes.
-
#customer(id, options = {}) ⇒ Object
gets the customer with the given id.
-
#customer_address(customer_id, id, options = {}) ⇒ Object
gets the address with the given id for the given customer.
-
#customer_addresses(customer_id, options = {}) ⇒ Object
gets a list of addresses for the given customer.
-
#customer_group(id, options = {}) ⇒ Object
gets the customer_group with the given id.
-
#customer_groups(options = {}) ⇒ Object
gets a list of customer_groups.
-
#customers(options = {}) ⇒ Object
gets a list of customers.
-
#customers_count(options = {}) ⇒ Object
returns the number of customers.
-
#delete_blog_post(id) ⇒ Object
deletes the post with the given id.
-
#delete_brand(id) ⇒ Object
deletes the brand with the given id.
-
#delete_category(id) ⇒ Object
deletes the category with the given id.
-
#delete_coupon(id) ⇒ Object
deletes the coupon with the given id.
-
#delete_customer(id) ⇒ Object
deletes the customer with the given id.
-
#delete_customer_address(customer_id, id) ⇒ Object
deletes the address with the given id for the given customer.
-
#delete_customer_group(id) ⇒ Object
deletes the customer_group with the given id.
-
#delete_hook(id) ⇒ Object
deletes the hook with the given id.
-
#delete_option(id) ⇒ Object
deletes the option with the given id.
-
#delete_option_set(id) ⇒ Object
deletes the option_set with the given id.
-
#delete_option_set_option(option_set_id, id) ⇒ Object
deletes the option with the given id for the given option_set.
-
#delete_option_value(option_id, id) ⇒ Object
deletes the value with the given id for the given option.
-
#delete_order(id) ⇒ Object
deletes the order with the given id.
-
#delete_order_shipment(order_id, id) ⇒ Object
deletes the shipment with the given id for the given order.
-
#delete_product(id) ⇒ Object
deletes the product with the given id.
-
#delete_product_configurable_field(product_id, id) ⇒ Object
deletes the configurable_field with the given id for the given product.
-
#delete_product_custom_field(product_id, id) ⇒ Object
deletes the custom_field with the given id for the given product.
-
#delete_product_discount_rule(product_id, id) ⇒ Object
deletes the discount_rule with the given id for the given product.
-
#delete_product_image(product_id, id) ⇒ Object
deletes the image with the given id for the given product.
-
#delete_product_rule(product_id, id) ⇒ Object
deletes the rule with the given id for the given product.
-
#delete_product_sku(product_id, id) ⇒ Object
deletes the sku with the given id for the given product.
-
#delete_product_video(product_id, id) ⇒ Object
deletes the video with the given id for the given product.
-
#delete_redirect(id) ⇒ Object
deletes the redirect with the given id.
-
#hook(id, options = {}) ⇒ Object
gets the hook with the given id.
-
#hooks(options = {}) ⇒ Object
gets a list of hooks.
-
#option(id, options = {}) ⇒ Object
gets the option with the given id.
-
#option_set(id, options = {}) ⇒ Object
gets the option_set with the given id.
-
#option_set_option(option_set_id, id, options = {}) ⇒ Object
gets the option with the given id for the given option_set.
-
#option_set_options(option_set_id, options = {}) ⇒ Object
gets a list of options for the given option_set.
-
#option_sets(options = {}) ⇒ Object
gets a list of option_sets.
-
#option_sets_count(options = {}) ⇒ Object
returns the number of option_sets.
-
#option_value(option_id, id, options = {}) ⇒ Object
gets the value with the given id for the given option.
-
#option_values(option_id, options = {}) ⇒ Object
gets a list of values for the given option.
-
#options(options = {}) ⇒ Object
gets a list of options.
-
#options_count(options = {}) ⇒ Object
returns the number of options.
-
#order(id, options = {}) ⇒ Object
gets the order with the given id.
-
#order_coupon(order_id, id, options = {}) ⇒ Object
gets the coupon with the given id for the given order.
-
#order_coupons(order_id, options = {}) ⇒ Object
gets a list of coupons for the given order.
-
#order_message(order_id, id, options = {}) ⇒ Object
gets the message with the given id for the given order.
-
#order_messages(order_id, options = {}) ⇒ Object
gets a list of messages for the given order.
-
#order_product(order_id, id, options = {}) ⇒ Object
gets the product with the given id for the given order.
-
#order_products(order_id, options = {}) ⇒ Object
gets a list of products for the given order.
-
#order_products_count(order_id, options = {}) ⇒ Object
returns the number of products for the given order.
-
#order_shipment(order_id, id, options = {}) ⇒ Object
gets the shipment with the given id for the given order.
-
#order_shipments(order_id, options = {}) ⇒ Object
gets a list of shipments for the given order.
-
#order_shipping_address(order_id, id, options = {}) ⇒ Object
gets the shipping_address with the given id for the given order.
-
#order_shipping_addresses(order_id, options = {}) ⇒ Object
gets a list of shipping_addresses for the given order.
-
#order_status(id, options = {}) ⇒ Object
gets the order_status with the given id.
-
#order_statuses(options = {}) ⇒ Object
gets a list of order_statuses.
-
#order_tax(order_id, id, options = {}) ⇒ Object
gets the tax with the given id for the given order.
-
#order_taxes(order_id, options = {}) ⇒ Object
gets a list of taxes for the given order.
-
#orders(options = {}) ⇒ Object
gets a list of orders.
-
#orders_count(options = {}) ⇒ Object
returns the number of orders.
-
#payment_methods(options = {}) ⇒ Object
gets a list of methods.
-
#product(id, options = {}) ⇒ Object
gets the product with the given id.
-
#product_configurable_field(product_id, id, options = {}) ⇒ Object
gets the configurable_field with the given id for the given product.
-
#product_configurable_fields(product_id, options = {}) ⇒ Object
gets a list of configurable_fields for the given product.
-
#product_configurable_fields_count(product_id, options = {}) ⇒ Object
returns the number of configurable_fields for the given product.
-
#product_custom_field(product_id, id, options = {}) ⇒ Object
gets the custom_field with the given id for the given product.
-
#product_custom_fields(product_id, options = {}) ⇒ Object
gets a list of custom_fields for the given product.
-
#product_discount_rule(product_id, id, options = {}) ⇒ Object
gets the discount_rule with the given id for the given product.
-
#product_discount_rules(product_id, options = {}) ⇒ Object
gets a list of discount_rules for the given product.
-
#product_discount_rules_count(product_id, options = {}) ⇒ Object
returns the number of discount_rules for the given product.
-
#product_googleproductsearch(product_id, options = {}) ⇒ Object
Gets the Google Product Search mappings for a product.
-
#product_image(product_id, id, options = {}) ⇒ Object
gets the image with the given id for the given product.
-
#product_images(product_id, options = {}) ⇒ Object
gets a list of images for the given product.
-
#product_images_count(product_id, options = {}) ⇒ Object
returns the number of images for the given product.
-
#product_option(product_id, id, options = {}) ⇒ Object
gets the option with the given id for the given product.
-
#product_options(product_id, options = {}) ⇒ Object
gets a list of options for the given product.
-
#product_reviews(product_id, options = {}) ⇒ Object
gets a list of reviews for the given product.
-
#product_rule(product_id, id, options = {}) ⇒ Object
gets the rule with the given id for the given product.
-
#product_rules(product_id, options = {}) ⇒ Object
gets a list of rules for the given product.
-
#product_rules_count(product_id, options = {}) ⇒ Object
returns the number of rules for the given product.
-
#product_sku(product_id, id, options = {}) ⇒ Object
gets the sku with the given id for the given product.
-
#product_skus(product_id, options = {}) ⇒ Object
gets a list of skus for the given product.
-
#product_skus_count(product_id, options = {}) ⇒ Object
returns the number of skus for the given product.
-
#product_video(product_id, id, options = {}) ⇒ Object
gets the video with the given id for the given product.
-
#product_videos(product_id, options = {}) ⇒ Object
gets a list of videos for the given product.
-
#product_videos_count(product_id, options = {}) ⇒ Object
returns the number of videos for the given product.
-
#products(options = {}) ⇒ Object
gets a list of products.
-
#products_count(options = {}) ⇒ Object
returns the number of products.
-
#redirect(id, options = {}) ⇒ Object
gets the redirect with the given id.
-
#redirects(options = {}) ⇒ Object
gets a list of redirects.
-
#redirects_count(options = {}) ⇒ Object
returns the number of redirects.
-
#shipping_method(id, options = {}) ⇒ Object
gets the method with the given id.
-
#shipping_methods(options = {}) ⇒ Object
gets a list of methods.
-
#store_information ⇒ Object
get basic store information.
-
#tax_class(id, options = {}) ⇒ Object
gets the tax_class with the given id.
-
#tax_classes(options = {}) ⇒ Object
gets a list of tax_classes.
-
#time ⇒ Object
get server time.
-
#update_blog_post(id, options = {}) ⇒ Object
update the attributes of the post with the given id.
-
#update_brand(id, options = {}) ⇒ Object
update the attributes of the brand with the given id.
-
#update_category(id, options = {}) ⇒ Object
update the attributes of the category with the given id.
-
#update_coupon(id, options = {}) ⇒ Object
update the attributes of the coupon with the given id.
-
#update_customer(id, options = {}) ⇒ Object
update the attributes of the customer with the given id.
-
#update_customer_address(customer_id, id, options = {}) ⇒ Object
update the attributes of the address with the given id for the given customer.
-
#update_customer_group(id, options = {}) ⇒ Object
update the attributes of the customer_group with the given id.
-
#update_hook(id, options = {}) ⇒ Object
update the attributes of the hook with the given id.
-
#update_option(id, options = {}) ⇒ Object
update the attributes of the option with the given id.
-
#update_option_set(id, options = {}) ⇒ Object
update the attributes of the option_set with the given id.
-
#update_option_set_option(option_set_id, id, options = {}) ⇒ Object
update the attributes of the option with the given id for the given option_set.
-
#update_option_value(option_id, id, options = {}) ⇒ Object
update the attributes of the value with the given id for the given option.
-
#update_order(id, options = {}) ⇒ Object
update the attributes of the order with the given id.
-
#update_order_shipment(order_id, id, options = {}) ⇒ Object
update the attributes of the shipment with the given id for the given order.
-
#update_product(id, options = {}) ⇒ Object
update the attributes of the product with the given id.
-
#update_product_custom_field(product_id, id, options = {}) ⇒ Object
update the attributes of the custom_field with the given id for the given product.
-
#update_product_discount_rule(product_id, id, options = {}) ⇒ Object
update the attributes of the discount_rule with the given id for the given product.
-
#update_product_image(product_id, id, options = {}) ⇒ Object
update the attributes of the image with the given id for the given product.
-
#update_product_rule(product_id, id, options = {}) ⇒ Object
update the attributes of the rule with the given id for the given product.
-
#update_product_sku(product_id, id, options = {}) ⇒ Object
update the attributes of the sku with the given id for the given product.
-
#update_product_video(product_id, id, options = {}) ⇒ Object
update the attributes of the video with the given id for the given product.
-
#update_redirect(id, options = {}) ⇒ Object
update the attributes of the redirect with the given id.
Methods inherited from API
#config, #initialize, #is_legacy?
Methods included from Request
Constructor Details
This class inherits a constructor from BigcommerceOAuthAPI::API
Instance Method Details
#blog_post(id, options = {}) ⇒ Object
gets the post with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 66
|
#blog_posts(options = {}) ⇒ Object
gets a list of posts
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 62
|
#blog_tags(options = {}) ⇒ Object
gets a list of tags
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 83
|
#brand(id, options = {}) ⇒ Object
gets the brand with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 91
|
#brands(options = {}) ⇒ Object
gets a list of brands
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 87
|
#brands_count(options = {}) ⇒ Object
returns the number of brands
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 108
|
#categories(options = {}) ⇒ Object
gets a list of categories
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 112
|
#category(id, options = {}) ⇒ Object
gets the category with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 116
|
#countries(options = {}) ⇒ Object
gets a list of countries
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 205
|
#countries_count(options = {}) ⇒ Object
returns the number of countries
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 213
|
#country(id, options = {}) ⇒ Object
gets the country with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 209
|
#country_state(country_id, id, options = {}) ⇒ Object
gets the state with the given id for the given country
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 222
|
#country_states(country_id, options = {}) ⇒ Object
gets a list of states for the given country
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 217
|
#country_states_count(country_id, options = {}) ⇒ Object
returns the number of states for the given country
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 227
|
#coupon(id, options = {}) ⇒ Object
gets the coupon with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 236
|
#coupons(options = {}) ⇒ Object
gets a list of coupons
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 232
|
#coupons_count(options = {}) ⇒ Object
returns the number of coupons
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 253
|
#create_blog_post(options = {}) ⇒ Object
creates a post with the given attributes
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 70
|
#create_brand(options = {}) ⇒ Object
creates a brand with the given attributes
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 95
|
#create_category(options = {}) ⇒ Object
creates a category with the given attributes
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 120
|
#create_coupon(options = {}) ⇒ Object
creates a coupon with the given attributes
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 240
|
#create_customer(options = {}) ⇒ Object
creates a customer with the given attributes
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 141
|
#create_customer_address(customer_id, options = {}) ⇒ Object
creates a address with the given attributes for the given customer
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 168
|
#create_customer_group(options = {}) ⇒ Object
creates a customer_group with the given attributes
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 192
|
#create_hook(options = {}) ⇒ Object
creates a hook with the given attributes
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 767
|
#create_option(options = {}) ⇒ Object
creates a option with the given attributes
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 265
|
#create_option_set(options = {}) ⇒ Object
creates a option_set with the given attributes
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 290
|
#create_option_set_option(option_set_id, options = {}) ⇒ Object
creates a option with the given attributes for the given option_set
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 317
|
#create_option_value(option_id, options = {}) ⇒ Object
creates a value with the given attributes for the given option
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 343
|
#create_order(options = {}) ⇒ Object
creates a order with the given attributes
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 375
|
#create_order_shipment(order_id, options = {}) ⇒ Object
creates a shipment with the given attributes for the given order
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 437
|
#create_product(options = {}) ⇒ Object
creates a product with the given attributes
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 485
|
#create_product_custom_field(product_id, options = {}) ⇒ Object
creates a custom_field with the given attributes for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 512
|
#create_product_discount_rule(product_id, options = {}) ⇒ Object
creates a discount_rule with the given attributes for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 538
|
#create_product_image(product_id, options = {}) ⇒ Object
creates a image with the given attributes for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 589
|
#create_product_rule(product_id, options = {}) ⇒ Object
creates a rule with the given attributes for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 635
|
#create_product_sku(product_id, options = {}) ⇒ Object
creates a sku with the given attributes for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 697
|
#create_product_video(product_id, options = {}) ⇒ Object
creates a video with the given attributes for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 666
|
#create_redirect(options = {}) ⇒ Object
creates a redirect with the given attributes
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 726
|
#customer(id, options = {}) ⇒ Object
gets the customer with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 137
|
#customer_address(customer_id, id, options = {}) ⇒ Object
gets the address with the given id for the given customer
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 163
|
#customer_addresses(customer_id, options = {}) ⇒ Object
gets a list of addresses for the given customer
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 158
|
#customer_group(id, options = {}) ⇒ Object
gets the customer_group with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 188
|
#customer_groups(options = {}) ⇒ Object
gets a list of customer_groups
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 184
|
#customers(options = {}) ⇒ Object
gets a list of customers
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 133
|
#customers_count(options = {}) ⇒ Object
returns the number of customers
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 154
|
#delete_blog_post(id) ⇒ Object
deletes the post with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 79
|
#delete_brand(id) ⇒ Object
deletes the brand with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 104
|
#delete_category(id) ⇒ Object
deletes the category with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 129
|
#delete_coupon(id) ⇒ Object
deletes the coupon with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 249
|
#delete_customer(id) ⇒ Object
deletes the customer with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 150
|
#delete_customer_address(customer_id, id) ⇒ Object
deletes the address with the given id for the given customer
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 179
|
#delete_customer_group(id) ⇒ Object
deletes the customer_group with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 201
|
#delete_hook(id) ⇒ Object
deletes the hook with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 776
|
#delete_option(id) ⇒ Object
deletes the option with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 274
|
#delete_option_set(id) ⇒ Object
deletes the option_set with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 299
|
#delete_option_set_option(option_set_id, id) ⇒ Object
deletes the option with the given id for the given option_set
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 328
|
#delete_option_value(option_id, id) ⇒ Object
deletes the value with the given id for the given option
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 354
|
#delete_order(id) ⇒ Object
deletes the order with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 384
|
#delete_order_shipment(order_id, id) ⇒ Object
deletes the shipment with the given id for the given order
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 448
|
#delete_product(id) ⇒ Object
deletes the product with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 494
|
#delete_product_configurable_field(product_id, id) ⇒ Object
deletes the configurable_field with the given id for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 569
|
#delete_product_custom_field(product_id, id) ⇒ Object
deletes the custom_field with the given id for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 523
|
#delete_product_discount_rule(product_id, id) ⇒ Object
deletes the discount_rule with the given id for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 549
|
#delete_product_image(product_id, id) ⇒ Object
deletes the image with the given id for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 600
|
#delete_product_rule(product_id, id) ⇒ Object
deletes the rule with the given id for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 646
|
#delete_product_sku(product_id, id) ⇒ Object
deletes the sku with the given id for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 708
|
#delete_product_video(product_id, id) ⇒ Object
deletes the video with the given id for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 677
|
#delete_redirect(id) ⇒ Object
deletes the redirect with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 735
|
#hook(id, options = {}) ⇒ Object
gets the hook with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 763
|
#hooks(options = {}) ⇒ Object
gets a list of hooks
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 759
|
#option(id, options = {}) ⇒ Object
gets the option with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 261
|
#option_set(id, options = {}) ⇒ Object
gets the option_set with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 286
|
#option_set_option(option_set_id, id, options = {}) ⇒ Object
gets the option with the given id for the given option_set
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 312
|
#option_set_options(option_set_id, options = {}) ⇒ Object
gets a list of options for the given option_set
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 307
|
#option_sets(options = {}) ⇒ Object
gets a list of option_sets
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 282
|
#option_sets_count(options = {}) ⇒ Object
returns the number of option_sets
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 303
|
#option_value(option_id, id, options = {}) ⇒ Object
gets the value with the given id for the given option
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 338
|
#option_values(option_id, options = {}) ⇒ Object
gets a list of values for the given option
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 333
|
#options(options = {}) ⇒ Object
gets a list of options
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 257
|
#options_count(options = {}) ⇒ Object
returns the number of options
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 278
|
#order(id, options = {}) ⇒ Object
gets the order with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 371
|
#order_coupon(order_id, id, options = {}) ⇒ Object
gets the coupon with the given id for the given order
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 397
|
#order_coupons(order_id, options = {}) ⇒ Object
gets a list of coupons for the given order
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 392
|
#order_message(order_id, id, options = {}) ⇒ Object
gets the message with the given id for the given order
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 407
|
#order_messages(order_id, options = {}) ⇒ Object
gets a list of messages for the given order
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 402
|
#order_product(order_id, id, options = {}) ⇒ Object
gets the product with the given id for the given order
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 417
|
#order_products(order_id, options = {}) ⇒ Object
gets a list of products for the given order
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 412
|
#order_products_count(order_id, options = {}) ⇒ Object
returns the number of products for the given order
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 422
|
#order_shipment(order_id, id, options = {}) ⇒ Object
gets the shipment with the given id for the given order
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 432
|
#order_shipments(order_id, options = {}) ⇒ Object
gets a list of shipments for the given order
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 427
|
#order_shipping_address(order_id, id, options = {}) ⇒ Object
gets the shipping_address with the given id for the given order
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 458
|
#order_shipping_addresses(order_id, options = {}) ⇒ Object
gets a list of shipping_addresses for the given order
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 453
|
#order_status(id, options = {}) ⇒ Object
gets the order_status with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 363
|
#order_statuses(options = {}) ⇒ Object
gets a list of order_statuses
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 359
|
#order_tax(order_id, id, options = {}) ⇒ Object
gets the tax with the given id for the given order
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 468
|
#order_taxes(order_id, options = {}) ⇒ Object
gets a list of taxes for the given order
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 463
|
#orders(options = {}) ⇒ Object
gets a list of orders
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 367
|
#orders_count(options = {}) ⇒ Object
returns the number of orders
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 388
|
#payment_methods(options = {}) ⇒ Object
gets a list of methods
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 473
|
#product(id, options = {}) ⇒ Object
gets the product with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 481
|
#product_configurable_field(product_id, id, options = {}) ⇒ Object
gets the configurable_field with the given id for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 564
|
#product_configurable_fields(product_id, options = {}) ⇒ Object
gets a list of configurable_fields for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 559
|
#product_configurable_fields_count(product_id, options = {}) ⇒ Object
returns the number of configurable_fields for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 574
|
#product_custom_field(product_id, id, options = {}) ⇒ Object
gets the custom_field with the given id for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 507
|
#product_custom_fields(product_id, options = {}) ⇒ Object
gets a list of custom_fields for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 502
|
#product_discount_rule(product_id, id, options = {}) ⇒ Object
gets the discount_rule with the given id for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 533
|
#product_discount_rules(product_id, options = {}) ⇒ Object
gets a list of discount_rules for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 528
|
#product_discount_rules_count(product_id, options = {}) ⇒ Object
returns the number of discount_rules for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 554
|
#product_googleproductsearch(product_id, options = {}) ⇒ Object
Gets the Google Product Search mappings for a product.
20 21 22 |
# File 'lib/bigcommerce-oauth-api/client.rb', line 20 def product_googleproductsearch(product_id, = {}) get("products/#{product_id}/googleproductsearch", ) end |
#product_image(product_id, id, options = {}) ⇒ Object
gets the image with the given id for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 584
|
#product_images(product_id, options = {}) ⇒ Object
gets a list of images for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 579
|
#product_images_count(product_id, options = {}) ⇒ Object
returns the number of images for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 605
|
#product_option(product_id, id, options = {}) ⇒ Object
gets the option with the given id for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 615
|
#product_options(product_id, options = {}) ⇒ Object
gets a list of options for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 610
|
#product_reviews(product_id, options = {}) ⇒ Object
gets a list of reviews for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 620
|
#product_rule(product_id, id, options = {}) ⇒ Object
gets the rule with the given id for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 630
|
#product_rules(product_id, options = {}) ⇒ Object
gets a list of rules for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 625
|
#product_rules_count(product_id, options = {}) ⇒ Object
returns the number of rules for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 651
|
#product_sku(product_id, id, options = {}) ⇒ Object
gets the sku with the given id for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 692
|
#product_skus(product_id, options = {}) ⇒ Object
gets a list of skus for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 687
|
#product_skus_count(product_id, options = {}) ⇒ Object
returns the number of skus for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 713
|
#product_video(product_id, id, options = {}) ⇒ Object
gets the video with the given id for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 661
|
#product_videos(product_id, options = {}) ⇒ Object
gets a list of videos for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 656
|
#product_videos_count(product_id, options = {}) ⇒ Object
returns the number of videos for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 682
|
#products(options = {}) ⇒ Object
gets a list of products
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 477
|
#products_count(options = {}) ⇒ Object
returns the number of products
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 498
|
#redirect(id, options = {}) ⇒ Object
gets the redirect with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 722
|
#redirects(options = {}) ⇒ Object
gets a list of redirects
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 718
|
#redirects_count(options = {}) ⇒ Object
returns the number of redirects
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 739
|
#shipping_method(id, options = {}) ⇒ Object
gets the method with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 747
|
#shipping_methods(options = {}) ⇒ Object
gets a list of methods
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 743
|
#store_information ⇒ Object
get basic store information
14 15 16 |
# File 'lib/bigcommerce-oauth-api/client.rb', line 14 def store_information get('store') end |
#tax_class(id, options = {}) ⇒ Object
gets the tax_class with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 755
|
#tax_classes(options = {}) ⇒ Object
gets a list of tax_classes
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 751
|
#time ⇒ Object
get server time
8 9 10 |
# File 'lib/bigcommerce-oauth-api/client.rb', line 8 def time get('time') end |
#update_blog_post(id, options = {}) ⇒ Object
update the attributes of the post with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 74
|
#update_brand(id, options = {}) ⇒ Object
update the attributes of the brand with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 99
|
#update_category(id, options = {}) ⇒ Object
update the attributes of the category with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 124
|
#update_coupon(id, options = {}) ⇒ Object
update the attributes of the coupon with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 244
|
#update_customer(id, options = {}) ⇒ Object
update the attributes of the customer with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 145
|
#update_customer_address(customer_id, id, options = {}) ⇒ Object
update the attributes of the address with the given id for the given customer
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 173
|
#update_customer_group(id, options = {}) ⇒ Object
update the attributes of the customer_group with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 196
|
#update_hook(id, options = {}) ⇒ Object
update the attributes of the hook with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 771
|
#update_option(id, options = {}) ⇒ Object
update the attributes of the option with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 269
|
#update_option_set(id, options = {}) ⇒ Object
update the attributes of the option_set with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 294
|
#update_option_set_option(option_set_id, id, options = {}) ⇒ Object
update the attributes of the option with the given id for the given option_set
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 322
|
#update_option_value(option_id, id, options = {}) ⇒ Object
update the attributes of the value with the given id for the given option
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 348
|
#update_order(id, options = {}) ⇒ Object
update the attributes of the order with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 379
|
#update_order_shipment(order_id, id, options = {}) ⇒ Object
update the attributes of the shipment with the given id for the given order
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 442
|
#update_product(id, options = {}) ⇒ Object
update the attributes of the product with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 489
|
#update_product_custom_field(product_id, id, options = {}) ⇒ Object
update the attributes of the custom_field with the given id for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 517
|
#update_product_discount_rule(product_id, id, options = {}) ⇒ Object
update the attributes of the discount_rule with the given id for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 543
|
#update_product_image(product_id, id, options = {}) ⇒ Object
update the attributes of the image with the given id for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 594
|
#update_product_rule(product_id, id, options = {}) ⇒ Object
update the attributes of the rule with the given id for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 640
|
#update_product_sku(product_id, id, options = {}) ⇒ Object
update the attributes of the sku with the given id for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 702
|
#update_product_video(product_id, id, options = {}) ⇒ Object
update the attributes of the video with the given id for the given product
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 671
|
#update_redirect(id, options = {}) ⇒ Object
update the attributes of the redirect with the given id
|
# File 'lib/bigcommerce-oauth-api/client.rb', line 730
|