Class: Verizon::V3CampaignHistory

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

Overview

Campaign history.

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:, campaign_list:, last_seen_campaign_id: SKIP, additional_properties: nil) ⇒ V3CampaignHistory

Returns a new instance of V3CampaignHistory.



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

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

  @has_more_data = has_more_data
  @last_seen_campaign_id = last_seen_campaign_id unless last_seen_campaign_id == SKIP
  @campaign_list = campaign_list
  @additional_properties = additional_properties
end

Instance Attribute Details

#campaign_list ⇒ Array[V3CampaignMetaInfo]

Firmware upgrade list.

Returns:



22
23
24
 
# File 'lib/verizon/models/v3_campaign_history.rb', line 22

def campaign_list
  @campaign_list
end

#has_more_data ⇒ TrueClass | FalseClass

Has more report flag?

Returns:

  • (TrueClass | FalseClass) 


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

def has_more_data
  @has_more_data
end

#last_seen_campaign_id ⇒ String

Campaign identifier.

Returns:

  • (String) 


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

def last_seen_campaign_id
  @last_seen_campaign_id
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/verizon/models/v3_campaign_history.rb', line 59

def self.from_hash(hash)
  return nil unless hash

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

  campaign_list = nil unless hash.key?('campaignList')
  last_seen_campaign_id =
    hash.key?('lastSeenCampaignId') ? hash['lastSeenCampaignId'] : 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.
  V3CampaignHistory.new(has_more_data: has_more_data,
                        campaign_list: campaign_list,
                        last_seen_campaign_id: last_seen_campaign_id,
                        additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



25
26
27
28
29
30
31
 
# File 'lib/verizon/models/v3_campaign_history.rb', line 25

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['has_more_data'] = 'hasMoreData'
  @_hash['last_seen_campaign_id'] = 'lastSeenCampaignId'
  @_hash['campaign_list'] = 'campaignList'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



41
42
43
44
45
 
# File 'lib/verizon/models/v3_campaign_history.rb', line 41

def self.nullables
  %w[
    campaign_list
  ]
end

.optionals ⇒ Object

An array for optional fields



34
35
36
37
38
 
# File 'lib/verizon/models/v3_campaign_history.rb', line 34

def self.optionals
  %w[
    last_seen_campaign_id
  ]
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



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

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

#to_s ⇒ Object

Provides a human-readable string representation of the object.



92
93
94
95
96
97
 
# File 'lib/verizon/models/v3_campaign_history.rb', line 92

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