bigcommerce-oauth-api 1.1.5 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 05b4b880635f6fe8171403389c9fea92c38e5085
-  data.tar.gz: 806eee759ea724460abfc652c92c408c7de93376
+  metadata.gz: bdf5b9ddfbfad7c95f914d01e772122c59363ebf
+  data.tar.gz: 53309df2bcfad86dcb8f1ecafc88e22499314f89
 SHA512:
-  metadata.gz: b99f001bda6eb84986de1424defc4268543b570fc02743facd0227b2591b2b043ae85ec694a261d4be3f42234a035c21414fc74ee94c9328fe7c6873da9b071d
-  data.tar.gz: 50f87ff14ffba40c076f0f04a67c50173a9dc8a6bd5bae8a935b4374fd43ae757bde1666f5b426df92e4d621e2e44402713075fe28b7ebf7fad7ecf2b90445e8
+  metadata.gz: 80a2d871dd59031976c08e65572705e583a0d552ebf02de3467f7fe333fe216904488ede52b947ee3760a2a5c592d031300e01e46c4b6ac0bf8882cb88e31986
+  data.tar.gz: e5c66453f20d4ec5fc7e1a0cdb3ab675976d264ffd9c5b14b8e2ba69a2e9d757866b4d0bbf1804f2f747c0e7ded23b345edea319a1c9c00e5d7ad1d3ac13eacd

data/CHANGELOG.md

@@ -1,3 +1,20 @@
+### 1.2.0 (2015-04-19)
+
+Features:
+
+    - add legacy api support
+    - add omniref and revert to using rdoc
+    - add order coupon apis
+    - add order tax apis
+    - add order statuses apis
+
+Bugfixes:
+
+    - update geography apis
+    - add a few missing "count" apis
+    - fix option value api
+    - update docs
+
 ### 1.1.5 (2014-12-25)
 
 Features:

data/README.md

@@ -1,5 +1,6 @@
 bigcommerce-oauth-api
 ==========================
+[![bigcommerce-oauth-api API Documentation](https://www.omniref.com/ruby/gems/bigcommerce-oauth-api.png)](https://www.omniref.com/ruby/gems/bigcommerce-oauth-api)
 [![Gem Version](https://badge.fury.io/rb/bigcommerce-oauth-api.svg)](http://badge.fury.io/rb/bigcommerce-oauth-api)
 [![Code Climate](https://codeclimate.com/github/corthmann/bigcommerce-oauth-api/badges/gpa.svg)](https://codeclimate.com/github/corthmann/bigcommerce-oauth-api)
 [![Test Coverage](https://codeclimate.com/github/corthmann/bigcommerce-oauth-api/badges/coverage.svg)](https://codeclimate.com/github/corthmann/bigcommerce-oauth-api)
@@ -20,26 +21,41 @@ gem 'bigcommerce-oauth-api'
 
 Configuration
 -------------
-The gem can be configured in two ways. Either by initializing the API with certain options.
+The gem can be configured either by module or class configuration. Starting from v1.2.0 `bigcommerce-oauth-api` supports both OAuth and legacy authentication.
 ```
+# module oauth configuration
 BigcommerceOAuthAPI.configuration do |config|
     config.store_hash = 'YOU STORE ID'
     config.client_id = 'YOUR CLIENT ID'
     config.access_token = 'YOUR OAUTH ACCESS TOKEN'
 end
-```
 
-Or by passing options to a new client instance.
-```
+# module legacy (basic auth) configuration
+BigcommerceOAuthAPI.configuration do |config|
+    config.endpoint = 'YOU STORE URL (https://store-XYZ.mybigcommerce.com)'
+    config.user_name = 'API USER NAME'
+    config.api_key = 'API KEY'
+end
+
+# class oauth configuration
 api = BigcommerceOAuthAPI::Client.new(
                                 :store_hash => 'YOUR STORE ID',
                                 :client_id => 'YOUR CLIENT ID',
                                 :access_token => 'YOUR OAUTH ACCESS TOKEN'
                                 )
+
+# class legacy (basic auth) configuration
+api = BigcommerceOAuthAPI::Client.new(
+                                :endpoint => 'YOU STORE URL (ex. https://store-XYZ.mybigcommerce.com)',
+                                :user_name => 'API USER NAME',
+                                :api_key => 'API KEY'
+                                )
 ```
 
 Using the API
 -------------
+It is recommended to use the Omniref documentation as a method reference in combination the official api documentation.
+
 Get a list of products:
 ```
 products = api.products
@@ -69,6 +85,7 @@ order_id = 101
 shipment_id = 1000
 api.delete_order_shipment(order_id, shipment_id)
 ```
+
 Webhooks
 -------------
 In many applications it is an advantage to receive a callback on events rather than polling information. Such callbacks are commonly called webhooks.
@@ -100,45 +117,48 @@ API Support
 -------------
 The following APIs are currently supported:
 
-API | Included from
---- | ---
-blog post | 1.0.2
-blog tag | 1.0.2
-brand api | 1.1.0
-bulk pricing (discount rules) | 1.1.0
-category | 1.1.0
-customer api | 1.0.2
-customer address | 1.0.2
-customer group | 1.0.2
-geography country | 1.0.2
-geography state | 1.0.2
-marketing coupon | 1.0.2
-option | 1.1.0
-option set | 1.1.0
-option set option | 1.1.0
-option set value | 1.1.0
-order | 1.0.2
-order message | 1.0.2
-order product | 1.0.2
-order shipment | 1.0.2
-order shipping address | 1.0.2
-payment method | 1.0.2
-product | 1.0.2
-product configurable field | 1.1.0
-product custom field | 1.0.2
-product googleproductsearch | 1.1.0
-product image | 1.1.0
-product option | 1.1.0
-product review | 1.1.0
-product rules | 1.1.0
-product video | 1.1.0
-product SKU | 1.1.0
-redirect | 1.0.2
-shipping method api | 1.0.2
-store information | 1.0.2
-system (time) | 1.0.2
-tax class | 1.0.2
-web hook | 1.0.2
+API | Gem Version | Official Documentation
+--- | --- | ---
+blog post | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/blog/posts
+blog tag | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/blog/tags
+brand api | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/brands
+bulk pricing (discount rules) | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/products/discount_rules
+category | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/categories
+customer api | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/customers
+customer address | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/customers/addresses
+customer group | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/customer_groups
+geography country | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/countries
+geography state | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/countries/states
+marketing coupon | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/coupons
+option | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/options
+option set | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/option_sets
+option set option | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/option_sets/options
+option value | 1.2.0 | https://developer.bigcommerce.com/api/stores/v2/options/values
+order | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/orders
+order coupon | 1.2.0 | https://developer.bigcommerce.com/api/stores/v2/orders/coupons
+order message | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/orders/messages
+order product | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/orders/products
+order shipment | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/orders/shipments
+order shipping address | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/orders/shipping_addresses
+order statuses | 1.2.0 | https://developer.bigcommerce.com/api/stores/v2/order_statuses
+order tax | 1.2.0 | https://developer.bigcommerce.com/api/stores/v2/orders/taxes
+payment method | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/payments/methods
+product | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/products
+product configurable field | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/products/configurable_fields
+product custom field | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/products/custom_fields
+product googleproductsearch | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/products/googleproductsearch
+product image | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/products/images
+product option | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/products/options
+product review | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/products/reviews
+product rules | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/products/rules
+product video | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/products/videos
+product SKU | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/products/skus
+redirect | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/redirects
+shipping method api | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/shipping/methods
+store information | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/store_information
+system (time) | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/time
+tax class | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/tax_classes
+web hook | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/webhooks
 
 Getting an OAuth Access Token
 -------------

data/bigcommerce-oauth-api.gemspec

@@ -3,9 +3,9 @@ require File.expand_path('../lib/bigcommerce-oauth-api/version', __FILE__)
 Gem::Specification.new do |s|
   s.name        = 'bigcommerce-oauth-api'
   s.version     = BigcommerceOAuthAPI::VERSION.dup
-  s.date        = '2014-12-25'
-  s.summary     = "Ruby wrapper for the Bigcommerce REST API using OAuth"
-  s.description = "Connect Ruby applications with the Bigcommerce REST API using OAuth"
+  s.date        = '2015-04-19'
+  s.summary     = "Ruby client library for Bigcommerce APIs with OAuth and basic authentication support"
+  s.description = "Connect Ruby applications to Bigcommerce APIs through OAuth or basic authentication"
   s.authors     = ["Christian Orthmann"]
   s.email       = 'christian.orthmann@gmail.com'
   s.require_path = 'lib'
@@ -19,7 +19,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency('webmock', '~> 1')
   s.add_development_dependency('simplecov', '~> 0')
   s.add_development_dependency('simplecov-rcov', '~> 0')
-  s.add_development_dependency('yard', '~> 0')
   s.add_runtime_dependency('faraday', '~> 0')
   s.add_runtime_dependency('faraday_middleware', '~> 0')
   s.add_runtime_dependency('activesupport', '>= 3.0.0', '< 5.0.0')

data/lib/bigcommerce-oauth-api/api.rb

@@ -22,6 +22,10 @@ module BigcommerceOAuthAPI
       conf
     end
 
+    def is_legacy?
+      !user_name.nil? && !api_key.nil? && endpoint != Configuration::DEFAULT_ENDPOINT
+    end
+
     include Connection
     include Request
   end

data/lib/bigcommerce-oauth-api/base.rb

@@ -10,15 +10,16 @@ module BigcommerceOAuthAPI
       map.each do |api, method_description|
         api_module = method_description[:api_module]
         api_scope = method_description[:scope]
+        is_legacy = (method_description[:legacy].nil? ? true : method_description[:legacy])
         path_prefix = (method_description.has_key?(:prefix_paths) ? "#{method_description[:prefix_paths]}/" : nil)
         method_prefix = (method_description.has_key?(:prefix_methods) ? "#{method_description[:prefix_methods]}_" : nil)
         method_description[:methods].each do |method|
-          with_action(method, api_module, api_scope, path_prefix, method_prefix)
+          with_action(method, api_module, api_scope, path_prefix, method_prefix, is_legacy)
         end
       end
     end
 
-    def self.with_action(method, api_module, api_scope, path_prefix = nil, method_prefix = nil)
+    def self.with_action(method, api_module, api_scope, path_prefix = nil, method_prefix = nil, is_legacy = true)
       is_nested = api_scope != :self
       method_name, method_params, has_options = get_method_name_and_params(method, api_module, api_scope, is_nested, method_prefix)
       method_path = get_method_path(method, api_module, api_scope, is_nested)
@@ -32,6 +33,7 @@ module BigcommerceOAuthAPI
 
       class_eval %Q{
         def #{method_name}#{method_params}
+          #{(is_legacy ? '' : 'raise NonLegacyApi.new if is_legacy?')}
           #{request_method}("#{path_prefix}#{method_path}"#{( has_options ? ', options' : '')})
         end
       }

data/lib/bigcommerce-oauth-api/client.rb

@@ -23,443 +23,1126 @@ module BigcommerceOAuthAPI
 
     with_api_methods :blog_post => { api_module: :post, scope: :self, methods: [:all, :select, :create, :update, :delete], prefix_paths: 'blog', prefix_methods: 'blog'},
                      :blog_tag => { api_module: :tag, scope: :self, methods: [:all], prefix_paths: 'blog', prefix_methods: 'blog'},
-                     :brand => { api_module: :brand, scope: :self, methods: [:all, :select, :create, :update, :delete]},
+                     :brand => { api_module: :brand, scope: :self, methods: [:all, :select, :create, :update, :delete, :count]},
                      :category => { api_module: :category, scope: :self, methods: [:all, :select, :create, :update, :delete]},
                      :customer => { api_module: :customer, scope: :self, methods: [:all, :select, :create, :update, :delete, :count]},
                      :customer_address => { api_module: :address, scope: :customer, methods: [:all, :select, :create, :update, :delete]},
                      :customer_group => { api_module: :customer_group, scope: :self, methods: [:all, :select, :create, :update, :delete]},
-                     :geography_country => { api_module: :country, scope: :self, methods: [:all, :select]},
-                     :geography_state => { api_module: :state, scope: :self, methods: [:all, :select]},
-                     :marketing_coupons => { api_module: :coupon, scope: :self, methods: [:all, :select, :create, :update, :delete]},
-                     :option => { api_module: :option, scope: :self, methods: [:all, :select, :create, :update, :delete]},
-                     :option_set => { api_module: :option_set, scope: :self, methods: [:all, :select, :create, :update, :delete]},
+                     :geography_country => { api_module: :country, scope: :self, methods: [:all, :select, :count]},
+                     :geography_state => { api_module: :state, scope: :country, methods: [:all, :select, :count]},
+                     :marketing_coupons => { api_module: :coupon, scope: :self, methods: [:all, :select, :create, :update, :delete, :count]},
+                     :option => { api_module: :option, scope: :self, methods: [:all, :select, :create, :update, :delete, :count]},
+                     :option_set => { api_module: :option_set, scope: :self, methods: [:all, :select, :create, :update, :delete, :count]},
                      :option_set_option => { api_module: :option, scope: :option_set, methods: [:all, :select, :create, :update, :delete]},
-                     :option_set_value => { api_module: :value, scope: :option_set, methods: [:all, :select, :create, :update, :delete]},
+                     :option_value => { api_module: :value, scope: :option, methods: [:all, :select, :create, :update, :delete]},
+                     :order_status => { api_module: :order_status, scope: :self, methods: [:all, :select]},
                      :order => { api_module: :order, scope: :self, methods: [:all, :select, :create, :update, :delete, :count]},
+                     :order_coupon => { api_module: :coupon, scope: :order, methods: [:all, :select]},
                      :order_message => { api_module: :message, scope: :order, methods: [:all, :select]},
-                     :order_product => { api_module: :product, scope: :order, methods: [:all, :select]},
+                     :order_product => { api_module: :product, scope: :order, methods: [:all, :select, :count]},
                      :order_shipment => { api_module: :shipment, scope: :order, methods: [:all, :select, :create, :update, :delete]},
                      :order_shipping_address => { api_module: :shipping_address, scope: :order, methods: [:all, :select]},
+                     :order_taxes => { api_module: :tax, scope: :order, methods: [:all, :select]},
                      :payment_method => { api_module: :method, scope: :self, methods: [:all], prefix_paths: 'payments', prefix_methods: 'payment'},
                      :product => { api_module: :product, scope: :self, methods: [:all, :select, :create, :update, :delete, :count]},
                      :product_custom_field => { api_module: :custom_field, scope: :product, methods: [:all, :select, :create, :update, :delete]},
-                     :product_discount_rule => { api_module: :discount_rule, scope: :product, methods: [:all, :select, :create, :update, :delete]},
-                     :product_configurable_field => { api_module: :configurable_field, scope: :product, methods: [:all, :select, :delete]},
-                     :product_image => { api_module: :image, scope: :product, methods: [:all, :select, :create, :update, :delete]},
+                     :product_discount_rule => { api_module: :discount_rule, scope: :product, methods: [:all, :select, :create, :update, :delete, :count]},
+                     :product_configurable_field => { api_module: :configurable_field, scope: :product, methods: [:all, :select, :delete, :count]},
+                     :product_image => { api_module: :image, scope: :product, methods: [:all, :select, :create, :update, :delete, :count]},
                      :product_option => { api_module: :option, scope: :product, methods: [:all, :select]},
                      :product_review => { api_module: :review, scope: :product, methods: [:all]},
-                     :product_rule => { api_module: :rule, scope: :product, methods: [:all, :select, :create, :update, :delete]},
-                     :product_video => { api_module: :video, scope: :product, methods: [:all, :select, :create, :update, :delete]},
-                     :product_sku => { api_module: :sku, scope: :product, methods: [:all, :select, :create, :update, :delete]},
-                     :redirect => { api_module: :redirect, scope: :self, methods: [:all, :select, :create, :update, :delete]},
+                     :product_rule => { api_module: :rule, scope: :product, methods: [:all, :select, :create, :update, :delete, :count]},
+                     :product_video => { api_module: :video, scope: :product, methods: [:all, :select, :create, :update, :delete, :count]},
+                     :product_sku => { api_module: :sku, scope: :product, methods: [:all, :select, :create, :update, :delete, :count]},
+                     :redirect => { api_module: :redirect, scope: :self, methods: [:all, :select, :create, :update, :delete, :count]},
                      :shipping_method => { api_module: :method, scope: :self, methods: [:all, :select], prefix_paths: 'shipping', prefix_methods: 'shipping'},
                      :tax_class => { api_module: :tax_class, scope: :self, methods: [:all, :select]},
-                     :web_hook => { api_module: :hook, scope: :self, methods: [:all, :select, :create, :update, :delete]}
+                     :web_hook => { api_module: :hook, scope: :self, methods: [:all, :select, :create, :update, :delete], legacy: false }
 
-    # @!method blog_posts(options = {})
+    ##
+    # :method: blog_posts
     # gets a list of posts
+    #
+    # :call-seq:
+    #   blog_posts(options = {})
 
-    # @!method blog_post(id, options = {})
+    ##
+    # :method: blog_post
     # gets the post with the given id
+    #
+    # :call-seq:
+    #   blog_post(id, options = {})
 
-    # @!method create_blog_post(options = {})
+    ##
+    # :method: create_blog_post
     # creates a post with the given attributes
+    #
+    # :call-seq:
+    #   create_blog_post(options = {})
 
-    # @!method update_blog_post(id, options = {})
-    # updates a post with the given attributes
+    ##
+    # :method: update_blog_post
+    # update the attributes of the post with the given id
+    #
+    # :call-seq:
+    #   update_blog_post(id, options = {})
 
-    # @!method delete_blog_post(id)
+    ##
+    # :method: delete_blog_post
     # deletes the post with the given id
+    #
+    # :call-seq:
+    #   delete_blog_post(id)
 
-    # @!method blog_tags(options = {})
+    ##
+    # :method: blog_tags
     # gets a list of tags
+    #
+    # :call-seq:
+    #   blog_tags(options = {})
 
-    # @!method brands(options = {})
+    ##
+    # :method: brands
     # gets a list of brands
+    #
+    # :call-seq:
+    #   brands(options = {})
 
-    # @!method brand(id, options = {})
+    ##
+    # :method: brand
     # gets the brand with the given id
+    #
+    # :call-seq:
+    #   brand(id, options = {})
 
-    # @!method create_brand(options = {})
+    ##
+    # :method: create_brand
     # creates a brand with the given attributes
+    #
+    # :call-seq:
+    #   create_brand(options = {})
 
-    # @!method update_brand(id, options = {})
-    # updates a brand with the given attributes
+    ##
+    # :method: update_brand
+    # update the attributes of the brand with the given id
+    #
+    # :call-seq:
+    #   update_brand(id, options = {})
 
-    # @!method delete_brand(id)
+    ##
+    # :method: delete_brand
     # deletes the brand with the given id
+    #
+    # :call-seq:
+    #   delete_brand(id)
 
-    # @!method categories(options = {})
+    ##
+    # :method: brands_count
+    # returns the number of brands
+    #
+    # :call-seq:
+    #   brands_count(options = {})
+
+    ##
+    # :method: categories
     # gets a list of categories
+    #
+    # :call-seq:
+    #   categories(options = {})
 
-    # @!method category(id, options = {})
+    ##
+    # :method: category
     # gets the category with the given id
+    #
+    # :call-seq:
+    #   category(id, options = {})
 
-    # @!method create_category(options = {})
+    ##
+    # :method: create_category
     # creates a category with the given attributes
+    #
+    # :call-seq:
+    #   create_category(options = {})
 
-    # @!method update_category(id, options = {})
-    # updates a category with the given attributes
+    ##
+    # :method: update_category
+    # update the attributes of the category with the given id
+    #
+    # :call-seq:
+    #   update_category(id, options = {})
 
-    # @!method delete_category(id)
+    ##
+    # :method: delete_category
     # deletes the category with the given id
+    #
+    # :call-seq:
+    #   delete_category(id)
 
-    # @!method customers(options = {})
+    ##
+    # :method: customers
     # gets a list of customers
+    #
+    # :call-seq:
+    #   customers(options = {})
 
-    # @!method customer(id, options = {})
+    ##
+    # :method: customer
     # gets the customer with the given id
+    #
+    # :call-seq:
+    #   customer(id, options = {})
 
-    # @!method create_customer(options = {})
+    ##
+    # :method: create_customer
     # creates a customer with the given attributes
+    #
+    # :call-seq:
+    #   create_customer(options = {})
 
-    # @!method update_customer(id, options = {})
-    # updates a customer with the given attributes
+    ##
+    # :method: update_customer
+    # update the attributes of the customer with the given id
+    #
+    # :call-seq:
+    #   update_customer(id, options = {})
 
-    # @!method delete_customer(id)
+    ##
+    # :method: delete_customer
     # deletes the customer with the given id
+    #
+    # :call-seq:
+    #   delete_customer(id)
 
-    # @!method customers_count(options = {})
-    # counts the number of customers
+    ##
+    # :method: customers_count
+    # returns the number of customers
+    #
+    # :call-seq:
+    #   customers_count(options = {})
 
-    # @!method customer_addresses(customer_id, options = {})
+    ##
+    # :method: customer_addresses
     # gets a list of addresses for the given customer
+    #
+    # :call-seq:
+    #   customer_addresses(customer_id, options = {})
 
-    # @!method customer_address(customer_id, id, options = {})
+    ##
+    # :method: customer_address
     # gets the address with the given id for the given customer
+    #
+    # :call-seq:
+    #   customer_address(customer_id, id, options = {})
 
-    # @!method create_customer_address(customer_id, options = {})
+    ##
+    # :method: create_customer_address
     # creates a address with the given attributes for the given customer
+    #
+    # :call-seq:
+    #   create_customer_address(customer_id, options = {})
 
-    # @!method update_customer_address(customer_id, id, options = {})
-    # updates a address with the given attributes for the given customer
+    ##
+    # :method: update_customer_address
+    # update the attributes of the address with the given id for the given customer
+    #
+    # :call-seq:
+    #   update_customer_address(customer_id, id, options = {})
 
-    # @!method delete_customer_address(customer_id, id)
+    ##
+    # :method: delete_customer_address
     # deletes the address with the given id for the given customer
+    #
+    # :call-seq:
+    #   delete_customer_address(customer_id, id)
 
-    # @!method customer_groups(options = {})
+    ##
+    # :method: customer_groups
     # gets a list of customer_groups
+    #
+    # :call-seq:
+    #   customer_groups(options = {})
 
-    # @!method customer_group(id, options = {})
+    ##
+    # :method: customer_group
     # gets the customer_group with the given id
+    #
+    # :call-seq:
+    #   customer_group(id, options = {})
 
-    # @!method create_customer_group(options = {})
+    ##
+    # :method: create_customer_group
     # creates a customer_group with the given attributes
+    #
+    # :call-seq:
+    #   create_customer_group(options = {})
 
-    # @!method update_customer_group(id, options = {})
-    # updates a customer_group with the given attributes
+    ##
+    # :method: update_customer_group
+    # update the attributes of the customer_group with the given id
+    #
+    # :call-seq:
+    #   update_customer_group(id, options = {})
 
-    # @!method delete_customer_group(id)
+    ##
+    # :method: delete_customer_group
     # deletes the customer_group with the given id
+    #
+    # :call-seq:
+    #   delete_customer_group(id)
 
-    # @!method countries(options = {})
+    ##
+    # :method: countries
     # gets a list of countries
+    #
+    # :call-seq:
+    #   countries(options = {})
 
-    # @!method country(id, options = {})
+    ##
+    # :method: country
     # gets the country with the given id
+    #
+    # :call-seq:
+    #   country(id, options = {})
 
-    # @!method states(options = {})
-    # gets a list of states
+    ##
+    # :method: countries_count
+    # returns the number of countries
+    #
+    # :call-seq:
+    #   countries_count(options = {})
 
-    # @!method state(id, options = {})
-    # gets the state with the given id
+    ##
+    # :method: country_states
+    # gets a list of states for the given country
+    #
+    # :call-seq:
+    #   country_states(country_id, options = {})
 
-    # @!method coupons(options = {})
+    ##
+    # :method: country_state
+    # gets the state with the given id for the given country
+    #
+    # :call-seq:
+    #   country_state(country_id, id, options = {})
+
+    ##
+    # :method: country_states_count
+    # returns the number of states for the given country
+    #
+    # :call-seq:
+    #   country_states_count(country_id, options = {})
+
+    ##
+    # :method: coupons
     # gets a list of coupons
+    #
+    # :call-seq:
+    #   coupons(options = {})
 
-    # @!method coupon(id, options = {})
+    ##
+    # :method: coupon
     # gets the coupon with the given id
+    #
+    # :call-seq:
+    #   coupon(id, options = {})
 
-    # @!method create_coupon(options = {})
+    ##
+    # :method: create_coupon
     # creates a coupon with the given attributes
+    #
+    # :call-seq:
+    #   create_coupon(options = {})
 
-    # @!method update_coupon(id, options = {})
-    # updates a coupon with the given attributes
+    ##
+    # :method: update_coupon
+    # update the attributes of the coupon with the given id
+    #
+    # :call-seq:
+    #   update_coupon(id, options = {})
 
-    # @!method delete_coupon(id)
+    ##
+    # :method: delete_coupon
     # deletes the coupon with the given id
+    #
+    # :call-seq:
+    #   delete_coupon(id)
 
-    # @!method options(options = {})
+    ##
+    # :method: coupons_count
+    # returns the number of coupons
+    #
+    # :call-seq:
+    #   coupons_count(options = {})
+
+    ##
+    # :method: options
     # gets a list of options
+    #
+    # :call-seq:
+    #   options(options = {})
 
-    # @!method option(id, options = {})
+    ##
+    # :method: option
     # gets the option with the given id
+    #
+    # :call-seq:
+    #   option(id, options = {})
 
-    # @!method create_option(options = {})
+    ##
+    # :method: create_option
     # creates a option with the given attributes
+    #
+    # :call-seq:
+    #   create_option(options = {})
 
-    # @!method update_option(id, options = {})
-    # updates a option with the given attributes
+    ##
+    # :method: update_option
+    # update the attributes of the option with the given id
+    #
+    # :call-seq:
+    #   update_option(id, options = {})
 
-    # @!method delete_option(id)
+    ##
+    # :method: delete_option
     # deletes the option with the given id
+    #
+    # :call-seq:
+    #   delete_option(id)
+
+    ##
+    # :method: options_count
+    # returns the number of options
+    #
+    # :call-seq:
+    #   options_count(options = {})
 
-    # @!method option_sets(options = {})
+    ##
+    # :method: option_sets
     # gets a list of option_sets
+    #
+    # :call-seq:
+    #   option_sets(options = {})
 
-    # @!method option_set(id, options = {})
+    ##
+    # :method: option_set
     # gets the option_set with the given id
+    #
+    # :call-seq:
+    #   option_set(id, options = {})
 
-    # @!method create_option_set(options = {})
+    ##
+    # :method: create_option_set
     # creates a option_set with the given attributes
+    #
+    # :call-seq:
+    #   create_option_set(options = {})
 
-    # @!method update_option_set(id, options = {})
-    # updates a option_set with the given attributes
+    ##
+    # :method: update_option_set
+    # update the attributes of the option_set with the given id
+    #
+    # :call-seq:
+    #   update_option_set(id, options = {})
 
-    # @!method delete_option_set(id)
+    ##
+    # :method: delete_option_set
     # deletes the option_set with the given id
+    #
+    # :call-seq:
+    #   delete_option_set(id)
 
-    # @!method option_set_options(option_set_id, options = {})
+    ##
+    # :method: option_sets_count
+    # returns the number of option_sets
+    #
+    # :call-seq:
+    #   option_sets_count(options = {})
+
+    ##
+    # :method: option_set_options
     # gets a list of options for the given option_set
+    #
+    # :call-seq:
+    #   option_set_options(option_set_id, options = {})
 
-    # @!method option_set_option(option_set_id, id, options = {})
+    ##
+    # :method: option_set_option
     # gets the option with the given id for the given option_set
+    #
+    # :call-seq:
+    #   option_set_option(option_set_id, id, options = {})
 
-    # @!method create_option_set_option(option_set_id, options = {})
+    ##
+    # :method: create_option_set_option
     # creates a option with the given attributes for the given option_set
+    #
+    # :call-seq:
+    #   create_option_set_option(option_set_id, options = {})
 
-    # @!method update_option_set_option(option_set_id, id, options = {})
-    # updates a option with the given attributes for the given option_set
+    ##
+    # :method: update_option_set_option
+    # update the attributes of the option with the given id for the given option_set
+    #
+    # :call-seq:
+    #   update_option_set_option(option_set_id, id, options = {})
 
-    # @!method delete_option_set_option(option_set_id, id)
+    ##
+    # :method: delete_option_set_option
     # deletes the option with the given id for the given option_set
+    #
+    # :call-seq:
+    #   delete_option_set_option(option_set_id, id)
 
-    # @!method option_set_values(option_set_id, options = {})
-    # gets a list of values for the given option_set
+    ##
+    # :method: option_values
+    # gets a list of values for the given option
+    #
+    # :call-seq:
+    #   option_values(option_id, options = {})
 
-    # @!method option_set_value(option_set_id, id, options = {})
-    # gets the value with the given id for the given option_set
+    ##
+    # :method: option_value
+    # gets the value with the given id for the given option
+    #
+    # :call-seq:
+    #   option_value(option_id, id, options = {})
 
-    # @!method create_option_set_value(option_set_id, options = {})
-    # creates a value with the given attributes for the given option_set
+    ##
+    # :method: create_option_value
+    # creates a value with the given attributes for the given option
+    #
+    # :call-seq:
+    #   create_option_value(option_id, options = {})
 
-    # @!method update_option_set_value(option_set_id, id, options = {})
-    # updates a value with the given attributes for the given option_set
+    ##
+    # :method: update_option_value
+    # update the attributes of the value with the given id for the given option
+    #
+    # :call-seq:
+    #   update_option_value(option_id, id, options = {})
 
-    # @!method delete_option_set_value(option_set_id, id)
-    # deletes the value with the given id for the given option_set
+    ##
+    # :method: delete_option_value
+    # deletes the value with the given id for the given option
+    #
+    # :call-seq:
+    #   delete_option_value(option_id, id)
+
+    ##
+    # :method: order_statuses
+    # gets a list of order_statuses
+    #
+    # :call-seq:
+    #   order_statuses(options = {})
+
+    ##
+    # :method: order_status
+    # gets the order_status with the given id
+    #
+    # :call-seq:
+    #   order_status(id, options = {})
 
-    # @!method orders(options = {})
+    ##
+    # :method: orders
     # gets a list of orders
+    #
+    # :call-seq:
+    #   orders(options = {})
 
-    # @!method order(id, options = {})
+    ##
+    # :method: order
     # gets the order with the given id
+    #
+    # :call-seq:
+    #   order(id, options = {})
 
-    # @!method create_order(options = {})
+    ##
+    # :method: create_order
     # creates a order with the given attributes
+    #
+    # :call-seq:
+    #   create_order(options = {})
 
-    # @!method update_order(id, options = {})
-    # updates a order with the given attributes
+    ##
+    # :method: update_order
+    # update the attributes of the order with the given id
+    #
+    # :call-seq:
+    #   update_order(id, options = {})
 
-    # @!method delete_order(id)
+    ##
+    # :method: delete_order
     # deletes the order with the given id
+    #
+    # :call-seq:
+    #   delete_order(id)
 
-    # @!method orders_count(options = {})
-    # counts the number of orders
+    ##
+    # :method: orders_count
+    # returns the number of orders
+    #
+    # :call-seq:
+    #   orders_count(options = {})
 
-    # @!method order_messages(order_id, options = {})
+    ##
+    # :method: order_coupons
+    # gets a list of coupons for the given order
+    #
+    # :call-seq:
+    #   order_coupons(order_id, options = {})
+
+    ##
+    # :method: order_coupon
+    # gets the coupon with the given id for the given order
+    #
+    # :call-seq:
+    #   order_coupon(order_id, id, options = {})
+
+    ##
+    # :method: order_messages
     # gets a list of messages for the given order
+    #
+    # :call-seq:
+    #   order_messages(order_id, options = {})
 
-    # @!method order_message(order_id, id, options = {})
+    ##
+    # :method: order_message
     # gets the message with the given id for the given order
+    #
+    # :call-seq:
+    #   order_message(order_id, id, options = {})
 
-    # @!method order_products(order_id, options = {})
+    ##
+    # :method: order_products
     # gets a list of products for the given order
+    #
+    # :call-seq:
+    #   order_products(order_id, options = {})
 
-    # @!method order_product(order_id, id, options = {})
+    ##
+    # :method: order_product
     # gets the product with the given id for the given order
+    #
+    # :call-seq:
+    #   order_product(order_id, id, options = {})
 
-    # @!method order_shipments(order_id, options = {})
+    ##
+    # :method: order_products_count
+    # returns the number of products for the given order
+    #
+    # :call-seq:
+    #   order_products_count(order_id, options = {})
+
+    ##
+    # :method: order_shipments
     # gets a list of shipments for the given order
+    #
+    # :call-seq:
+    #   order_shipments(order_id, options = {})
 
-    # @!method order_shipment(order_id, id, options = {})
+    ##
+    # :method: order_shipment
     # gets the shipment with the given id for the given order
+    #
+    # :call-seq:
+    #   order_shipment(order_id, id, options = {})
 
-    # @!method create_order_shipment(order_id, options = {})
+    ##
+    # :method: create_order_shipment
     # creates a shipment with the given attributes for the given order
+    #
+    # :call-seq:
+    #   create_order_shipment(order_id, options = {})
 
-    # @!method update_order_shipment(order_id, id, options = {})
-    # updates a shipment with the given attributes for the given order
+    ##
+    # :method: update_order_shipment
+    # update the attributes of the shipment with the given id for the given order
+    #
+    # :call-seq:
+    #   update_order_shipment(order_id, id, options = {})
 
-    # @!method delete_order_shipment(order_id, id)
+    ##
+    # :method: delete_order_shipment
     # deletes the shipment with the given id for the given order
+    #
+    # :call-seq:
+    #   delete_order_shipment(order_id, id)
 
-    # @!method order_shipping_addresses(order_id, options = {})
+    ##
+    # :method: order_shipping_addresses
     # gets a list of shipping_addresses for the given order
+    #
+    # :call-seq:
+    #   order_shipping_addresses(order_id, options = {})
 
-    # @!method order_shipping_address(order_id, id, options = {})
+    ##
+    # :method: order_shipping_address
     # gets the shipping_address with the given id for the given order
+    #
+    # :call-seq:
+    #   order_shipping_address(order_id, id, options = {})
+
+    ##
+    # :method: order_taxes
+    # gets a list of taxes for the given order
+    #
+    # :call-seq:
+    #   order_taxes(order_id, options = {})
 
-    # @!method payment_methods(options = {})
+    ##
+    # :method: order_tax
+    # gets the tax with the given id for the given order
+    #
+    # :call-seq:
+    #   order_tax(order_id, id, options = {})
+
+    ##
+    # :method: payment_methods
     # gets a list of methods
+    #
+    # :call-seq:
+    #   payment_methods(options = {})
 
-    # @!method products(options = {})
+    ##
+    # :method: products
     # gets a list of products
+    #
+    # :call-seq:
+    #   products(options = {})
 
-    # @!method product(id, options = {})
+    ##
+    # :method: product
     # gets the product with the given id
+    #
+    # :call-seq:
+    #   product(id, options = {})
 
-    # @!method create_product(options = {})
+    ##
+    # :method: create_product
     # creates a product with the given attributes
+    #
+    # :call-seq:
+    #   create_product(options = {})
 
-    # @!method update_product(id, options = {})
-    # updates a product with the given attributes
+    ##
+    # :method: update_product
+    # update the attributes of the product with the given id
+    #
+    # :call-seq:
+    #   update_product(id, options = {})
 
-    # @!method delete_product(id)
+    ##
+    # :method: delete_product
     # deletes the product with the given id
+    #
+    # :call-seq:
+    #   delete_product(id)
 
-    # @!method products_count(options = {})
-    # counts the number of products
+    ##
+    # :method: products_count
+    # returns the number of products
+    #
+    # :call-seq:
+    #   products_count(options = {})
 
-    # @!method product_custom_fields(product_id, options = {})
+    ##
+    # :method: product_custom_fields
     # gets a list of custom_fields for the given product
+    #
+    # :call-seq:
+    #   product_custom_fields(product_id, options = {})
 
-    # @!method product_custom_field(product_id, id, options = {})
+    ##
+    # :method: product_custom_field
     # gets the custom_field with the given id for the given product
+    #
+    # :call-seq:
+    #   product_custom_field(product_id, id, options = {})
 
-    # @!method create_product_custom_field(product_id, options = {})
+    ##
+    # :method: create_product_custom_field
     # creates a custom_field with the given attributes for the given product
+    #
+    # :call-seq:
+    #   create_product_custom_field(product_id, options = {})
 
-    # @!method update_product_custom_field(product_id, id, options = {})
-    # updates a custom_field with the given attributes for the given product
+    ##
+    # :method: update_product_custom_field
+    # update the attributes of the custom_field with the given id for the given product
+    #
+    # :call-seq:
+    #   update_product_custom_field(product_id, id, options = {})
 
-    # @!method delete_product_custom_field(product_id, id)
+    ##
+    # :method: delete_product_custom_field
     # deletes the custom_field with the given id for the given product
+    #
+    # :call-seq:
+    #   delete_product_custom_field(product_id, id)
 
-    # @!method product_discount_rules(product_id, options = {})
+    ##
+    # :method: product_discount_rules
     # gets a list of discount_rules for the given product
+    #
+    # :call-seq:
+    #   product_discount_rules(product_id, options = {})
 
-    # @!method product_discount_rule(product_id, id, options = {})
+    ##
+    # :method: product_discount_rule
     # gets the discount_rule with the given id for the given product
+    #
+    # :call-seq:
+    #   product_discount_rule(product_id, id, options = {})
 
-    # @!method create_product_discount_rule(product_id, options = {})
+    ##
+    # :method: create_product_discount_rule
     # creates a discount_rule with the given attributes for the given product
+    #
+    # :call-seq:
+    #   create_product_discount_rule(product_id, options = {})
 
-    # @!method update_product_discount_rule(product_id, id, options = {})
-    # updates a discount_rule with the given attributes for the given product
+    ##
+    # :method: update_product_discount_rule
+    # update the attributes of the discount_rule with the given id for the given product
+    #
+    # :call-seq:
+    #   update_product_discount_rule(product_id, id, options = {})
 
-    # @!method delete_product_discount_rule(product_id, id)
+    ##
+    # :method: delete_product_discount_rule
     # deletes the discount_rule with the given id for the given product
+    #
+    # :call-seq:
+    #   delete_product_discount_rule(product_id, id)
 
-    # @!method product_configurable_fields(product_id, options = {})
+    ##
+    # :method: product_discount_rules_count
+    # returns the number of discount_rules for the given product
+    #
+    # :call-seq:
+    #   product_discount_rules_count(product_id, options = {})
+
+    ##
+    # :method: product_configurable_fields
     # gets a list of configurable_fields for the given product
+    #
+    # :call-seq:
+    #   product_configurable_fields(product_id, options = {})
 
-    # @!method product_configurable_field(product_id, id, options = {})
+    ##
+    # :method: product_configurable_field
     # gets the configurable_field with the given id for the given product
+    #
+    # :call-seq:
+    #   product_configurable_field(product_id, id, options = {})
 
-    # @!method delete_product_configurable_field(product_id, id)
+    ##
+    # :method: delete_product_configurable_field
     # deletes the configurable_field with the given id for the given product
+    #
+    # :call-seq:
+    #   delete_product_configurable_field(product_id, id)
 
-    # @!method product_images(product_id, options = {})
+    ##
+    # :method: product_configurable_fields_count
+    # returns the number of configurable_fields for the given product
+    #
+    # :call-seq:
+    #   product_configurable_fields_count(product_id, options = {})
+
+    ##
+    # :method: product_images
     # gets a list of images for the given product
+    #
+    # :call-seq:
+    #   product_images(product_id, options = {})
 
-    # @!method product_image(product_id, id, options = {})
+    ##
+    # :method: product_image
     # gets the image with the given id for the given product
+    #
+    # :call-seq:
+    #   product_image(product_id, id, options = {})
 
-    # @!method create_product_image(product_id, options = {})
+    ##
+    # :method: create_product_image
     # creates a image with the given attributes for the given product
+    #
+    # :call-seq:
+    #   create_product_image(product_id, options = {})
 
-    # @!method update_product_image(product_id, id, options = {})
-    # updates a image with the given attributes for the given product
+    ##
+    # :method: update_product_image
+    # update the attributes of the image with the given id for the given product
+    #
+    # :call-seq:
+    #   update_product_image(product_id, id, options = {})
 
-    # @!method delete_product_image(product_id, id)
+    ##
+    # :method: delete_product_image
     # deletes the image with the given id for the given product
+    #
+    # :call-seq:
+    #   delete_product_image(product_id, id)
+
+    ##
+    # :method: product_images_count
+    # returns the number of images for the given product
+    #
+    # :call-seq:
+    #   product_images_count(product_id, options = {})
 
-    # @!method product_options(product_id, options = {})
+    ##
+    # :method: product_options
     # gets a list of options for the given product
+    #
+    # :call-seq:
+    #   product_options(product_id, options = {})
 
-    # @!method product_option(product_id, id, options = {})
+    ##
+    # :method: product_option
     # gets the option with the given id for the given product
+    #
+    # :call-seq:
+    #   product_option(product_id, id, options = {})
 
-    # @!method product_reviews(product_id, options = {})
+    ##
+    # :method: product_reviews
     # gets a list of reviews for the given product
+    #
+    # :call-seq:
+    #   product_reviews(product_id, options = {})
 
-    # @!method product_rules(product_id, options = {})
+    ##
+    # :method: product_rules
     # gets a list of rules for the given product
+    #
+    # :call-seq:
+    #   product_rules(product_id, options = {})
 
-    # @!method product_rule(product_id, id, options = {})
+    ##
+    # :method: product_rule
     # gets the rule with the given id for the given product
+    #
+    # :call-seq:
+    #   product_rule(product_id, id, options = {})
 
-    # @!method create_product_rule(product_id, options = {})
+    ##
+    # :method: create_product_rule
     # creates a rule with the given attributes for the given product
+    #
+    # :call-seq:
+    #   create_product_rule(product_id, options = {})
 
-    # @!method update_product_rule(product_id, id, options = {})
-    # updates a rule with the given attributes for the given product
+    ##
+    # :method: update_product_rule
+    # update the attributes of the rule with the given id for the given product
+    #
+    # :call-seq:
+    #   update_product_rule(product_id, id, options = {})
 
-    # @!method delete_product_rule(product_id, id)
+    ##
+    # :method: delete_product_rule
     # deletes the rule with the given id for the given product
+    #
+    # :call-seq:
+    #   delete_product_rule(product_id, id)
 
-    # @!method product_videos(product_id, options = {})
+    ##
+    # :method: product_rules_count
+    # returns the number of rules for the given product
+    #
+    # :call-seq:
+    #   product_rules_count(product_id, options = {})
+
+    ##
+    # :method: product_videos
     # gets a list of videos for the given product
+    #
+    # :call-seq:
+    #   product_videos(product_id, options = {})
 
-    # @!method product_video(product_id, id, options = {})
+    ##
+    # :method: product_video
     # gets the video with the given id for the given product
+    #
+    # :call-seq:
+    #   product_video(product_id, id, options = {})
 
-    # @!method create_product_video(product_id, options = {})
+    ##
+    # :method: create_product_video
     # creates a video with the given attributes for the given product
+    #
+    # :call-seq:
+    #   create_product_video(product_id, options = {})
 
-    # @!method update_product_video(product_id, id, options = {})
-    # updates a video with the given attributes for the given product
+    ##
+    # :method: update_product_video
+    # update the attributes of the video with the given id for the given product
+    #
+    # :call-seq:
+    #   update_product_video(product_id, id, options = {})
 
-    # @!method delete_product_video(product_id, id)
+    ##
+    # :method: delete_product_video
     # deletes the video with the given id for the given product
+    #
+    # :call-seq:
+    #   delete_product_video(product_id, id)
+
+    ##
+    # :method: product_videos_count
+    # returns the number of videos for the given product
+    #
+    # :call-seq:
+    #   product_videos_count(product_id, options = {})
 
-    # @!method product_skus(product_id, options = {})
+    ##
+    # :method: product_skus
     # gets a list of skus for the given product
+    #
+    # :call-seq:
+    #   product_skus(product_id, options = {})
 
-    # @!method product_sku(product_id, id, options = {})
+    ##
+    # :method: product_sku
     # gets the sku with the given id for the given product
+    #
+    # :call-seq:
+    #   product_sku(product_id, id, options = {})
 
-    # @!method create_product_sku(product_id, options = {})
+    ##
+    # :method: create_product_sku
     # creates a sku with the given attributes for the given product
+    #
+    # :call-seq:
+    #   create_product_sku(product_id, options = {})
 
-    # @!method update_product_sku(product_id, id, options = {})
-    # updates a sku with the given attributes for the given product
+    ##
+    # :method: update_product_sku
+    # update the attributes of the sku with the given id for the given product
+    #
+    # :call-seq:
+    #   update_product_sku(product_id, id, options = {})
 
-    # @!method delete_product_sku(product_id, id)
+    ##
+    # :method: delete_product_sku
     # deletes the sku with the given id for the given product
+    #
+    # :call-seq:
+    #   delete_product_sku(product_id, id)
 
-    # @!method redirects(options = {})
+    ##
+    # :method: product_skus_count
+    # returns the number of skus for the given product
+    #
+    # :call-seq:
+    #   product_skus_count(product_id, options = {})
+
+    ##
+    # :method: redirects
     # gets a list of redirects
+    #
+    # :call-seq:
+    #   redirects(options = {})
 
-    # @!method redirect(id, options = {})
+    ##
+    # :method: redirect
     # gets the redirect with the given id
+    #
+    # :call-seq:
+    #   redirect(id, options = {})
 
-    # @!method create_redirect(options = {})
+    ##
+    # :method: create_redirect
     # creates a redirect with the given attributes
+    #
+    # :call-seq:
+    #   create_redirect(options = {})
 
-    # @!method update_redirect(id, options = {})
-    # updates a redirect with the given attributes
+    ##
+    # :method: update_redirect
+    # update the attributes of the redirect with the given id
+    #
+    # :call-seq:
+    #   update_redirect(id, options = {})
 
-    # @!method delete_redirect(id)
+    ##
+    # :method: delete_redirect
     # deletes the redirect with the given id
+    #
+    # :call-seq:
+    #   delete_redirect(id)
 
-    # @!method shipping_methods(options = {})
+    ##
+    # :method: redirects_count
+    # returns the number of redirects
+    #
+    # :call-seq:
+    #   redirects_count(options = {})
+
+    ##
+    # :method: shipping_methods
     # gets a list of methods
+    #
+    # :call-seq:
+    #   shipping_methods(options = {})
 
-    # @!method shipping_method(id, options = {})
+    ##
+    # :method: shipping_method
     # gets the method with the given id
+    #
+    # :call-seq:
+    #   shipping_method(id, options = {})
 
-    # @!method tax_classes(options = {})
+    ##
+    # :method: tax_classes
     # gets a list of tax_classes
+    #
+    # :call-seq:
+    #   tax_classes(options = {})
 
-    # @!method tax_class(id, options = {})
+    ##
+    # :method: tax_class
     # gets the tax_class with the given id
+    #
+    # :call-seq:
+    #   tax_class(id, options = {})
 
-    # @!method hooks(options = {})
+    ##
+    # :method: hooks
     # gets a list of hooks
+    #
+    # :call-seq:
+    #   hooks(options = {})
 
-    # @!method hook(id, options = {})
+    ##
+    # :method: hook
     # gets the hook with the given id
+    #
+    # :call-seq:
+    #   hook(id, options = {})
 
-    # @!method create_hook(options = {})
+    ##
+    # :method: create_hook
     # creates a hook with the given attributes
+    #
+    # :call-seq:
+    #   create_hook(options = {})
 
-    # @!method update_hook(id, options = {})
-    # updates a hook with the given attributes
+    ##
+    # :method: update_hook
+    # update the attributes of the hook with the given id
+    #
+    # :call-seq:
+    #   update_hook(id, options = {})
 
-    # @!method delete_hook(id)
+    ##
+    # :method: delete_hook
     # deletes the hook with the given id
+    #
+    # :call-seq:
+    #   delete_hook(id)
 
   end
 end