Class: WhopSDK::Models::FinancialActivityListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• WhopSDK::Models::FinancialActivityListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/whop_sdk/models/financial_activity_list_params.rb,
sig/whop_sdk/models/financial_activity_list_params.rbs

Overview

See Also:

• WhopSDK::Resources::FinancialActivity#list

Instance Attribute Summary

• #account_id ⇒ String^?

  The owning account ID (a biz_ identifier).

• #available_after ⇒ Date^?

  Only include rows whose funds became withdrawable on or after this YYYY-MM-DD settlement date (UTC), distinct from posted_at.

• #available_before ⇒ Date^?

  Only include rows whose funds became withdrawable on or before this YYYY-MM-DD settlement date (UTC).

• #currency ⇒ String^?

  Optional currency code filter, for example usd.

• #cursor ⇒ String^?

  Cursor returned by the previous page.

• #include_owned_accounts ⇒ Boolean^?

  When true, aggregates the authenticated user's personal ledger with the businesses they own (owner role with balance read) into one feed.

• #limit ⇒ Integer^?

  Maximum number of rows to return.

• #line_types ⇒ Array<String>^?

  Optional ledger line categories to include.

• #posted_after ⇒ Time^?

  Only include rows posted after this ISO 8601 timestamp.

• #posted_before ⇒ Time^?

  Only include rows posted before this ISO 8601 timestamp.

• #user_id ⇒ String^?

  The owning user ID (a user_ identifier).

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(account_id: nil, available_after: nil, available_before: nil, currency: nil, cursor: nil, include_owned_accounts: nil, limit: nil, line_types: nil, posted_after: nil, posted_before: nil, user_id: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see FinancialActivityListParams for more details.

• #to_hash ⇒ {

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, #inspect, inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(account_id: nil, available_after: nil, available_before: nil, currency: nil, cursor: nil, include_owned_accounts: nil, limit: nil, line_types: nil, posted_after: nil, posted_before: nil, user_id: nil, request_options: {}) ⇒ Object

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

Parameters:

• account_id (String) (defaults to: nil) —

  The owning account ID (a biz_ identifier). Provide this or user_id.

• available_after (Date) (defaults to: nil) —

  Only include rows whose funds became withdrawable on or after this YYYY-MM-DD

• available_before (Date) (defaults to: nil) —

  Only include rows whose funds became withdrawable on or before this YYYY-MM-DD

• currency (String) (defaults to: nil) —

  Optional currency code filter, for example usd.

• cursor (String) (defaults to: nil) —

  Cursor returned by the previous page.

• include_owned_accounts (Boolean) (defaults to: nil) —

  When true, aggregates the authenticated user's personal ledger with the business

• limit (Integer) (defaults to: nil) —

  Maximum number of rows to return.

• line_types (Array<String>) (defaults to: nil) —

  Optional ledger line categories to include. Some categories (for example `onchai

• posted_after (Time) (defaults to: nil) —

  Only include rows posted after this ISO 8601 timestamp.

• posted_before (Time) (defaults to: nil) —

  Only include rows posted before this ISO 8601 timestamp.

• user_id (String) (defaults to: nil) —

  The owning user ID (a user_ identifier). Provide this or account_id.

• request_options (WhopSDK::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/whop_sdk/models/financial_activity_list_params.rb', line 84

Instance Attribute Details

#account_id ⇒ String^?

The owning account ID (a biz_ identifier). Provide this or user_id.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/financial_activity_list_params.rb', line 14

optional :account_id, String

#available_after ⇒ Date^?

Only include rows whose funds became withdrawable on or after this YYYY-MM-DD settlement date (UTC), distinct from posted_at. Requires currency.

Parameters:

• (Date)

Returns:

• (Date, nil)

# File 'lib/whop_sdk/models/financial_activity_list_params.rb', line 21

optional :available_after, Date

#available_before ⇒ Date^?

Only include rows whose funds became withdrawable on or before this YYYY-MM-DD settlement date (UTC). Set equal to available_after for a single day. Requires currency.

Parameters:

• (Date)

Returns:

• (Date, nil)

# File 'lib/whop_sdk/models/financial_activity_list_params.rb', line 29

optional :available_before, Date

#currency ⇒ String^?

Optional currency code filter, for example usd.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/financial_activity_list_params.rb', line 35

optional :currency, String

#cursor ⇒ String^?

Cursor returned by the previous page.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/financial_activity_list_params.rb', line 41

optional :cursor, String

#include_owned_accounts ⇒ Boolean^?

When true, aggregates the authenticated user's personal ledger with the businesses they own (owner role with balance read) into one feed. Requires user_id to be the authenticated user; cannot be combined with account_id or the settlement-date filters. Each returned row includes the owning account.

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/whop_sdk/models/financial_activity_list_params.rb', line 50

optional :include_owned_accounts, WhopSDK::Internal::Type::Boolean

#limit ⇒ Integer^?

Maximum number of rows to return.

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/whop_sdk/models/financial_activity_list_params.rb', line 56

optional :limit, Integer

#line_types ⇒ Array<String>^?

Optional ledger line categories to include. Some categories (for example onchain_deposit, which covers inbound crypto deposits such as MoonPay onramps) are only returned when explicitly requested here.

Parameters:

• (::Array[String])

Returns:

• (Array<String>, nil)

# File 'lib/whop_sdk/models/financial_activity_list_params.rb', line 64

optional :line_types, WhopSDK::Internal::Type::ArrayOf[String]

#posted_after ⇒ Time^?

Only include rows posted after this ISO 8601 timestamp.

Parameters:

• (Time)

Returns:

• (Time, nil)

# File 'lib/whop_sdk/models/financial_activity_list_params.rb', line 70

optional :posted_after, Time

#posted_before ⇒ Time^?

Only include rows posted before this ISO 8601 timestamp.

Parameters:

• (Time)

Returns:

• (Time, nil)

# File 'lib/whop_sdk/models/financial_activity_list_params.rb', line 76

optional :posted_before, Time

#user_id ⇒ String^?

The owning user ID (a user_ identifier). Provide this or account_id.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/financial_activity_list_params.rb', line 82

optional :user_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/whop_sdk/models/financial_activity_list_params.rbs', line 82

def to_hash: -> {