Class: WhopSDK::Models::Transfer

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/whop_sdk/models/transfer.rb

Defined Under Namespace

Modules: Destination, Origin

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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(id: , route: , title: , typename: :Company) ⇒ Object

An object representing a (sanitized) company.

Parameters:

  • id (String) (defaults to: ) —

    The ID (tag) of the company.

  • route (String) (defaults to: ) —

    The slug/route of the company on the Whop site.

  • title (String) (defaults to: ) —

    The title of the company.

  • typename (Symbol, :Company) (defaults to: :Company) —

    The typename of this object




# File 'lib/whop_sdk/models/transfer.rb', line 66

Instance Attribute Details

#amount ⇒ Float

The amount of the credit transaction transfer

Returns:

  • (Float) 


16
 
# File 'lib/whop_sdk/models/transfer.rb', line 16

required :amount, Float

#created_at ⇒ Time

The timestamp when the credit transaction transfer was created

Returns:

  • (Time) 


22
 
# File 'lib/whop_sdk/models/transfer.rb', line 22

required :created_at, Time

#currency ⇒ Symbol, WhopSDK::Models::Currency

The currency of the credit transaction transfer

Returns:



28
 
# File 'lib/whop_sdk/models/transfer.rb', line 28

required :currency, enum: -> { WhopSDK::Currency }

#destination ⇒ WhopSDK::Models::Transfer::Destination::User, ...

The recipient of the credit transaction transfer

Returns:



34
 
# File 'lib/whop_sdk/models/transfer.rb', line 34

required :destination, union: -> { WhopSDK::Transfer::Destination }

#destination_ledger_account_id ⇒ String

The ID of the destination ledger account

Returns:

  • (String) 


40
 
# File 'lib/whop_sdk/models/transfer.rb', line 40

required :destination_ledger_account_id, String

#fee_amount ⇒ Float?

The decimal fee of the credit transaction transfer

Returns:

  • (Float, nil) 


46
 
# File 'lib/whop_sdk/models/transfer.rb', line 46

required :fee_amount, Float, nil?: true

#id ⇒ String

The unique identifier of the credit transaction transfer

Returns:

  • (String) 


10
 
# File 'lib/whop_sdk/models/transfer.rb', line 10

required :id, String

#notes ⇒ String?

The notes of the credit transaction transfer

Returns:

  • (String, nil) 


52
 
# File 'lib/whop_sdk/models/transfer.rb', line 52

required :notes, String, nil?: true

#origin ⇒ WhopSDK::Models::Transfer::Origin::User, ...

The sender of the credit transaction transfer

Returns:



58
 
# File 'lib/whop_sdk/models/transfer.rb', line 58

required :origin, union: -> { WhopSDK::Transfer::Origin }

#origin_ledger_account_id ⇒ String

The ID of the origin ledger account

Returns:

  • (String) 


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

required :origin_ledger_account_id, String