Class: Dodopayments::Models::RefundCreateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Dodopayments::Models::RefundCreateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/dodopayments/models/refund_create_params.rb,
sig/dodopayments/models/refund_create_params.rbs

Overview

See Also:

• Dodopayments::Resources::Refunds#create

Defined Under Namespace

Classes: Item

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::Dodopayments

Instance Attribute Summary

• #items ⇒ Array<Dodopayments::Models::RefundCreateParams::Item>^?

  Partially Refund an Individual Item.

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

  Additional metadata associated with the refund.

• #payment_id ⇒ String

  The unique identifier of the payment to be refunded.

• #reason ⇒ String^?

  The reason for the refund, if any.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize ⇒ Object constructor
• #to_hash ⇒ {

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

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 ⇒ Object

# File 'sig/dodopayments/models/refund_create_params.rbs', line 28

def initialize: (

Instance Attribute Details

#items ⇒ Array<Dodopayments::Models::RefundCreateParams::Item>^?

Partially Refund an Individual Item

Parameters:

• value (::Array[Dodopayments::RefundCreateParams::Item], nil)

Returns:

• (Array<Dodopayments::Models::RefundCreateParams::Item>, nil)

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

optional :items,
-> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::RefundCreateParams::Item] },
nil?: true

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

Additional metadata associated with the refund.

Returns:

• (Hash{Symbol=>String, Float, Boolean}, nil)

# File 'lib/dodopayments/models/refund_create_params.rb', line 28

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

#payment_id ⇒ String

The unique identifier of the payment to be refunded.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/dodopayments/models/refund_create_params.rb', line 14

required :payment_id, String

#reason ⇒ String^?

The reason for the refund, if any. Maximum length is 3000 characters. Optional.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/dodopayments/models/refund_create_params.rb', line 34

optional :reason, String, nil?: true

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/dodopayments/models/refund_create_params.rbs', line 36

def to_hash: -> {