Class: MethodRuby::Resources::Accounts::Transactions

Inherits:
Object
  • Object
show all
Defined in:
lib/method_ruby/resources/accounts/transactions.rb

Overview

Transactions for accounts

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ Transactions

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

Parameters:



87
88
89
 
# File 'lib/method_ruby/resources/accounts/transactions.rb', line 87

def initialize(client:)
  @client = client
end

Instance Method Details

#list(account_id, method_version:, from_date: nil, page: nil, page_cursor: nil, page_limit: nil, to_date: nil, request_options: {}) ⇒ MethodRuby::Models::Accounts::TransactionListResponse

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

Returns a paginated list of transactions for the specified account. Results can be filtered by status and date range.

Parameters:

  • account_id (String) —

    Path param: Unique identifier for the account.

  • method_version (Symbol, MethodRuby::Models::Accounts::TransactionListParams::MethodVersion) —

    Header param: API version to use for this request. This spec targets ‘2025-12-01

  • from_date (Date) —

    Query param: Filter results from this date (inclusive, YYYY-MM-DD format).

  • page (Integer) —

    Query param: Page number for pagination (1-indexed).

  • page_cursor (String) —

    Query param: Cursor for cursor-based pagination. Use the value from ‘Pagination-

  • page_limit (Integer) —

    Query param: Number of items per page.

  • to_date (Date) —

    Query param: Filter results to this date (inclusive, YYYY-MM-DD format).

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

Returns:

See Also:



69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/method_ruby/resources/accounts/transactions.rb', line 69

def list(, params)
  query_params = [:from_date, :page, :page_cursor, :page_limit, :to_date]
  parsed, options = MethodRuby::Accounts::TransactionListParams.dump_request(params)
  query = MethodRuby::Internal::Util.encode_query_params(parsed.slice(*query_params))
  @client.request(
    method: :get,
    path: ["accounts/%1$s/transactions", ],
    query: query,
    headers: parsed.except(*query_params).transform_keys(method_version: "method-version"),
    model: MethodRuby::Models::Accounts::TransactionListResponse,
    security: {secret_key: true},
    options: options
  )
end

#retrieve(acc_txn_id, account_id:, method_version:, request_options: {}) ⇒ MethodRuby::Models::Accounts::TransactionRetrieveResponse

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

Retrieves an account transaction by its unique identifier.

Parameters:

Returns:

See Also:



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'lib/method_ruby/resources/accounts/transactions.rb', line 26

def retrieve(acc_txn_id, params)
  parsed, options = MethodRuby::Accounts::TransactionRetrieveParams.dump_request(params)
   =
    parsed.delete(:account_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["accounts/%1$s/transactions/%2$s", , acc_txn_id],
    headers: parsed.transform_keys(method_version: "method-version"),
    model: MethodRuby::Models::Accounts::TransactionRetrieveResponse,
    security: {secret_key: true},
    options: options
  )
end