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