Class: OneSignal::SubscriptionObject

Inherits:
Object
  • Object
show all
Defined in:
lib/onesignal/models/subscription_object.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubscriptionObject

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/onesignal/models/subscription_object.rb', line 133

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `OneSignal::SubscriptionObject` 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 `OneSignal::SubscriptionObject`. 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?(:'id')
    self.id = attributes[:'id']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#app_version ⇒ Object

Returns the value of attribute app_version.



42
43
44
 
# File 'lib/onesignal/models/subscription_object.rb', line 42

def app_version
  @app_version
end

#carrier ⇒ Object

Returns the value of attribute carrier.



46
47
48
 
# File 'lib/onesignal/models/subscription_object.rb', line 46

def carrier
  @carrier
end

#device_model ⇒ Object

Returns the value of attribute device_model.



34
35
36
 
# File 'lib/onesignal/models/subscription_object.rb', line 34

def device_model
  @device_model
end

#device_os ⇒ Object

Returns the value of attribute device_os.



36
37
38
 
# File 'lib/onesignal/models/subscription_object.rb', line 36

def device_os
  @device_os
end

#enabled ⇒ Object

Returns the value of attribute enabled.



24
25
26
 
# File 'lib/onesignal/models/subscription_object.rb', line 24

def enabled
  @enabled
end

#id ⇒ Object

Returns the value of attribute id.



18
19
20
 
# File 'lib/onesignal/models/subscription_object.rb', line 18

def id
  @id
end

#net_type ⇒ Object

Returns the value of attribute net_type.



44
45
46
 
# File 'lib/onesignal/models/subscription_object.rb', line 44

def net_type
  @net_type
end

#notification_types ⇒ Object

Returns the value of attribute notification_types.



26
27
28
 
# File 'lib/onesignal/models/subscription_object.rb', line 26

def notification_types
  @notification_types
end

#rooted ⇒ Object

Returns the value of attribute rooted.



38
39
40
 
# File 'lib/onesignal/models/subscription_object.rb', line 38

def rooted
  @rooted
end

#sdk ⇒ Object

Returns the value of attribute sdk.



32
33
34
 
# File 'lib/onesignal/models/subscription_object.rb', line 32

def sdk
  @sdk
end

#session_count ⇒ Object

Returns the value of attribute session_count.



30
31
32
 
# File 'lib/onesignal/models/subscription_object.rb', line 30

def session_count
  @session_count
end

#session_time ⇒ Object

Returns the value of attribute session_time.



28
29
30
 
# File 'lib/onesignal/models/subscription_object.rb', line 28

def session_time
  @session_time
end

#test_type ⇒ Object

Returns the value of attribute test_type.



40
41
42
 
# File 'lib/onesignal/models/subscription_object.rb', line 40

def test_type
  @test_type
end

#token ⇒ Object

Returns the value of attribute token.



22
23
24
 
# File 'lib/onesignal/models/subscription_object.rb', line 22

def token
  @token
end

#type ⇒ Object

Returns the value of attribute type.



20
21
22
 
# File 'lib/onesignal/models/subscription_object.rb', line 20

def type
  @type
end

#web_auth ⇒ Object

Returns the value of attribute web_auth.



48
49
50
 
# File 'lib/onesignal/models/subscription_object.rb', line 48

def web_auth
  @web_auth
end

#web_p256 ⇒ Object

Returns the value of attribute web_p256.



50
51
52
 
# File 'lib/onesignal/models/subscription_object.rb', line 50

def web_p256
  @web_p256
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



98
99
100
 
# File 'lib/onesignal/models/subscription_object.rb', line 98

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
 
# File 'lib/onesignal/models/subscription_object.rb', line 75

def self.attribute_map
  {
    :'id' => :'id',
    :'type' => :'type',
    :'token' => :'token',
    :'enabled' => :'enabled',
    :'notification_types' => :'notification_types',
    :'session_time' => :'session_time',
    :'session_count' => :'session_count',
    :'sdk' => :'sdk',
    :'device_model' => :'device_model',
    :'device_os' => :'device_os',
    :'rooted' => :'rooted',
    :'test_type' => :'test_type',
    :'app_version' => :'app_version',
    :'net_type' => :'net_type',
    :'carrier' => :'carrier',
    :'web_auth' => :'web_auth',
    :'web_p256' => :'web_p256'
  }
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



279
280
281
 
# File 'lib/onesignal/models/subscription_object.rb', line 279

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



126
127
128
129
 
# File 'lib/onesignal/models/subscription_object.rb', line 126

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

.openapi_types ⇒ Object

Attribute type mapping.



103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/onesignal/models/subscription_object.rb', line 103

def self.openapi_types
  {
    :'id' => :'String',
    :'type' => :'String',
    :'token' => :'String',
    :'enabled' => :'Boolean',
    :'notification_types' => :'Float',
    :'session_time' => :'Float',
    :'session_count' => :'Float',
    :'sdk' => :'String',
    :'device_model' => :'String',
    :'device_os' => :'String',
    :'rooted' => :'Boolean',
    :'test_type' => :'Float',
    :'app_version' => :'String',
    :'net_type' => :'Float',
    :'carrier' => :'String',
    :'web_auth' => :'String',
    :'web_p256' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/onesignal/models/subscription_object.rb', line 242

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      type == o.type &&
      token == o.token &&
      enabled == o.enabled &&
      notification_types == o.notification_types &&
      session_time == o.session_time &&
      session_count == o.session_count &&
      sdk == o.sdk &&
      device_model == o.device_model &&
      device_os == o.device_os &&
      rooted == o.rooted &&
      test_type == o.test_type &&
      app_version == o.app_version &&
      net_type == o.net_type &&
      carrier == o.carrier &&
      web_auth == o.web_auth &&
      web_p256 == o.web_p256
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



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
339
340
341
342
343
344
345
346
347
 
# File 'lib/onesignal/models/subscription_object.rb', line 310

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 = OneSignal.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



381
382
383
384
385
386
387
388
389
390
391
392
393
 
# File 'lib/onesignal/models/subscription_object.rb', line 381

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



286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/onesignal/models/subscription_object.rb', line 286

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


266
267
268
 
# File 'lib/onesignal/models/subscription_object.rb', line 266

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



272
273
274
 
# File 'lib/onesignal/models/subscription_object.rb', line 272

def hash
  [id, type, token, enabled, notification_types, session_time, session_count, sdk, device_model, device_os, rooted, test_type, app_version, net_type, carrier, web_auth, web_p256].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



217
218
219
220
 
# File 'lib/onesignal/models/subscription_object.rb', line 217

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



357
358
359
 
# File 'lib/onesignal/models/subscription_object.rb', line 357

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



363
364
365
366
367
368
369
370
371
372
373
374
375
 
# File 'lib/onesignal/models/subscription_object.rb', line 363

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



351
352
353
 
# File 'lib/onesignal/models/subscription_object.rb', line 351

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



224
225
226
227
228
 
# File 'lib/onesignal/models/subscription_object.rb', line 224

def valid?
  type_validator = EnumAttributeValidator.new('String', ["iOSPush", "AndroidPush", "FireOSPush", "ChromeExtensionPush", "ChromePush", "WindowsPush", "SafariLegacyPush", "FirefoxPush", "macOSPush", "HuaweiPush", "SafariPush", "Email", "SMS"])
  return false unless type_validator.valid?(@type)
  true
end