Class: WhopSDK::Models::RefundRetrieveResponse

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

Overview

See Also:

Defined Under Namespace

Classes: Payment

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: , currency: , payment: , provider: , provider_created_at: , reference_status: , reference_type: , reference_value: , status: ) ⇒ Object

An object representing a refund made on a payment.

Parameters:

  • id (String) (defaults to: ) —

    The ID of the refund.

  • amount (Float) (defaults to: ) —

    The amount of the refund.

  • created_at (Time) (defaults to: ) —

    The time the refund was created.

  • currency (Symbol, WhopSDK::Models::Currency) (defaults to: ) —

    The currency of the refund.

  • payment (WhopSDK::Models::RefundRetrieveResponse::Payment, nil) (defaults to: ) —

    The payment associated with the refund.

  • provider (Symbol, WhopSDK::Models::PaymentProvider) (defaults to: ) —

    The provider of the refund.

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

    The time the refund was created by the provider.

  • reference_status (Symbol, WhopSDK::Models::RefundReferenceStatus, nil) (defaults to: ) —

    The status of the refund reference.

  • reference_type (Symbol, WhopSDK::Models::RefundReferenceType, nil) (defaults to: ) —

    The type of refund reference that was made available by the payment provider.

  • reference_value (String, nil) (defaults to: ) —

    The value of the reference.

  • status (Symbol, WhopSDK::Models::RefundStatus) (defaults to: ) —

    The status of the refund.




# File 'lib/whop_sdk/models/refund_retrieve_response.rb', line 73

Instance Attribute Details

#amount ⇒ Float

The amount of the refund.

Returns:

  • (Float) 


17
 
# File 'lib/whop_sdk/models/refund_retrieve_response.rb', line 17

required :amount, Float

#created_at ⇒ Time

The time the refund was created.

Returns:

  • (Time) 


23
 
# File 'lib/whop_sdk/models/refund_retrieve_response.rb', line 23

required :created_at, Time

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

The currency of the refund.

Returns:



29
 
# File 'lib/whop_sdk/models/refund_retrieve_response.rb', line 29

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

#id ⇒ String

The ID of the refund.

Returns:

  • (String) 


11
 
# File 'lib/whop_sdk/models/refund_retrieve_response.rb', line 11

required :id, String

#payment ⇒ WhopSDK::Models::RefundRetrieveResponse::Payment?

The payment associated with the refund.

Returns:



35
 
# File 'lib/whop_sdk/models/refund_retrieve_response.rb', line 35

required :payment, -> { WhopSDK::Models::RefundRetrieveResponse::Payment }, nil?: true

#provider ⇒ Symbol, WhopSDK::Models::PaymentProvider

The provider of the refund.

Returns:



41
 
# File 'lib/whop_sdk/models/refund_retrieve_response.rb', line 41

required :provider, enum: -> { WhopSDK::PaymentProvider }

#provider_created_at ⇒ Time?

The time the refund was created by the provider.

Returns:

  • (Time, nil) 


47
 
# File 'lib/whop_sdk/models/refund_retrieve_response.rb', line 47

required :provider_created_at, Time, nil?: true

#reference_status ⇒ Symbol, ...

The status of the refund reference.

Returns:



53
 
# File 'lib/whop_sdk/models/refund_retrieve_response.rb', line 53

required :reference_status, enum: -> { WhopSDK::RefundReferenceStatus }, nil?: true

#reference_type ⇒ Symbol, ...

The type of refund reference that was made available by the payment provider.

Returns:



59
 
# File 'lib/whop_sdk/models/refund_retrieve_response.rb', line 59

required :reference_type, enum: -> { WhopSDK::RefundReferenceType }, nil?: true

#reference_value ⇒ String?

The value of the reference.

Returns:

  • (String, nil) 


65
 
# File 'lib/whop_sdk/models/refund_retrieve_response.rb', line 65

required :reference_value, String, nil?: true

#status ⇒ Symbol, WhopSDK::Models::RefundStatus

The status of the refund.

Returns:



71
 
# File 'lib/whop_sdk/models/refund_retrieve_response.rb', line 71

required :status, enum: -> { WhopSDK::RefundStatus }