Class: Dodopayments::Models::PaymentListResponse

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

Overview

See Also:

  • Dodopayments::Resources::Payments#list

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(brand_id:, created_at:, currency:, customer:, digital_products_delivered:, has_license_key:, metadata:, payment_id:, payment_provider:, total_amount:, card_last_four: nil, card_network: nil, dispute_status: nil, invoice_id: nil, invoice_url: nil, payment_method: nil, payment_method_type: nil, refund_status: nil, status: nil, subscription_id: nil) ⇒ Object

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

Parameters:

  • Arbitrary key-value metadata. Values can be string, integer, number, or boolean.

  • Which processor handled this payment. stripe / adyen for BYOP routes

  • (defaults to: nil)

    The last four digits of the card

  • (defaults to: nil)

    Card network like VISA, MASTERCARD etc.

  • (defaults to: nil)

    The most recent dispute status for this payment. None if no disputes exist.

  • (defaults to: nil)

    Invoice ID for this payment. Uses India-specific invoice ID if available.

  • (defaults to: nil)

    URL to download the invoice PDF for this payment.

  • (defaults to: nil)
  • (defaults to: nil)
  • (defaults to: nil)

    Summary of the refund status for this payment. None if no succeeded refunds exis

  • (defaults to: nil)
  • (defaults to: nil) 



# File 'lib/dodopayments/models/payment_list_response.rb', line 117

Instance Attribute Details

#brand_id ⇒ String

Parameters:

Returns:



10
 
# File 'lib/dodopayments/models/payment_list_response.rb', line 10

required :brand_id, String

#card_last_four ⇒ String?

The last four digits of the card

Parameters:

Returns:



64
 
# File 'lib/dodopayments/models/payment_list_response.rb', line 64

optional :card_last_four, String, nil?: true

#card_network ⇒ String?

Card network like VISA, MASTERCARD etc.

Parameters:

Returns:



70
 
# File 'lib/dodopayments/models/payment_list_response.rb', line 70

optional :card_network, String, nil?: true

#created_at ⇒ Time

Parameters:

Returns:



15
 
# File 'lib/dodopayments/models/payment_list_response.rb', line 15

required :created_at, Time

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

Parameters:

Returns:



20
 
# File 'lib/dodopayments/models/payment_list_response.rb', line 20

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

#customer ⇒ Dodopayments::Models::CustomerLimitedDetails

Parameters:

Returns:



25
 
# File 'lib/dodopayments/models/payment_list_response.rb', line 25

required :customer, -> { Dodopayments::CustomerLimitedDetails }

#digital_products_delivered ⇒ Boolean

Parameters:

Returns:



30
 
# File 'lib/dodopayments/models/payment_list_response.rb', line 30

required :digital_products_delivered, Dodopayments::Internal::Type::Boolean

#dispute_status ⇒ Symbol, ...

The most recent dispute status for this payment. None if no disputes exist.

Parameters:

Returns:



76
 
# File 'lib/dodopayments/models/payment_list_response.rb', line 76

optional :dispute_status, enum: -> { Dodopayments::DisputeStatus }, nil?: true

#has_license_key ⇒ Boolean

Parameters:

Returns:



35
 
# File 'lib/dodopayments/models/payment_list_response.rb', line 35

required :has_license_key, Dodopayments::Internal::Type::Boolean

#invoice_id ⇒ String?

Invoice ID for this payment. Uses India-specific invoice ID if available.

Parameters:

Returns:



82
 
# File 'lib/dodopayments/models/payment_list_response.rb', line 82

optional :invoice_id, String, nil?: true

#invoice_url ⇒ String?

URL to download the invoice PDF for this payment.

Parameters:

Returns:



88
 
# File 'lib/dodopayments/models/payment_list_response.rb', line 88

optional :invoice_url, String, nil?: true

#metadata ⇒ Hash{Symbol=>String, Float, Boolean}

Arbitrary key-value metadata. Values can be string, integer, number, or boolean.

Parameters:

Returns:



41
 
# File 'lib/dodopayments/models/payment_list_response.rb', line 41

required :metadata, -> { Dodopayments::Internal::Type::HashOf[union: Dodopayments::MetadataItem] }

#payment_id ⇒ String

Parameters:

Returns:



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

required :payment_id, String

#payment_method ⇒ String?

Parameters:

Returns:



93
 
# File 'lib/dodopayments/models/payment_list_response.rb', line 93

optional :payment_method, String, nil?: true

#payment_method_type ⇒ String?

Parameters:

Returns:



98
 
# File 'lib/dodopayments/models/payment_list_response.rb', line 98

optional :payment_method_type, String, nil?: true

#payment_provider ⇒ Symbol, Dodopayments::Models::PaymentListResponse::PaymentProvider

Which processor handled this payment. stripe / adyen for BYOP routes (the merchant's own payment connector); dodo for everything Dodo processed itself.

Parameters:

Returns:



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

required :payment_provider, enum: -> { Dodopayments::Models::PaymentListResponse::PaymentProvider }

#refund_status ⇒ Symbol, ...

Summary of the refund status for this payment. None if no succeeded refunds exist.

Parameters:

Returns:



105
 
# File 'lib/dodopayments/models/payment_list_response.rb', line 105

optional :refund_status, enum: -> { Dodopayments::PaymentRefundStatus }, nil?: true

#status ⇒ Symbol, ...

Parameters:

Returns:



110
 
# File 'lib/dodopayments/models/payment_list_response.rb', line 110

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

#subscription_id ⇒ String?

Parameters:

Returns:



115
 
# File 'lib/dodopayments/models/payment_list_response.rb', line 115

optional :subscription_id, String, nil?: true

#total_amount ⇒ Integer

Parameters:

Returns:



58
 
# File 'lib/dodopayments/models/payment_list_response.rb', line 58

required :total_amount, Integer

Instance Method Details

#to_hash ⇒ {

Returns:



91
 
# File 'sig/dodopayments/models/payment_list_response.rbs', line 91

def to_hash: -> {