Class: Dodopayments::Models::CreditEntitlements::BalanceListGrantsResponse

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/dodopayments/models/credit_entitlements/balance_list_grants_response.rb,
sig/dodopayments/models/credit_entitlements/balance_list_grants_response.rbs

Overview

See Also:

  • Dodopayments::Resources::CreditEntitlements::Balances#list_grants

Defined Under Namespace

Modules: SourceType

Instance Attribute 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:, created_at:, credit_entitlement_id:, customer_id:, initial_amount:, is_expired:, is_rolled_over:, remaining_amount:, rollover_count:, source_type:, updated_at:, expires_at: nil, metadata: nil, parent_grant_id: nil, source_id: nil) ⇒ Object

Some parameter documentations has been truncated, see Dodopayments::Models::CreditEntitlements::BalanceListGrantsResponse for more details.

Response for a credit grant

Parameters:

  • id (String)
  • created_at (Time)
  • credit_entitlement_id (String)
  • customer_id (String)
  • initial_amount (String)
  • is_expired (Boolean)
  • is_rolled_over (Boolean)
  • remaining_amount (String)
  • rollover_count (Integer)
  • source_type (Symbol, Dodopayments::Models::CreditEntitlements::BalanceListGrantsResponse::SourceType)
  • updated_at (Time)
  • expires_at (Time, nil) (defaults to: nil)
  • metadata (Hash{Symbol=>String, Float, Boolean}, nil) (defaults to: nil) —

    Arbitrary key-value metadata. Values can be string, integer, number, or boolean.

  • parent_grant_id (String, nil) (defaults to: nil)
  • source_id (String, nil) (defaults to: nil) 



# File 'lib/dodopayments/models/credit_entitlements/balance_list_grants_response.rb', line 87

Instance Attribute Details

#created_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


16
 
# File 'lib/dodopayments/models/credit_entitlements/balance_list_grants_response.rb', line 16

required :created_at, Time

#credit_entitlement_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


21
 
# File 'lib/dodopayments/models/credit_entitlements/balance_list_grants_response.rb', line 21

required :credit_entitlement_id, String

#customer_id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


26
 
# File 'lib/dodopayments/models/credit_entitlements/balance_list_grants_response.rb', line 26

required :customer_id, String

#expires_at ⇒ Time?

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


67
 
# File 'lib/dodopayments/models/credit_entitlements/balance_list_grants_response.rb', line 67

optional :expires_at, Time, nil?: true

#id ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


11
 
# File 'lib/dodopayments/models/credit_entitlements/balance_list_grants_response.rb', line 11

required :id, String

#initial_amount ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


31
 
# File 'lib/dodopayments/models/credit_entitlements/balance_list_grants_response.rb', line 31

required :initial_amount, String

#is_expired ⇒ Boolean

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


36
 
# File 'lib/dodopayments/models/credit_entitlements/balance_list_grants_response.rb', line 36

required :is_expired, Dodopayments::Internal::Type::Boolean

#is_rolled_over ⇒ Boolean

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


41
 
# File 'lib/dodopayments/models/credit_entitlements/balance_list_grants_response.rb', line 41

required :is_rolled_over, Dodopayments::Internal::Type::Boolean

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

Arbitrary key-value metadata. Values can be string, integer, number, or boolean.

Parameters:

  • value (Dodopayments::Models::metadata, nil)

Returns:

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


73
74
75
 
# File 'lib/dodopayments/models/credit_entitlements/balance_list_grants_response.rb', line 73

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

#parent_grant_id ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


80
 
# File 'lib/dodopayments/models/credit_entitlements/balance_list_grants_response.rb', line 80

optional :parent_grant_id, String, nil?: true

#remaining_amount ⇒ String

Parameters:

  • value (String)

Returns:

  • (String) 


46
 
# File 'lib/dodopayments/models/credit_entitlements/balance_list_grants_response.rb', line 46

required :remaining_amount, String

#rollover_count ⇒ Integer

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


51
 
# File 'lib/dodopayments/models/credit_entitlements/balance_list_grants_response.rb', line 51

required :rollover_count, Integer

#source_id ⇒ String?

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


85
 
# File 'lib/dodopayments/models/credit_entitlements/balance_list_grants_response.rb', line 85

optional :source_id, String, nil?: true

#source_type ⇒ Symbol, Dodopayments::Models::CreditEntitlements::BalanceListGrantsResponse::SourceType

Parameters:

  • value (Dodopayments::Models::CreditEntitlements::BalanceListGrantsResponse::source_type)

Returns:



56
57
 
# File 'lib/dodopayments/models/credit_entitlements/balance_list_grants_response.rb', line 56

required :source_type,
enum: -> { Dodopayments::Models::CreditEntitlements::BalanceListGrantsResponse::SourceType }

#updated_at ⇒ Time

Parameters:

  • value (Time)

Returns:

  • (Time) 


62
 
# File 'lib/dodopayments/models/credit_entitlements/balance_list_grants_response.rb', line 62

required :updated_at, Time

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


72
 
# File 'sig/dodopayments/models/credit_entitlements/balance_list_grants_response.rbs', line 72

def to_hash: -> {