Class: MWS::Finances::Client

Inherits:
Peddler::Client show all
Defined in:
lib/mws/finances/client.rb

Overview

With the MWS Finances API you can retrieve financial transactions for your seller account.

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

#get_service_statusPeddler::XMLParser

Gets API status


76
77
78
79
# File 'lib/mws/finances/client.rb', line 76

def get_service_status
  operation('GetServiceStatus')
  run
end

#list_financial_event_groups(financial_event_group_started_after, opts = {}) ⇒ Peddler::XMLParser

Lists financial event groups

Parameters:

  • financial_event_group_started_after (String, #iso8601)
  • opts (Hash) (defaults to: {})

Options Hash (opts):

  • :max_results_per_page (Integer)
  • :financial_event_group_started_before (String, #iso8601)

Returns:

  • (Peddler::XMLParser)

See Also:


50
51
52
53
54
55
56
57
58
# File 'lib/mws/finances/client.rb', line 50

def list_financial_event_groups(financial_event_group_started_after,
                                opts = {})
  operation('ListFinancialEventGroups')
    .add(opts)
    .add('FinancialEventGroupStartedAfter' =>
           financial_event_group_started_after)

  run
end

#list_financial_event_groups_by_next_token(next_token) ⇒ Peddler::XMLParser

Lists the next page of financial event groups

Parameters:

  • next_token (String)

Returns:

  • (Peddler::XMLParser)

See Also:


65
66
67
68
69
70
# File 'lib/mws/finances/client.rb', line 65

def list_financial_event_groups_by_next_token(next_token)
  operation('ListFinancialEventGroupsByNextToken')
    .add('NextToken' => next_token)

  run
end

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

Lists financial events

Parameters:

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

Options Hash (opts):

  • :max_results_per_page (Integer)
  • :amazon_order_id (String)
  • :financial_event_group_id (String)
  • :posted_after (String, #iso8601)
  • :posted_before (String, #iso8601)

Returns:

  • (Peddler::XMLParser)

See Also:


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

def list_financial_events(opts = {})
  operation('ListFinancialEvents')
    .add(opts)

  run
end

#list_financial_events_by_next_token(next_token) ⇒ Peddler::XMLParser

Lists the next page of financial events

Parameters:

  • next_token (String)

Returns:

  • (Peddler::XMLParser)

See Also:


35
36
37
38
39
40
# File 'lib/mws/finances/client.rb', line 35

def list_financial_events_by_next_token(next_token)
  operation('ListFinancialEventsByNextToken')
    .add('NextToken' => next_token)

  run
end