Class: WhopSDK::Models::Payouts::MethodListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/whop_sdk/models/payouts/method_list_params.rb,
sig/whop_sdk/models/payouts/method_list_params.rbs

Overview

See Also:

  • WhopSDK::Resources::Payouts::Methods#list

Defined Under Namespace

Modules: Status

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

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, after: nil, amount: nil, before: nil, currency: nil, first: nil, include_available: nil, last: nil, status: nil, user_id: nil, request_options: {}) ⇒ Object

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

Parameters:

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

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

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

    Cursor to fetch the page after (from page_info.end_cursor).

  • amount (Float) (defaults to: nil) —

    Optional withdrawal amount in whole currency units, for example 250.00. When p

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

    Cursor to fetch the page before (from page_info.start_cursor).

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

    Currency code of the amount, for example usd. Only meaningful with amount.

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

    Number of payout methods to return from the start of the window. Capped at 25 wh

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

    When true, the response also carries available_destinations — payout rails the a

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

    Number of payout methods to return from the end of the window.

  • status (Symbol, WhopSDK::Models::Payouts::MethodListParams::Status) (defaults to: nil) —

    Optional status filter. created means saved but unused, active means a payou

  • 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/payouts/method_list_params.rb', line 78

Instance Attribute Details

#account_id ⇒ String?

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

Parameters:

  • (String)

Returns:

  • (String, nil) 


15
 
# File 'lib/whop_sdk/models/payouts/method_list_params.rb', line 15

optional :account_id, String

#after ⇒ String?

Cursor to fetch the page after (from page_info.end_cursor).

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :after, String

#amount ⇒ Float?

Optional withdrawal amount in whole currency units, for example 250.00. When provided, each method includes a quote with the estimated fee, amount received, and delivery date for that amount.

Parameters:

  • (Float)

Returns:

  • (Float, nil) 


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

optional :amount, Float

#before ⇒ String?

Cursor to fetch the page before (from page_info.start_cursor).

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :before, String

#currency ⇒ String?

Currency code of the amount, for example usd. Only meaningful with amount.

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :currency, String

#first ⇒ Integer?

Number of payout methods to return from the start of the window. Capped at 25 when an amount is provided.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


48
 
# File 'lib/whop_sdk/models/payouts/method_list_params.rb', line 48

optional :first, Integer

#include_available ⇒ Boolean?

When true, the response also carries available_destinations — payout rails the account could add as a new payout method, with per-currency quotes when an amount is provided.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


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

optional :include_available, WhopSDK::Internal::Type::Boolean

#last ⇒ Integer?

Number of payout methods to return from the end of the window.

Parameters:

  • (Integer)

Returns:

  • (Integer, nil) 


62
 
# File 'lib/whop_sdk/models/payouts/method_list_params.rb', line 62

optional :last, Integer

#status ⇒ Symbol, ...

Optional status filter. created means saved but unused, active means a payout through it succeeded, broken means the last payout failed and the method needs fixing.

Returns:



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

optional :status, enum: -> { WhopSDK::Payouts::MethodListParams::Status }

#user_id ⇒ String?

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

Parameters:

  • (String)

Returns:

  • (String, nil) 


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

optional :user_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


79
 
# File 'sig/whop_sdk/models/payouts/method_list_params.rbs', line 79

def to_hash: -> {