Class: Orb::Models::Customers::CreditListByExternalIDResponse

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

Overview

See Also:

  • Orb::Resources::Customers::Credits#list_by_external_id

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::Customers::CreditListByExternalIDResponse for more details.

Parameters:




# File 'lib/orb/models/customers/credit_list_by_external_id_response.rb', line 87

Instance Attribute Details

#balance ⇒ Float

Parameters:

  • value (Float)

Returns:

  • (Float) 


16
 
# File 'lib/orb/models/customers/credit_list_by_external_id_response.rb', line 16

required :balance, Float

#credit_allocation ⇒ Orb::Models::Customers::CreditListByExternalIDResponse::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:



74
75
76
 
# File 'lib/orb/models/customers/credit_list_by_external_id_response.rb', line 74

optional :credit_allocation,
-> { Orb::Models::Customers::CreditListByExternalIDResponse::CreditAllocation },
nil?: true

#credit_block_source ⇒ Symbol, Orb::Models::Customers::CreditListByExternalIDResponse::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::Customers::CreditListByExternalIDResponse::credit_block_source)

Returns:



26
27
 
# File 'lib/orb/models/customers/credit_list_by_external_id_response.rb', line 26

required :credit_block_source,
enum: -> { Orb::Models::Customers::CreditListByExternalIDResponse::CreditBlockSource }

#credit_commitment ⇒ Orb::Models::Customers::CreditListByExternalIDResponse::CreditCommitment?

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

Parameters:

Returns:



83
84
85
 
# File 'lib/orb/models/customers/credit_list_by_external_id_response.rb', line 83

optional :credit_commitment,
-> { Orb::Models::Customers::CreditListByExternalIDResponse::CreditCommitment },
nil?: true

#effective_date ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


32
 
# File 'lib/orb/models/customers/credit_list_by_external_id_response.rb', line 32

required :effective_date, Time, nil?: true

#expiry_date ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


37
 
# File 'lib/orb/models/customers/credit_list_by_external_id_response.rb', line 37

required :expiry_date, Time, nil?: true

#filters ⇒ Array<Orb::Models::Customers::CreditListByExternalIDResponse::Filter>

Parameters:

Returns:



42
43
 
# File 'lib/orb/models/customers/credit_list_by_external_id_response.rb', line 42

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

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


11
 
# File 'lib/orb/models/customers/credit_list_by_external_id_response.rb', line 11

required :id, String

#maximum_initial_balance ⇒ Float?

Parameters:

  • value (Float, nil)

Returns:

  • (Float, nil) 


48
 
# File 'lib/orb/models/customers/credit_list_by_external_id_response.rb', line 48

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


57
 
# File 'lib/orb/models/customers/credit_list_by_external_id_response.rb', line 57

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

#per_unit_cost_basis ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


62
 
# File 'lib/orb/models/customers/credit_list_by_external_id_response.rb', line 62

required :per_unit_cost_basis, String, nil?: true

#status ⇒ Symbol, Orb::Models::Customers::CreditListByExternalIDResponse::Status

Parameters:

  • value (Orb::Models::Customers::CreditListByExternalIDResponse::status)

Returns:



67
 
# File 'lib/orb/models/customers/credit_list_by_external_id_response.rb', line 67

required :status, enum: -> { Orb::Models::Customers::CreditListByExternalIDResponse::Status }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/orb/models/customers/credit_list_by_external_id_response.rb', line 130

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


60
 
# File 'sig/orb/models/customers/credit_list_by_external_id_response.rbs', line 60

def to_hash: -> {