Class: Straddle::Models::CapabilityRequest

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/straddle/models/capability_request.rb,
sig/straddle/models/capability_request.rbs

Defined Under Namespace

Modules: Category, Status, Type

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

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(id:, account_id:, category:, created_at:, enable:, status:, type:, updated_at:, settings: nil) ⇒ Object

Some parameter documentations has been truncated, see Straddle::Models::CapabilityRequest for more details.

Parameters:

  • id (String) —

    Straddle's unique ID for the capability request.

  • account_id (String) —

    ID of the account associated with the capability request.

  • category (Symbol, Straddle::Models::CapabilityRequest::Category) —

    Groups the requested capability. payment_type covers charges and payouts.

  • created_at (Time) —

    Date and time when Straddle created the capability request.

  • enable (Boolean) —

    Whether the request enables or disables the capability.

  • status (Symbol, Straddle::Models::CapabilityRequest::Status) —

    Status of the capability request.

  • type (Symbol, Straddle::Models::CapabilityRequest::Type) —

    Capability type requested within the category.

  • updated_at (Time) —

    Date and time of the most recent capability request update.

  • settings (Hash{Symbol=>Object}, nil) (defaults to: nil) —

    Limits and other settings requested for the capability.




# File 'lib/straddle/models/capability_request.rb', line 62

Instance Attribute Details

#account_id ⇒ String

ID of the account associated with the capability request.

Parameters:

  • value (String)

Returns:

  • (String) 


16
 
# File 'lib/straddle/models/capability_request.rb', line 16

required :account_id, String

#category ⇒ Symbol, Straddle::Models::CapabilityRequest::Category

Groups the requested capability. payment_type covers charges and payouts. customer_type covers individuals and businesses. consent_type covers signed_agreement and internet authorization.

Parameters:

  • value (Straddle::Models::CapabilityRequest::category)

Returns:



24
 
# File 'lib/straddle/models/capability_request.rb', line 24

required :category, enum: -> { Straddle::CapabilityRequest::Category }

#created_at ⇒ Time

Date and time when Straddle created the capability request.

Parameters:

  • value (Time)

Returns:

  • (Time) 


30
 
# File 'lib/straddle/models/capability_request.rb', line 30

required :created_at, Time

#enable ⇒ Boolean

Whether the request enables or disables the capability.

Parameters:

  • value (Boolean)

Returns:

  • (Boolean) 


36
 
# File 'lib/straddle/models/capability_request.rb', line 36

required :enable, Straddle::Internal::Type::Boolean

#id ⇒ String

Straddle's unique ID for the capability request.

Parameters:

  • value (String)

Returns:

  • (String) 


10
 
# File 'lib/straddle/models/capability_request.rb', line 10

required :id, String

#settings ⇒ Hash{Symbol=>Object}?

Limits and other settings requested for the capability.

Parameters:

  • value (::Hash[Symbol, top], nil)

Returns:

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


60
 
# File 'lib/straddle/models/capability_request.rb', line 60

optional :settings, Straddle::Internal::Type::HashOf[Straddle::Internal::Type::Unknown], nil?: true

#status ⇒ Symbol, Straddle::Models::CapabilityRequest::Status

Status of the capability request.

Parameters:

  • value (Straddle::Models::CapabilityRequest::status)

Returns:



42
 
# File 'lib/straddle/models/capability_request.rb', line 42

required :status, enum: -> { Straddle::CapabilityRequest::Status }

#type ⇒ Symbol, Straddle::Models::CapabilityRequest::Type

Capability type requested within the category.

Parameters:

  • value (Straddle::Models::CapabilityRequest::type_)

Returns:



48
 
# File 'lib/straddle/models/capability_request.rb', line 48

required :type, enum: -> { Straddle::CapabilityRequest::Type }

#updated_at ⇒ Time

Date and time of the most recent capability request update.

Parameters:

  • value (Time)

Returns:

  • (Time) 


54
 
# File 'lib/straddle/models/capability_request.rb', line 54

required :updated_at, Time

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/straddle/models/capability_request.rb', line 96

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


47
 
# File 'sig/straddle/models/capability_request.rbs', line 47

def to_hash: -> {