Class: ThePlaidApi::EmployersSearchRequest

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/the_plaid_api/models/employers_search_request.rb

Overview

EmployersSearchRequest defines the request schema for ‘/employers/search`.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(query:, products:, client_id: SKIP, secret: SKIP, additional_properties: nil) ⇒ EmployersSearchRequest

Returns a new instance of EmployersSearchRequest.



55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/the_plaid_api/models/employers_search_request.rb', line 55

def initialize(query:, products:, client_id: SKIP, secret: SKIP,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @client_id = client_id unless client_id == SKIP
  @secret = secret unless secret == SKIP
  @query = query
  @products = products
  @additional_properties = additional_properties
end

Instance Attribute Details

#client_id ⇒ String

Your Plaid API ‘client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body.

Returns:

  • (String) 


16
17
18
 
# File 'lib/the_plaid_api/models/employers_search_request.rb', line 16

def client_id
  @client_id
end

#products ⇒ Array[String]

The Plaid products the returned employers should support. Currently, this field must be set to ‘“deposit_switch”`.

Returns:

  • (Array[String]) 


30
31
32
 
# File 'lib/the_plaid_api/models/employers_search_request.rb', line 30

def products
  @products
end

#query ⇒ String

The employer name to be searched for.

Returns:

  • (String) 


25
26
27
 
# File 'lib/the_plaid_api/models/employers_search_request.rb', line 25

def query
  @query
end

#secret ⇒ String

Your Plaid API ‘secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body.

Returns:

  • (String) 


21
22
23
 
# File 'lib/the_plaid_api/models/employers_search_request.rb', line 21

def secret
  @secret
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/the_plaid_api/models/employers_search_request.rb', line 68

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  query = hash.key?('query') ? hash['query'] : nil
  products = hash.key?('products') ? hash['products'] : nil
  client_id = hash.key?('client_id') ? hash['client_id'] : SKIP
  secret = hash.key?('secret') ? hash['secret'] : SKIP

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  EmployersSearchRequest.new(query: query,
                             products: products,
                             client_id: client_id,
                             secret: secret,
                             additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



33
34
35
36
37
38
39
40
 
# File 'lib/the_plaid_api/models/employers_search_request.rb', line 33

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['client_id'] = 'client_id'
  @_hash['secret'] = 'secret'
  @_hash['query'] = 'query'
  @_hash['products'] = 'products'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



51
52
53
 
# File 'lib/the_plaid_api/models/employers_search_request.rb', line 51

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



43
44
45
46
47
48
 
# File 'lib/the_plaid_api/models/employers_search_request.rb', line 43

def self.optionals
  %w[
    client_id
    secret
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



100
101
102
103
104
105
 
# File 'lib/the_plaid_api/models/employers_search_request.rb', line 100

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} client_id: #{@client_id.inspect}, secret: #{@secret.inspect}, query:"\
  " #{@query.inspect}, products: #{@products.inspect}, additional_properties:"\
  " #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



93
94
95
96
97
 
# File 'lib/the_plaid_api/models/employers_search_request.rb', line 93

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} client_id: #{@client_id}, secret: #{@secret}, query: #{@query}, products:"\
  " #{@products}, additional_properties: #{@additional_properties}>"
end