bigcommerce-oauth-api 1.1.5 → 1.2.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/CHANGELOG.md +17 -0
- data/README.md +63 -43
- data/bigcommerce-oauth-api.gemspec +3 -4
- data/lib/bigcommerce-oauth-api/api.rb +4 -0
- data/lib/bigcommerce-oauth-api/base.rb +4 -2
- data/lib/bigcommerce-oauth-api/client.rb +865 -182
- data/lib/bigcommerce-oauth-api/configuration.rb +8 -1
- data/lib/bigcommerce-oauth-api/connection.rb +14 -6
- data/lib/bigcommerce-oauth-api/error.rb +3 -0
- data/lib/bigcommerce-oauth-api/version.rb +1 -1
- data/spec/bigcommerce_oauth_api/api_spec.rb +60 -1
- data/spec/bigcommerce_oauth_api/client/client_module_spec.rb +172 -85
- data/spec/bigcommerce_oauth_api/client/client_nested_module_spec.rb +195 -91
- data/spec/spec_helper.rb +17 -8
- metadata +28 -40
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA1:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: bdf5b9ddfbfad7c95f914d01e772122c59363ebf
|
4
|
+
data.tar.gz: 53309df2bcfad86dcb8f1ecafc88e22499314f89
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 80a2d871dd59031976c08e65572705e583a0d552ebf02de3467f7fe333fe216904488ede52b947ee3760a2a5c592d031300e01e46c4b6ac0bf8882cb88e31986
|
7
|
+
data.tar.gz: e5c66453f20d4ec5fc7e1a0cdb3ab675976d264ffd9c5b14b8e2ba69a2e9d757866b4d0bbf1804f2f747c0e7ded23b345edea319a1c9c00e5d7ad1d3ac13eacd
|
data/CHANGELOG.md
CHANGED
@@ -1,3 +1,20 @@
|
|
1
|
+
### 1.2.0 (2015-04-19)
|
2
|
+
|
3
|
+
Features:
|
4
|
+
|
5
|
+
- add legacy api support
|
6
|
+
- add omniref and revert to using rdoc
|
7
|
+
- add order coupon apis
|
8
|
+
- add order tax apis
|
9
|
+
- add order statuses apis
|
10
|
+
|
11
|
+
Bugfixes:
|
12
|
+
|
13
|
+
- update geography apis
|
14
|
+
- add a few missing "count" apis
|
15
|
+
- fix option value api
|
16
|
+
- update docs
|
17
|
+
|
1
18
|
### 1.1.5 (2014-12-25)
|
2
19
|
|
3
20
|
Features:
|
data/README.md
CHANGED
@@ -1,5 +1,6 @@
|
|
1
1
|
bigcommerce-oauth-api
|
2
2
|
==========================
|
3
|
+
[![bigcommerce-oauth-api API Documentation](https://www.omniref.com/ruby/gems/bigcommerce-oauth-api.png)](https://www.omniref.com/ruby/gems/bigcommerce-oauth-api)
|
3
4
|
[![Gem Version](https://badge.fury.io/rb/bigcommerce-oauth-api.svg)](http://badge.fury.io/rb/bigcommerce-oauth-api)
|
4
5
|
[![Code Climate](https://codeclimate.com/github/corthmann/bigcommerce-oauth-api/badges/gpa.svg)](https://codeclimate.com/github/corthmann/bigcommerce-oauth-api)
|
5
6
|
[![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'
|
|
20
21
|
|
21
22
|
Configuration
|
22
23
|
-------------
|
23
|
-
The gem can be configured
|
24
|
+
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.
|
24
25
|
```
|
26
|
+
# module oauth configuration
|
25
27
|
BigcommerceOAuthAPI.configuration do |config|
|
26
28
|
config.store_hash = 'YOU STORE ID'
|
27
29
|
config.client_id = 'YOUR CLIENT ID'
|
28
30
|
config.access_token = 'YOUR OAUTH ACCESS TOKEN'
|
29
31
|
end
|
30
|
-
```
|
31
32
|
|
32
|
-
|
33
|
-
|
33
|
+
# module legacy (basic auth) configuration
|
34
|
+
BigcommerceOAuthAPI.configuration do |config|
|
35
|
+
config.endpoint = 'YOU STORE URL (https://store-XYZ.mybigcommerce.com)'
|
36
|
+
config.user_name = 'API USER NAME'
|
37
|
+
config.api_key = 'API KEY'
|
38
|
+
end
|
39
|
+
|
40
|
+
# class oauth configuration
|
34
41
|
api = BigcommerceOAuthAPI::Client.new(
|
35
42
|
:store_hash => 'YOUR STORE ID',
|
36
43
|
:client_id => 'YOUR CLIENT ID',
|
37
44
|
:access_token => 'YOUR OAUTH ACCESS TOKEN'
|
38
45
|
)
|
46
|
+
|
47
|
+
# class legacy (basic auth) configuration
|
48
|
+
api = BigcommerceOAuthAPI::Client.new(
|
49
|
+
:endpoint => 'YOU STORE URL (ex. https://store-XYZ.mybigcommerce.com)',
|
50
|
+
:user_name => 'API USER NAME',
|
51
|
+
:api_key => 'API KEY'
|
52
|
+
)
|
39
53
|
```
|
40
54
|
|
41
55
|
Using the API
|
42
56
|
-------------
|
57
|
+
It is recommended to use the Omniref documentation as a method reference in combination the official api documentation.
|
58
|
+
|
43
59
|
Get a list of products:
|
44
60
|
```
|
45
61
|
products = api.products
|
@@ -69,6 +85,7 @@ order_id = 101
|
|
69
85
|
shipment_id = 1000
|
70
86
|
api.delete_order_shipment(order_id, shipment_id)
|
71
87
|
```
|
88
|
+
|
72
89
|
Webhooks
|
73
90
|
-------------
|
74
91
|
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
|
|
100
117
|
-------------
|
101
118
|
The following APIs are currently supported:
|
102
119
|
|
103
|
-
API |
|
104
|
-
--- | ---
|
105
|
-
blog post | 1.0.2
|
106
|
-
blog tag | 1.0.2
|
107
|
-
brand api | 1.1.0
|
108
|
-
bulk pricing (discount rules) | 1.1.0
|
109
|
-
category | 1.1.0
|
110
|
-
customer api | 1.0.2
|
111
|
-
customer address | 1.0.2
|
112
|
-
customer group | 1.0.2
|
113
|
-
geography country | 1.0.2
|
114
|
-
geography state | 1.0.2
|
115
|
-
marketing coupon | 1.0.2
|
116
|
-
option | 1.1.0
|
117
|
-
option set | 1.1.0
|
118
|
-
option set option | 1.1.0
|
119
|
-
option
|
120
|
-
order | 1.0.2
|
121
|
-
order
|
122
|
-
order
|
123
|
-
order
|
124
|
-
order
|
125
|
-
|
126
|
-
|
127
|
-
|
128
|
-
|
129
|
-
product
|
130
|
-
product
|
131
|
-
product
|
132
|
-
product
|
133
|
-
product
|
134
|
-
product
|
135
|
-
product
|
136
|
-
|
137
|
-
|
138
|
-
|
139
|
-
|
140
|
-
|
141
|
-
|
120
|
+
API | Gem Version | Official Documentation
|
121
|
+
--- | --- | ---
|
122
|
+
blog post | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/blog/posts
|
123
|
+
blog tag | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/blog/tags
|
124
|
+
brand api | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/brands
|
125
|
+
bulk pricing (discount rules) | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/products/discount_rules
|
126
|
+
category | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/categories
|
127
|
+
customer api | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/customers
|
128
|
+
customer address | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/customers/addresses
|
129
|
+
customer group | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/customer_groups
|
130
|
+
geography country | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/countries
|
131
|
+
geography state | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/countries/states
|
132
|
+
marketing coupon | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/coupons
|
133
|
+
option | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/options
|
134
|
+
option set | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/option_sets
|
135
|
+
option set option | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/option_sets/options
|
136
|
+
option value | 1.2.0 | https://developer.bigcommerce.com/api/stores/v2/options/values
|
137
|
+
order | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/orders
|
138
|
+
order coupon | 1.2.0 | https://developer.bigcommerce.com/api/stores/v2/orders/coupons
|
139
|
+
order message | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/orders/messages
|
140
|
+
order product | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/orders/products
|
141
|
+
order shipment | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/orders/shipments
|
142
|
+
order shipping address | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/orders/shipping_addresses
|
143
|
+
order statuses | 1.2.0 | https://developer.bigcommerce.com/api/stores/v2/order_statuses
|
144
|
+
order tax | 1.2.0 | https://developer.bigcommerce.com/api/stores/v2/orders/taxes
|
145
|
+
payment method | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/payments/methods
|
146
|
+
product | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/products
|
147
|
+
product configurable field | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/products/configurable_fields
|
148
|
+
product custom field | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/products/custom_fields
|
149
|
+
product googleproductsearch | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/products/googleproductsearch
|
150
|
+
product image | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/products/images
|
151
|
+
product option | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/products/options
|
152
|
+
product review | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/products/reviews
|
153
|
+
product rules | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/products/rules
|
154
|
+
product video | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/products/videos
|
155
|
+
product SKU | 1.1.0 | https://developer.bigcommerce.com/api/stores/v2/products/skus
|
156
|
+
redirect | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/redirects
|
157
|
+
shipping method api | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/shipping/methods
|
158
|
+
store information | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/store_information
|
159
|
+
system (time) | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/time
|
160
|
+
tax class | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/tax_classes
|
161
|
+
web hook | 1.0.2 | https://developer.bigcommerce.com/api/stores/v2/webhooks
|
142
162
|
|
143
163
|
Getting an OAuth Access Token
|
144
164
|
-------------
|
@@ -3,9 +3,9 @@ require File.expand_path('../lib/bigcommerce-oauth-api/version', __FILE__)
|
|
3
3
|
Gem::Specification.new do |s|
|
4
4
|
s.name = 'bigcommerce-oauth-api'
|
5
5
|
s.version = BigcommerceOAuthAPI::VERSION.dup
|
6
|
-
s.date = '
|
7
|
-
s.summary = "Ruby
|
8
|
-
s.description = "Connect Ruby applications
|
6
|
+
s.date = '2015-04-19'
|
7
|
+
s.summary = "Ruby client library for Bigcommerce APIs with OAuth and basic authentication support"
|
8
|
+
s.description = "Connect Ruby applications to Bigcommerce APIs through OAuth or basic authentication"
|
9
9
|
s.authors = ["Christian Orthmann"]
|
10
10
|
s.email = 'christian.orthmann@gmail.com'
|
11
11
|
s.require_path = 'lib'
|
@@ -19,7 +19,6 @@ Gem::Specification.new do |s|
|
|
19
19
|
s.add_development_dependency('webmock', '~> 1')
|
20
20
|
s.add_development_dependency('simplecov', '~> 0')
|
21
21
|
s.add_development_dependency('simplecov-rcov', '~> 0')
|
22
|
-
s.add_development_dependency('yard', '~> 0')
|
23
22
|
s.add_runtime_dependency('faraday', '~> 0')
|
24
23
|
s.add_runtime_dependency('faraday_middleware', '~> 0')
|
25
24
|
s.add_runtime_dependency('activesupport', '>= 3.0.0', '< 5.0.0')
|
@@ -10,15 +10,16 @@ module BigcommerceOAuthAPI
|
|
10
10
|
map.each do |api, method_description|
|
11
11
|
api_module = method_description[:api_module]
|
12
12
|
api_scope = method_description[:scope]
|
13
|
+
is_legacy = (method_description[:legacy].nil? ? true : method_description[:legacy])
|
13
14
|
path_prefix = (method_description.has_key?(:prefix_paths) ? "#{method_description[:prefix_paths]}/" : nil)
|
14
15
|
method_prefix = (method_description.has_key?(:prefix_methods) ? "#{method_description[:prefix_methods]}_" : nil)
|
15
16
|
method_description[:methods].each do |method|
|
16
|
-
with_action(method, api_module, api_scope, path_prefix, method_prefix)
|
17
|
+
with_action(method, api_module, api_scope, path_prefix, method_prefix, is_legacy)
|
17
18
|
end
|
18
19
|
end
|
19
20
|
end
|
20
21
|
|
21
|
-
def self.with_action(method, api_module, api_scope, path_prefix = nil, method_prefix = nil)
|
22
|
+
def self.with_action(method, api_module, api_scope, path_prefix = nil, method_prefix = nil, is_legacy = true)
|
22
23
|
is_nested = api_scope != :self
|
23
24
|
method_name, method_params, has_options = get_method_name_and_params(method, api_module, api_scope, is_nested, method_prefix)
|
24
25
|
method_path = get_method_path(method, api_module, api_scope, is_nested)
|
@@ -32,6 +33,7 @@ module BigcommerceOAuthAPI
|
|
32
33
|
|
33
34
|
class_eval %Q{
|
34
35
|
def #{method_name}#{method_params}
|
36
|
+
#{(is_legacy ? '' : 'raise NonLegacyApi.new if is_legacy?')}
|
35
37
|
#{request_method}("#{path_prefix}#{method_path}"#{( has_options ? ', options' : '')})
|
36
38
|
end
|
37
39
|
}
|
@@ -23,443 +23,1126 @@ module BigcommerceOAuthAPI
|
|
23
23
|
|
24
24
|
with_api_methods :blog_post => { api_module: :post, scope: :self, methods: [:all, :select, :create, :update, :delete], prefix_paths: 'blog', prefix_methods: 'blog'},
|
25
25
|
:blog_tag => { api_module: :tag, scope: :self, methods: [:all], prefix_paths: 'blog', prefix_methods: 'blog'},
|
26
|
-
:brand => { api_module: :brand, scope: :self, methods: [:all, :select, :create, :update, :delete]},
|
26
|
+
:brand => { api_module: :brand, scope: :self, methods: [:all, :select, :create, :update, :delete, :count]},
|
27
27
|
:category => { api_module: :category, scope: :self, methods: [:all, :select, :create, :update, :delete]},
|
28
28
|
:customer => { api_module: :customer, scope: :self, methods: [:all, :select, :create, :update, :delete, :count]},
|
29
29
|
:customer_address => { api_module: :address, scope: :customer, methods: [:all, :select, :create, :update, :delete]},
|
30
30
|
:customer_group => { api_module: :customer_group, scope: :self, methods: [:all, :select, :create, :update, :delete]},
|
31
|
-
:geography_country => { api_module: :country, scope: :self, methods: [:all, :select]},
|
32
|
-
:geography_state => { api_module: :state, scope: :
|
33
|
-
:marketing_coupons => { api_module: :coupon, scope: :self, methods: [:all, :select, :create, :update, :delete]},
|
34
|
-
:option => { api_module: :option, scope: :self, methods: [:all, :select, :create, :update, :delete]},
|
35
|
-
:option_set => { api_module: :option_set, scope: :self, methods: [:all, :select, :create, :update, :delete]},
|
31
|
+
:geography_country => { api_module: :country, scope: :self, methods: [:all, :select, :count]},
|
32
|
+
:geography_state => { api_module: :state, scope: :country, methods: [:all, :select, :count]},
|
33
|
+
:marketing_coupons => { api_module: :coupon, scope: :self, methods: [:all, :select, :create, :update, :delete, :count]},
|
34
|
+
:option => { api_module: :option, scope: :self, methods: [:all, :select, :create, :update, :delete, :count]},
|
35
|
+
:option_set => { api_module: :option_set, scope: :self, methods: [:all, :select, :create, :update, :delete, :count]},
|
36
36
|
:option_set_option => { api_module: :option, scope: :option_set, methods: [:all, :select, :create, :update, :delete]},
|
37
|
-
:
|
37
|
+
:option_value => { api_module: :value, scope: :option, methods: [:all, :select, :create, :update, :delete]},
|
38
|
+
:order_status => { api_module: :order_status, scope: :self, methods: [:all, :select]},
|
38
39
|
:order => { api_module: :order, scope: :self, methods: [:all, :select, :create, :update, :delete, :count]},
|
40
|
+
:order_coupon => { api_module: :coupon, scope: :order, methods: [:all, :select]},
|
39
41
|
:order_message => { api_module: :message, scope: :order, methods: [:all, :select]},
|
40
|
-
:order_product => { api_module: :product, scope: :order, methods: [:all, :select]},
|
42
|
+
:order_product => { api_module: :product, scope: :order, methods: [:all, :select, :count]},
|
41
43
|
:order_shipment => { api_module: :shipment, scope: :order, methods: [:all, :select, :create, :update, :delete]},
|
42
44
|
:order_shipping_address => { api_module: :shipping_address, scope: :order, methods: [:all, :select]},
|
45
|
+
:order_taxes => { api_module: :tax, scope: :order, methods: [:all, :select]},
|
43
46
|
:payment_method => { api_module: :method, scope: :self, methods: [:all], prefix_paths: 'payments', prefix_methods: 'payment'},
|
44
47
|
:product => { api_module: :product, scope: :self, methods: [:all, :select, :create, :update, :delete, :count]},
|
45
48
|
:product_custom_field => { api_module: :custom_field, scope: :product, methods: [:all, :select, :create, :update, :delete]},
|
46
|
-
:product_discount_rule => { api_module: :discount_rule, scope: :product, methods: [:all, :select, :create, :update, :delete]},
|
47
|
-
:product_configurable_field => { api_module: :configurable_field, scope: :product, methods: [:all, :select, :delete]},
|
48
|
-
:product_image => { api_module: :image, scope: :product, methods: [:all, :select, :create, :update, :delete]},
|
49
|
+
:product_discount_rule => { api_module: :discount_rule, scope: :product, methods: [:all, :select, :create, :update, :delete, :count]},
|
50
|
+
:product_configurable_field => { api_module: :configurable_field, scope: :product, methods: [:all, :select, :delete, :count]},
|
51
|
+
:product_image => { api_module: :image, scope: :product, methods: [:all, :select, :create, :update, :delete, :count]},
|
49
52
|
:product_option => { api_module: :option, scope: :product, methods: [:all, :select]},
|
50
53
|
:product_review => { api_module: :review, scope: :product, methods: [:all]},
|
51
|
-
:product_rule => { api_module: :rule, scope: :product, methods: [:all, :select, :create, :update, :delete]},
|
52
|
-
:product_video => { api_module: :video, scope: :product, methods: [:all, :select, :create, :update, :delete]},
|
53
|
-
:product_sku => { api_module: :sku, scope: :product, methods: [:all, :select, :create, :update, :delete]},
|
54
|
-
:redirect => { api_module: :redirect, scope: :self, methods: [:all, :select, :create, :update, :delete]},
|
54
|
+
:product_rule => { api_module: :rule, scope: :product, methods: [:all, :select, :create, :update, :delete, :count]},
|
55
|
+
:product_video => { api_module: :video, scope: :product, methods: [:all, :select, :create, :update, :delete, :count]},
|
56
|
+
:product_sku => { api_module: :sku, scope: :product, methods: [:all, :select, :create, :update, :delete, :count]},
|
57
|
+
:redirect => { api_module: :redirect, scope: :self, methods: [:all, :select, :create, :update, :delete, :count]},
|
55
58
|
:shipping_method => { api_module: :method, scope: :self, methods: [:all, :select], prefix_paths: 'shipping', prefix_methods: 'shipping'},
|
56
59
|
:tax_class => { api_module: :tax_class, scope: :self, methods: [:all, :select]},
|
57
|
-
:web_hook => { api_module: :hook, scope: :self, methods: [:all, :select, :create, :update, :delete]}
|
60
|
+
:web_hook => { api_module: :hook, scope: :self, methods: [:all, :select, :create, :update, :delete], legacy: false }
|
58
61
|
|
59
|
-
|
62
|
+
##
|
63
|
+
# :method: blog_posts
|
60
64
|
# gets a list of posts
|
65
|
+
#
|
66
|
+
# :call-seq:
|
67
|
+
# blog_posts(options = {})
|
61
68
|
|
62
|
-
|
69
|
+
##
|
70
|
+
# :method: blog_post
|
63
71
|
# gets the post with the given id
|
72
|
+
#
|
73
|
+
# :call-seq:
|
74
|
+
# blog_post(id, options = {})
|
64
75
|
|
65
|
-
|
76
|
+
##
|
77
|
+
# :method: create_blog_post
|
66
78
|
# creates a post with the given attributes
|
79
|
+
#
|
80
|
+
# :call-seq:
|
81
|
+
# create_blog_post(options = {})
|
67
82
|
|
68
|
-
|
69
|
-
#
|
83
|
+
##
|
84
|
+
# :method: update_blog_post
|
85
|
+
# update the attributes of the post with the given id
|
86
|
+
#
|
87
|
+
# :call-seq:
|
88
|
+
# update_blog_post(id, options = {})
|
70
89
|
|
71
|
-
|
90
|
+
##
|
91
|
+
# :method: delete_blog_post
|
72
92
|
# deletes the post with the given id
|
93
|
+
#
|
94
|
+
# :call-seq:
|
95
|
+
# delete_blog_post(id)
|
73
96
|
|
74
|
-
|
97
|
+
##
|
98
|
+
# :method: blog_tags
|
75
99
|
# gets a list of tags
|
100
|
+
#
|
101
|
+
# :call-seq:
|
102
|
+
# blog_tags(options = {})
|
76
103
|
|
77
|
-
|
104
|
+
##
|
105
|
+
# :method: brands
|
78
106
|
# gets a list of brands
|
107
|
+
#
|
108
|
+
# :call-seq:
|
109
|
+
# brands(options = {})
|
79
110
|
|
80
|
-
|
111
|
+
##
|
112
|
+
# :method: brand
|
81
113
|
# gets the brand with the given id
|
114
|
+
#
|
115
|
+
# :call-seq:
|
116
|
+
# brand(id, options = {})
|
82
117
|
|
83
|
-
|
118
|
+
##
|
119
|
+
# :method: create_brand
|
84
120
|
# creates a brand with the given attributes
|
121
|
+
#
|
122
|
+
# :call-seq:
|
123
|
+
# create_brand(options = {})
|
85
124
|
|
86
|
-
|
87
|
-
#
|
125
|
+
##
|
126
|
+
# :method: update_brand
|
127
|
+
# update the attributes of the brand with the given id
|
128
|
+
#
|
129
|
+
# :call-seq:
|
130
|
+
# update_brand(id, options = {})
|
88
131
|
|
89
|
-
|
132
|
+
##
|
133
|
+
# :method: delete_brand
|
90
134
|
# deletes the brand with the given id
|
135
|
+
#
|
136
|
+
# :call-seq:
|
137
|
+
# delete_brand(id)
|
91
138
|
|
92
|
-
|
139
|
+
##
|
140
|
+
# :method: brands_count
|
141
|
+
# returns the number of brands
|
142
|
+
#
|
143
|
+
# :call-seq:
|
144
|
+
# brands_count(options = {})
|
145
|
+
|
146
|
+
##
|
147
|
+
# :method: categories
|
93
148
|
# gets a list of categories
|
149
|
+
#
|
150
|
+
# :call-seq:
|
151
|
+
# categories(options = {})
|
94
152
|
|
95
|
-
|
153
|
+
##
|
154
|
+
# :method: category
|
96
155
|
# gets the category with the given id
|
156
|
+
#
|
157
|
+
# :call-seq:
|
158
|
+
# category(id, options = {})
|
97
159
|
|
98
|
-
|
160
|
+
##
|
161
|
+
# :method: create_category
|
99
162
|
# creates a category with the given attributes
|
163
|
+
#
|
164
|
+
# :call-seq:
|
165
|
+
# create_category(options = {})
|
100
166
|
|
101
|
-
|
102
|
-
#
|
167
|
+
##
|
168
|
+
# :method: update_category
|
169
|
+
# update the attributes of the category with the given id
|
170
|
+
#
|
171
|
+
# :call-seq:
|
172
|
+
# update_category(id, options = {})
|
103
173
|
|
104
|
-
|
174
|
+
##
|
175
|
+
# :method: delete_category
|
105
176
|
# deletes the category with the given id
|
177
|
+
#
|
178
|
+
# :call-seq:
|
179
|
+
# delete_category(id)
|
106
180
|
|
107
|
-
|
181
|
+
##
|
182
|
+
# :method: customers
|
108
183
|
# gets a list of customers
|
184
|
+
#
|
185
|
+
# :call-seq:
|
186
|
+
# customers(options = {})
|
109
187
|
|
110
|
-
|
188
|
+
##
|
189
|
+
# :method: customer
|
111
190
|
# gets the customer with the given id
|
191
|
+
#
|
192
|
+
# :call-seq:
|
193
|
+
# customer(id, options = {})
|
112
194
|
|
113
|
-
|
195
|
+
##
|
196
|
+
# :method: create_customer
|
114
197
|
# creates a customer with the given attributes
|
198
|
+
#
|
199
|
+
# :call-seq:
|
200
|
+
# create_customer(options = {})
|
115
201
|
|
116
|
-
|
117
|
-
#
|
202
|
+
##
|
203
|
+
# :method: update_customer
|
204
|
+
# update the attributes of the customer with the given id
|
205
|
+
#
|
206
|
+
# :call-seq:
|
207
|
+
# update_customer(id, options = {})
|
118
208
|
|
119
|
-
|
209
|
+
##
|
210
|
+
# :method: delete_customer
|
120
211
|
# deletes the customer with the given id
|
212
|
+
#
|
213
|
+
# :call-seq:
|
214
|
+
# delete_customer(id)
|
121
215
|
|
122
|
-
|
123
|
-
#
|
216
|
+
##
|
217
|
+
# :method: customers_count
|
218
|
+
# returns the number of customers
|
219
|
+
#
|
220
|
+
# :call-seq:
|
221
|
+
# customers_count(options = {})
|
124
222
|
|
125
|
-
|
223
|
+
##
|
224
|
+
# :method: customer_addresses
|
126
225
|
# gets a list of addresses for the given customer
|
226
|
+
#
|
227
|
+
# :call-seq:
|
228
|
+
# customer_addresses(customer_id, options = {})
|
127
229
|
|
128
|
-
|
230
|
+
##
|
231
|
+
# :method: customer_address
|
129
232
|
# gets the address with the given id for the given customer
|
233
|
+
#
|
234
|
+
# :call-seq:
|
235
|
+
# customer_address(customer_id, id, options = {})
|
130
236
|
|
131
|
-
|
237
|
+
##
|
238
|
+
# :method: create_customer_address
|
132
239
|
# creates a address with the given attributes for the given customer
|
240
|
+
#
|
241
|
+
# :call-seq:
|
242
|
+
# create_customer_address(customer_id, options = {})
|
133
243
|
|
134
|
-
|
135
|
-
#
|
244
|
+
##
|
245
|
+
# :method: update_customer_address
|
246
|
+
# update the attributes of the address with the given id for the given customer
|
247
|
+
#
|
248
|
+
# :call-seq:
|
249
|
+
# update_customer_address(customer_id, id, options = {})
|
136
250
|
|
137
|
-
|
251
|
+
##
|
252
|
+
# :method: delete_customer_address
|
138
253
|
# deletes the address with the given id for the given customer
|
254
|
+
#
|
255
|
+
# :call-seq:
|
256
|
+
# delete_customer_address(customer_id, id)
|
139
257
|
|
140
|
-
|
258
|
+
##
|
259
|
+
# :method: customer_groups
|
141
260
|
# gets a list of customer_groups
|
261
|
+
#
|
262
|
+
# :call-seq:
|
263
|
+
# customer_groups(options = {})
|
142
264
|
|
143
|
-
|
265
|
+
##
|
266
|
+
# :method: customer_group
|
144
267
|
# gets the customer_group with the given id
|
268
|
+
#
|
269
|
+
# :call-seq:
|
270
|
+
# customer_group(id, options = {})
|
145
271
|
|
146
|
-
|
272
|
+
##
|
273
|
+
# :method: create_customer_group
|
147
274
|
# creates a customer_group with the given attributes
|
275
|
+
#
|
276
|
+
# :call-seq:
|
277
|
+
# create_customer_group(options = {})
|
148
278
|
|
149
|
-
|
150
|
-
#
|
279
|
+
##
|
280
|
+
# :method: update_customer_group
|
281
|
+
# update the attributes of the customer_group with the given id
|
282
|
+
#
|
283
|
+
# :call-seq:
|
284
|
+
# update_customer_group(id, options = {})
|
151
285
|
|
152
|
-
|
286
|
+
##
|
287
|
+
# :method: delete_customer_group
|
153
288
|
# deletes the customer_group with the given id
|
289
|
+
#
|
290
|
+
# :call-seq:
|
291
|
+
# delete_customer_group(id)
|
154
292
|
|
155
|
-
|
293
|
+
##
|
294
|
+
# :method: countries
|
156
295
|
# gets a list of countries
|
296
|
+
#
|
297
|
+
# :call-seq:
|
298
|
+
# countries(options = {})
|
157
299
|
|
158
|
-
|
300
|
+
##
|
301
|
+
# :method: country
|
159
302
|
# gets the country with the given id
|
303
|
+
#
|
304
|
+
# :call-seq:
|
305
|
+
# country(id, options = {})
|
160
306
|
|
161
|
-
|
162
|
-
#
|
307
|
+
##
|
308
|
+
# :method: countries_count
|
309
|
+
# returns the number of countries
|
310
|
+
#
|
311
|
+
# :call-seq:
|
312
|
+
# countries_count(options = {})
|
163
313
|
|
164
|
-
|
165
|
-
#
|
314
|
+
##
|
315
|
+
# :method: country_states
|
316
|
+
# gets a list of states for the given country
|
317
|
+
#
|
318
|
+
# :call-seq:
|
319
|
+
# country_states(country_id, options = {})
|
166
320
|
|
167
|
-
|
321
|
+
##
|
322
|
+
# :method: country_state
|
323
|
+
# gets the state with the given id for the given country
|
324
|
+
#
|
325
|
+
# :call-seq:
|
326
|
+
# country_state(country_id, id, options = {})
|
327
|
+
|
328
|
+
##
|
329
|
+
# :method: country_states_count
|
330
|
+
# returns the number of states for the given country
|
331
|
+
#
|
332
|
+
# :call-seq:
|
333
|
+
# country_states_count(country_id, options = {})
|
334
|
+
|
335
|
+
##
|
336
|
+
# :method: coupons
|
168
337
|
# gets a list of coupons
|
338
|
+
#
|
339
|
+
# :call-seq:
|
340
|
+
# coupons(options = {})
|
169
341
|
|
170
|
-
|
342
|
+
##
|
343
|
+
# :method: coupon
|
171
344
|
# gets the coupon with the given id
|
345
|
+
#
|
346
|
+
# :call-seq:
|
347
|
+
# coupon(id, options = {})
|
172
348
|
|
173
|
-
|
349
|
+
##
|
350
|
+
# :method: create_coupon
|
174
351
|
# creates a coupon with the given attributes
|
352
|
+
#
|
353
|
+
# :call-seq:
|
354
|
+
# create_coupon(options = {})
|
175
355
|
|
176
|
-
|
177
|
-
#
|
356
|
+
##
|
357
|
+
# :method: update_coupon
|
358
|
+
# update the attributes of the coupon with the given id
|
359
|
+
#
|
360
|
+
# :call-seq:
|
361
|
+
# update_coupon(id, options = {})
|
178
362
|
|
179
|
-
|
363
|
+
##
|
364
|
+
# :method: delete_coupon
|
180
365
|
# deletes the coupon with the given id
|
366
|
+
#
|
367
|
+
# :call-seq:
|
368
|
+
# delete_coupon(id)
|
181
369
|
|
182
|
-
|
370
|
+
##
|
371
|
+
# :method: coupons_count
|
372
|
+
# returns the number of coupons
|
373
|
+
#
|
374
|
+
# :call-seq:
|
375
|
+
# coupons_count(options = {})
|
376
|
+
|
377
|
+
##
|
378
|
+
# :method: options
|
183
379
|
# gets a list of options
|
380
|
+
#
|
381
|
+
# :call-seq:
|
382
|
+
# options(options = {})
|
184
383
|
|
185
|
-
|
384
|
+
##
|
385
|
+
# :method: option
|
186
386
|
# gets the option with the given id
|
387
|
+
#
|
388
|
+
# :call-seq:
|
389
|
+
# option(id, options = {})
|
187
390
|
|
188
|
-
|
391
|
+
##
|
392
|
+
# :method: create_option
|
189
393
|
# creates a option with the given attributes
|
394
|
+
#
|
395
|
+
# :call-seq:
|
396
|
+
# create_option(options = {})
|
190
397
|
|
191
|
-
|
192
|
-
#
|
398
|
+
##
|
399
|
+
# :method: update_option
|
400
|
+
# update the attributes of the option with the given id
|
401
|
+
#
|
402
|
+
# :call-seq:
|
403
|
+
# update_option(id, options = {})
|
193
404
|
|
194
|
-
|
405
|
+
##
|
406
|
+
# :method: delete_option
|
195
407
|
# deletes the option with the given id
|
408
|
+
#
|
409
|
+
# :call-seq:
|
410
|
+
# delete_option(id)
|
411
|
+
|
412
|
+
##
|
413
|
+
# :method: options_count
|
414
|
+
# returns the number of options
|
415
|
+
#
|
416
|
+
# :call-seq:
|
417
|
+
# options_count(options = {})
|
196
418
|
|
197
|
-
|
419
|
+
##
|
420
|
+
# :method: option_sets
|
198
421
|
# gets a list of option_sets
|
422
|
+
#
|
423
|
+
# :call-seq:
|
424
|
+
# option_sets(options = {})
|
199
425
|
|
200
|
-
|
426
|
+
##
|
427
|
+
# :method: option_set
|
201
428
|
# gets the option_set with the given id
|
429
|
+
#
|
430
|
+
# :call-seq:
|
431
|
+
# option_set(id, options = {})
|
202
432
|
|
203
|
-
|
433
|
+
##
|
434
|
+
# :method: create_option_set
|
204
435
|
# creates a option_set with the given attributes
|
436
|
+
#
|
437
|
+
# :call-seq:
|
438
|
+
# create_option_set(options = {})
|
205
439
|
|
206
|
-
|
207
|
-
#
|
440
|
+
##
|
441
|
+
# :method: update_option_set
|
442
|
+
# update the attributes of the option_set with the given id
|
443
|
+
#
|
444
|
+
# :call-seq:
|
445
|
+
# update_option_set(id, options = {})
|
208
446
|
|
209
|
-
|
447
|
+
##
|
448
|
+
# :method: delete_option_set
|
210
449
|
# deletes the option_set with the given id
|
450
|
+
#
|
451
|
+
# :call-seq:
|
452
|
+
# delete_option_set(id)
|
211
453
|
|
212
|
-
|
454
|
+
##
|
455
|
+
# :method: option_sets_count
|
456
|
+
# returns the number of option_sets
|
457
|
+
#
|
458
|
+
# :call-seq:
|
459
|
+
# option_sets_count(options = {})
|
460
|
+
|
461
|
+
##
|
462
|
+
# :method: option_set_options
|
213
463
|
# gets a list of options for the given option_set
|
464
|
+
#
|
465
|
+
# :call-seq:
|
466
|
+
# option_set_options(option_set_id, options = {})
|
214
467
|
|
215
|
-
|
468
|
+
##
|
469
|
+
# :method: option_set_option
|
216
470
|
# gets the option with the given id for the given option_set
|
471
|
+
#
|
472
|
+
# :call-seq:
|
473
|
+
# option_set_option(option_set_id, id, options = {})
|
217
474
|
|
218
|
-
|
475
|
+
##
|
476
|
+
# :method: create_option_set_option
|
219
477
|
# creates a option with the given attributes for the given option_set
|
478
|
+
#
|
479
|
+
# :call-seq:
|
480
|
+
# create_option_set_option(option_set_id, options = {})
|
220
481
|
|
221
|
-
|
222
|
-
#
|
482
|
+
##
|
483
|
+
# :method: update_option_set_option
|
484
|
+
# update the attributes of the option with the given id for the given option_set
|
485
|
+
#
|
486
|
+
# :call-seq:
|
487
|
+
# update_option_set_option(option_set_id, id, options = {})
|
223
488
|
|
224
|
-
|
489
|
+
##
|
490
|
+
# :method: delete_option_set_option
|
225
491
|
# deletes the option with the given id for the given option_set
|
492
|
+
#
|
493
|
+
# :call-seq:
|
494
|
+
# delete_option_set_option(option_set_id, id)
|
226
495
|
|
227
|
-
|
228
|
-
#
|
496
|
+
##
|
497
|
+
# :method: option_values
|
498
|
+
# gets a list of values for the given option
|
499
|
+
#
|
500
|
+
# :call-seq:
|
501
|
+
# option_values(option_id, options = {})
|
229
502
|
|
230
|
-
|
231
|
-
#
|
503
|
+
##
|
504
|
+
# :method: option_value
|
505
|
+
# gets the value with the given id for the given option
|
506
|
+
#
|
507
|
+
# :call-seq:
|
508
|
+
# option_value(option_id, id, options = {})
|
232
509
|
|
233
|
-
|
234
|
-
#
|
510
|
+
##
|
511
|
+
# :method: create_option_value
|
512
|
+
# creates a value with the given attributes for the given option
|
513
|
+
#
|
514
|
+
# :call-seq:
|
515
|
+
# create_option_value(option_id, options = {})
|
235
516
|
|
236
|
-
|
237
|
-
#
|
517
|
+
##
|
518
|
+
# :method: update_option_value
|
519
|
+
# update the attributes of the value with the given id for the given option
|
520
|
+
#
|
521
|
+
# :call-seq:
|
522
|
+
# update_option_value(option_id, id, options = {})
|
238
523
|
|
239
|
-
|
240
|
-
#
|
524
|
+
##
|
525
|
+
# :method: delete_option_value
|
526
|
+
# deletes the value with the given id for the given option
|
527
|
+
#
|
528
|
+
# :call-seq:
|
529
|
+
# delete_option_value(option_id, id)
|
530
|
+
|
531
|
+
##
|
532
|
+
# :method: order_statuses
|
533
|
+
# gets a list of order_statuses
|
534
|
+
#
|
535
|
+
# :call-seq:
|
536
|
+
# order_statuses(options = {})
|
537
|
+
|
538
|
+
##
|
539
|
+
# :method: order_status
|
540
|
+
# gets the order_status with the given id
|
541
|
+
#
|
542
|
+
# :call-seq:
|
543
|
+
# order_status(id, options = {})
|
241
544
|
|
242
|
-
|
545
|
+
##
|
546
|
+
# :method: orders
|
243
547
|
# gets a list of orders
|
548
|
+
#
|
549
|
+
# :call-seq:
|
550
|
+
# orders(options = {})
|
244
551
|
|
245
|
-
|
552
|
+
##
|
553
|
+
# :method: order
|
246
554
|
# gets the order with the given id
|
555
|
+
#
|
556
|
+
# :call-seq:
|
557
|
+
# order(id, options = {})
|
247
558
|
|
248
|
-
|
559
|
+
##
|
560
|
+
# :method: create_order
|
249
561
|
# creates a order with the given attributes
|
562
|
+
#
|
563
|
+
# :call-seq:
|
564
|
+
# create_order(options = {})
|
250
565
|
|
251
|
-
|
252
|
-
#
|
566
|
+
##
|
567
|
+
# :method: update_order
|
568
|
+
# update the attributes of the order with the given id
|
569
|
+
#
|
570
|
+
# :call-seq:
|
571
|
+
# update_order(id, options = {})
|
253
572
|
|
254
|
-
|
573
|
+
##
|
574
|
+
# :method: delete_order
|
255
575
|
# deletes the order with the given id
|
576
|
+
#
|
577
|
+
# :call-seq:
|
578
|
+
# delete_order(id)
|
256
579
|
|
257
|
-
|
258
|
-
#
|
580
|
+
##
|
581
|
+
# :method: orders_count
|
582
|
+
# returns the number of orders
|
583
|
+
#
|
584
|
+
# :call-seq:
|
585
|
+
# orders_count(options = {})
|
259
586
|
|
260
|
-
|
587
|
+
##
|
588
|
+
# :method: order_coupons
|
589
|
+
# gets a list of coupons for the given order
|
590
|
+
#
|
591
|
+
# :call-seq:
|
592
|
+
# order_coupons(order_id, options = {})
|
593
|
+
|
594
|
+
##
|
595
|
+
# :method: order_coupon
|
596
|
+
# gets the coupon with the given id for the given order
|
597
|
+
#
|
598
|
+
# :call-seq:
|
599
|
+
# order_coupon(order_id, id, options = {})
|
600
|
+
|
601
|
+
##
|
602
|
+
# :method: order_messages
|
261
603
|
# gets a list of messages for the given order
|
604
|
+
#
|
605
|
+
# :call-seq:
|
606
|
+
# order_messages(order_id, options = {})
|
262
607
|
|
263
|
-
|
608
|
+
##
|
609
|
+
# :method: order_message
|
264
610
|
# gets the message with the given id for the given order
|
611
|
+
#
|
612
|
+
# :call-seq:
|
613
|
+
# order_message(order_id, id, options = {})
|
265
614
|
|
266
|
-
|
615
|
+
##
|
616
|
+
# :method: order_products
|
267
617
|
# gets a list of products for the given order
|
618
|
+
#
|
619
|
+
# :call-seq:
|
620
|
+
# order_products(order_id, options = {})
|
268
621
|
|
269
|
-
|
622
|
+
##
|
623
|
+
# :method: order_product
|
270
624
|
# gets the product with the given id for the given order
|
625
|
+
#
|
626
|
+
# :call-seq:
|
627
|
+
# order_product(order_id, id, options = {})
|
271
628
|
|
272
|
-
|
629
|
+
##
|
630
|
+
# :method: order_products_count
|
631
|
+
# returns the number of products for the given order
|
632
|
+
#
|
633
|
+
# :call-seq:
|
634
|
+
# order_products_count(order_id, options = {})
|
635
|
+
|
636
|
+
##
|
637
|
+
# :method: order_shipments
|
273
638
|
# gets a list of shipments for the given order
|
639
|
+
#
|
640
|
+
# :call-seq:
|
641
|
+
# order_shipments(order_id, options = {})
|
274
642
|
|
275
|
-
|
643
|
+
##
|
644
|
+
# :method: order_shipment
|
276
645
|
# gets the shipment with the given id for the given order
|
646
|
+
#
|
647
|
+
# :call-seq:
|
648
|
+
# order_shipment(order_id, id, options = {})
|
277
649
|
|
278
|
-
|
650
|
+
##
|
651
|
+
# :method: create_order_shipment
|
279
652
|
# creates a shipment with the given attributes for the given order
|
653
|
+
#
|
654
|
+
# :call-seq:
|
655
|
+
# create_order_shipment(order_id, options = {})
|
280
656
|
|
281
|
-
|
282
|
-
#
|
657
|
+
##
|
658
|
+
# :method: update_order_shipment
|
659
|
+
# update the attributes of the shipment with the given id for the given order
|
660
|
+
#
|
661
|
+
# :call-seq:
|
662
|
+
# update_order_shipment(order_id, id, options = {})
|
283
663
|
|
284
|
-
|
664
|
+
##
|
665
|
+
# :method: delete_order_shipment
|
285
666
|
# deletes the shipment with the given id for the given order
|
667
|
+
#
|
668
|
+
# :call-seq:
|
669
|
+
# delete_order_shipment(order_id, id)
|
286
670
|
|
287
|
-
|
671
|
+
##
|
672
|
+
# :method: order_shipping_addresses
|
288
673
|
# gets a list of shipping_addresses for the given order
|
674
|
+
#
|
675
|
+
# :call-seq:
|
676
|
+
# order_shipping_addresses(order_id, options = {})
|
289
677
|
|
290
|
-
|
678
|
+
##
|
679
|
+
# :method: order_shipping_address
|
291
680
|
# gets the shipping_address with the given id for the given order
|
681
|
+
#
|
682
|
+
# :call-seq:
|
683
|
+
# order_shipping_address(order_id, id, options = {})
|
684
|
+
|
685
|
+
##
|
686
|
+
# :method: order_taxes
|
687
|
+
# gets a list of taxes for the given order
|
688
|
+
#
|
689
|
+
# :call-seq:
|
690
|
+
# order_taxes(order_id, options = {})
|
292
691
|
|
293
|
-
|
692
|
+
##
|
693
|
+
# :method: order_tax
|
694
|
+
# gets the tax with the given id for the given order
|
695
|
+
#
|
696
|
+
# :call-seq:
|
697
|
+
# order_tax(order_id, id, options = {})
|
698
|
+
|
699
|
+
##
|
700
|
+
# :method: payment_methods
|
294
701
|
# gets a list of methods
|
702
|
+
#
|
703
|
+
# :call-seq:
|
704
|
+
# payment_methods(options = {})
|
295
705
|
|
296
|
-
|
706
|
+
##
|
707
|
+
# :method: products
|
297
708
|
# gets a list of products
|
709
|
+
#
|
710
|
+
# :call-seq:
|
711
|
+
# products(options = {})
|
298
712
|
|
299
|
-
|
713
|
+
##
|
714
|
+
# :method: product
|
300
715
|
# gets the product with the given id
|
716
|
+
#
|
717
|
+
# :call-seq:
|
718
|
+
# product(id, options = {})
|
301
719
|
|
302
|
-
|
720
|
+
##
|
721
|
+
# :method: create_product
|
303
722
|
# creates a product with the given attributes
|
723
|
+
#
|
724
|
+
# :call-seq:
|
725
|
+
# create_product(options = {})
|
304
726
|
|
305
|
-
|
306
|
-
#
|
727
|
+
##
|
728
|
+
# :method: update_product
|
729
|
+
# update the attributes of the product with the given id
|
730
|
+
#
|
731
|
+
# :call-seq:
|
732
|
+
# update_product(id, options = {})
|
307
733
|
|
308
|
-
|
734
|
+
##
|
735
|
+
# :method: delete_product
|
309
736
|
# deletes the product with the given id
|
737
|
+
#
|
738
|
+
# :call-seq:
|
739
|
+
# delete_product(id)
|
310
740
|
|
311
|
-
|
312
|
-
#
|
741
|
+
##
|
742
|
+
# :method: products_count
|
743
|
+
# returns the number of products
|
744
|
+
#
|
745
|
+
# :call-seq:
|
746
|
+
# products_count(options = {})
|
313
747
|
|
314
|
-
|
748
|
+
##
|
749
|
+
# :method: product_custom_fields
|
315
750
|
# gets a list of custom_fields for the given product
|
751
|
+
#
|
752
|
+
# :call-seq:
|
753
|
+
# product_custom_fields(product_id, options = {})
|
316
754
|
|
317
|
-
|
755
|
+
##
|
756
|
+
# :method: product_custom_field
|
318
757
|
# gets the custom_field with the given id for the given product
|
758
|
+
#
|
759
|
+
# :call-seq:
|
760
|
+
# product_custom_field(product_id, id, options = {})
|
319
761
|
|
320
|
-
|
762
|
+
##
|
763
|
+
# :method: create_product_custom_field
|
321
764
|
# creates a custom_field with the given attributes for the given product
|
765
|
+
#
|
766
|
+
# :call-seq:
|
767
|
+
# create_product_custom_field(product_id, options = {})
|
322
768
|
|
323
|
-
|
324
|
-
#
|
769
|
+
##
|
770
|
+
# :method: update_product_custom_field
|
771
|
+
# update the attributes of the custom_field with the given id for the given product
|
772
|
+
#
|
773
|
+
# :call-seq:
|
774
|
+
# update_product_custom_field(product_id, id, options = {})
|
325
775
|
|
326
|
-
|
776
|
+
##
|
777
|
+
# :method: delete_product_custom_field
|
327
778
|
# deletes the custom_field with the given id for the given product
|
779
|
+
#
|
780
|
+
# :call-seq:
|
781
|
+
# delete_product_custom_field(product_id, id)
|
328
782
|
|
329
|
-
|
783
|
+
##
|
784
|
+
# :method: product_discount_rules
|
330
785
|
# gets a list of discount_rules for the given product
|
786
|
+
#
|
787
|
+
# :call-seq:
|
788
|
+
# product_discount_rules(product_id, options = {})
|
331
789
|
|
332
|
-
|
790
|
+
##
|
791
|
+
# :method: product_discount_rule
|
333
792
|
# gets the discount_rule with the given id for the given product
|
793
|
+
#
|
794
|
+
# :call-seq:
|
795
|
+
# product_discount_rule(product_id, id, options = {})
|
334
796
|
|
335
|
-
|
797
|
+
##
|
798
|
+
# :method: create_product_discount_rule
|
336
799
|
# creates a discount_rule with the given attributes for the given product
|
800
|
+
#
|
801
|
+
# :call-seq:
|
802
|
+
# create_product_discount_rule(product_id, options = {})
|
337
803
|
|
338
|
-
|
339
|
-
#
|
804
|
+
##
|
805
|
+
# :method: update_product_discount_rule
|
806
|
+
# update the attributes of the discount_rule with the given id for the given product
|
807
|
+
#
|
808
|
+
# :call-seq:
|
809
|
+
# update_product_discount_rule(product_id, id, options = {})
|
340
810
|
|
341
|
-
|
811
|
+
##
|
812
|
+
# :method: delete_product_discount_rule
|
342
813
|
# deletes the discount_rule with the given id for the given product
|
814
|
+
#
|
815
|
+
# :call-seq:
|
816
|
+
# delete_product_discount_rule(product_id, id)
|
343
817
|
|
344
|
-
|
818
|
+
##
|
819
|
+
# :method: product_discount_rules_count
|
820
|
+
# returns the number of discount_rules for the given product
|
821
|
+
#
|
822
|
+
# :call-seq:
|
823
|
+
# product_discount_rules_count(product_id, options = {})
|
824
|
+
|
825
|
+
##
|
826
|
+
# :method: product_configurable_fields
|
345
827
|
# gets a list of configurable_fields for the given product
|
828
|
+
#
|
829
|
+
# :call-seq:
|
830
|
+
# product_configurable_fields(product_id, options = {})
|
346
831
|
|
347
|
-
|
832
|
+
##
|
833
|
+
# :method: product_configurable_field
|
348
834
|
# gets the configurable_field with the given id for the given product
|
835
|
+
#
|
836
|
+
# :call-seq:
|
837
|
+
# product_configurable_field(product_id, id, options = {})
|
349
838
|
|
350
|
-
|
839
|
+
##
|
840
|
+
# :method: delete_product_configurable_field
|
351
841
|
# deletes the configurable_field with the given id for the given product
|
842
|
+
#
|
843
|
+
# :call-seq:
|
844
|
+
# delete_product_configurable_field(product_id, id)
|
352
845
|
|
353
|
-
|
846
|
+
##
|
847
|
+
# :method: product_configurable_fields_count
|
848
|
+
# returns the number of configurable_fields for the given product
|
849
|
+
#
|
850
|
+
# :call-seq:
|
851
|
+
# product_configurable_fields_count(product_id, options = {})
|
852
|
+
|
853
|
+
##
|
854
|
+
# :method: product_images
|
354
855
|
# gets a list of images for the given product
|
856
|
+
#
|
857
|
+
# :call-seq:
|
858
|
+
# product_images(product_id, options = {})
|
355
859
|
|
356
|
-
|
860
|
+
##
|
861
|
+
# :method: product_image
|
357
862
|
# gets the image with the given id for the given product
|
863
|
+
#
|
864
|
+
# :call-seq:
|
865
|
+
# product_image(product_id, id, options = {})
|
358
866
|
|
359
|
-
|
867
|
+
##
|
868
|
+
# :method: create_product_image
|
360
869
|
# creates a image with the given attributes for the given product
|
870
|
+
#
|
871
|
+
# :call-seq:
|
872
|
+
# create_product_image(product_id, options = {})
|
361
873
|
|
362
|
-
|
363
|
-
#
|
874
|
+
##
|
875
|
+
# :method: update_product_image
|
876
|
+
# update the attributes of the image with the given id for the given product
|
877
|
+
#
|
878
|
+
# :call-seq:
|
879
|
+
# update_product_image(product_id, id, options = {})
|
364
880
|
|
365
|
-
|
881
|
+
##
|
882
|
+
# :method: delete_product_image
|
366
883
|
# deletes the image with the given id for the given product
|
884
|
+
#
|
885
|
+
# :call-seq:
|
886
|
+
# delete_product_image(product_id, id)
|
887
|
+
|
888
|
+
##
|
889
|
+
# :method: product_images_count
|
890
|
+
# returns the number of images for the given product
|
891
|
+
#
|
892
|
+
# :call-seq:
|
893
|
+
# product_images_count(product_id, options = {})
|
367
894
|
|
368
|
-
|
895
|
+
##
|
896
|
+
# :method: product_options
|
369
897
|
# gets a list of options for the given product
|
898
|
+
#
|
899
|
+
# :call-seq:
|
900
|
+
# product_options(product_id, options = {})
|
370
901
|
|
371
|
-
|
902
|
+
##
|
903
|
+
# :method: product_option
|
372
904
|
# gets the option with the given id for the given product
|
905
|
+
#
|
906
|
+
# :call-seq:
|
907
|
+
# product_option(product_id, id, options = {})
|
373
908
|
|
374
|
-
|
909
|
+
##
|
910
|
+
# :method: product_reviews
|
375
911
|
# gets a list of reviews for the given product
|
912
|
+
#
|
913
|
+
# :call-seq:
|
914
|
+
# product_reviews(product_id, options = {})
|
376
915
|
|
377
|
-
|
916
|
+
##
|
917
|
+
# :method: product_rules
|
378
918
|
# gets a list of rules for the given product
|
919
|
+
#
|
920
|
+
# :call-seq:
|
921
|
+
# product_rules(product_id, options = {})
|
379
922
|
|
380
|
-
|
923
|
+
##
|
924
|
+
# :method: product_rule
|
381
925
|
# gets the rule with the given id for the given product
|
926
|
+
#
|
927
|
+
# :call-seq:
|
928
|
+
# product_rule(product_id, id, options = {})
|
382
929
|
|
383
|
-
|
930
|
+
##
|
931
|
+
# :method: create_product_rule
|
384
932
|
# creates a rule with the given attributes for the given product
|
933
|
+
#
|
934
|
+
# :call-seq:
|
935
|
+
# create_product_rule(product_id, options = {})
|
385
936
|
|
386
|
-
|
387
|
-
#
|
937
|
+
##
|
938
|
+
# :method: update_product_rule
|
939
|
+
# update the attributes of the rule with the given id for the given product
|
940
|
+
#
|
941
|
+
# :call-seq:
|
942
|
+
# update_product_rule(product_id, id, options = {})
|
388
943
|
|
389
|
-
|
944
|
+
##
|
945
|
+
# :method: delete_product_rule
|
390
946
|
# deletes the rule with the given id for the given product
|
947
|
+
#
|
948
|
+
# :call-seq:
|
949
|
+
# delete_product_rule(product_id, id)
|
391
950
|
|
392
|
-
|
951
|
+
##
|
952
|
+
# :method: product_rules_count
|
953
|
+
# returns the number of rules for the given product
|
954
|
+
#
|
955
|
+
# :call-seq:
|
956
|
+
# product_rules_count(product_id, options = {})
|
957
|
+
|
958
|
+
##
|
959
|
+
# :method: product_videos
|
393
960
|
# gets a list of videos for the given product
|
961
|
+
#
|
962
|
+
# :call-seq:
|
963
|
+
# product_videos(product_id, options = {})
|
394
964
|
|
395
|
-
|
965
|
+
##
|
966
|
+
# :method: product_video
|
396
967
|
# gets the video with the given id for the given product
|
968
|
+
#
|
969
|
+
# :call-seq:
|
970
|
+
# product_video(product_id, id, options = {})
|
397
971
|
|
398
|
-
|
972
|
+
##
|
973
|
+
# :method: create_product_video
|
399
974
|
# creates a video with the given attributes for the given product
|
975
|
+
#
|
976
|
+
# :call-seq:
|
977
|
+
# create_product_video(product_id, options = {})
|
400
978
|
|
401
|
-
|
402
|
-
#
|
979
|
+
##
|
980
|
+
# :method: update_product_video
|
981
|
+
# update the attributes of the video with the given id for the given product
|
982
|
+
#
|
983
|
+
# :call-seq:
|
984
|
+
# update_product_video(product_id, id, options = {})
|
403
985
|
|
404
|
-
|
986
|
+
##
|
987
|
+
# :method: delete_product_video
|
405
988
|
# deletes the video with the given id for the given product
|
989
|
+
#
|
990
|
+
# :call-seq:
|
991
|
+
# delete_product_video(product_id, id)
|
992
|
+
|
993
|
+
##
|
994
|
+
# :method: product_videos_count
|
995
|
+
# returns the number of videos for the given product
|
996
|
+
#
|
997
|
+
# :call-seq:
|
998
|
+
# product_videos_count(product_id, options = {})
|
406
999
|
|
407
|
-
|
1000
|
+
##
|
1001
|
+
# :method: product_skus
|
408
1002
|
# gets a list of skus for the given product
|
1003
|
+
#
|
1004
|
+
# :call-seq:
|
1005
|
+
# product_skus(product_id, options = {})
|
409
1006
|
|
410
|
-
|
1007
|
+
##
|
1008
|
+
# :method: product_sku
|
411
1009
|
# gets the sku with the given id for the given product
|
1010
|
+
#
|
1011
|
+
# :call-seq:
|
1012
|
+
# product_sku(product_id, id, options = {})
|
412
1013
|
|
413
|
-
|
1014
|
+
##
|
1015
|
+
# :method: create_product_sku
|
414
1016
|
# creates a sku with the given attributes for the given product
|
1017
|
+
#
|
1018
|
+
# :call-seq:
|
1019
|
+
# create_product_sku(product_id, options = {})
|
415
1020
|
|
416
|
-
|
417
|
-
#
|
1021
|
+
##
|
1022
|
+
# :method: update_product_sku
|
1023
|
+
# update the attributes of the sku with the given id for the given product
|
1024
|
+
#
|
1025
|
+
# :call-seq:
|
1026
|
+
# update_product_sku(product_id, id, options = {})
|
418
1027
|
|
419
|
-
|
1028
|
+
##
|
1029
|
+
# :method: delete_product_sku
|
420
1030
|
# deletes the sku with the given id for the given product
|
1031
|
+
#
|
1032
|
+
# :call-seq:
|
1033
|
+
# delete_product_sku(product_id, id)
|
421
1034
|
|
422
|
-
|
1035
|
+
##
|
1036
|
+
# :method: product_skus_count
|
1037
|
+
# returns the number of skus for the given product
|
1038
|
+
#
|
1039
|
+
# :call-seq:
|
1040
|
+
# product_skus_count(product_id, options = {})
|
1041
|
+
|
1042
|
+
##
|
1043
|
+
# :method: redirects
|
423
1044
|
# gets a list of redirects
|
1045
|
+
#
|
1046
|
+
# :call-seq:
|
1047
|
+
# redirects(options = {})
|
424
1048
|
|
425
|
-
|
1049
|
+
##
|
1050
|
+
# :method: redirect
|
426
1051
|
# gets the redirect with the given id
|
1052
|
+
#
|
1053
|
+
# :call-seq:
|
1054
|
+
# redirect(id, options = {})
|
427
1055
|
|
428
|
-
|
1056
|
+
##
|
1057
|
+
# :method: create_redirect
|
429
1058
|
# creates a redirect with the given attributes
|
1059
|
+
#
|
1060
|
+
# :call-seq:
|
1061
|
+
# create_redirect(options = {})
|
430
1062
|
|
431
|
-
|
432
|
-
#
|
1063
|
+
##
|
1064
|
+
# :method: update_redirect
|
1065
|
+
# update the attributes of the redirect with the given id
|
1066
|
+
#
|
1067
|
+
# :call-seq:
|
1068
|
+
# update_redirect(id, options = {})
|
433
1069
|
|
434
|
-
|
1070
|
+
##
|
1071
|
+
# :method: delete_redirect
|
435
1072
|
# deletes the redirect with the given id
|
1073
|
+
#
|
1074
|
+
# :call-seq:
|
1075
|
+
# delete_redirect(id)
|
436
1076
|
|
437
|
-
|
1077
|
+
##
|
1078
|
+
# :method: redirects_count
|
1079
|
+
# returns the number of redirects
|
1080
|
+
#
|
1081
|
+
# :call-seq:
|
1082
|
+
# redirects_count(options = {})
|
1083
|
+
|
1084
|
+
##
|
1085
|
+
# :method: shipping_methods
|
438
1086
|
# gets a list of methods
|
1087
|
+
#
|
1088
|
+
# :call-seq:
|
1089
|
+
# shipping_methods(options = {})
|
439
1090
|
|
440
|
-
|
1091
|
+
##
|
1092
|
+
# :method: shipping_method
|
441
1093
|
# gets the method with the given id
|
1094
|
+
#
|
1095
|
+
# :call-seq:
|
1096
|
+
# shipping_method(id, options = {})
|
442
1097
|
|
443
|
-
|
1098
|
+
##
|
1099
|
+
# :method: tax_classes
|
444
1100
|
# gets a list of tax_classes
|
1101
|
+
#
|
1102
|
+
# :call-seq:
|
1103
|
+
# tax_classes(options = {})
|
445
1104
|
|
446
|
-
|
1105
|
+
##
|
1106
|
+
# :method: tax_class
|
447
1107
|
# gets the tax_class with the given id
|
1108
|
+
#
|
1109
|
+
# :call-seq:
|
1110
|
+
# tax_class(id, options = {})
|
448
1111
|
|
449
|
-
|
1112
|
+
##
|
1113
|
+
# :method: hooks
|
450
1114
|
# gets a list of hooks
|
1115
|
+
#
|
1116
|
+
# :call-seq:
|
1117
|
+
# hooks(options = {})
|
451
1118
|
|
452
|
-
|
1119
|
+
##
|
1120
|
+
# :method: hook
|
453
1121
|
# gets the hook with the given id
|
1122
|
+
#
|
1123
|
+
# :call-seq:
|
1124
|
+
# hook(id, options = {})
|
454
1125
|
|
455
|
-
|
1126
|
+
##
|
1127
|
+
# :method: create_hook
|
456
1128
|
# creates a hook with the given attributes
|
1129
|
+
#
|
1130
|
+
# :call-seq:
|
1131
|
+
# create_hook(options = {})
|
457
1132
|
|
458
|
-
|
459
|
-
#
|
1133
|
+
##
|
1134
|
+
# :method: update_hook
|
1135
|
+
# update the attributes of the hook with the given id
|
1136
|
+
#
|
1137
|
+
# :call-seq:
|
1138
|
+
# update_hook(id, options = {})
|
460
1139
|
|
461
|
-
|
1140
|
+
##
|
1141
|
+
# :method: delete_hook
|
462
1142
|
# deletes the hook with the given id
|
1143
|
+
#
|
1144
|
+
# :call-seq:
|
1145
|
+
# delete_hook(id)
|
463
1146
|
|
464
1147
|
end
|
465
1148
|
end
|