Class: Dodopayments::Resources::Customers::Wallets::LedgerEntries

Inherits:

Object

• Object
• Dodopayments::Resources::Customers::Wallets::LedgerEntries

Defined in:

lib/dodopayments/resources/customers/wallets/ledger_entries.rb

Instance Method Summary

• #create(customer_id, amount:, currency:, entry_type:, idempotency_key: nil, reason: nil, request_options: {}) ⇒ Dodopayments::Models::Customers::CustomerWallet
• #initialize(client:) ⇒ LedgerEntries constructor private

  A new instance of LedgerEntries.

• #list(customer_id, currency: nil, page_number: nil, page_size: nil, request_options: {}) ⇒ Dodopayments::Internal::DefaultPageNumberPagination<Dodopayments::Models::Customers::Wallets::CustomerWalletTransaction>

Constructor Details

#initialize(client:) ⇒ LedgerEntries

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 LedgerEntries.

Parameters:

• client (Dodopayments::Client)

# File 'lib/dodopayments/resources/customers/wallets/ledger_entries.rb', line 69

def initialize(client:)
  @client = client
end

Instance Method Details

#create(customer_id, amount:, currency:, entry_type:, idempotency_key: nil, reason: nil, request_options: {}) ⇒ Dodopayments::Models::Customers::CustomerWallet

Parameters:

• customer_id (String) —

  Customer ID

• amount (Integer)
• currency (Symbol, Dodopayments::Models::Currency) —

  Currency of the wallet to adjust

• entry_type (Symbol, Dodopayments::Models::Customers::Wallets::LedgerEntryCreateParams::EntryType) —

  Type of ledger entry - credit or debit

• idempotency_key (String, nil) —

  Optional idempotency key to prevent duplicate entries

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

Returns:

• (Dodopayments::Models::Customers::CustomerWallet)

See Also:

• Models::Customers::Wallets::LedgerEntryCreateParams

# File 'lib/dodopayments/resources/customers/wallets/ledger_entries.rb', line 27

def create(customer_id, params)
  parsed, options = Dodopayments::Customers::Wallets::LedgerEntryCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["customers/%1$s/wallets/ledger-entries", customer_id],
    body: parsed,
    model: Dodopayments::Customers::CustomerWallet,
    options: options
  )
end

#list(customer_id, currency: nil, page_number: nil, page_size: nil, request_options: {}) ⇒ Dodopayments::Internal::DefaultPageNumberPagination<Dodopayments::Models::Customers::Wallets::CustomerWalletTransaction>

Parameters:

• customer_id (String) —

  Customer ID

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

  Optional currency filter

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

Returns:

• (Dodopayments::Internal::DefaultPageNumberPagination<Dodopayments::Models::Customers::Wallets::CustomerWalletTransaction>)

See Also:

• Models::Customers::Wallets::LedgerEntryListParams

# File 'lib/dodopayments/resources/customers/wallets/ledger_entries.rb', line 53

def list(customer_id, params = {})
  parsed, options = Dodopayments::Customers::Wallets::LedgerEntryListParams.dump_request(params)
  query = Dodopayments::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: ["customers/%1$s/wallets/ledger-entries", customer_id],
    query: query,
    page: Dodopayments::Internal::DefaultPageNumberPagination,
    model: Dodopayments::Customers::Wallets::CustomerWalletTransaction,
    options: options
  )
end