Class: WhopSDK::Models::Payment::Dispute

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

Instance Attribute Summary collapse

Method Summary

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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

This class inherits a constructor from WhopSDK::Internal::Type::BaseModel

Instance Attribute Details

#amount ⇒ Float

The disputed amount in the specified currency, formatted as a decimal.

Returns:

  • (Float) 


537
 
# File 'lib/whop_sdk/models/payment.rb', line 537

required :amount, Float

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

The three-letter ISO currency code for the disputed amount.

Returns:



543
 
# File 'lib/whop_sdk/models/payment.rb', line 543

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

#editable ⇒ Boolean?

Whether the dispute evidence can still be edited and submitted. Returns true only when the dispute status requires a response.

Returns:

  • (Boolean, nil) 


550
 
# File 'lib/whop_sdk/models/payment.rb', line 550

required :editable, WhopSDK::Internal::Type::Boolean, nil?: true

#id ⇒ String

The unique identifier for the dispute.

Returns:

  • (String) 


531
 
# File 'lib/whop_sdk/models/payment.rb', line 531

required :id, String

#needs_response_by ⇒ Time?

The deadline by which dispute evidence must be submitted. Null if no response deadline is set.

Returns:

  • (Time, nil) 


557
 
# File 'lib/whop_sdk/models/payment.rb', line 557

required :needs_response_by, Time, nil?: true

#notes ⇒ String?

Additional freeform notes submitted by the company as part of the dispute evidence.

Returns:

  • (String, nil) 


564
 
# File 'lib/whop_sdk/models/payment.rb', line 564

required :notes, String, nil?: true

#reason ⇒ String?

A human-readable reason for the dispute.

Returns:

  • (String, nil) 


570
 
# File 'lib/whop_sdk/models/payment.rb', line 570

required :reason, String, nil?: true

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

The current status of the dispute lifecycle, such as needs_response, under_review, won, or lost.

Returns:



577
 
# File 'lib/whop_sdk/models/payment.rb', line 577

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