Class: MWS::Reports
- Inherits:
-
Peddler::Client
- Object
- Peddler::Client
- MWS::Reports
- Defined in:
- lib/mws/reports.rb
Overview
The Reports API lets you request reports about your inventory and orders.
Constant Summary
Constants inherited from Peddler::Client
Peddler::Client::BadMarketplaceId, Peddler::Client::HOSTS
Instance Attribute Summary
Attributes inherited from Peddler::Client
#body, #marketplace_id, #merchant_id
Instance Method Summary collapse
-
#cancel_report_requests(opts = {}) ⇒ Peddler::XMLParser
Cancels one or more report requests.
-
#get_report(report_id, &blk) ⇒ Peddler::XMLParser, Peddler::CSVParser
Gets a report and its Content-MD5 header.
-
#get_report_count(opts = {}) ⇒ Peddler::XMLParser
Counts reports.
-
#get_report_list(opts = {}) ⇒ Peddler::XMLParser
Lists reports.
-
#get_report_list_by_next_token(next_token) ⇒ Peddler::XMLParser
Lists the next page of reports.
-
#get_report_request_count(opts = {}) ⇒ Peddler::XMLParser
Counts requested reports.
-
#get_report_request_list(opts = {}) ⇒ Peddler::XMLParser
Lists report requests.
-
#get_report_request_list_by_next_token(next_token) ⇒ Peddler::XMLParser
Lists the next page of the report requests.
-
#get_report_schedule_count(*report_type_list) ⇒ Peddler::XMLParser
Count scheduled reports.
-
#get_report_schedule_list(*report_type_list) ⇒ Peddler::XMLParser
List scheduled reports.
-
#get_report_schedule_list_by_next_token(next_token) ⇒ Object
List next page of scheduled reports.
-
#manage_report_schedule(report_type, schedule, opts = {}) ⇒ Peddler::XMLParser
Creates, updates, or deletes a report request schedule.
-
#request_report(report_type, opts = {}) ⇒ Peddler::XMLParser
Creates a report request.
-
#update_report_acknowledgements(acknowledged, *report_id_list) ⇒ Peddler::XMLParser
Update acknowledged status of one or more reports.
Methods inherited from Peddler::Client
#aws_endpoint, #headers, inherited, #operation, path, #run
Instance Method Details
#cancel_report_requests(opts = {}) ⇒ Peddler::XMLParser
Cancels one or more report requests
84 85 86 87 88 89 90 91 |
# File 'lib/mws/reports.rb', line 84 def cancel_report_requests(opts = {}) operation('CancelReportRequests') .add(opts) .structure!('ReportTypeList', 'Type') .structure!('ReportProcessingStatusList', 'Status') run end |
#get_report(report_id, &blk) ⇒ Peddler::XMLParser, Peddler::CSVParser
Gets a report and its Content-MD5 header
148 149 150 151 152 153 |
# File 'lib/mws/reports.rb', line 148 def get_report(report_id, &blk) operation('GetReport') .add('ReportId' => report_id) run(&blk) end |
#get_report_count(opts = {}) ⇒ Peddler::XMLParser
Counts reports
134 135 136 137 138 139 140 |
# File 'lib/mws/reports.rb', line 134 def get_report_count(opts = {}) operation('GetReportCount') .add(opts) .structure!('ReportTypeList', 'Type') run end |
#get_report_list(opts = {}) ⇒ Peddler::XMLParser
Lists reports
104 105 106 107 108 109 110 111 |
# File 'lib/mws/reports.rb', line 104 def get_report_list(opts = {}) operation('GetReportList') .add(opts) .structure!('ReportTypeList', 'Type') .structure!('ReportRequestIdList', 'Id') run end |
#get_report_list_by_next_token(next_token) ⇒ Peddler::XMLParser
Lists the next page of reports
118 119 120 121 122 123 |
# File 'lib/mws/reports.rb', line 118 def get_report_list_by_next_token(next_token) operation('GetReportListByNextToken') .add('NextToken' => next_token) run end |
#get_report_request_count(opts = {}) ⇒ Peddler::XMLParser
Counts requested reports
66 67 68 69 70 71 72 73 |
# File 'lib/mws/reports.rb', line 66 def get_report_request_count(opts = {}) operation('GetReportRequestCount') .add(opts) .structure!('ReportTypeList', 'Type') .structure!('ReportProcessingStatusList', 'Status') run end |
#get_report_request_list(opts = {}) ⇒ Peddler::XMLParser
Lists report requests
35 36 37 38 39 40 41 42 43 |
# File 'lib/mws/reports.rb', line 35 def get_report_request_list(opts = {}) operation('GetReportRequestList') .add(opts) .structure!('ReportRequestIdList', 'Id') .structure!('ReportTypeList', 'Type') .structure!('ReportProcessingStatusList', 'Status') run end |
#get_report_request_list_by_next_token(next_token) ⇒ Peddler::XMLParser
Lists the next page of the report requests
50 51 52 53 54 55 |
# File 'lib/mws/reports.rb', line 50 def get_report_request_list_by_next_token(next_token) operation('GetReportRequestListByNextToken') .add('NextToken' => next_token) run end |
#get_report_schedule_count(*report_type_list) ⇒ Peddler::XMLParser
Count scheduled reports
198 199 200 201 202 203 204 |
# File 'lib/mws/reports.rb', line 198 def get_report_schedule_count(*report_type_list) operation('GetReportScheduleCount') .add('ReportTypeList' => report_type_list) .structure!('ReportTypeList', 'Type') run end |
#get_report_schedule_list(*report_type_list) ⇒ Peddler::XMLParser
List scheduled reports
176 177 178 179 180 181 182 |
# File 'lib/mws/reports.rb', line 176 def get_report_schedule_list(*report_type_list) operation('GetReportScheduleList') .add('ReportTypeList' => report_type_list) .structure!('ReportTypeList', 'Type') run end |
#get_report_schedule_list_by_next_token(next_token) ⇒ Object
List next page of scheduled reports
189 190 191 |
# File 'lib/mws/reports.rb', line 189 def get_report_schedule_list_by_next_token(next_token) raise NotImplementedError end |
#manage_report_schedule(report_type, schedule, opts = {}) ⇒ Peddler::XMLParser
Creates, updates, or deletes a report request schedule
164 165 166 167 168 169 |
# File 'lib/mws/reports.rb', line 164 def manage_report_schedule(report_type, schedule, opts = {}) operation('ManageReportSchedule') .add(opts.merge('ReportType' => report_type, 'Schedule' => schedule)) run end |
#request_report(report_type, opts = {}) ⇒ Peddler::XMLParser
Creates a report request
16 17 18 19 20 21 22 |
# File 'lib/mws/reports.rb', line 16 def request_report(report_type, opts = {}) operation('RequestReport') .add(opts.merge('ReportType' => report_type)) .structure!('MarketplaceIdList', 'Id') run end |
#update_report_acknowledgements(acknowledged, *report_id_list) ⇒ Peddler::XMLParser
Update acknowledged status of one or more reports
212 213 214 215 216 217 218 |
# File 'lib/mws/reports.rb', line 212 def update_report_acknowledgements(acknowledged, *report_id_list) operation('UpdateReportAcknowledgement') .add('ReportIdList' => report_id_list, 'Acknowledged' => acknowledged) .structure!('ReportIdList', 'Id') run end |