peddler 1.2.0 → 1.3.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +50 -28
  3. data/lib/mws.rb +2 -0
  4. data/lib/mws/cart_information/client.rb +7 -6
  5. data/lib/mws/customer_information/client.rb +6 -6
  6. data/lib/mws/feeds/client.rb +8 -8
  7. data/lib/mws/finances/client.rb +6 -6
  8. data/lib/mws/fulfillment_inbound_shipment/client.rb +41 -40
  9. data/lib/mws/fulfillment_inventory/client.rb +3 -3
  10. data/lib/mws/fulfillment_outbound_shipment/client.rb +18 -18
  11. data/lib/mws/merchant_fulfillment.rb +1 -0
  12. data/lib/mws/merchant_fulfillment/client.rb +88 -0
  13. data/lib/mws/off_amazon_payments/client.rb +203 -202
  14. data/lib/mws/orders/client.rb +6 -6
  15. data/lib/mws/products/client.rb +38 -38
  16. data/lib/mws/recommendations/client.rb +4 -4
  17. data/lib/mws/reports/client.rb +19 -17
  18. data/lib/mws/sellers/client.rb +2 -2
  19. data/lib/mws/subscriptions/client.rb +22 -22
  20. data/lib/mws/webstore/client.rb +8 -8
  21. data/lib/peddler/client.rb +7 -7
  22. data/lib/peddler/flat_file_parser.rb +1 -1
  23. data/lib/peddler/marketplace.rb +2 -2
  24. data/lib/peddler/operation.rb +7 -12
  25. data/lib/peddler/vcr_matcher.rb +5 -3
  26. data/lib/peddler/version.rb +2 -1
  27. data/test/helper.rb +11 -2
  28. data/test/integration/test_fulfillment_inbound_shipment.rb +1 -1
  29. data/test/integration/test_merchant_fulfillment.rb +11 -0
  30. data/test/integration/test_orders.rb +20 -0
  31. data/test/unit/mws/test_merchant_fulfillment_client.rb +83 -0
  32. data/test/unit/peddler/test_client.rb +12 -10
  33. data/test/unit/peddler/test_vcr_matcher.rb +3 -3
  34. data/test/vcr_cassettes/MerchantFulfillment.yml +195 -0
  35. data/test/vcr_cassettes/Orders.yml +1902 -5
  36. metadata +10 -2
@@ -5,7 +5,7 @@ module MWS
5
5
  # With the MWS Orders API, you can list orders created or updated during a
6
6
  # time frame you specify or retrieve information about specific orders.
7
7
  class Client < ::Peddler::Client
8
- version "2013-09-01"
8
+ version '2013-09-01'
9
9
  path "/Orders/#{version}"
10
10
 
11
11
  # Lists orders
@@ -14,7 +14,7 @@ module MWS
14
14
  # either created_after or last_updated_after. When requesting orders by
15
15
  # "Unshipped" status you must also request "PartiallyShipped" orders.
16
16
  # @see http://docs.developer.amazonservices.com/en_US/orders/2013-09-01/Orders_ListOrders.html
17
- # @param opts [Hash]
17
+ # @param [Hash] opts
18
18
  # @option opts [String, #iso8601] :created_after
19
19
  # @option opts [String, #iso8601] :created_before
20
20
  # @option opts [String, #iso8601] :last_updated_after
@@ -48,7 +48,7 @@ module MWS
48
48
  # Lists the next page of orders
49
49
  #
50
50
  # @see http://docs.developer.amazonservices.com/en_US/orders/2013-09-01/Orders_ListOrdersByNextToken.html
51
- # @param next_token [String]
51
+ # @param [String] next_token
52
52
  # @return [Peddler::XMLParser]
53
53
  def list_orders_by_next_token(next_token)
54
54
  operation('ListOrdersByNextToken')
@@ -60,7 +60,7 @@ module MWS
60
60
  # Gets one or more orders
61
61
  #
62
62
  # @see http://docs.developer.amazonservices.com/en_US/orders/2013-09-01/Orders_GetOrder.html
63
- # @param amazon_order_ids [Array<String>]
63
+ # @param [String] amazon_order_id one or more amazon_order_ids
64
64
  # @return [Peddler::XMLParser]
65
65
  def get_order(*amazon_order_ids)
66
66
  operation('GetOrder')
@@ -73,7 +73,7 @@ module MWS
73
73
  # Lists order items for an order
74
74
  #
75
75
  # @see http://docs.developer.amazonservices.com/en_US/orders/2013-09-01/Orders_ListOrderItems.html
76
- # @param amazon_order_id [String]
76
+ # @param [String] amazon_order_id
77
77
  # @return [Peddler::XMLParser]
78
78
  def list_order_items(amazon_order_id)
79
79
  operation('ListOrderItems')
@@ -85,7 +85,7 @@ module MWS
85
85
  # Lists the next page of order items for an order
86
86
  #
87
87
  # @see http://docs.developer.amazonservices.com/en_US/orders/2013-09-01/Orders_ListOrderItemsByNextToken.html
88
- # @param next_token [String]
88
+ # @param [String] next_token
89
89
  # @return [Peddler::XMLParser]
90
90
  def list_order_items_by_next_token(next_token)
91
91
  operation('ListOrderItemsByNextToken')
@@ -7,15 +7,15 @@ module MWS
7
7
  # sourcing and pricing decisions for listing those products on Amazon
8
8
  # Marketplace websites.
9
9
  class Client < ::Peddler::Client
10
- version "2011-10-01"
10
+ version '2011-10-01'
11
11
  path "/Products/#{version}"
12
12
 
13
13
  # Lists products and their attributes, based on a search query
14
14
  #
15
15
  # @see http://docs.developer.amazonservices.com/en_US/products/Products_ListMatchingProducts.html
16
16
  # @overload list_matching_products(query, opts = { marketplace_id: primary_marketplace_id })
17
- # @param query [String]
18
- # @param opts [Hash]
17
+ # @param [String] query
18
+ # @param [Hash] opts
19
19
  # @option opts [String] :marketplace_id
20
20
  # @option opts [String] :query_context_id
21
21
  # @return [Peddler::XMLParser]
@@ -30,10 +30,10 @@ module MWS
30
30
  # SellerSKU, UPC, EAN, ISBN, and JAN values
31
31
  #
32
32
  # @see http://docs.developer.amazonservices.com/en_US/products/Products_GetMatchingProduct.html
33
- # @overload get_matching_product_for_id(id_type, *id_list, opts = { marketplace_id: primary_marketplace_id })
34
- # @param id_type [String]
35
- # @param id_list [Array<String>]
36
- # @param opts [Hash]
33
+ # @overload get_matching_product_for_id(id_type, *ids, opts = { marketplace_id: primary_marketplace_id })
34
+ # @param [String] id_type
35
+ # @param [String] id one or more ids
36
+ # @param [Hash] opts
37
37
  # @option opts [String] :marketplace_id
38
38
  # @return [Peddler::XMLParser]
39
39
  def get_matching_product_for_id(id_type, *id_list)
@@ -49,9 +49,9 @@ module MWS
49
49
  # Lists products and their attributes, based on a list of ASIN values
50
50
  #
51
51
  # @see http://docs.developer.amazonservices.com/en_US/products/Products_GetMatchingProductForId.html
52
- # @overload get_matching_product(*asin_list, opts = { marketplace_id: primary_marketplace_id })
53
- # @param asin_list [Array<String>]
54
- # @param opts [Hash]
52
+ # @overload get_matching_product(*asins, opts = { marketplace_id: primary_marketplace_id })
53
+ # @param [String] asin one or more asins
54
+ # @param [Hash] opts
55
55
  # @option opts [String] :marketplace_id
56
56
  # @return [Peddler::XMLParser]
57
57
  def get_matching_product(*asin_list)
@@ -67,9 +67,9 @@ module MWS
67
67
  # Gets the current competitive price of a product, based on Seller SKU
68
68
  #
69
69
  # @see http://docs.developer.amazonservices.com/en_US/products/Products_GetCompetitivePricingForSKU.html
70
- # @overload get_competitive_pricing_for_sku(*seller_sku_list, opts = { marketplace_id: primary_marketplace_id })
71
- # @param seller_sku_list [Array<String>]
72
- # @param opts [Hash]
70
+ # @overload get_competitive_pricing_for_sku(*seller_skus, opts = { marketplace_id: primary_marketplace_id })
71
+ # @param [String] seller_sku one or more seller_skus
72
+ # @param [Hash] opts
73
73
  # @option opts [String] :marketplace_id
74
74
  # @return [Peddler::XMLParser]
75
75
  def get_competitive_pricing_for_sku(*seller_sku_list)
@@ -85,9 +85,9 @@ module MWS
85
85
  # Gets the current competitive price of a product, identified by its ASIN
86
86
  #
87
87
  # @see http://docs.developer.amazonservices.com/en_US/products/Products_GetCompetitivePricingForASIN.html
88
- # @overload get_competitive_pricing_for_asin(*asin_list, opts = { marketplace_id: primary_marketplace_id })
89
- # @param asin_list [Array<String>]
90
- # @param opts [Hash]
88
+ # @overload get_competitive_pricing_for_asin(*asins, opts = { marketplace_id: primary_marketplace_id })
89
+ # @param [String] asin one or more asins
90
+ # @param [Hash] opts
91
91
  # @option opts [String] :marketplace_id
92
92
  # @return [Peddler::XMLParser]
93
93
  def get_competitive_pricing_for_asin(*asin_list)
@@ -104,9 +104,9 @@ module MWS
104
104
  # a product, based on Seller SKU
105
105
  #
106
106
  # @see http://docs.developer.amazonservices.com/en_US/products/Products_GetLowestOfferListingsForSKU.html
107
- # @overload get_lowest_offer_listings_for_sku(*seller_sku_list, opts = { marketplace_id: primary_marketplace_id })
108
- # @param seller_sku_list [Array<String>]
109
- # @param opts [Hash]
107
+ # @overload get_lowest_offer_listings_for_sku(*seller_skus, opts = { marketplace_id: primary_marketplace_id })
108
+ # @param [String] seller_sku one or more seller_skus
109
+ # @param [Hash] opts
110
110
  # @option opts [String] :marketplace_id
111
111
  # @option opts [String] :item_condition
112
112
  # @option opts [Boolean] :exclude_me
@@ -125,9 +125,9 @@ module MWS
125
125
  # a product, identified by its ASIN
126
126
  #
127
127
  # @see http://docs.developer.amazonservices.com/en_US/products/Products_GetLowestOfferListingsForASIN.html
128
- # @overload get_lowest_offer_listings_for_asin(*asin_list, opts = { marketplace_id: primary_marketplace_id })
129
- # @param asin_list [Array<String>]
130
- # @param opts [Hash]
128
+ # @overload get_lowest_offer_listings_for_asin(*asins, opts = { marketplace_id: primary_marketplace_id })
129
+ # @param [String] asin one or more asins
130
+ # @param [Hash] opts
131
131
  # @option opts [String] :marketplace_id
132
132
  # @option opts [String] :item_condition
133
133
  # @option opts [Boolean] :exclude_me
@@ -146,9 +146,9 @@ module MWS
146
146
  #
147
147
  # @see http://docs.developer.amazonservices.com/en_MX/products/Products_GetLowestPricedOffersForSKU.html
148
148
  # @overload get_lowest_priced_offers_for_sku(seller_sku, item_condition, opts = { marketplace_id: primary_marketplace_id })
149
- # @param seller_sku [String]
150
- # @param item_condition [String]
151
- # @param opts [Hash]
149
+ # @param [String] seller_sku
150
+ # @param [String] item_condition
151
+ # @param [Hash] opts
152
152
  # @option opts [String] :marketplace_id
153
153
  # @return [Peddler::XMLParser]
154
154
  def get_lowest_priced_offers_for_sku(seller_sku, item_condition, opts = {})
@@ -166,9 +166,9 @@ module MWS
166
166
  #
167
167
  # @see http://docs.developer.amazonservices.com/en_MX/products/Products_GetLowestPricedOffersForASIN.html
168
168
  # @overload get_lowest_priced_offers_for_sku(asin, item_condition, opts = { marketplace_id: primary_marketplace_id })
169
- # @param asin [String]
170
- # @param item_condition [String]
171
- # @param opts [Hash]
169
+ # @param [String] asin
170
+ # @param [String] item_condition
171
+ # @param [Hash] opts
172
172
  # @option opts [String] :marketplace_id
173
173
  # @return [Peddler::XMLParser]
174
174
  def get_lowest_priced_offers_for_asin(asin, item_condition, opts = {})
@@ -186,9 +186,9 @@ module MWS
186
186
  # Seller SKU
187
187
  #
188
188
  # @see http://docs.developer.amazonservices.com/en_US/products/Products_GetMyPriceForSKU.html
189
- # @overload get_my_price_for_sku(*seller_sku_list, opts = { marketplace_id: primary_marketplace_id })
190
- # @param seller_sku_list [Array<String>]
191
- # @param opts [Hash]
189
+ # @overload get_my_price_for_sku(*seller_skus, opts = { marketplace_id: primary_marketplace_id })
190
+ # @param [String] seller_sku one or more seller_skus
191
+ # @param [Hash] opts
192
192
  # @option opts [String] :marketplace_id
193
193
  # @option opts [String] :item_condition
194
194
  # @return [Peddler::XMLParser]
@@ -206,9 +206,9 @@ module MWS
206
206
  # its ASIN
207
207
  #
208
208
  # @see http://docs.developer.amazonservices.com/en_US/products/Products_GetMyPriceForASIN.html
209
- # @overload get_my_price_for_asin(*seller_sku_list, opts = { marketplace_id: primary_marketplace_id })
210
- # @param asin_list [Array<String>]
211
- # @param opts [Hash]
209
+ # @overload get_my_price_for_asin(*asins, opts = { marketplace_id: primary_marketplace_id })
210
+ # @param [String] asin one or more asins
211
+ # @param [Hash] opts
212
212
  # @option opts [String] :marketplace_id
213
213
  # @option opts [String] :item_condition
214
214
  # @return [Peddler::XMLParser]
@@ -227,8 +227,8 @@ module MWS
227
227
  #
228
228
  # @see http://docs.developer.amazonservices.com/en_US/products/Products_GetProductCategoriesForSKU.html
229
229
  # @overload get_product_categories_for_sku(sku, opts = { marketplace_id: primary_marketplace_id })
230
- # @param seller_sku [String]
231
- # @param opts [Hash]
230
+ # @param [String] seller_sku
231
+ # @param [Hash] opts
232
232
  # @option opts [String] :marketplace_id
233
233
  # @return [Peddler::XMLParser]
234
234
  def get_product_categories_for_sku(seller_sku, opts = {})
@@ -242,8 +242,8 @@ module MWS
242
242
  #
243
243
  # @see http://docs.developer.amazonservices.com/en_US/products/Products_GetProductCategoriesForASIN.html
244
244
  # @overload get_product_categories_for_asin(asin, opts = { marketplace_id: primary_marketplace_id })
245
- # @param asin [String]
246
- # @param opts [Hash]
245
+ # @param [String] asin
246
+ # @param [Hash] opts
247
247
  # @option opts [String] :marketplace_id
248
248
  # @return [Peddler::XMLParser]
249
249
  def get_product_categories_for_asin(asin, opts = {})
@@ -7,7 +7,7 @@ module MWS
7
7
  # is an actionable, timely, and personalized opportunity to increase your
8
8
  # sales and performance.
9
9
  class Client < ::Peddler::Client
10
- version "2013-04-01"
10
+ version '2013-04-01'
11
11
  path "/Recommendations/#{version}"
12
12
 
13
13
  # Checks whether there are active recommendations for each category for
@@ -15,7 +15,7 @@ module MWS
15
15
  # recommendations were last updated for each category
16
16
  #
17
17
  # @see http://docs.developer.amazonservices.com/en_US/recommendations/Recommendations_GetLastUpdatedTimeForRecommendations.html
18
- # @param marketplace_id [String]
18
+ # @param [String] marketplace_id
19
19
  # @return [Peddler::XMLParser]
20
20
  def get_last_updated_time_for_recommendations(marketplace_id = primary_marketplace_id)
21
21
  operation('GetLastUpdatedTimeForRecommendations')
@@ -29,7 +29,7 @@ module MWS
29
29
  #
30
30
  # @see http://docs.developer.amazonservices.com/en_US/recommendations/Recommendations_ListRecommendations.html
31
31
  # @overload list_recommendations(opts = { marketplace_id: primary_marketplace_id })
32
- # @param opts [Hash]
32
+ # @param [Hash] opts
33
33
  # @option opts [String] :marketplace_id
34
34
  # @option opts [String] :recommendation_category
35
35
  # @option opts [Array<Struct, Hash>] :category_query_list
@@ -50,7 +50,7 @@ module MWS
50
50
  # Lists the next page of active recommendations
51
51
  #
52
52
  # @see http://docs.developer.amazonservices.com/en_US/recommendations/Recommendations_ListRecommendationsByNextToken.html
53
- # @param next_token [String]
53
+ # @param [String] next_token
54
54
  # @return [Peddler::XMLParser]
55
55
  def list_recommendations_by_next_token(next_token)
56
56
  operation('ListRecommendationsByNextToken')
@@ -9,8 +9,8 @@ module MWS
9
9
  # Creates a report request
10
10
  #
11
11
  # @see http://docs.developer.amazonservices.com/en_US/reports/Reports_RequestReport.html
12
- # @param report_type [String]
13
- # @param opts [Hash]
12
+ # @param [String] report_type
13
+ # @param [Hash] opts
14
14
  # @option opts [String, #iso8601] :start_date
15
15
  # @option opts [String, #iso8601] :end_date
16
16
  # @option opts [String] :report_options
@@ -27,7 +27,7 @@ module MWS
27
27
  # Lists report requests
28
28
  #
29
29
  # @see http://docs.developer.amazonservices.com/en_US/reports/Reports_GetReportRequestList.html
30
- # @param opts [Hash]
30
+ # @param [Hash] opts
31
31
  # @option opts [Array<String>, String] :report_request_id_list
32
32
  # @option opts [Array<String>, String] :report_type_list
33
33
  # @option opts [Array<String>, String] :report_processing_status_list
@@ -48,7 +48,7 @@ module MWS
48
48
  # Lists the next page of the report requests
49
49
  #
50
50
  # @see http://docs.developer.amazonservices.com/en_US/reports/Reports_GetReportRequestListByNextToken.html
51
- # @param next_token [String]
51
+ # @param [String] next_token
52
52
  # @return [Peddler::XMLParser]
53
53
  def get_report_request_list_by_next_token(next_token)
54
54
  operation('GetReportRequestListByNextToken')
@@ -60,7 +60,7 @@ module MWS
60
60
  # Counts requested reports
61
61
  #
62
62
  # @see http://docs.developer.amazonservices.com/en_US/reports/Reports_GetReportRequestCount.html
63
- # @param opts [Hash]
63
+ # @param [Hash] opts
64
64
  # @option opts [Array<String>, String] :report_type_list
65
65
  # @option opts [Array<String>, String] :report_processing_status_list
66
66
  # @option opts [String, #iso8601] :requested_from_date
@@ -78,7 +78,7 @@ module MWS
78
78
  # Cancels one or more report requests
79
79
  #
80
80
  # @see http://docs.developer.amazonservices.com/en_US/reports/Reports_CancelReportRequests.html
81
- # @param opts [Hash]
81
+ # @param [Hash] opts
82
82
  # @option opts [Array<String>, String] :report_type_list
83
83
  # @option opts [Array<String>, String] :report_processing_status_list
84
84
  # @option opts [String, #iso8601] :requested_from_date
@@ -96,7 +96,7 @@ module MWS
96
96
  # Lists reports
97
97
  #
98
98
  # @see http://docs.developer.amazonservices.com/en_US/reports/Reports_GetReportList.html
99
- # @param opts [Hash]
99
+ # @param [Hash] opts
100
100
  # @option opts [Integer] :max_count
101
101
  # @option opts [Array<String>, String] :report_type_list
102
102
  # @option opts [Boolean] :acknowledged
@@ -116,7 +116,7 @@ module MWS
116
116
  # Lists the next page of reports
117
117
  #
118
118
  # @see http://docs.developer.amazonservices.com/en_US/reports/Reports_GetReportListByNextToken.html
119
- # @param next_token [String]
119
+ # @param [String] next_token
120
120
  # @return [Peddler::XMLParser]
121
121
  def get_report_list_by_next_token(next_token)
122
122
  operation('GetReportListByNextToken')
@@ -128,7 +128,7 @@ module MWS
128
128
  # Counts reports
129
129
  #
130
130
  # @see http://docs.developer.amazonservices.com/en_US/reports/Reports_GetReportCount.html
131
- # @param opts [Hash]
131
+ # @param [Hash] opts
132
132
  # @option opts [Array<String>, String] :report_type_list
133
133
  # @option opts [Boolean] :acknowledged
134
134
  # @option opts [String, #iso8601] :available_from_date
@@ -145,7 +145,7 @@ module MWS
145
145
  # Gets a report and its Content-MD5 header
146
146
  #
147
147
  # @see http://docs.developer.amazonservices.com/en_US/reports/Reports_GetReport.html
148
- # @param report_id [String]
148
+ # @param [String] report_id
149
149
  # @return [Peddler::XMLParser] if report is in XML format
150
150
  # @return [Peddler::CSVParser] if report is a flat file
151
151
  def get_report(report_id, &blk)
@@ -158,9 +158,9 @@ module MWS
158
158
  # Creates, updates, or deletes a report request schedule
159
159
  #
160
160
  # @see http://docs.developer.amazonservices.com/en_US/reports/Reports_ManageReportSchedule.html
161
- # @param report_type [String]
162
- # @param schedule [String]
163
- # @param opts [Hash]
161
+ # @param [String] report_type
162
+ # @param [String] schedule
163
+ # @param [Hash] opts
164
164
  # @option opts [String, #iso8601] :schedule_date
165
165
  # @return [Peddler::XMLParser]
166
166
  def manage_report_schedule(report_type, schedule, opts = {})
@@ -173,7 +173,7 @@ module MWS
173
173
  # Lists scheduled reports
174
174
  #
175
175
  # @see http://docs.developer.amazonservices.com/en_US/reports/Reports_GetReportScheduleList.html
176
- # @param report_type_list [*Array<String>]
176
+ # @param [*Array<String>] report_type_list
177
177
  # @return [Peddler::XMLParser]
178
178
  def get_report_schedule_list(*report_type_list)
179
179
  operation('GetReportScheduleList')
@@ -194,7 +194,8 @@ module MWS
194
194
  # Counts scheduled reports
195
195
  #
196
196
  # @see http://docs.developer.amazonservices.com/en_US/reports/Reports_GetReportScheduleCount.html
197
- # @param report_type_list [Array<String>]
197
+ # @overload get_report_schedule_count(*report_types)
198
+ # @param [String] report_type one or more report_types
198
199
  # @return [Peddler::XMLParser]
199
200
  def get_report_schedule_count(*report_type_list)
200
201
  operation('GetReportScheduleCount')
@@ -207,8 +208,9 @@ module MWS
207
208
  # Updates acknowledged status of one or more reports
208
209
  #
209
210
  # @see http://docs.developer.amazonservices.com/en_US/reports/Reports_UpdateReportAcknowledgements.html
210
- # @param acknowledged [Boolean]
211
- # @param report_id_list [Array<String>]
211
+ # @overload update_report_acknowledgements(acknowledged, *report_ids)
212
+ # @param [Boolean] acknowledged
213
+ # @param [String] report_id one or more report_ids
212
214
  # @return [Peddler::XMLParser]
213
215
  def update_report_acknowledgements(acknowledged, *report_id_list)
214
216
  operation('UpdateReportAcknowledgements')
@@ -5,7 +5,7 @@ module MWS
5
5
  # The Sellers API lets sellers retrieve information about their seller
6
6
  # account, such as the marketplaces they participate in.
7
7
  class Client < ::Peddler::Client
8
- version "2011-07-01"
8
+ version '2011-07-01'
9
9
  path "/Sellers/#{version}"
10
10
 
11
11
  # Lists the marketplaces the seller participates in
@@ -20,7 +20,7 @@ module MWS
20
20
  # Lists the next page of marketplaces the seller participates in
21
21
  #
22
22
  # @see http://docs.developer.amazonservices.com/en_US/sellers/Sellers_ListMarketplaceParticipationsByNextToken.html
23
- # @param next_token [String]
23
+ # @param [String] next_token
24
24
  # @return [Peddler::XMLParser]
25
25
  def list_marketplace_participations_by_next_token(next_token)
26
26
  operation('ListMarketplaceParticipationsByNextToken')
@@ -9,14 +9,14 @@ module MWS
9
9
  # Amazon MWS service. Instead, the information is sent directly to you when
10
10
  # an event occurs to which you are subscribed.
11
11
  class Client < ::Peddler::Client
12
- version "2013-07-01"
12
+ version '2013-07-01'
13
13
  path "/Subscriptions/#{version}"
14
14
 
15
15
  # Registers a new destination to receive notifications
16
16
  #
17
17
  # @see http://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_RegisterDestination.html
18
- # @param sqs_queue_url [String]
19
- # @param marketplace_id [String]
18
+ # @param [String] sqs_queue_url
19
+ # @param [String] marketplace_id
20
20
  # @return [Peddler::XMLParser]
21
21
  def register_destination(sqs_queue_url, marketplace_id = primary_marketplace_id)
22
22
  operation('RegisterDestination')
@@ -29,8 +29,8 @@ module MWS
29
29
  # Removes an existing destination from the list of registered destinations
30
30
  #
31
31
  # @see http://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_DeregisterDestination.html
32
- # @param sqs_queue_url [String]
33
- # @param marketplace_id [String]
32
+ # @param [String] sqs_queue_url
33
+ # @param [String] marketplace_id
34
34
  # @return [Peddler::XMLParser]
35
35
  def deregister_destination(sqs_queue_url, marketplace_id = primary_marketplace_id)
36
36
  operation('DeregisterDestination')
@@ -43,7 +43,7 @@ module MWS
43
43
  # Lists all registered destinations
44
44
  #
45
45
  # @see http://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_ListRegisteredDestinations.html
46
- # @param marketplace_id [String]
46
+ # @param [String] marketplace_id
47
47
  # @return [Peddler::XMLParser]
48
48
  def list_registered_destinations(marketplace_id = primary_marketplace_id)
49
49
  operation('ListRegisteredDestinations')
@@ -55,8 +55,8 @@ module MWS
55
55
  # Sends a test notification to an existing destination
56
56
  #
57
57
  # @see http://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_SendTestNotificationToDestination.html
58
- # @param sqs_queue_url [String]
59
- # @param marketplace_id [String]
58
+ # @param [String] sqs_queue_url
59
+ # @param [String] marketplace_id
60
60
  # @return [Peddler::XMLParser]
61
61
  def send_test_notification_to_destination(sqs_queue_url, marketplace_id = primary_marketplace_id)
62
62
  operation('SendTestNotificationToDestination')
@@ -69,9 +69,9 @@ module MWS
69
69
  # Creates a new subscription
70
70
  #
71
71
  # @see http://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_CreateSubscription.html
72
- # @param notification_type [String]
73
- # @param sqs_queue_url [String]
74
- # @param marketplace_id [String]
72
+ # @param [String] notification_type
73
+ # @param [String] sqs_queue_url
74
+ # @param [String] marketplace_id
75
75
  # @return [Peddler::XMLParser]
76
76
  def create_subscription(notification_type, sqs_queue_url, marketplace_id = primary_marketplace_id)
77
77
  operation('CreateSubscription')
@@ -84,9 +84,9 @@ module MWS
84
84
  # Gets a subscription
85
85
  #
86
86
  # @see http://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_GetSubscription.html
87
- # @param notification_type [String]
88
- # @param sqs_queue_url [String]
89
- # @param marketplace_id [String]
87
+ # @param [String] notification_type
88
+ # @param [String] sqs_queue_url
89
+ # @param [String] marketplace_id
90
90
  # @return [Peddler::XMLParser]
91
91
  def get_subscription(notification_type, sqs_queue_url, marketplace_id = primary_marketplace_id)
92
92
  operation('GetSubscription')
@@ -102,9 +102,9 @@ module MWS
102
102
  # Deletes a subscription
103
103
  #
104
104
  # @see http://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_DeleteSubscription.html
105
- # @param notification_type [String]
106
- # @param sqs_queue_url [String]
107
- # @param marketplace_id [String]
105
+ # @param [String] notification_type
106
+ # @param [String] sqs_queue_url
107
+ # @param [String] marketplace_id
108
108
  # @return [Peddler::XMLParser]
109
109
  def delete_subscription(notification_type, sqs_queue_url, marketplace_id = primary_marketplace_id)
110
110
  operation('DeleteSubscription')
@@ -120,7 +120,7 @@ module MWS
120
120
  # Lists current subscriptions
121
121
  #
122
122
  # @see http://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_ListSubscriptions.html
123
- # @param marketplace_id [String]
123
+ # @param [String] marketplace_id
124
124
  # @return [Peddler::XMLParser]
125
125
  def list_subscriptions(marketplace_id = primary_marketplace_id)
126
126
  operation('ListSubscriptions')
@@ -132,10 +132,10 @@ module MWS
132
132
  # Updates a subscription
133
133
  #
134
134
  # @see http://docs.developer.amazonservices.com/en_US/subscriptions/Subscriptions_UpdateSubscription.html
135
- # @param notification_type [String]
136
- # @param sqs_queue_url [String]
137
- # @param enabled [Boolean]
138
- # @param marketplace_id [String]
135
+ # @param [String] notification_type
136
+ # @param [String] sqs_queue_url
137
+ # @param [Boolean] enabled
138
+ # @param [String] marketplace_id
139
139
  # @return [Peddler::XMLParser]
140
140
  def update_subscription(notification_type, sqs_queue_url, enabled, marketplace_id = primary_marketplace_id)
141
141
  operation('UpdateSubscription')