Class: WhopSDK::Models::Dispute

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• WhopSDK::Models::Dispute

Defined in:

lib/whop_sdk/models/dispute.rb

Overview

See Also:

• Resources::Disputes#retrieve

Defined Under Namespace

Classes: CancellationPolicyAttachment, Company, CustomerCommunicationAttachment, Payment, Plan, Product, RefundPolicyAttachment, UncategorizedAttachment

Instance Attribute Summary

• #access_activity_log ⇒ String^?

  A log of IP-based access activity for the customer on Whop, submitted as evidence in the dispute.

• #amount ⇒ Float

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

• #billing_address ⇒ String^?

  The customer’s billing address from their payment details, submitted as evidence in the dispute.

• #cancellation_policy_attachment ⇒ WhopSDK::Models::Dispute::CancellationPolicyAttachment^?

  The cancellation policy document uploaded as dispute evidence.

• #cancellation_policy_disclosure ⇒ String^?

  A text disclosure describing the company’s cancellation policy, submitted as dispute evidence.

• #company ⇒ WhopSDK::Models::Dispute::Company^?

  The company that the dispute was filed against.

• #created_at ⇒ Time^?

  The datetime the dispute was created.

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

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

• #customer_communication_attachment ⇒ WhopSDK::Models::Dispute::CustomerCommunicationAttachment^?

  Evidence of customer communication or product usage, uploaded as a dispute attachment.

• #customer_email_address ⇒ String^?

  The customer’s email address from their payment details, included in the evidence packet sent to the payment processor.

• #customer_name ⇒ String^?

  The customer’s full name from their payment details, included in the evidence packet sent to the payment processor.

• #editable ⇒ Boolean^?

  Whether the dispute evidence can still be edited and submitted.

• #id ⇒ String

  The unique identifier for the dispute.

• #needs_response_by ⇒ Time^?

  The deadline by which dispute evidence must be submitted.

• #notes ⇒ String^?

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

• #payment ⇒ WhopSDK::Models::Dispute::Payment^?

  The original payment that was disputed.

• #plan ⇒ WhopSDK::Models::Dispute::Plan^?

  The plan associated with the disputed payment.

• #product ⇒ WhopSDK::Models::Dispute::Product^?

  The product associated with the disputed payment.

• #product_description ⇒ String^?

  A description of the product or service provided, submitted as dispute evidence.

• #reason ⇒ String^?

  A human-readable reason for the dispute.

• #refund_policy_attachment ⇒ WhopSDK::Models::Dispute::RefundPolicyAttachment^?

  The refund policy document uploaded as dispute evidence.

• #refund_policy_disclosure ⇒ String^?

  A text disclosure describing the company’s refund policy, submitted as dispute evidence.

• #refund_refusal_explanation ⇒ String^?

  An explanation from the company for why a refund was refused, submitted as dispute evidence.

• #service_date ⇒ String^?

  The date when the product or service was delivered to the customer, submitted as dispute evidence.

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

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

• #uncategorized_attachment ⇒ WhopSDK::Models::Dispute::UncategorizedAttachment^?

  An additional attachment that does not fit into the standard evidence categories.

• #visa_rdr ⇒ Boolean

  Whether the dispute was automatically resolved through Visa Rapid Dispute Resolution (RDR).

Instance Method Summary

• #initialize(id:, content_type:, filename:, url:) ⇒ Object constructor

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

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:, content_type:, filename:, url:) ⇒ Object

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

The refund policy document uploaded as dispute evidence. Null if no refund policy has been provided.

Parameters:

• id (String) —

  Represents a unique identifier that is Base64 obfuscated. It is often used to re

• content_type (String, nil) —

  The MIME type of the uploaded file (e.g., image/jpeg, video/mp4, audio/mpeg).

• filename (String, nil) —

  The original filename of the uploaded attachment, including its file extension.

• url (String, nil) —

  A pre-optimized URL for rendering this attachment on the client. This should be

# File 'lib/whop_sdk/models/dispute.rb', line 192

Instance Attribute Details

#access_activity_log ⇒ String^?

A log of IP-based access activity for the customer on Whop, submitted as evidence in the dispute.

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/dispute.rb', line 18

required :access_activity_log, String, nil?: true

#amount ⇒ Float

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

Returns:

• (Float)

# File 'lib/whop_sdk/models/dispute.rb', line 24

required :amount, Float

#billing_address ⇒ String^?

The customer’s billing address from their payment details, submitted as evidence in the dispute.

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/dispute.rb', line 31

required :billing_address, String, nil?: true

#cancellation_policy_attachment ⇒ WhopSDK::Models::Dispute::CancellationPolicyAttachment^?

The cancellation policy document uploaded as dispute evidence. Null if no cancellation policy has been provided.

Returns:

• (WhopSDK::Models::Dispute::CancellationPolicyAttachment, nil)

# File 'lib/whop_sdk/models/dispute.rb', line 38

required :cancellation_policy_attachment,
-> { WhopSDK::Dispute::CancellationPolicyAttachment },
nil?: true

#cancellation_policy_disclosure ⇒ String^?

A text disclosure describing the company’s cancellation policy, submitted as dispute evidence.

Returns:

• (String, nil)

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

required :cancellation_policy_disclosure, String, nil?: true

#company ⇒ WhopSDK::Models::Dispute::Company^?

The company that the dispute was filed against.

Returns:

• (WhopSDK::Models::Dispute::Company, nil)

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

required :company, -> { WhopSDK::Dispute::Company }, nil?: true

#created_at ⇒ Time^?

The datetime the dispute was created.

Returns:

• (Time, nil)

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

required :created_at, Time, nil?: true

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

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

Returns:

• (Symbol, WhopSDK::Models::Currency)

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

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

#customer_communication_attachment ⇒ WhopSDK::Models::Dispute::CustomerCommunicationAttachment^?

Evidence of customer communication or product usage, uploaded as a dispute attachment. Null if not provided.

Returns:

• (WhopSDK::Models::Dispute::CustomerCommunicationAttachment, nil)

# File 'lib/whop_sdk/models/dispute.rb', line 72

required :customer_communication_attachment,
-> { WhopSDK::Dispute::CustomerCommunicationAttachment },
nil?: true

#customer_email_address ⇒ String^?

The customer’s email address from their payment details, included in the evidence packet sent to the payment processor. Editable before submission.

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/dispute.rb', line 81

required :customer_email_address, String, nil?: true

#customer_name ⇒ String^?

The customer’s full name from their payment details, included in the evidence packet sent to the payment processor. Editable before submission.

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/dispute.rb', line 88

required :customer_name, String, nil?: true

#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)

# File 'lib/whop_sdk/models/dispute.rb', line 95

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

#id ⇒ String

The unique identifier for the dispute.

Returns:

• (String)

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

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)

# File 'lib/whop_sdk/models/dispute.rb', line 102

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)

# File 'lib/whop_sdk/models/dispute.rb', line 109

required :notes, String, nil?: true

#payment ⇒ WhopSDK::Models::Dispute::Payment^?

The original payment that was disputed.

Returns:

• (WhopSDK::Models::Dispute::Payment, nil)

# File 'lib/whop_sdk/models/dispute.rb', line 115

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

#plan ⇒ WhopSDK::Models::Dispute::Plan^?

The plan associated with the disputed payment. Null if the dispute is not linked to a specific plan.

Returns:

• (WhopSDK::Models::Dispute::Plan, nil)

# File 'lib/whop_sdk/models/dispute.rb', line 122

required :plan, -> { WhopSDK::Dispute::Plan }, nil?: true

#product ⇒ WhopSDK::Models::Dispute::Product^?

The product associated with the disputed payment. Null if the dispute is not linked to a specific product.

Returns:

• (WhopSDK::Models::Dispute::Product, nil)

# File 'lib/whop_sdk/models/dispute.rb', line 129

required :product, -> { WhopSDK::Dispute::Product }, nil?: true

#product_description ⇒ String^?

A description of the product or service provided, submitted as dispute evidence.

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/dispute.rb', line 135

required :product_description, String, nil?: true

#reason ⇒ String^?

A human-readable reason for the dispute.

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/dispute.rb', line 141

required :reason, String, nil?: true

#refund_policy_attachment ⇒ WhopSDK::Models::Dispute::RefundPolicyAttachment^?

The refund policy document uploaded as dispute evidence. Null if no refund policy has been provided.

Returns:

• (WhopSDK::Models::Dispute::RefundPolicyAttachment, nil)

# File 'lib/whop_sdk/models/dispute.rb', line 148

required :refund_policy_attachment, -> { WhopSDK::Dispute::RefundPolicyAttachment }, nil?: true

#refund_policy_disclosure ⇒ String^?

A text disclosure describing the company’s refund policy, submitted as dispute evidence.

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/dispute.rb', line 155

required :refund_policy_disclosure, String, nil?: true

#refund_refusal_explanation ⇒ String^?

An explanation from the company for why a refund was refused, submitted as dispute evidence.

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/dispute.rb', line 162

required :refund_refusal_explanation, String, nil?: true

#service_date ⇒ String^?

The date when the product or service was delivered to the customer, submitted as dispute evidence.

Returns:

• (String, nil)

# File 'lib/whop_sdk/models/dispute.rb', line 169

required :service_date, 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:

• (Symbol, WhopSDK::Models::DisputeStatuses)

# File 'lib/whop_sdk/models/dispute.rb', line 176

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

#uncategorized_attachment ⇒ WhopSDK::Models::Dispute::UncategorizedAttachment^?

An additional attachment that does not fit into the standard evidence categories. Null if not provided.

Returns:

• (WhopSDK::Models::Dispute::UncategorizedAttachment, nil)

# File 'lib/whop_sdk/models/dispute.rb', line 183

required :uncategorized_attachment, -> { WhopSDK::Dispute::UncategorizedAttachment }, nil?: true

#visa_rdr ⇒ Boolean

Whether the dispute was automatically resolved through Visa Rapid Dispute Resolution (RDR).

Returns:

• (Boolean)

# File 'lib/whop_sdk/models/dispute.rb', line 190

required :visa_rdr, WhopSDK::Internal::Type::Boolean