Class: OneSignal::FilterNotificationTarget

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ FilterNotificationTarget

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
156
157
158
159
160
161
162
163
 
# File 'lib/onesignal/models/filter_notification_target.rb', line 103

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount_spent ⇒ Object

relation = ">", "<", or "=" value = Amount in USD a user has spent on IAP (In App Purchases). Example: "0.99"



31
32
33
 
# File 'lib/onesignal/models/filter_notification_target.rb', line 31

def amount_spent
  @amount_spent
end

#app_version ⇒ Object

relation = ">", "<", "=" or "!=" value = app version. Example: "1.0.0"



43
44
45
 
# File 'lib/onesignal/models/filter_notification_target.rb', line 43

def app_version
  @app_version
end

#bought_sku ⇒ Object

relation = ">", "<" or "=" key = SKU purchased in your app as an IAP (In App Purchases). Example: "com.domain.100coinpack" value = value of SKU to compare to. Example: "0.99"



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

def bought_sku
  @bought_sku
end

#country ⇒ Object

relation = "=" value = 2-digit Country code Example: "field": "country", "relation": "=", "value", "US"



52
53
54
 
# File 'lib/onesignal/models/filter_notification_target.rb', line 52

def country
  @country
end

#email ⇒ Object

value = email address Only for sending Push Notifications Use this for targeting push subscribers associated with an email set with all SDK setEmail methods To send emails to specific email addresses use include_email_tokens parameter



49
50
51
 
# File 'lib/onesignal/models/filter_notification_target.rb', line 49

def email
  @email
end

#first_session ⇒ Object

relation = ">" or "<" hours_ago = number of hours before or after the users first session. Example: "1.1"



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

def first_session
  @first_session
end

#language ⇒ Object

relation = "=" or "!=" value = 2 character language code. Example: "en". For a list of all language codes see Language & Localization.



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

def language
  @language
end

#last_session ⇒ Object

relation = ">" or "<" hours_ago = number of hours before or after the users last session. Example: "1.1"



19
20
21
 
# File 'lib/onesignal/models/filter_notification_target.rb', line 19

def last_session
  @last_session
end

#location ⇒ Object

radius = in meters lat = latitude long = longitude



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

def location
  @location
end

#session_count ⇒ Object

relation = ">", "<", "=" or "!=" value = number sessions. Example: "1"



25
26
27
 
# File 'lib/onesignal/models/filter_notification_target.rb', line 25

def session_count
  @session_count
end

#session_time ⇒ Object

relation = ">", "<", "=" or "!=" value = Time in seconds the user has been in your app. Example: "3600"



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

def session_time
  @session_time
end

#tag ⇒ Object

relation = ">", "<", "=", "!=", "exists", "not_exists", "time_elapsed_gt" (paid plan only) or "time_elapsed_lt" (paid plan only) See Time Operators key = Tag key to compare. value = Tag value to compare. Not required for "exists" or "not_exists". Example: See Formatting Filters



37
38
39
 
# File 'lib/onesignal/models/filter_notification_target.rb', line 37

def tag
  @tag
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



73
74
75
 
# File 'lib/onesignal/models/filter_notification_target.rb', line 73

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/onesignal/models/filter_notification_target.rb', line 55

def self.attribute_map
  {
    :'last_session' => :'last_session',
    :'first_session' => :'first_session',
    :'session_count' => :'session_count',
    :'session_time' => :'session_time',
    :'amount_spent' => :'amount_spent',
    :'bought_sku' => :'bought_sku',
    :'tag' => :'tag',
    :'language' => :'language',
    :'app_version' => :'app_version',
    :'location' => :'location',
    :'email' => :'email',
    :'country' => :'country'
  }
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



212
213
214
 
# File 'lib/onesignal/models/filter_notification_target.rb', line 212

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



96
97
98
99
 
# File 'lib/onesignal/models/filter_notification_target.rb', line 96

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

.openapi_types ⇒ Object

Attribute type mapping.



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/onesignal/models/filter_notification_target.rb', line 78

def self.openapi_types
  {
    :'last_session' => :'String',
    :'first_session' => :'String',
    :'session_count' => :'String',
    :'session_time' => :'String',
    :'amount_spent' => :'String',
    :'bought_sku' => :'String',
    :'tag' => :'String',
    :'language' => :'String',
    :'app_version' => :'String',
    :'location' => :'String',
    :'email' => :'String',
    :'country' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
 
# File 'lib/onesignal/models/filter_notification_target.rb', line 180

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      last_session == o.last_session &&
      first_session == o.first_session &&
      session_count == o.session_count &&
      session_time == o.session_time &&
      amount_spent == o.amount_spent &&
      bought_sku == o.bought_sku &&
      tag == o.tag &&
      language == o.language &&
      app_version == o.app_version &&
      location == o.location &&
      email == o.email &&
      country == o.country
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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/onesignal/models/filter_notification_target.rb', line 243

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



314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/onesignal/models/filter_notification_target.rb', line 314

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



219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/onesignal/models/filter_notification_target.rb', line 219

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


199
200
201
 
# File 'lib/onesignal/models/filter_notification_target.rb', line 199

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



205
206
207
 
# File 'lib/onesignal/models/filter_notification_target.rb', line 205

def hash
  [last_session, first_session, session_count, session_time, amount_spent, bought_sku, tag, language, app_version, location, email, country].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



167
168
169
170
 
# File 'lib/onesignal/models/filter_notification_target.rb', line 167

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



290
291
292
 
# File 'lib/onesignal/models/filter_notification_target.rb', line 290

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



296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/onesignal/models/filter_notification_target.rb', line 296

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



284
285
286
 
# File 'lib/onesignal/models/filter_notification_target.rb', line 284

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



174
175
176
 
# File 'lib/onesignal/models/filter_notification_target.rb', line 174

def valid?
  true
end