Class: Peddler::APIs::FinancesV0

Inherits:
Peddler::API show all
Defined in:
lib/peddler/apis/finances_v0.rb

Overview

Selling Partner API for Finances

The Selling Partner API for Finances helps you obtain financial information relevant to a seller’s business. You can obtain financial events for a given order, financial event group, or date range without having to wait until a statement period closes. You can also obtain financial event groups for a given date range.

See Also:

Instance Attribute Summary

Attributes inherited from Peddler::API

#access_token, #endpoint, #retries

Instance Method Summary collapse

Methods inherited from Peddler::API

#endpoint_uri, #http, #initialize, #meter, #retriable, #sandbox, #sandbox?, #typed, #typed?, #use, #via

Constructor Details

This class inherits a constructor from Peddler::API

Instance Method Details

#list_financial_event_groups(max_results_per_page: 10, financial_event_group_started_before: nil, financial_event_group_started_after: nil, next_token: nil, rate_limit: 0.5) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Returns financial event groups for a given date range. It may take up to 48 hours for orders to appear in your financial events.



39
40
41
42
43
44
45
46
47
48
49
50
 
# File 'lib/peddler/apis/finances_v0.rb', line 39

def list_financial_event_groups(max_results_per_page: 10, financial_event_group_started_before: nil,
  financial_event_group_started_after: nil, next_token: nil, rate_limit: 0.5)
  path = "/finances/v0/financialEventGroups"
  params = {
    "MaxResultsPerPage" => max_results_per_page,
    "FinancialEventGroupStartedBefore" => financial_event_group_started_before,
    "FinancialEventGroupStartedAfter" => financial_event_group_started_after,
    "NextToken" => next_token,
  }.compact
  parser = Peddler::Types::FinancesV0::ListFinancialEventGroupsResponse if typed?
  meter(rate_limit).get(path, params:, parser:)
end

#list_financial_events(max_results_per_page: 100, posted_after: nil, posted_before: nil, next_token: nil, rate_limit: 0.5) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Returns financial events for the specified data range. It may take up to 48 hours for orders to appear in your financial events.

Note: in ‘ListFinancialEvents`, deferred events don’t show up in responses until in they are released.



126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/peddler/apis/finances_v0.rb', line 126

def list_financial_events(max_results_per_page: 100, posted_after: nil, posted_before: nil, next_token: nil,
  rate_limit: 0.5)
  path = "/finances/v0/financialEvents"
  params = {
    "MaxResultsPerPage" => max_results_per_page,
    "PostedAfter" => posted_after,
    "PostedBefore" => posted_before,
    "NextToken" => next_token,
  }.compact
  parser = Peddler::Types::FinancesV0::ListFinancialEventsResponse if typed?
  meter(rate_limit).get(path, params:, parser:)
end

#list_financial_events_by_group_id(event_group_id, max_results_per_page: 100, posted_after: nil, posted_before: nil, next_token: nil, rate_limit: 0.5) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Returns all financial events for the specified financial event group. It may take up to 48 hours for orders to appear in your financial events.

Note: This operation will only retrieve group’s data for the past two years. If a request is submitted for data spanning more than two years, an empty response is returned.



74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/peddler/apis/finances_v0.rb', line 74

def list_financial_events_by_group_id(event_group_id, max_results_per_page: 100, posted_after: nil,
  posted_before: nil, next_token: nil, rate_limit: 0.5)
  path = "/finances/v0/financialEventGroups/#{percent_encode(event_group_id)}/financialEvents"
  params = {
    "MaxResultsPerPage" => max_results_per_page,
    "PostedAfter" => posted_after,
    "PostedBefore" => posted_before,
    "NextToken" => next_token,
  }.compact
  parser = Peddler::Types::FinancesV0::ListFinancialEventsResponse if typed?
  meter(rate_limit).get(path, params:, parser:)
end

#list_financial_events_by_order_id(order_id, max_results_per_page: 100, next_token: nil, rate_limit: 0.5) ⇒ Peddler::Response

Note:

This operation can make a static sandbox call.

Returns all financial events for the specified order. It may take up to 48 hours for orders to appear in your financial events.



97
98
99
100
101
102
103
104
105
 
# File 'lib/peddler/apis/finances_v0.rb', line 97

def list_financial_events_by_order_id(order_id, max_results_per_page: 100, next_token: nil, rate_limit: 0.5)
  path = "/finances/v0/orders/#{percent_encode(order_id)}/financialEvents"
  params = {
    "MaxResultsPerPage" => max_results_per_page,
    "NextToken" => next_token,
  }.compact
  parser = Peddler::Types::FinancesV0::ListFinancialEventsResponse if typed?
  meter(rate_limit).get(path, params:, parser:)
end