Class: Increase::Models::Simulations::InterestPaymentCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/increase/models/simulations/interest_payment_create_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(account_id: , amount: , accrued_on_account_id: nil, period_end: nil, period_start: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Increase::Models::Simulations::InterestPaymentCreateParams for more details.

Parameters:

  • account_id (String) (defaults to: ) —

    The identifier of the Account the Interest Payment should be paid to is for.

  • amount (Integer) (defaults to: ) —

    The interest amount in cents. Must be positive.

  • accrued_on_account_id (String) (defaults to: nil) —

    The identifier of the Account the Interest accrued on. Defaults to ‘account_id`.

  • period_end (Time) (defaults to: nil) —

    The end of the interest period. If not provided, defaults to the current time.

  • period_start (Time) (defaults to: nil) —

    The start of the interest period. If not provided, defaults to the current time.

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



# File 'lib/increase/models/simulations/interest_payment_create_params.rb', line 41

Instance Attribute Details

#account_id ⇒ String

The identifier of the Account the Interest Payment should be paid to is for.

Returns:

  • (String) 


15
 
# File 'lib/increase/models/simulations/interest_payment_create_params.rb', line 15

required :account_id, String

#accrued_on_account_id ⇒ String?

The identifier of the Account the Interest accrued on. Defaults to ‘account_id`.

Returns:

  • (String, nil) 


27
 
# File 'lib/increase/models/simulations/interest_payment_create_params.rb', line 27

optional :accrued_on_account_id, String

#amount ⇒ Integer

The interest amount in cents. Must be positive.

Returns:

  • (Integer) 


21
 
# File 'lib/increase/models/simulations/interest_payment_create_params.rb', line 21

required :amount, Integer

#period_end ⇒ Time?

The end of the interest period. If not provided, defaults to the current time.

Returns:

  • (Time, nil) 


33
 
# File 'lib/increase/models/simulations/interest_payment_create_params.rb', line 33

optional :period_end, Time

#period_start ⇒ Time?

The start of the interest period. If not provided, defaults to the current time.

Returns:

  • (Time, nil) 


39
 
# File 'lib/increase/models/simulations/interest_payment_create_params.rb', line 39

optional :period_start, Time