Class: MWS::Reports::Client
- Inherits:
-
Peddler::Client
- Object
- Peddler::Client
- MWS::Reports::Client
- Defined in:
- lib/mws/reports/client.rb
Overview
The Reports API lets you request reports about your inventory and orders.
Instance Attribute Summary
Attributes inherited from Peddler::Client
#auth_token, #body, #marketplace_id, #merchant_id, #path
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 ⇒ 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, #defaults, #headers, inherited, #initialize, #marketplace, #on_error, #operation, parser, parser=, path, #run
Constructor Details
This class inherits a constructor from Peddler::Client
Instance Method Details
#cancel_report_requests(opts = {}) ⇒ Peddler::XMLParser
Cancels one or more report requests
85 86 87 88 89 90 91 92 |
# File 'lib/mws/reports/client.rb', line 85 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
149 150 151 152 153 154 |
# File 'lib/mws/reports/client.rb', line 149 def get_report(report_id, &blk) operation('GetReport') .add('ReportId' => report_id) run(&blk) end |
#get_report_count(opts = {}) ⇒ Peddler::XMLParser
Counts reports
135 136 137 138 139 140 141 |
# File 'lib/mws/reports/client.rb', line 135 def get_report_count(opts = {}) operation('GetReportCount') .add(opts) .structure!('ReportTypeList', 'Type') run end |
#get_report_list(opts = {}) ⇒ Peddler::XMLParser
Lists reports
105 106 107 108 109 110 111 112 |
# File 'lib/mws/reports/client.rb', line 105 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
119 120 121 122 123 124 |
# File 'lib/mws/reports/client.rb', line 119 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
67 68 69 70 71 72 73 74 |
# File 'lib/mws/reports/client.rb', line 67 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
36 37 38 39 40 41 42 43 44 |
# File 'lib/mws/reports/client.rb', line 36 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
51 52 53 54 55 56 |
# File 'lib/mws/reports/client.rb', line 51 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
197 198 199 200 201 202 203 |
# File 'lib/mws/reports/client.rb', line 197 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/client.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 ⇒ Object
List next page of scheduled reports
188 189 190 |
# File 'lib/mws/reports/client.rb', line 188 def get_report_schedule_list_by_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/client.rb', line 164 def manage_report_schedule(report_type, schedule, opts = {}) operation('ManageReportSchedule') .add(opts.update('ReportType' => report_type, 'Schedule' => schedule)) run end |
#request_report(report_type, opts = {}) ⇒ Peddler::XMLParser
Creates a report request
17 18 19 20 21 22 23 |
# File 'lib/mws/reports/client.rb', line 17 def request_report(report_type, opts = {}) operation('RequestReport') .add(opts.update('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
211 212 213 214 215 216 217 |
# File 'lib/mws/reports/client.rb', line 211 def update_report_acknowledgements(acknowledged, *report_id_list) operation('UpdateReportAcknowledgements') .add('ReportIdList' => report_id_list, 'Acknowledged' => acknowledged) .structure!('ReportIdList', 'Id') run end |