Class: Orb::Models::CreditBlockListInvoicesResponse::Block

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/orb/models/credit_block_list_invoices_response.rb,
sig/orb/models/credit_block_list_invoices_response.rbs

Overview

See Also:

  • Orb::Models::CreditBlockListInvoicesResponse#block

Defined Under Namespace

Modules: CreditBlockSource, Status Classes: CreditAllocation, CreditCommitment, Filter

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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:, balance:, credit_block_source:, effective_date:, expiry_date:, filters:, maximum_initial_balance:, metadata:, per_unit_cost_basis:, status:, credit_allocation: nil, credit_commitment: nil) ⇒ Object

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

The Credit Block resource models prepaid credits within Orb.

Parameters:




# File 'lib/orb/models/credit_block_list_invoices_response.rb', line 105

Instance Attribute Details

#balance ⇒ Float

Parameters:

  • value (Float)

Returns:

  • (Float) 


34
 
# File 'lib/orb/models/credit_block_list_invoices_response.rb', line 34

required :balance, Float

#credit_allocation ⇒ Orb::Models::CreditBlockListInvoicesResponse::Block::CreditAllocation?

The credit allocation that funded a block. Extends the allocation resource serialized on prices with the catalog-item attribution of the funding price.

Parameters:

Returns:



92
93
94
 
# File 'lib/orb/models/credit_block_list_invoices_response.rb', line 92

optional :credit_allocation,
-> { Orb::Models::CreditBlockListInvoicesResponse::Block::CreditAllocation },
nil?: true

#credit_block_source ⇒ Symbol, Orb::Models::CreditBlockListInvoicesResponse::Block::CreditBlockSource

How this credit block was created: allocation (a subscription's recurring credit allocation), top_up (an automatic balance-threshold top-up), commitment (a subscription commitment true-up rolled forward as credit), or manual (a manual credit ledger increment, including credits voided or expired off another block).

Parameters:

  • value (Orb::Models::CreditBlockListInvoicesResponse::Block::credit_block_source)

Returns:



44
45
 
# File 'lib/orb/models/credit_block_list_invoices_response.rb', line 44

required :credit_block_source,
enum: -> { Orb::Models::CreditBlockListInvoicesResponse::Block::CreditBlockSource }

#credit_commitment ⇒ Orb::Models::CreditBlockListInvoicesResponse::Block::CreditCommitment?

The subscription commitment whose true-up rolled forward into this credit block. Present only when credit_block_source is commitment.

Parameters:

Returns:



101
102
103
 
# File 'lib/orb/models/credit_block_list_invoices_response.rb', line 101

optional :credit_commitment,
-> { Orb::Models::CreditBlockListInvoicesResponse::Block::CreditCommitment },
nil?: true

#effective_date ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


50
 
# File 'lib/orb/models/credit_block_list_invoices_response.rb', line 50

required :effective_date, Time, nil?: true

#expiry_date ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


55
 
# File 'lib/orb/models/credit_block_list_invoices_response.rb', line 55

required :expiry_date, Time, nil?: true

#filters ⇒ Array<Orb::Models::CreditBlockListInvoicesResponse::Block::Filter>

Parameters:

Returns:



60
61
 
# File 'lib/orb/models/credit_block_list_invoices_response.rb', line 60

required :filters,
-> { Orb::Internal::Type::ArrayOf[Orb::Models::CreditBlockListInvoicesResponse::Block::Filter] }

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


29
 
# File 'lib/orb/models/credit_block_list_invoices_response.rb', line 29

required :id, String

#maximum_initial_balance ⇒ Float?

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


66
 
# File 'lib/orb/models/credit_block_list_invoices_response.rb', line 66

required :maximum_initial_balance, Float, nil?: true

#metadata ⇒ Hash{Symbol=>String}

User specified key-value pairs for the resource. If not present, this defaults to an empty dictionary. Individual keys can be removed by setting the value to null, and the entire metadata mapping can be cleared by setting metadata to null.

Parameters:

  • value (::Hash[Symbol, String])

Returns:

  • (Hash{Symbol=>String}) 


75
 
# File 'lib/orb/models/credit_block_list_invoices_response.rb', line 75

required :metadata, Orb::Internal::Type::HashOf[String]

#per_unit_cost_basis ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


80
 
# File 'lib/orb/models/credit_block_list_invoices_response.rb', line 80

required :per_unit_cost_basis, String, nil?: true

#status ⇒ Symbol, Orb::Models::CreditBlockListInvoicesResponse::Block::Status

Parameters:

  • value (Orb::Models::CreditBlockListInvoicesResponse::Block::status)

Returns:



85
 
# File 'lib/orb/models/credit_block_list_invoices_response.rb', line 85

required :status, enum: -> { Orb::Models::CreditBlockListInvoicesResponse::Block::Status }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/orb/models/credit_block_list_invoices_response.rb', line 150

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


80
 
# File 'sig/orb/models/credit_block_list_invoices_response.rbs', line 80

def to_hash: -> {