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, #merchant_id, #path, #primary_marketplace_id, #version

Instance Method Summary collapse

Methods inherited from Peddler::Client

#aws_endpoint, #defaults, #error_handler, #headers, #initialize, #marketplace, #marketplace_id, #marketplace_id=, on_error, #on_error, #operation, path, #run, version

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:

See Also:



87
88
89
90
91
92
93
94
 
# File 'lib/mws/reports/client.rb', line 87

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

Parameters:

  • report_id (String)

Returns:

  • (Peddler::XMLParser) —

    if report is in XML format

  • (Peddler::CSVParser) —

    if report is a flat file

See Also:



151
152
153
154
155
156
 
# File 'lib/mws/reports/client.rb', line 151

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:

See Also:



137
138
139
140
141
142
143
 
# File 'lib/mws/reports/client.rb', line 137

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:

See Also:



107
108
109
110
111
112
113
114
 
# File 'lib/mws/reports/client.rb', line 107

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:

See Also:



121
122
123
124
125
126
 
# File 'lib/mws/reports/client.rb', line 121

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:

See Also:



69
70
71
72
73
74
75
76
 
# File 'lib/mws/reports/client.rb', line 69

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:

See Also:



38
39
40
41
42
43
44
45
46
 
# File 'lib/mws/reports/client.rb', line 38

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:

See Also:



53
54
55
56
57
58
 
# File 'lib/mws/reports/client.rb', line 53

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

Parameters:

  • report_type_list (Array<String>)

Returns:

See Also:



199
200
201
202
203
204
205
 
# File 'lib/mws/reports/client.rb', line 199

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

Parameters:

  • report_type_list (*Array<String>)

Returns:

See Also:



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

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

Raises:

  • (NotImplementedError)

See Also:



190
191
192
 
# File 'lib/mws/reports/client.rb', line 190

def get_report_schedule_list_by_next_token(*)
  fail 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:

See Also:



166
167
168
169
170
171
 
# File 'lib/mws/reports/client.rb', line 166

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

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:

See Also:



19
20
21
22
23
24
25
 
# File 'lib/mws/reports/client.rb', line 19

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

Parameters:

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

Returns:

See Also:



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

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

  run
end