Class: Dodopayments::Models::CreditEntitlements::BalanceCreateLedgerEntryParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/dodopayments/models/credit_entitlements/balance_create_ledger_entry_params.rb

Overview

See Also:

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(credit_entitlement_id:, customer_id:, amount:, entry_type:, expires_at: nil, idempotency_key: nil, metadata: nil, reason: nil, request_options: {}) ⇒ Object

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

Parameters:

  • credit_entitlement_id (String)
  • customer_id (String)
  • amount (String) —

    Amount to credit or debit

  • entry_type (Symbol, Dodopayments::Models::CreditEntitlements::LedgerEntryType) —

    Entry type: credit or debit

  • expires_at (Time, nil) (defaults to: nil) —

    Expiration for credited amount (only for credit type)

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

    Idempotency key to prevent duplicate entries

  • metadata (Hash{Symbol=>String}, nil) (defaults to: nil) —

    Optional metadata (max 50 key-value pairs, key max 40 chars, value max 500 chars

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

    Human-readable reason for the entry

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



# File 'lib/dodopayments/models/credit_entitlements/balance_create_ledger_entry_params.rb', line 58

Instance Attribute Details

#amount ⇒ String

Amount to credit or debit

Returns:

  • (String) 


25
 
# File 'lib/dodopayments/models/credit_entitlements/balance_create_ledger_entry_params.rb', line 25

required :amount, String

#credit_entitlement_id ⇒ String

Returns:

  • (String) 


14
 
# File 'lib/dodopayments/models/credit_entitlements/balance_create_ledger_entry_params.rb', line 14

required :credit_entitlement_id, String

#customer_id ⇒ String

Returns:

  • (String) 


19
 
# File 'lib/dodopayments/models/credit_entitlements/balance_create_ledger_entry_params.rb', line 19

required :customer_id, String

#entry_type ⇒ Symbol, Dodopayments::Models::CreditEntitlements::LedgerEntryType

Entry type: credit or debit

Returns:



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

required :entry_type, enum: -> { Dodopayments::CreditEntitlements::LedgerEntryType }

#expires_at ⇒ Time?

Expiration for credited amount (only for credit type)

Returns:

  • (Time, nil) 


37
 
# File 'lib/dodopayments/models/credit_entitlements/balance_create_ledger_entry_params.rb', line 37

optional :expires_at, Time, nil?: true

#idempotency_key ⇒ String?

Idempotency key to prevent duplicate entries

Returns:

  • (String, nil) 


43
 
# File 'lib/dodopayments/models/credit_entitlements/balance_create_ledger_entry_params.rb', line 43

optional :idempotency_key, String, nil?: true

#metadata ⇒ Hash{Symbol=>String}?

Optional metadata (max 50 key-value pairs, key max 40 chars, value max 500 chars)

Returns:

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


50
 
# File 'lib/dodopayments/models/credit_entitlements/balance_create_ledger_entry_params.rb', line 50

optional :metadata, Dodopayments::Internal::Type::HashOf[String], nil?: true

#reason ⇒ String?

Human-readable reason for the entry

Returns:

  • (String, nil) 


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

optional :reason, String, nil?: true