Class: Orb::Models::Invoice::PaymentAttempt

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/orb/models/invoice.rb

Defined Under Namespace

Modules: PaymentProvider

Instance Attribute 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: , amount: , created_at: , payment_provider: , payment_provider_id: , succeeded: ) ⇒ Object

Parameters:

  • id (String) (defaults to: )

    The ID of the payment attempt.

  • amount (String) (defaults to: )

    The amount of the payment attempt.

  • created_at (Time) (defaults to: )

    The time at which the payment attempt was created.

  • payment_provider (Symbol, Orb::Models::Invoice::PaymentAttempt::PaymentProvider, nil) (defaults to: )

    The payment provider that attempted to collect the payment.

  • payment_provider_id (String, nil) (defaults to: )

    The ID of the payment attempt in the payment provider.

  • succeeded (Boolean) (defaults to: )

    Whether the payment attempt succeeded.



# File 'lib/orb/models/invoice.rb', line 1008

Instance Attribute Details

#amountString

The amount of the payment attempt.

Returns:

  • (String)


982
# File 'lib/orb/models/invoice.rb', line 982

required :amount, String

#created_atTime

The time at which the payment attempt was created.

Returns:

  • (Time)


988
# File 'lib/orb/models/invoice.rb', line 988

required :created_at, Time

#idString

The ID of the payment attempt.

Returns:

  • (String)


976
# File 'lib/orb/models/invoice.rb', line 976

required :id, String

#payment_providerSymbol, ...

The payment provider that attempted to collect the payment.



994
# File 'lib/orb/models/invoice.rb', line 994

required :payment_provider, enum: -> { Orb::Invoice::PaymentAttempt::PaymentProvider }, nil?: true

#payment_provider_idString?

The ID of the payment attempt in the payment provider.

Returns:

  • (String, nil)


1000
# File 'lib/orb/models/invoice.rb', line 1000

required :payment_provider_id, String, nil?: true

#succeededBoolean

Whether the payment attempt succeeded.

Returns:

  • (Boolean)


1006
# File 'lib/orb/models/invoice.rb', line 1006

required :succeeded, Orb::Internal::Type::Boolean