Class: Straddle::Models::FundingEvent

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Straddle::Models::FundingEvent

Defined in:

lib/straddle/models/funding_event.rb,
sig/straddle/models/funding_event.rbs

Constant Summary

Straddle =

Returns:

• (:FundingEventConfiguration)

Instance Attribute Summary

• #amount ⇒ Integer

  Total funding event amount in the smallest currency unit.

• #config ⇒ Straddle::Models::FundingEventConfiguration^?

  Configuration used to process this funding event.

• #created_at ⇒ Time

  Timestamp when this funding event was created.

• #direction ⇒ Symbol, Straddle::Models::FundingEventTransferDirection

  Transfer direction relative to the linked bank account.

• #event_type ⇒ Symbol, Straddle::Models::FundingEventType

  Reason for the funding event.

• #id ⇒ String

  Unique identifier for this funding event.

• #linked_bank_account_details ⇒ Straddle::Models::UnmaskedLinkedBankAccountDetails^?

  Details of the linked bank account used for this funding event.

• #payment_count ⇒ Integer

  Number of payments included in this funding event.

• #status ⇒ Symbol, ...

  Current status of this funding event.

• #status_details ⇒ Straddle::Models::PaymentStatusDetails^?

  Reason, source, and message for the most recent status change.

• #status_history ⇒ Array<Straddle::Models::PaymentStatusHistory>

  Complete ordered history of all status changes for this funding event.

• #trace_ids ⇒ Hash{Symbol=>String}

  Network-level trace identifiers assigned during processing.

• #trace_numbers ⇒ Array<String>

  Network trace numbers associated with payments in this funding event.

• #transfer_date ⇒ Date

  The date the funds transfer was initiated.

• #updated_at ⇒ Time

  Timestamp when this funding event was last updated.

Instance Method Summary

• #initialize(id:, amount:, created_at:, direction:, event_type:, payment_count:, status_history:, trace_ids:, trace_numbers:, transfer_date:, updated_at:, config: nil, linked_bank_account_details: nil, status: nil, status_details: nil) ⇒ Object constructor

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

• #to_hash ⇒ {

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:, amount:, created_at:, direction:, event_type:, payment_count:, status_history:, trace_ids:, trace_numbers:, transfer_date:, updated_at:, config: nil, linked_bank_account_details: nil, status: nil, status_details: nil) ⇒ Object

Some parameter documentations has been truncated, see Straddle::Models::FundingEvent for more details.

Parameters:

• id (String) —

  Unique identifier for this funding event.

• amount (Integer) —

  Total funding event amount in the smallest currency unit. For example, 1000 is

• created_at (Time) —

  Timestamp when this funding event was created.

• direction (Symbol, Straddle::Models::FundingEventTransferDirection) —

  Transfer direction relative to the linked bank account. deposit moves funds in

• event_type (Symbol, Straddle::Models::FundingEventType) —

  Reason for the funding event. charge_deposit settles collected charges to the

• payment_count (Integer) —

  Number of payments included in this funding event.

• status_history (Array<Straddle::Models::PaymentStatusHistory>) —

  Complete ordered history of all status changes for this funding event.

• trace_ids (Hash{Symbol=>String}) —

  Network-level trace identifiers assigned during processing. Keys vary by payment

• trace_numbers (Array<String>) —

  Network trace numbers associated with payments in this funding event.

• transfer_date (Date) —

  The date the funds transfer was initiated.

• updated_at (Time) —

  Timestamp when this funding event was last updated.

• config (Straddle::Models::FundingEventConfiguration) (defaults to: nil) —

  Configuration used to process this funding event.

• linked_bank_account_details (Straddle::Models::UnmaskedLinkedBankAccountDetails) (defaults to: nil) —

  Details of the linked bank account used for this funding event.

• status (Symbol, Straddle::Models::PaymentStatus) (defaults to: nil) —

  Current status of this funding event.

• status_details (Straddle::Models::PaymentStatusDetails) (defaults to: nil) —

  Reason, source, and message for the most recent status change.

# File 'lib/straddle/models/funding_event.rb', line 102

Instance Attribute Details

#amount ⇒ Integer

Total funding event amount in the smallest currency unit. For example, 1000 is $10.00 USD.

Parameters:

• value (Integer)

Returns:

• (Integer)

# File 'lib/straddle/models/funding_event.rb', line 17

required :amount, Integer

#config ⇒ Straddle::Models::FundingEventConfiguration^?

Configuration used to process this funding event.

Returns:

• (Straddle::Models::FundingEventConfiguration, nil)

# File 'lib/straddle/models/funding_event.rb', line 82

optional :config, -> { Straddle::FundingEventConfiguration }

#created_at ⇒ Time

Timestamp when this funding event was created.

Parameters:

• value (Time)

Returns:

• (Time)

# File 'lib/straddle/models/funding_event.rb', line 23

required :created_at, Time

#direction ⇒ Symbol, Straddle::Models::FundingEventTransferDirection

Transfer direction relative to the linked bank account. deposit moves funds into the account, and withdrawal moves funds out.

Parameters:

• value (Straddle::Models::funding_event_transfer_direction)

Returns:

• (Symbol, Straddle::Models::FundingEventTransferDirection)

# File 'lib/straddle/models/funding_event.rb', line 30

required :direction, enum: -> { Straddle::FundingEventTransferDirection }

#event_type ⇒ Symbol, Straddle::Models::FundingEventType

Reason for the funding event. charge_deposit settles collected charges to the linked bank account. charge_reversal withdraws funds for reversed charges. payout_withdrawal withdraws funds for payouts. payout_return deposits returned payout funds.

Parameters:

• value (Straddle::Models::funding_event_type)

Returns:

• (Symbol, Straddle::Models::FundingEventType)

# File 'lib/straddle/models/funding_event.rb', line 39

required :event_type, enum: -> { Straddle::FundingEventType }

#id ⇒ String

Unique identifier for this funding event.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/straddle/models/funding_event.rb', line 10

required :id, String

#linked_bank_account_details ⇒ Straddle::Models::UnmaskedLinkedBankAccountDetails^?

Details of the linked bank account used for this funding event.

Returns:

• (Straddle::Models::UnmaskedLinkedBankAccountDetails, nil)

# File 'lib/straddle/models/funding_event.rb', line 88

optional :linked_bank_account_details, -> { Straddle::UnmaskedLinkedBankAccountDetails }

#payment_count ⇒ Integer

Number of payments included in this funding event.

Parameters:

• value (Integer)

Returns:

• (Integer)

# File 'lib/straddle/models/funding_event.rb', line 45

required :payment_count, Integer

#status ⇒ Symbol, ...

Current status of this funding event.

Returns:

• (Symbol, Straddle::Models::PaymentStatus, nil)

# File 'lib/straddle/models/funding_event.rb', line 94

optional :status, enum: -> { Straddle::PaymentStatus }

#status_details ⇒ Straddle::Models::PaymentStatusDetails^?

Reason, source, and message for the most recent status change.

Returns:

• (Straddle::Models::PaymentStatusDetails, nil)

# File 'lib/straddle/models/funding_event.rb', line 100

optional :status_details, -> { Straddle::PaymentStatusDetails }

#status_history ⇒ Array<Straddle::Models::PaymentStatusHistory>

Complete ordered history of all status changes for this funding event.

Parameters:

• value (::Array[Straddle::PaymentStatusHistory])

Returns:

• (Array<Straddle::Models::PaymentStatusHistory>)

# File 'lib/straddle/models/funding_event.rb', line 51

required :status_history, -> { Straddle::Internal::Type::ArrayOf[Straddle::PaymentStatusHistory] }

#trace_ids ⇒ Hash{Symbol=>String}

Network-level trace identifiers assigned during processing. Keys vary by payment rail.

Parameters:

• value (::Hash[Symbol, String])

Returns:

• (Hash{Symbol=>String})

# File 'lib/straddle/models/funding_event.rb', line 58

required :trace_ids, Straddle::Internal::Type::HashOf[String]

#trace_numbers ⇒ Array<String>

Network trace numbers associated with payments in this funding event.

Parameters:

• value (::Array[String])

Returns:

• (Array<String>)

# File 'lib/straddle/models/funding_event.rb', line 64

required :trace_numbers, Straddle::Internal::Type::ArrayOf[String]

#transfer_date ⇒ Date

The date the funds transfer was initiated.

Parameters:

• value (Date)

Returns:

• (Date)

# File 'lib/straddle/models/funding_event.rb', line 70

required :transfer_date, Date

#updated_at ⇒ Time

Timestamp when this funding event was last updated.

Parameters:

• value (Time)

Returns:

• (Time)

# File 'lib/straddle/models/funding_event.rb', line 76

required :updated_at, Time

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/straddle/models/funding_event.rbs', line 87

def to_hash: -> {