Class: FinchAPI::Resources::Sandbox::Individual

Inherits:

Object

• Object
• FinchAPI::Resources::Sandbox::Individual

Defined in:

lib/finch_api/resources/sandbox/individual.rb

Instance Method Summary

• #initialize(client:) ⇒ Individual constructor private

  A new instance of Individual.

• #update(individual_id, dob: nil, emails: nil, encrypted_ssn: nil, ethnicity: nil, first_name: nil, gender: nil, last_name: nil, middle_name: nil, phone_numbers: nil, preferred_name: nil, residence: nil, ssn: nil, request_options: {}) ⇒ FinchAPI::Models::Sandbox::IndividualUpdateResponse

  Some parameter documentations has been truncated, see Models::Sandbox::IndividualUpdateParams for more details.

Constructor Details

#initialize(client:) ⇒ Individual

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Individual.

Parameters:

• client (FinchAPI::Client)

# File 'lib/finch_api/resources/sandbox/individual.rb', line 59

def initialize(client:)
  @client = client
end

Instance Method Details

#update(individual_id, dob: nil, emails: nil, encrypted_ssn: nil, ethnicity: nil, first_name: nil, gender: nil, last_name: nil, middle_name: nil, phone_numbers: nil, preferred_name: nil, residence: nil, ssn: nil, request_options: {}) ⇒ FinchAPI::Models::Sandbox::IndividualUpdateResponse

Some parameter documentations has been truncated, see Models::Sandbox::IndividualUpdateParams for more details.

Update sandbox individual

Parameters:

• individual_id (String)
• dob (String, nil)
• emails (Array<FinchAPI::Models::Sandbox::IndividualUpdateParams::Email>, nil)
• encrypted_ssn (String, nil) —

  Social Security Number of the individual in encrypted format. This field is

• ethnicity (Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Ethnicity, nil) —

  The EEOC-defined ethnicity of the individual.

• first_name (String, nil) —

  The legal first name of the individual.

• gender (Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::Gender, nil) —

  The gender of the individual.

• last_name (String, nil) —

  The legal last name of the individual.

• middle_name (String, nil) —

  The legal middle name of the individual.

• phone_numbers (Array<FinchAPI::Models::Sandbox::IndividualUpdateParams::PhoneNumber, nil>, nil)
• preferred_name (String, nil) —

  The preferred name of the individual.

• residence (FinchAPI::Models::Location, nil)
• ssn (String, nil) —

  Social Security Number of the individual. This field is only available with the

• request_options (FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (FinchAPI::Models::Sandbox::IndividualUpdateResponse)

See Also:

• Models::Sandbox::IndividualUpdateParams

# File 'lib/finch_api/resources/sandbox/individual.rb', line 45

def update(individual_id, params = {})
  parsed, options = FinchAPI::Sandbox::IndividualUpdateParams.dump_request(params)
  @client.request(
    method: :put,
    path: ["sandbox/individual/%1$s", individual_id],
    body: parsed,
    model: FinchAPI::Models::Sandbox::IndividualUpdateResponse,
    options: options
  )
end