Class: MethodRuby::Models::Accounts::ConsentWithdrawParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• MethodRuby::Models::Accounts::ConsentWithdrawParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/method_ruby/models/accounts/consent_withdraw_params.rb,
sig/method_ruby/models/accounts/consent_withdraw_params.rbs

Overview

See Also:

• MethodRuby::Resources::Accounts::Consent#withdraw

Defined Under Namespace

Modules: MethodVersion, Type

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::MethodRuby

Instance Attribute Summary

• #account_id ⇒ String
• #idempotency_key ⇒ String^?
• #method_version ⇒ Symbol, MethodRuby::Models::Accounts::ConsentWithdrawParams::MethodVersion
• #reason ⇒ String^?

  Optional reason for the consent action.

• #type ⇒ Symbol, MethodRuby::Models::Accounts::ConsentWithdrawParams::Type

  The consent action to take.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(account_id:, type:, method_version:, reason: nil, idempotency_key: nil, request_options: {}) ⇒ Object constructor
• #to_hash ⇒ {

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:, type:, method_version:, reason: nil, idempotency_key: nil, request_options: {}) ⇒ Object

Parameters:

• account_id (String)
• type (Symbol, MethodRuby::Models::Accounts::ConsentWithdrawParams::Type) —

  The consent action to take.

• method_version (Symbol, MethodRuby::Models::Accounts::ConsentWithdrawParams::MethodVersion)
• reason (String) (defaults to: nil) —

  Optional reason for the consent action.

• idempotency_key (String) (defaults to: nil)
• request_options (MethodRuby::RequestOptions, Hash{Symbol=>Object}) (defaults to: {})

# File 'lib/method_ruby/models/accounts/consent_withdraw_params.rb', line 38

Instance Attribute Details

#account_id ⇒ String

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/method_ruby/models/accounts/consent_withdraw_params.rb', line 14

required :account_id, String

#idempotency_key ⇒ String^?

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/method_ruby/models/accounts/consent_withdraw_params.rb', line 36

optional :idempotency_key, String

#method_version ⇒ Symbol, MethodRuby::Models::Accounts::ConsentWithdrawParams::MethodVersion

Parameters:

• value (MethodRuby::Models::Accounts::ConsentWithdrawParams::method_version)

Returns:

• (Symbol, MethodRuby::Models::Accounts::ConsentWithdrawParams::MethodVersion)

# File 'lib/method_ruby/models/accounts/consent_withdraw_params.rb', line 25

required :method_version, enum: -> { MethodRuby::Accounts::ConsentWithdrawParams::MethodVersion }

#reason ⇒ String^?

Optional reason for the consent action.

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/method_ruby/models/accounts/consent_withdraw_params.rb', line 31

optional :reason, String

#type ⇒ Symbol, MethodRuby::Models::Accounts::ConsentWithdrawParams::Type

The consent action to take.

Parameters:

• value (MethodRuby::Models::Accounts::ConsentWithdrawParams::type_)

Returns:

• (Symbol, MethodRuby::Models::Accounts::ConsentWithdrawParams::Type)

# File 'lib/method_ruby/models/accounts/consent_withdraw_params.rb', line 20

required :type, enum: -> { MethodRuby::Accounts::ConsentWithdrawParams::Type }

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/method_ruby/models/accounts/consent_withdraw_params.rb', line 57

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/method_ruby/models/accounts/consent_withdraw_params.rbs', line 41

def to_hash: -> {