Class: Lithic::Models::AccountHolderListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Lithic::Models::AccountHolderListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/lithic/models/account_holder_list_params.rb

Overview

See Also:

• Resources::AccountHolders#list

Instance Attribute Summary

• #begin_ ⇒ Time^?

  Date string in RFC 3339 format.

• #email ⇒ String^?

  Email address of the account holder.

• #end_ ⇒ Time^?

  Date string in RFC 3339 format.

• #ending_before ⇒ String^?

  A cursor representing an item’s token before which a page of results should end.

• #external_id ⇒ String^?

  If applicable, represents the external_id associated with the account_holder.

• #first_name ⇒ String^?

  (Individual Account Holders only) The first name of the account holder.

• #last_name ⇒ String^?

  (Individual Account Holders only) The last name of the account holder.

• #legal_business_name ⇒ String^?

  (Business Account Holders only) The legal business name of the account holder.

• #limit ⇒ Integer^?

  The number of account_holders to limit the response to.

• #phone_number ⇒ String^?

  Phone number of the account holder.

• #starting_after ⇒ String^?

  A cursor representing an item’s token after which a page of results should begin.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(begin_: nil, email: nil, end_: nil, ending_before: nil, external_id: nil, first_name: nil, last_name: nil, legal_business_name: nil, limit: nil, phone_number: nil, starting_after: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see AccountHolderListParams for more details.

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(begin_: nil, email: nil, end_: nil, ending_before: nil, external_id: nil, first_name: nil, last_name: nil, legal_business_name: nil, limit: nil, phone_number: nil, starting_after: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Lithic::Models::AccountHolderListParams for more details.

# File 'lib/lithic/models/account_holder_list_params.rb', line 84

Instance Attribute Details

#begin_ ⇒ Time^?

Date string in RFC 3339 format. Only entries created after the specified time will be included. UTC time zone.

# File 'lib/lithic/models/account_holder_list_params.rb', line 15

optional :begin_, Time

#email ⇒ String^?

Email address of the account holder. The query must be an exact match, case insensitive.

# File 'lib/lithic/models/account_holder_list_params.rb', line 22

optional :email, String

#end_ ⇒ Time^?

Date string in RFC 3339 format. Only entries created before the specified time will be included. UTC time zone.

# File 'lib/lithic/models/account_holder_list_params.rb', line 29

optional :end_, Time

#ending_before ⇒ String^?

A cursor representing an item’s token before which a page of results should end. Used to retrieve the previous page of results before this item.

# File 'lib/lithic/models/account_holder_list_params.rb', line 36

optional :ending_before, String

#external_id ⇒ String^?

If applicable, represents the external_id associated with the account_holder.

# File 'lib/lithic/models/account_holder_list_params.rb', line 42

optional :external_id, String

#first_name ⇒ String^?

(Individual Account Holders only) The first name of the account holder. The query is case insensitive and supports partial matches.

# File 'lib/lithic/models/account_holder_list_params.rb', line 49

optional :first_name, String

#last_name ⇒ String^?

(Individual Account Holders only) The last name of the account holder. The query is case insensitive and supports partial matches.

# File 'lib/lithic/models/account_holder_list_params.rb', line 56

optional :last_name, String

#legal_business_name ⇒ String^?

(Business Account Holders only) The legal business name of the account holder. The query is case insensitive and supports partial matches.

# File 'lib/lithic/models/account_holder_list_params.rb', line 63

optional :legal_business_name, String

#limit ⇒ Integer^?

The number of account_holders to limit the response to.

# File 'lib/lithic/models/account_holder_list_params.rb', line 69

optional :limit, Integer

#phone_number ⇒ String^?

Phone number of the account holder. The query must be an exact match.

# File 'lib/lithic/models/account_holder_list_params.rb', line 75

optional :phone_number, String

#starting_after ⇒ String^?

A cursor representing an item’s token after which a page of results should begin. Used to retrieve the next page of results after this item.

# File 'lib/lithic/models/account_holder_list_params.rb', line 82

optional :starting_after, String