Class: Knievel::CreateFlightRequest

Inherits:
ApiModelBase show all
Defined in:
lib/knievel/models/create_flight_request.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ CreateFlightRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/knievel/models/create_flight_request.rb', line 88

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

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

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

  if attributes.key?(:'campaign_id')
    self.campaign_id = attributes[:'campaign_id']
  else
    self.campaign_id = nil
  end

  if attributes.key?(:'name')
    self.name = attributes[:'name']
  else
    self.name = nil
  end

  if attributes.key?(:'priority_id')
    self.priority_id = attributes[:'priority_id']
  else
    self.priority_id = nil
  end

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

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

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

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

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

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

Instance Attribute Details

#ad_types ⇒ Object

Returns the value of attribute ad_types.



34
35
36
 
# File 'lib/knievel/models/create_flight_request.rb', line 34

def ad_types
  @ad_types
end

#campaign_id ⇒ Object

Returns the value of attribute campaign_id.



20
21
22
 
# File 'lib/knievel/models/create_flight_request.rb', line 20

def campaign_id
  @campaign_id
end

#end_date ⇒ Object

Returns the value of attribute end_date.



28
29
30
 
# File 'lib/knievel/models/create_flight_request.rb', line 28

def end_date
  @end_date
end

#external_id ⇒ Object

Returns the value of attribute external_id.



18
19
20
 
# File 'lib/knievel/models/create_flight_request.rb', line 18

def external_id
  @external_id
end

#is_active ⇒ Object

Returns the value of attribute is_active.



36
37
38
 
# File 'lib/knievel/models/create_flight_request.rb', line 36

def is_active
  @is_active
end

#name ⇒ Object

Returns the value of attribute name.



22
23
24
 
# File 'lib/knievel/models/create_flight_request.rb', line 22

def name
  @name
end

#priority_id ⇒ Object

Returns the value of attribute priority_id.



24
25
26
 
# File 'lib/knievel/models/create_flight_request.rb', line 24

def priority_id
  @priority_id
end

#site_ids ⇒ Object

Returns the value of attribute site_ids.



30
31
32
 
# File 'lib/knievel/models/create_flight_request.rb', line 30

def site_ids
  @site_ids
end

#start_date ⇒ Object

Returns the value of attribute start_date.



26
27
28
 
# File 'lib/knievel/models/create_flight_request.rb', line 26

def start_date
  @start_date
end

#zone_ids ⇒ Object

Returns the value of attribute zone_ids.



32
33
34
 
# File 'lib/knievel/models/create_flight_request.rb', line 32

def zone_ids
  @zone_ids
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



55
56
57
 
# File 'lib/knievel/models/create_flight_request.rb', line 55

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



60
61
62
 
# File 'lib/knievel/models/create_flight_request.rb', line 60

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/knievel/models/create_flight_request.rb', line 39

def self.attribute_map
  {
    :'external_id' => :'external_id',
    :'campaign_id' => :'campaign_id',
    :'name' => :'name',
    :'priority_id' => :'priority_id',
    :'start_date' => :'start_date',
    :'end_date' => :'end_date',
    :'site_ids' => :'site_ids',
    :'zone_ids' => :'zone_ids',
    :'ad_types' => :'ad_types',
    :'is_active' => :'is_active'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/knievel/models/create_flight_request.rb', line 264

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



81
82
83
84
 
# File 'lib/knievel/models/create_flight_request.rb', line 81

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

.openapi_types ⇒ Object

Attribute type mapping.



65
66
67
68
69
70
71
72
73
74
75
76
77
78
 
# File 'lib/knievel/models/create_flight_request.rb', line 65

def self.openapi_types
  {
    :'external_id' => :'String',
    :'campaign_id' => :'Integer',
    :'name' => :'String',
    :'priority_id' => :'Integer',
    :'start_date' => :'String',
    :'end_date' => :'String',
    :'site_ids' => :'Array<Integer>',
    :'zone_ids' => :'Array<Integer>',
    :'ad_types' => :'Array<Integer>',
    :'is_active' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



234
235
236
237
238
239
240
241
242
243
244
245
246
247
 
# File 'lib/knievel/models/create_flight_request.rb', line 234

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      external_id == o.external_id &&
      campaign_id == o.campaign_id &&
      name == o.name &&
      priority_id == o.priority_id &&
      start_date == o.start_date &&
      end_date == o.end_date &&
      site_ids == o.site_ids &&
      zone_ids == o.zone_ids &&
      ad_types == o.ad_types &&
      is_active == o.is_active
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


251
252
253
 
# File 'lib/knievel/models/create_flight_request.rb', line 251

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



257
258
259
 
# File 'lib/knievel/models/create_flight_request.rb', line 257

def hash
  [external_id, campaign_id, name, priority_id, start_date, end_date, site_ids, zone_ids, ad_types, is_active].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



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/knievel/models/create_flight_request.rb', line 159

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @campaign_id.nil?
    invalid_properties.push('invalid value for "campaign_id", campaign_id cannot be nil.')
  end

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

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

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

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



286
287
288
289
290
291
292
293
294
295
296
297
298
 
# File 'lib/knievel/models/create_flight_request.rb', line 286

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

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



183
184
185
186
187
188
189
190
 
# File 'lib/knievel/models/create_flight_request.rb', line 183

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @campaign_id.nil?
  return false if @name.nil?
  return false if @priority_id.nil?
  return false if @ad_types.nil?
  true
end