Class: Lithic::Models::AccountHolderUpdatedWebhookEvent::KYBPayload

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/lithic/models/account_holder_updated_webhook_event.rb

Defined Under Namespace

Modules: EventType Classes: UpdateRequest

Instance Attribute 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(address1:, city:, country:, postal_code:, state:, address2: nil) ⇒ Object

Some parameter documentations has been truncated, see Lithic::Models::AccountHolderUpdatedWebhookEvent::KYBPayload::UpdateRequest::ControlPerson::Address for more details.

Individual’s current address - PO boxes, UPS drops, and FedEx drops are not acceptable; APO/FPO are acceptable. Only USA addresses are currently supported.

Parameters:

  • address1 (String) —

    Valid deliverable address (no PO boxes).

  • city (String) —

    Name of city.

  • country (String) —

    Valid country code. Only USA is currently supported, entered in uppercase ISO 31

  • postal_code (String) —

    Valid postal code. Only USA ZIP codes are currently supported, entered as a five

  • state (String) —

    Valid state code. Only USA state codes are currently supported, entered in upper

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

    Unit or apartment number (if applicable).




# File 'lib/lithic/models/account_holder_updated_webhook_event.rb', line 57

Instance Attribute Details

#event_type ⇒ Symbol, ...

The type of event that occurred.

Returns:



35
 
# File 'lib/lithic/models/account_holder_updated_webhook_event.rb', line 35

optional :event_type, enum: -> { Lithic::AccountHolderUpdatedWebhookEvent::KYBPayload::EventType }

#external_id ⇒ String?

A user provided id that can be used to link an account holder with an external system

Returns:

  • (String, nil) 


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

optional :external_id, String

#nature_of_business ⇒ String?

Short description of the company’s line of business (i.e., what does the company do?).

Returns:

  • (String, nil) 


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

optional :nature_of_business, String

#token ⇒ String

The token of the account_holder that was created.

Returns:

  • (String) 


23
 
# File 'lib/lithic/models/account_holder_updated_webhook_event.rb', line 23

required :token, String

#update_request ⇒ Lithic::Models::AccountHolderUpdatedWebhookEvent::KYBPayload::UpdateRequest

Original request to update the account holder.

Returns:



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

required :update_request, -> { Lithic::AccountHolderUpdatedWebhookEvent::KYBPayload::UpdateRequest }

#website_url ⇒ String?

Company website URL.

Returns:

  • (String, nil) 


55
 
# File 'lib/lithic/models/account_holder_updated_webhook_event.rb', line 55

optional :website_url, String