Class: ThePlaidApi::BusinessIndustryPrediction

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

Overview

The predicted industry classification for the business, based on digital presence assessments.

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(code:, title:, additional_properties: nil) ⇒ BusinessIndustryPrediction

Returns a new instance of BusinessIndustryPrediction.



39
40
41
42
43
44
45
46
 
# File 'lib/the_plaid_api/models/business_industry_prediction.rb', line 39

def initialize(code:, title:, additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @code = code
  @title = title
  @additional_properties = additional_properties
end

Instance Attribute Details

#code ⇒ Integer

NAICS code for the predicted business industry.

Returns:

  • (Integer) 


15
16
17
 
# File 'lib/the_plaid_api/models/business_industry_prediction.rb', line 15

def code
  @code
end

#title ⇒ String

The business industry classification of the predicted NAICS code.

Returns:

  • (String) 


19
20
21
 
# File 'lib/the_plaid_api/models/business_industry_prediction.rb', line 19

def title
  @title
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/the_plaid_api/models/business_industry_prediction.rb', line 49

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  code = hash.key?('code') ? hash['code'] : nil
  title = hash.key?('title') ? hash['title'] : nil

  # 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.
  BusinessIndustryPrediction.new(code: code,
                                 title: title,
                                 additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



22
23
24
25
26
27
 
# File 'lib/the_plaid_api/models/business_industry_prediction.rb', line 22

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['code'] = 'code'
  @_hash['title'] = 'title'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



35
36
37
 
# File 'lib/the_plaid_api/models/business_industry_prediction.rb', line 35

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



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

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



77
78
79
80
81
 
# File 'lib/the_plaid_api/models/business_industry_prediction.rb', line 77

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



70
71
72
73
74
 
# File 'lib/the_plaid_api/models/business_industry_prediction.rb', line 70

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