Class: MethodRuby::Models::Entities::ConnectListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/method_ruby/models/entities/connect_list_params.rb

Overview

See Also:

Defined Under Namespace

Modules: Expand, MethodVersion

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Class 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, #initialize, 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

This class inherits a constructor from MethodRuby::Internal::Type::BaseModel

Instance Attribute Details

#entity_id ⇒ String

Returns:

  • (String) 


14
 
# File 'lib/method_ruby/models/entities/connect_list_params.rb', line 14

required :entity_id, String

#expand ⇒ Array<Symbol, MethodRuby::Models::Entities::ConnectListParams::Expand>?

Expand connected accounts inline on entity connect resources. Supports expanding the account list itself or one level of account fields.

Returns:



26
27
 
# File 'lib/method_ruby/models/entities/connect_list_params.rb', line 26

optional :expand,
-> { MethodRuby::Internal::Type::ArrayOf[enum: MethodRuby::Entities::ConnectListParams::Expand] }

#from_date ⇒ Date?

Filter results from this date (inclusive, YYYY-MM-DD format).

Returns:

  • (Date, nil) 


33
 
# File 'lib/method_ruby/models/entities/connect_list_params.rb', line 33

optional :from_date, Date

#method_version ⇒ Symbol, MethodRuby::Models::Entities::ConnectListParams::MethodVersion

Returns:



19
 
# File 'lib/method_ruby/models/entities/connect_list_params.rb', line 19

required :method_version, enum: -> { MethodRuby::Entities::ConnectListParams::MethodVersion }

#page ⇒ Integer?

Page number for pagination (1-indexed).

Returns:

  • (Integer, nil) 


39
 
# File 'lib/method_ruby/models/entities/connect_list_params.rb', line 39

optional :page, Integer

#page_cursor ⇒ String?

Cursor for cursor-based pagination. Use the value from ‘Pagination-Page-Cursor-Next` or `Pagination-Page-Cursor-Prev` response headers.

Returns:

  • (String, nil) 


46
 
# File 'lib/method_ruby/models/entities/connect_list_params.rb', line 46

optional :page_cursor, String

#page_limit ⇒ Integer?

Number of items per page.

Returns:

  • (Integer, nil) 


52
 
# File 'lib/method_ruby/models/entities/connect_list_params.rb', line 52

optional :page_limit, Integer

#to_date ⇒ Date?

Filter results to this date (inclusive, YYYY-MM-DD format).

Returns:

  • (Date, nil) 


58
 
# File 'lib/method_ruby/models/entities/connect_list_params.rb', line 58

optional :to_date, Date

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/method_ruby/models/entities/connect_list_params.rb', line 87