Class: NewStoreApi::RetrieveBulkEmailLookupResponse

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/new_store_api/models/retrieve_bulk_email_lookup_response.rb

Overview

Response with the mapping of profile IDs to profile emails for the requested profile emails.

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(results = nil) ⇒ RetrieveBulkEmailLookupResponse

Returns a new instance of RetrieveBulkEmailLookupResponse.



34
35
36
 
# File 'lib/new_store_api/models/retrieve_bulk_email_lookup_response.rb', line 34

def initialize(results = nil)
  @results = results
end

Instance Attribute Details

#results ⇒ Array[BulkProfileLookupResponse]

TODO: Write general description for this method

Returns:



15
16
17
 
# File 'lib/new_store_api/models/retrieve_bulk_email_lookup_response.rb', line 15

def results
  @results
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
 
# File 'lib/new_store_api/models/retrieve_bulk_email_lookup_response.rb', line 39

def self.from_hash(hash)
  return nil unless hash

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

  results = nil unless hash.key?('results')

  # Create object from extracted values.
  RetrieveBulkEmailLookupResponse.new(results)
end

.names ⇒ Object

A mapping from model property names to API property names.



18
19
20
21
22
 
# File 'lib/new_store_api/models/retrieve_bulk_email_lookup_response.rb', line 18

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

.nullables ⇒ Object

An array for nullable fields



30
31
32
 
# File 'lib/new_store_api/models/retrieve_bulk_email_lookup_response.rb', line 30

def self.nullables
  []
end

.optionals ⇒ Object

An array for optional fields



25
26
27
 
# File 'lib/new_store_api/models/retrieve_bulk_email_lookup_response.rb', line 25

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



65
66
67
68
 
# File 'lib/new_store_api/models/retrieve_bulk_email_lookup_response.rb', line 65

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} results: #{@results.inspect}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



59
60
61
62
 
# File 'lib/new_store_api/models/retrieve_bulk_email_lookup_response.rb', line 59

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} results: #{@results}>"
end