Class: Orb::Models::InvoiceMarkPaidParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/orb/models/invoice_mark_paid_params.rb,
sig/orb/models/invoice_mark_paid_params.rbs

Overview

See Also:

  • Orb::Resources::Invoices#mark_paid

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

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(invoice_id:, payment_received_date:, external_id: nil, notes: nil, request_options: {}) ⇒ Object

Parameters:

  • invoice_id (String)
  • payment_received_date (Date) —

    A date string to specify the date of the payment.

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

    An optional external ID to associate with the payment.

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

    An optional note to associate with the payment.

  • request_options (Orb::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/orb/models/invoice_mark_paid_params.rb', line 33

Instance Attribute Details

#external_id ⇒ String?

An optional external ID to associate with the payment.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


25
 
# File 'lib/orb/models/invoice_mark_paid_params.rb', line 25

optional :external_id, String, nil?: true

#invoice_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


13
 
# File 'lib/orb/models/invoice_mark_paid_params.rb', line 13

required :invoice_id, String

#notes ⇒ String?

An optional note to associate with the payment.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


31
 
# File 'lib/orb/models/invoice_mark_paid_params.rb', line 31

optional :notes, String, nil?: true

#payment_received_date ⇒ Date

A date string to specify the date of the payment.

Parameters:

  • value (Date)

Returns:

  • (Date) 


19
 
# File 'lib/orb/models/invoice_mark_paid_params.rb', line 19

required :payment_received_date, Date

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


32
 
# File 'sig/orb/models/invoice_mark_paid_params.rbs', line 32

def to_hash: -> {