Class: Increase::Models::LockboxUpdateParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Increase::Models::LockboxUpdateParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/increase/models/lockbox_update_params.rb

Overview

See Also:

• Resources::Lockboxes#update

Defined Under Namespace

Modules: CheckDepositBehavior

Instance Attribute Summary

• #check_deposit_behavior ⇒ Symbol, ...

  This indicates if checks mailed to this lockbox will be deposited.

• #description ⇒ String^?

  The description you choose for the Lockbox.

• #recipient_name ⇒ String^?

  The recipient name you choose for the Lockbox.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(check_deposit_behavior: nil, description: nil, recipient_name: nil, request_options: {}) ⇒ Object constructor

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(check_deposit_behavior: nil, description: nil, recipient_name: nil, request_options: {}) ⇒ Object

Parameters:

• check_deposit_behavior (Symbol, Increase::Models::LockboxUpdateParams::CheckDepositBehavior) (defaults to: nil) —

  This indicates if checks mailed to this lockbox will be deposited.

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

  The description you choose for the Lockbox.

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

  The recipient name you choose for the Lockbox.

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

# File 'lib/increase/models/lockbox_update_params.rb', line 28

Instance Attribute Details

#check_deposit_behavior ⇒ Symbol, ...

This indicates if checks mailed to this lockbox will be deposited.

Returns:

• (Symbol, Increase::Models::LockboxUpdateParams::CheckDepositBehavior, nil)

# File 'lib/increase/models/lockbox_update_params.rb', line 14

optional :check_deposit_behavior, enum: -> { Increase::LockboxUpdateParams::CheckDepositBehavior }

#description ⇒ String^?

The description you choose for the Lockbox.

Returns:

• (String, nil)

# File 'lib/increase/models/lockbox_update_params.rb', line 20

optional :description, String

#recipient_name ⇒ String^?

The recipient name you choose for the Lockbox.

Returns:

• (String, nil)

# File 'lib/increase/models/lockbox_update_params.rb', line 26

optional :recipient_name, String