Class: Dodopayments::Models::ManualRetry

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/dodopayments/models/manual_retry.rb,
sig/dodopayments/models/manual_retry.rbs

Overview

See Also:

  • Dodopayments::Resources::Payments#retry_

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(invoice_id:, is_manual_retry:, payment_id:, retry_attempt:, sends_allowed:, sends_used:, retry_available_at: nil, status: nil) ⇒ Object

Some parameter documentations has been truncated, see Dodopayments::Models::ManualRetry for more details.

Parameters:

  • invoice_id (String) —

    The invoice the send charged.

  • is_manual_retry (Boolean) —

    Always true on this route. Tells the row apart from an automatic attempt.

  • payment_id (String) —

    The payment row this send created.

  • retry_attempt (Integer) —

    Which attempt this send is, counting manual sends on the invoice.

  • sends_allowed (Integer)
  • sends_used (Integer) —

    Manual sends spent on this invoice, including this one.

  • retry_available_at (Time, nil) (defaults to: nil) —

    When the next send becomes available. Null when no send is left.

  • status (Symbol, Dodopayments::Models::IntentStatus, nil) (defaults to: nil) —

    Outcome of the charge. processing means the processor has not settled it




# File 'lib/dodopayments/models/manual_retry.rb', line 55

Instance Attribute Details

#invoice_id ⇒ String

The invoice the send charged.

Parameters:

  • value (String)

Returns:

  • (String) 


11
 
# File 'lib/dodopayments/models/manual_retry.rb', line 11

required :invoice_id, String

#is_manual_retry ⇒ Boolean

Always true on this route. Tells the row apart from an automatic attempt.

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


17
 
# File 'lib/dodopayments/models/manual_retry.rb', line 17

required :is_manual_retry, Dodopayments::Internal::Type::Boolean

#payment_id ⇒ String

The payment row this send created.

Parameters:

  • value (String)

Returns:

  • (String) 


23
 
# File 'lib/dodopayments/models/manual_retry.rb', line 23

required :payment_id, String

#retry_attempt ⇒ Integer

Which attempt this send is, counting manual sends on the invoice.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


29
 
# File 'lib/dodopayments/models/manual_retry.rb', line 29

required :retry_attempt, Integer

#retry_available_at ⇒ Time?

When the next send becomes available. Null when no send is left.

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


46
 
# File 'lib/dodopayments/models/manual_retry.rb', line 46

optional :retry_available_at, Time, nil?: true

#sends_allowed ⇒ Integer

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


34
 
# File 'lib/dodopayments/models/manual_retry.rb', line 34

required :sends_allowed, Integer

#sends_used ⇒ Integer

Manual sends spent on this invoice, including this one.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


40
 
# File 'lib/dodopayments/models/manual_retry.rb', line 40

required :sends_used, Integer

#status ⇒ Symbol, ...

Outcome of the charge. processing means the processor has not settled it yet, and the payment webhooks report the result.

Parameters:

  • value (Dodopayments::Models::intent_status, nil)

Returns:



53
 
# File 'lib/dodopayments/models/manual_retry.rb', line 53

optional :status, enum: -> { Dodopayments::IntentStatus }, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


43
 
# File 'sig/dodopayments/models/manual_retry.rbs', line 43

def to_hash: -> {