Class: MWS::Reports::Client

Inherits:
Peddler::Client show all
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, #merchant_id

Instance Method Summary collapse

Methods inherited from Peddler::Client

#initialize

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

Parameters:

  • opts (Hash) (defaults to: {})

Options Hash (opts):

  • :report_type_list (Array<String>, String)
  • :report_processing_status_list (Array<String>, String)
  • :requested_from_date (String, #iso8601)
  • :requested_to_date (String, #iso8601)

Returns:

  • (Peddler::XMLParser)

See Also:



95
96
97
98
99
100
101
102
 
# File 'lib/mws/reports/client.rb', line 95

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::FlatFileParser

Gets a report and its Content-MD5 header

Parameters:

  • report_id (String)

Returns:

  • (Peddler::XMLParser) —

    if report is in XML format

  • (Peddler::FlatFileParser) —

    if report is a flat file

See Also:



161
162
163
164
165
166
 
# File 'lib/mws/reports/client.rb', line 161

def get_report(report_id, &blk)
  operation('GetReport')
    .add('ReportId' => report_id)

  run(&blk)
end

#get_report_count(opts = {}) ⇒ Peddler::XMLParser

Counts reports

Parameters:

  • opts (Hash) (defaults to: {})

Options Hash (opts):

  • :report_type_list (Array<String>, String)
  • :acknowledged (Boolean)
  • :available_from_date (String, #iso8601)
  • :available_to_date (String, #iso8601)

Returns:

  • (Peddler::XMLParser)

See Also:



147
148
149
150
151
152
153
 
# File 'lib/mws/reports/client.rb', line 147

def get_report_count(opts = {})
  operation('GetReportCount')
    .add(opts)
    .structure!('ReportTypeList', 'Type')

  run
end

#get_report_list(opts = {}) ⇒ Peddler::XMLParser

Lists reports

Parameters:

  • opts (Hash) (defaults to: {})

Options Hash (opts):

  • :max_count (Integer)
  • :report_type_list (Array<String>, String)
  • :acknowledged (Boolean)
  • :available_from_date (String, #iso8601)
  • :available_to_date (String, #iso8601)
  • :report_request_id_list (Array<String>, String)

Returns:

  • (Peddler::XMLParser)

See Also:



116
117
118
119
120
121
122
123
 
# File 'lib/mws/reports/client.rb', line 116

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

Parameters:

  • next_token (String)

Returns:

  • (Peddler::XMLParser)

See Also:



130
131
132
133
134
135
 
# File 'lib/mws/reports/client.rb', line 130

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

Parameters:

  • opts (Hash) (defaults to: {})

Options Hash (opts):

  • :report_type_list (Array<String>, String)
  • :report_processing_status_list (Array<String>, String)
  • :requested_from_date (String, #iso8601)
  • :requested_to_date (String, #iso8601)

Returns:

  • (Peddler::XMLParser)

See Also:



76
77
78
79
80
81
82
83
 
# File 'lib/mws/reports/client.rb', line 76

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

Parameters:

  • opts (Hash) (defaults to: {})

Options Hash (opts):

  • :report_request_id_list (Array<String>, String)
  • :report_type_list (Array<String>, String)
  • :report_processing_status_list (Array<String>, String)
  • :max_count (Integer)
  • :requested_from_date (String, #iso8601)
  • :requested_to_date (String, #iso8601)

Returns:

  • (Peddler::XMLParser)

See Also:



44
45
46
47
48
49
50
51
52
 
# File 'lib/mws/reports/client.rb', line 44

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

Parameters:

  • next_token (String)

Returns:

  • (Peddler::XMLParser)

See Also:



59
60
61
62
63
64
 
# File 'lib/mws/reports/client.rb', line 59

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

Counts scheduled reports

Parameters:

  • report_type_list (Array<String>)

Returns:

  • (Peddler::XMLParser)

See Also:



213
214
215
216
217
218
219
 
# File 'lib/mws/reports/client.rb', line 213

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

Lists scheduled reports

Parameters:

  • report_type_list (Array<String>)

Returns:

  • (Peddler::XMLParser)

See Also:



191
192
193
194
195
196
197
 
# File 'lib/mws/reports/client.rb', line 191

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

Lists next page of scheduled reports

Raises:

  • (NotImplementedError)

See Also:



203
204
205
 
# File 'lib/mws/reports/client.rb', line 203

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

Parameters:

  • report_type (String)
  • schedule (String)
  • opts (Hash) (defaults to: {})

Options Hash (opts):

  • :schedule_date (String, #iso8601)

Returns:

  • (Peddler::XMLParser)

See Also:



177
178
179
180
181
182
183
 
# File 'lib/mws/reports/client.rb', line 177

def manage_report_schedule(report_type, schedule, opts = {})
  operation('ManageReportSchedule')
    .add(opts)
    .add('ReportType' => report_type, 'Schedule' => schedule)

  run
end

#request_report(report_type, opts = {}) ⇒ Peddler::XMLParser

Creates a report request

Parameters:

  • report_type (String)
  • opts (Hash) (defaults to: {})

Options Hash (opts):

  • :start_date (String, #iso8601)
  • :end_date (String, #iso8601)
  • :report_options (String)
  • :marketplace_id_list (Array<String>, String)

Returns:

  • (Peddler::XMLParser)

See Also:



23
24
25
26
27
28
29
30
 
# File 'lib/mws/reports/client.rb', line 23

def request_report(report_type, opts = {})
  operation('RequestReport')
    .add(opts)
    .add('ReportType' => report_type)
    .structure!('MarketplaceIdList', 'Id')

  run
end

#update_report_acknowledgements(acknowledged, *report_id_list) ⇒ Peddler::XMLParser

Updates acknowledged status of one or more reports

Parameters:

  • acknowledged (Boolean)
  • report_id_list (Array<String>)

Returns:

  • (Peddler::XMLParser)

See Also:



227
228
229
230
231
232
233
 
# File 'lib/mws/reports/client.rb', line 227

def update_report_acknowledgements(acknowledged, *report_id_list)
  operation('UpdateReportAcknowledgements')
    .add('ReportIdList' => report_id_list, 'Acknowledged' => acknowledged)
    .structure!('ReportIdList', 'Id')

  run
end