Class: Orb::Models::InvoiceIssueSummaryParams

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

Overview

See Also:

  • Orb::Resources::Invoices#issue_summary

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:, synchronous: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Orb::Models::InvoiceIssueSummaryParams for more details.

Parameters:

  • invoice_id (String)
  • synchronous (Boolean) (defaults to: nil) —

    If true, the invoice will be issued synchronously. If false, the invoice will be

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



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

Instance Attribute Details

#invoice_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :invoice_id, String

#synchronous ⇒ Boolean?

If true, the invoice will be issued synchronously. If false, the invoice will be issued asynchronously. The synchronous option is only available for invoices that have no usage fees. If the invoice is configured to sync to an external provider, a successful response from this endpoint guarantees the invoice is present in the provider.

Parameters:

  • (Boolean)

Returns:

  • (Boolean, nil) 


23
 
# File 'lib/orb/models/invoice_issue_summary_params.rb', line 23

optional :synchronous, Orb::Internal::Type::Boolean

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


23
 
# File 'sig/orb/models/invoice_issue_summary_params.rbs', line 23

def to_hash: -> {