Class: Increase::Models::CardDispute

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/increase/models/card_dispute.rb

Overview

See Also:

Defined Under Namespace

Modules: Status, Type Classes: Acceptance, Loss, Rejection, Win

Instance Attribute Summary collapse

Class Method 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(card_dispute_id: , explanation: , rejected_at: ) ⇒ Object

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

If the Card Dispute’s status is ‘rejected`, this will contain details of the unsuccessful dispute.

Parameters:

  • card_dispute_id (String) (defaults to: ) —

    The identifier of the Card Dispute that was rejected.

  • explanation (String) (defaults to: ) —

    Why the Card Dispute was rejected.

  • rejected_at (Time) (defaults to: ) —

    The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time at which th




# File 'lib/increase/models/card_dispute.rb', line 87

Instance Attribute Details

#acceptance ⇒ Increase::Models::CardDispute::Acceptance?

If the Card Dispute’s status is ‘accepted`, this will contain details of the successful dispute.

Returns:



18
 
# File 'lib/increase/models/card_dispute.rb', line 18

required :acceptance, -> { Increase::CardDispute::Acceptance }, nil?: true

#amount ⇒ Integer?

The amount of the dispute, if provided, or the transaction amount otherwise.

Returns:

  • (Integer, nil) 


24
 
# File 'lib/increase/models/card_dispute.rb', line 24

required :amount, Integer, nil?: true

#created_at ⇒ Time

The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time at which the Card Dispute was created.

Returns:

  • (Time) 


31
 
# File 'lib/increase/models/card_dispute.rb', line 31

required :created_at, Time

#disputed_transaction_id ⇒ String

The identifier of the Transaction that was disputed.

Returns:

  • (String) 


37
 
# File 'lib/increase/models/card_dispute.rb', line 37

required :disputed_transaction_id, String

#explanation ⇒ String

Why you disputed the Transaction in question.

Returns:

  • (String) 


43
 
# File 'lib/increase/models/card_dispute.rb', line 43

required :explanation, String

#id ⇒ String

The Card Dispute identifier.

Returns:

  • (String) 


11
 
# File 'lib/increase/models/card_dispute.rb', line 11

required :id, String

#idempotency_key ⇒ String?

The idempotency key you chose for this object. This value is unique across Increase and is used to ensure that a request is only processed once. Learn more about [idempotency](increase.com/documentation/idempotency-keys).

Returns:

  • (String, nil) 


51
 
# File 'lib/increase/models/card_dispute.rb', line 51

required :idempotency_key, String, nil?: true

#loss ⇒ Increase::Models::CardDispute::Loss?

If the Card Dispute’s status is ‘lost`, this will contain details of the lost dispute.

Returns:



58
 
# File 'lib/increase/models/card_dispute.rb', line 58

required :loss, -> { Increase::CardDispute::Loss }, nil?: true

#rejection ⇒ Increase::Models::CardDispute::Rejection?

If the Card Dispute’s status is ‘rejected`, this will contain details of the unsuccessful dispute.

Returns:



65
 
# File 'lib/increase/models/card_dispute.rb', line 65

required :rejection, -> { Increase::CardDispute::Rejection }, nil?: true

#status ⇒ Symbol, Increase::Models::CardDispute::Status

The results of the Dispute investigation.

Returns:



71
 
# File 'lib/increase/models/card_dispute.rb', line 71

required :status, enum: -> { Increase::CardDispute::Status }

#type ⇒ Symbol, Increase::Models::CardDispute::Type

A constant representing the object’s type. For this resource it will always be ‘card_dispute`.

Returns:



78
 
# File 'lib/increase/models/card_dispute.rb', line 78

required :type, enum: -> { Increase::CardDispute::Type }

#win ⇒ Increase::Models::CardDispute::Win?

If the Card Dispute’s status is ‘won`, this will contain details of the won dispute.

Returns:



85
 
# File 'lib/increase/models/card_dispute.rb', line 85

required :win, -> { Increase::CardDispute::Win }, nil?: true

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/increase/models/card_dispute.rb', line 257