Class: Verizon::AccountLeadsResult

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/verizon/models/account_leads_result.rb

Overview

Returns information for all leads associated with an account.

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(has_more_data: SKIP, leads: SKIP, additional_properties: nil) ⇒ AccountLeadsResult

Returns a new instance of AccountLeadsResult.



41
42
43
44
45
46
47
48
 
# File 'lib/verizon/models/account_leads_result.rb', line 41

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

  @has_more_data = has_more_data unless has_more_data == SKIP
  @leads = leads unless leads == SKIP
  @additional_properties = additional_properties
end

Instance Attribute Details

#has_more_data ⇒ TrueClass | FalseClass

False if no more leads.True if there is more data to be retrieved.

Returns:

  • (TrueClass | FalseClass) 


14
15
16
 
# File 'lib/verizon/models/account_leads_result.rb', line 14

def has_more_data
  @has_more_data
end

#leads ⇒ Array[AccountLead]

The leads associated with an account.

Returns:



18
19
20
 
# File 'lib/verizon/models/account_leads_result.rb', line 18

def leads
  @leads
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/verizon/models/account_leads_result.rb', line 51

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  has_more_data = hash.key?('hasMoreData') ? hash['hasMoreData'] : SKIP
  # Parameter is an array, so we need to iterate through it
  leads = nil
  unless hash['leads'].nil?
    leads = []
    hash['leads'].each do |structure|
      leads << (AccountLead.from_hash(structure) if structure)
    end
  end

  leads = SKIP unless hash.key?('leads')

  # 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.
  AccountLeadsResult.new(has_more_data: has_more_data,
                         leads: leads,
                         additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



21
22
23
24
25
26
 
# File 'lib/verizon/models/account_leads_result.rb', line 21

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['has_more_data'] = 'hasMoreData'
  @_hash['leads'] = 'leads'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



37
38
39
 
# File 'lib/verizon/models/account_leads_result.rb', line 37

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



29
30
31
32
33
34
 
# File 'lib/verizon/models/account_leads_result.rb', line 29

def self.optionals
  %w[
    has_more_data
    leads
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



88
89
90
91
92
 
# File 'lib/verizon/models/account_leads_result.rb', line 88

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



81
82
83
84
85
 
# File 'lib/verizon/models/account_leads_result.rb', line 81

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