Class: Trulioo::BusinessSearchRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/trulioo_sdk/models/business_search_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BusinessSearchRequest

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/trulioo_sdk/models/business_search_request.rb', line 66

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Trulioo::BusinessSearchRequest` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Trulioo::BusinessSearchRequest`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'accept_trulioo_terms_and_conditions')
    self.accept_trulioo_terms_and_conditions = attributes[:'accept_trulioo_terms_and_conditions']
  end

  if attributes.key?(:'call_back_url')
    self.call_back_url = attributes[:'call_back_url']
  end

  if attributes.key?(:'timeout')
    self.timeout = attributes[:'timeout']
  end

  if attributes.key?(:'consent_for_data_sources')
    if (value = attributes[:'consent_for_data_sources']).is_a?(Array)
      self.consent_for_data_sources = value
    end
  end

  if attributes.key?(:'business')
    self.business = attributes[:'business']
  end

  if attributes.key?(:'country_code')
    self.country_code = attributes[:'country_code']
  end
end

Instance Attribute Details

#accept_trulioo_terms_and_conditions ⇒ Object

Indicate that Trulioo terms and conditions are accepted



15
16
17
 
# File 'lib/trulioo_sdk/models/business_search_request.rb', line 15

def accept_trulioo_terms_and_conditions
  @accept_trulioo_terms_and_conditions
end

#business ⇒ Object

Returns the value of attribute business.



24
25
26
 
# File 'lib/trulioo_sdk/models/business_search_request.rb', line 24

def business
  @business
end

#call_back_url ⇒ Object

Returns the value of attribute call_back_url.



17
18
19
 
# File 'lib/trulioo_sdk/models/business_search_request.rb', line 17

def call_back_url
  @call_back_url
end

#consent_for_data_sources ⇒ Object

Some datasources required your customer provide consent to access them. Set that the customer has provided consent for each datasource that requires one. If consent is not provided the datasource will not be queried.



22
23
24
 
# File 'lib/trulioo_sdk/models/business_search_request.rb', line 22

def consent_for_data_sources
  @consent_for_data_sources
end

#country_code ⇒ Object

The country code for which the verification needs to be performed.



27
28
29
 
# File 'lib/trulioo_sdk/models/business_search_request.rb', line 27

def country_code
  @country_code
end

#timeout ⇒ Object

Returns the value of attribute timeout.



19
20
21
 
# File 'lib/trulioo_sdk/models/business_search_request.rb', line 19

def timeout
  @timeout
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



42
43
44
 
# File 'lib/trulioo_sdk/models/business_search_request.rb', line 42

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



30
31
32
33
34
35
36
37
38
39
 
# File 'lib/trulioo_sdk/models/business_search_request.rb', line 30

def self.attribute_map
  {
    :'accept_trulioo_terms_and_conditions' => :'AcceptTruliooTermsAndConditions',
    :'call_back_url' => :'CallBackUrl',
    :'timeout' => :'Timeout',
    :'consent_for_data_sources' => :'ConsentForDataSources',
    :'business' => :'Business',
    :'country_code' => :'CountryCode'
  }
end

.build_from_hash(attributes) ⇒ Object

:nocov: Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



177
178
179
 
# File 'lib/trulioo_sdk/models/business_search_request.rb', line 177

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



59
60
61
62
 
# File 'lib/trulioo_sdk/models/business_search_request.rb', line 59

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
54
55
56
 
# File 'lib/trulioo_sdk/models/business_search_request.rb', line 47

def self.openapi_types
  {
    :'accept_trulioo_terms_and_conditions' => :'Boolean',
    :'call_back_url' => :'String',
    :'timeout' => :'Integer',
    :'consent_for_data_sources' => :'Array<String>',
    :'business' => :'BusinessSearchRequestBusinessSearchModel',
    :'country_code' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



150
151
152
153
154
155
156
157
158
159
 
# File 'lib/trulioo_sdk/models/business_search_request.rb', line 150

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      accept_trulioo_terms_and_conditions == o.accept_trulioo_terms_and_conditions &&
      call_back_url == o.call_back_url &&
      timeout == o.timeout &&
      consent_for_data_sources == o.consent_for_data_sources &&
      business == o.business &&
      country_code == o.country_code
end

#_deserialize(type, value) ⇒ Object

:nocov: Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/trulioo_sdk/models/business_search_request.rb', line 211

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = Trulioo.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

:nocov: Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/trulioo_sdk/models/business_search_request.rb', line 290

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

:nocov: Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
 
# File 'lib/trulioo_sdk/models/business_search_request.rb', line 186

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


163
164
165
 
# File 'lib/trulioo_sdk/models/business_search_request.rb', line 163

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



169
170
171
 
# File 'lib/trulioo_sdk/models/business_search_request.rb', line 169

def hash
  [accept_trulioo_terms_and_conditions, call_back_url, timeout, consent_for_data_sources, business, country_code].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/trulioo_sdk/models/business_search_request.rb', line 108

def list_invalid_properties
  invalid_properties = Array.new
  if !@call_back_url.nil? && @call_back_url.to_s.length > 2083
    invalid_properties.push('invalid value for "call_back_url", the character length must be smaller than or equal to 2083.')
  end

  if !@call_back_url.nil? && @call_back_url.to_s.length < 0
    invalid_properties.push('invalid value for "call_back_url", the character length must be great than or equal to 0.')
  end

  if @country_code.nil?
    invalid_properties.push('invalid value for "country_code", country_code cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

:nocov: to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



262
263
264
 
# File 'lib/trulioo_sdk/models/business_search_request.rb', line 262

def to_body
  to_hash
end

#to_hash ⇒ Hash

:nocov: Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/trulioo_sdk/models/business_search_request.rb', line 270

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

:nocov: Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



254
255
256
 
# File 'lib/trulioo_sdk/models/business_search_request.rb', line 254

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



127
128
129
130
131
132
 
# File 'lib/trulioo_sdk/models/business_search_request.rb', line 127

def valid?
  return false if !@call_back_url.nil? && @call_back_url.to_s.length > 2083
  return false if !@call_back_url.nil? && @call_back_url.to_s.length < 0
  return false if @country_code.nil?
  true
end