Class: KlaviyoAPI::DeviceMetadata

Inherits:
Object
  • Object
show all
Defined in:
lib/klaviyo-api-sdk/models/device_metadata.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DeviceMetadata

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
 
# File 'lib/klaviyo-api-sdk/models/device_metadata.rb', line 125

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#app_build ⇒ Object

The build of the app that created the push token



46
47
48
 
# File 'lib/klaviyo-api-sdk/models/device_metadata.rb', line 46

def app_build
  @app_build
end

#app_id ⇒ Object

The ID of the app that created the push token



49
50
51
 
# File 'lib/klaviyo-api-sdk/models/device_metadata.rb', line 49

def app_id
  @app_id
end

#app_name ⇒ Object

The name of the app that created the push token



40
41
42
 
# File 'lib/klaviyo-api-sdk/models/device_metadata.rb', line 40

def app_name
  @app_name
end

#app_version ⇒ Object

The version of the app that created the push token



43
44
45
 
# File 'lib/klaviyo-api-sdk/models/device_metadata.rb', line 43

def app_version
  @app_version
end

#device_id ⇒ Object

Relatively stable ID for the device. Will update on app uninstall and reinstall



19
20
21
 
# File 'lib/klaviyo-api-sdk/models/device_metadata.rb', line 19

def device_id
  @device_id
end

#device_model ⇒ Object

The model of the device



28
29
30
 
# File 'lib/klaviyo-api-sdk/models/device_metadata.rb', line 28

def device_model
  @device_model
end

#environment ⇒ Object

The environment in which the push token was created



52
53
54
 
# File 'lib/klaviyo-api-sdk/models/device_metadata.rb', line 52

def environment
  @environment
end

#klaviyo_sdk ⇒ Object

The name of the SDK used to create the push token.



22
23
24
 
# File 'lib/klaviyo-api-sdk/models/device_metadata.rb', line 22

def klaviyo_sdk
  @klaviyo_sdk
end

#manufacturer ⇒ Object

The manufacturer of the device



37
38
39
 
# File 'lib/klaviyo-api-sdk/models/device_metadata.rb', line 37

def manufacturer
  @manufacturer
end

#os_name ⇒ Object

The name of the operating system on the device.



31
32
33
 
# File 'lib/klaviyo-api-sdk/models/device_metadata.rb', line 31

def os_name
  @os_name
end

#os_version ⇒ Object

The version of the operating system on the device



34
35
36
 
# File 'lib/klaviyo-api-sdk/models/device_metadata.rb', line 34

def os_version
  @os_version
end

#sdk_version ⇒ Object

The version of the SDK used to create the push token



25
26
27
 
# File 'lib/klaviyo-api-sdk/models/device_metadata.rb', line 25

def sdk_version
  @sdk_version
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



95
96
97
 
# File 'lib/klaviyo-api-sdk/models/device_metadata.rb', line 95

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/klaviyo-api-sdk/models/device_metadata.rb', line 77

def self.attribute_map
  {
    :'device_id' => :'device_id',
    :'klaviyo_sdk' => :'klaviyo_sdk',
    :'sdk_version' => :'sdk_version',
    :'device_model' => :'device_model',
    :'os_name' => :'os_name',
    :'os_version' => :'os_version',
    :'manufacturer' => :'manufacturer',
    :'app_name' => :'app_name',
    :'app_version' => :'app_version',
    :'app_build' => :'app_build',
    :'app_id' => :'app_id',
    :'environment' => :'environment'
  }
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



270
271
272
 
# File 'lib/klaviyo-api-sdk/models/device_metadata.rb', line 270

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



118
119
120
121
 
# File 'lib/klaviyo-api-sdk/models/device_metadata.rb', line 118

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

.openapi_types ⇒ Object

Attribute type mapping.



100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
 
# File 'lib/klaviyo-api-sdk/models/device_metadata.rb', line 100

def self.openapi_types
  {
    :'device_id' => :'String',
    :'klaviyo_sdk' => :'String',
    :'sdk_version' => :'String',
    :'device_model' => :'String',
    :'os_name' => :'String',
    :'os_version' => :'String',
    :'manufacturer' => :'String',
    :'app_name' => :'String',
    :'app_version' => :'String',
    :'app_build' => :'String',
    :'app_id' => :'String',
    :'environment' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/klaviyo-api-sdk/models/device_metadata.rb', line 238

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      device_id == o.device_id &&
      klaviyo_sdk == o.klaviyo_sdk &&
      sdk_version == o.sdk_version &&
      device_model == o.device_model &&
      os_name == o.os_name &&
      os_version == o.os_version &&
      manufacturer == o.manufacturer &&
      app_name == o.app_name &&
      app_version == o.app_version &&
      app_build == o.app_build &&
      app_id == o.app_id &&
      environment == o.environment
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/klaviyo-api-sdk/models/device_metadata.rb', line 301

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :Boolean
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    # models (e.g. Pet) or oneOf
    klass = KlaviyoAPI.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/klaviyo-api-sdk/models/device_metadata.rb', line 372

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
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



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
 
# File 'lib/klaviyo-api-sdk/models/device_metadata.rb', line 277

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

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


257
258
259
 
# File 'lib/klaviyo-api-sdk/models/device_metadata.rb', line 257

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



263
264
265
 
# File 'lib/klaviyo-api-sdk/models/device_metadata.rb', line 263

def hash
  [device_id, klaviyo_sdk, sdk_version, device_model, os_name, os_version, manufacturer, app_name, app_version, app_build, app_id, environment].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



189
190
191
192
 
# File 'lib/klaviyo-api-sdk/models/device_metadata.rb', line 189

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



348
349
350
 
# File 'lib/klaviyo-api-sdk/models/device_metadata.rb', line 348

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/klaviyo-api-sdk/models/device_metadata.rb', line 354

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

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



342
343
344
 
# File 'lib/klaviyo-api-sdk/models/device_metadata.rb', line 342

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • (Boolean) —

    true if the model is valid



196
197
198
199
200
201
202
203
204
 
# File 'lib/klaviyo-api-sdk/models/device_metadata.rb', line 196

def valid?
  klaviyo_sdk_validator = EnumAttributeValidator.new('String', ["android", "swift"])
  return false unless klaviyo_sdk_validator.valid?(@klaviyo_sdk)
  os_name_validator = EnumAttributeValidator.new('String', ["android", "ios", "ipados", "macos", "tvos"])
  return false unless os_name_validator.valid?(@os_name)
  environment_validator = EnumAttributeValidator.new('String', ["debug", "release"])
  return false unless environment_validator.valid?(@environment)
  true
end