Class: Dodopayments::Resources::Balances

Inherits:

Object

• Object
• Dodopayments::Resources::Balances

Defined in:

lib/dodopayments/resources/balances.rb

Instance Method Summary

• #initialize(client:) ⇒ Balances constructor private

  A new instance of Balances.

• #retrieve_ledger(created_at_gte: nil, created_at_lte: nil, currency: nil, event_type: nil, limit: nil, page_number: nil, page_size: nil, reference_object_id: nil, request_options: {}) ⇒ Dodopayments::Internal::DefaultPageNumberPagination<Dodopayments::Models::BalanceLedgerEntry>

  Some parameter documentations has been truncated, see Models::BalanceRetrieveLedgerParams for more details.

Constructor Details

#initialize(client:) ⇒ Balances

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Balances.

Parameters:

• client (Dodopayments::Client)

# File 'lib/dodopayments/resources/balances.rb', line 48

def initialize(client:)
  @client = client
end

Instance Method Details

#retrieve_ledger(created_at_gte: nil, created_at_lte: nil, currency: nil, event_type: nil, limit: nil, page_number: nil, page_size: nil, reference_object_id: nil, request_options: {}) ⇒ Dodopayments::Internal::DefaultPageNumberPagination<Dodopayments::Models::BalanceLedgerEntry>

Some parameter documentations has been truncated, see Models::BalanceRetrieveLedgerParams for more details.

Parameters:

• created_at_gte (Time) —

  Get events after this created time

• created_at_lte (Time) —

  Get events created before this time

• currency (Symbol, Dodopayments::Models::BalanceRetrieveLedgerParams::Currency) —

  Filter by currency

• event_type (Symbol, Dodopayments::Models::BalanceRetrieveLedgerParams::EventType) —

  Filter by Ledger Event Type

• limit (Integer) —

  Min : 1, Max : 100, default 10

• page_number (Integer) —

  Page number default is 0

• page_size (Integer) —

  Page size default is 10 max is 100

• reference_object_id (String) —

  Get events history of a specific object like payment/subscription/refund/dispute

• request_options (Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Dodopayments::Internal::DefaultPageNumberPagination<Dodopayments::Models::BalanceLedgerEntry>)

See Also:

• Models::BalanceRetrieveLedgerParams

# File 'lib/dodopayments/resources/balances.rb', line 32

def retrieve_ledger(params = {})
  parsed, options = Dodopayments::BalanceRetrieveLedgerParams.dump_request(params)
  query = Dodopayments::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "balances/ledger",
    query: query,
    page: Dodopayments::Internal::DefaultPageNumberPagination,
    model: Dodopayments::BalanceLedgerEntry,
    options: options
  )
end