Class: Increase::Models::Simulations::CardIncrementCreateParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/increase/models/simulations/card_increment_create_params.rb,
sig/increase/models/simulations/card_increment_create_params.rbs

Overview

See Also:

  • Increase::Resources::Simulations::CardIncrements#create

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(amount:, card_payment_id:, event_subscription_id: nil, request_options: {}) ⇒ Object

Parameters:

  • amount (Integer) —

    The amount of the increment in minor units in the card authorization's currency.

  • card_payment_id (String) —

    The identifier of the Card Payment to create an increment on.

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

    The identifier of the Event Subscription to use. If provided, will override the default real time event subscription. Because you can only create one real time decision event subscription, you can use this field to route events to any specified event subscription for testing purposes.

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



# File 'lib/increase/models/simulations/card_increment_create_params.rb', line 32

Instance Attribute Details

#amount ⇒ Integer

The amount of the increment in minor units in the card authorization's currency.

Parameters:

  • value (Integer)

Returns:

  • (Integer) 


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

required :amount, Integer

#card_payment_id ⇒ String

The identifier of the Card Payment to create an increment on.

Parameters:

  • value (String)

Returns:

  • (String) 


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

required :card_payment_id, String

#event_subscription_id ⇒ String?

The identifier of the Event Subscription to use. If provided, will override the default real time event subscription. Because you can only create one real time decision event subscription, you can use this field to route events to any specified event subscription for testing purposes.

Parameters:

  • (String)

Returns:

  • (String, nil) 


30
 
# File 'lib/increase/models/simulations/card_increment_create_params.rb', line 30

optional :event_subscription_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


31
 
# File 'sig/increase/models/simulations/card_increment_create_params.rbs', line 31

def to_hash: -> {