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, #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

#get_service_status ⇒ Peddler::XMLParser

Gets API status

Returns:

See Also:



70
71
72
73
74
 
# File 'lib/mws/finances/client.rb', line 70

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:

See Also:



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

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

  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:

See Also:



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

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:

See Also:



21
22
23
24
 
# File 'lib/mws/finances/client.rb', line 21

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:

See Also:



31
32
33
34
35
36
 
# File 'lib/mws/finances/client.rb', line 31

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

  run
end