Class: OneSignal::NotificationTarget

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NotificationTarget

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
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
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
# File 'lib/onesignal/models/notification_target.rb', line 172

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

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

  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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount_spentObject

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



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

def amount_spent
  @amount_spent
end

#app_versionObject

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



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

def app_version
  @app_version
end

#bought_skuObject

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"



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

def bought_sku
  @bought_sku
end

#countryObject

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



58
59
60
# File 'lib/onesignal/models/notification_target.rb', line 58

def country
  @country
end

#emailObject

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



55
56
57
# File 'lib/onesignal/models/notification_target.rb', line 55

def email
  @email
end

#excluded_segmentsObject

Segment that will be excluded when sending. Users in these segments will not receive a notification, even if they were included in included_segments. This targeting parameter is only compatible with included_segments. Example: ["Active Users", "Inactive Users"]



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

def excluded_segments
  @excluded_segments
end

#first_sessionObject

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



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

def first_session
  @first_session
end

#include_amazon_reg_idsObject

Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using Amazon ADM registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: amzn1.adm-registration.v1.XpvSSUk0Rc3hTVVV… Limit of 2,000 entries per REST API call



79
80
81
# File 'lib/onesignal/models/notification_target.rb', line 79

def include_amazon_reg_ids
  @include_amazon_reg_ids
end

#include_android_reg_idsObject

Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using Android device registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_… Limit of 2,000 entries per REST API call



88
89
90
# File 'lib/onesignal/models/notification_target.rb', line 88

def include_android_reg_ids
  @include_android_reg_ids
end

#include_chrome_reg_idsObject

Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using Chrome App registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_… Limit of 2,000 entries per REST API call



82
83
84
# File 'lib/onesignal/models/notification_target.rb', line 82

def include_chrome_reg_ids
  @include_chrome_reg_ids
end

#include_chrome_web_reg_idsObject

Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using Chrome Web Push registration IDs. If a token does not correspond to an existing user, a new user will be created. Example: APA91bEeiUeSukAAUdnw3O2RB45FWlSpgJ7Ji_… Limit of 2,000 entries per REST API call



85
86
87
# File 'lib/onesignal/models/notification_target.rb', line 85

def include_chrome_web_reg_ids
  @include_chrome_web_reg_ids
end

#include_email_tokensObject

Recommended for Sending Emails - Target specific email addresses. If an email does not correspond to an existing user, a new user will be created. Example: [email protected] Limit of 2,000 entries per REST API call



67
68
69
# File 'lib/onesignal/models/notification_target.rb', line 67

def include_email_tokens
  @include_email_tokens
end

#include_external_user_idsObject

Target specific devices by custom user IDs assigned via API. Not compatible with any other targeting parameters Example: ["custom-id-assigned-by-api"] REQUIRED: REST API Key Authentication Limit of 2,000 entries per REST API call. Note: If targeting push, email, or sms subscribers with same ids, use with channel_for_external_user_ids to indicate you are sending a push or email or sms.



64
65
66
# File 'lib/onesignal/models/notification_target.rb', line 64

def include_external_user_ids
  @include_external_user_ids
end

#include_ios_tokensObject

Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using iOS device tokens. Warning: Only works with Production tokens. All non-alphanumeric characters must be removed from each token. If a token does not correspond to an existing user, a new user will be created. Example: ce777617da7f548fe7a9ab6febb56cf39fba6d38203… Limit of 2,000 entries per REST API call



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

def include_ios_tokens
  @include_ios_tokens
end

#include_phone_numbersObject

Recommended for Sending SMS - Target specific phone numbers. The phone number should be in the E.164 format. Phone number should be an existing subscriber on OneSignal. Refer our docs to learn how to add phone numbers to OneSignal. Example phone number: +1999999999 Limit of 2,000 entries per REST API call



70
71
72
# File 'lib/onesignal/models/notification_target.rb', line 70

def include_phone_numbers
  @include_phone_numbers
end

#include_player_idsObject

Specific playerids to send your notification to. _Does not require API Auth Key. Do not combine with other targeting parameters. Not compatible with any other targeting parameters. Example: ["1dd608f2-c6a1-11e3-851d-000c2940e62c"] Limit of 2,000 entries per REST API call



61
62
63
# File 'lib/onesignal/models/notification_target.rb', line 61

def include_player_ids
  @include_player_ids
end

#include_wp_wns_urisObject

Not Recommended: Please consider using include_player_ids or include_external_user_ids instead. Target using Windows URIs. If a token does not correspond to an existing user, a new user will be created. Example: s.notify.live.net/u/1/bn1/HmQAAACPaLDr-… Limit of 2,000 entries per REST API call



76
77
78
# File 'lib/onesignal/models/notification_target.rb', line 76

def include_wp_wns_uris
  @include_wp_wns_uris
end

#included_segmentsObject

The segment names you want to target. Users in these segments will receive a notification. This targeting parameter is only compatible with excluded_segments. Example: ["Active Users", "Inactive Users"]



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

def included_segments
  @included_segments
end

#languageObject

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



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

def language
  @language
end

#last_sessionObject

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



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

def last_session
  @last_session
end

#locationObject

radius = in meters lat = latitude long = longitude



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

def location
  @location
end

#session_countObject

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



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

def session_count
  @session_count
end

#session_timeObject

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



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

def session_time
  @session_time
end

#tagObject

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



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

def tag
  @tag
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



121
122
123
# File 'lib/onesignal/models/notification_target.rb', line 121

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



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
# File 'lib/onesignal/models/notification_target.rb', line 91

def self.attribute_map
  {
    :'included_segments' => :'included_segments',
    :'excluded_segments' => :'excluded_segments',
    :'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',
    :'include_player_ids' => :'include_player_ids',
    :'include_external_user_ids' => :'include_external_user_ids',
    :'include_email_tokens' => :'include_email_tokens',
    :'include_phone_numbers' => :'include_phone_numbers',
    :'include_ios_tokens' => :'include_ios_tokens',
    :'include_wp_wns_uris' => :'include_wp_wns_uris',
    :'include_amazon_reg_ids' => :'include_amazon_reg_ids',
    :'include_chrome_reg_ids' => :'include_chrome_reg_ids',
    :'include_chrome_web_reg_ids' => :'include_chrome_web_reg_ids',
    :'include_android_reg_ids' => :'include_android_reg_ids'
  }
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



377
378
379
# File 'lib/onesignal/models/notification_target.rb', line 377

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

.openapi_any_ofObject

List of class defined in anyOf (OpenAPI v3)



162
163
164
165
166
167
168
# File 'lib/onesignal/models/notification_target.rb', line 162

def self.openapi_any_of
  [
  :'FilterNotificationTarget',
  :'PlayerNotificationTarget',
  :'SegmentNotificationTarget'
  ]
end

.openapi_nullableObject

List of attributes with nullable: true



156
157
158
159
# File 'lib/onesignal/models/notification_target.rb', line 156

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

.openapi_typesObject

Attribute type mapping.



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
# File 'lib/onesignal/models/notification_target.rb', line 126

def self.openapi_types
  {
    :'included_segments' => :'Array<String>',
    :'excluded_segments' => :'Array<String>',
    :'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',
    :'include_player_ids' => :'Array<String>',
    :'include_external_user_ids' => :'Array<String>',
    :'include_email_tokens' => :'Array<String>',
    :'include_phone_numbers' => :'Array<String>',
    :'include_ios_tokens' => :'Array<String>',
    :'include_wp_wns_uris' => :'Array<String>',
    :'include_amazon_reg_ids' => :'Array<String>',
    :'include_chrome_reg_ids' => :'Array<String>',
    :'include_chrome_web_reg_ids' => :'Array<String>',
    :'include_android_reg_ids' => :'Array<String>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
# File 'lib/onesignal/models/notification_target.rb', line 333

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      included_segments == o.included_segments &&
      excluded_segments == o.excluded_segments &&
      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 &&
      include_player_ids == o.include_player_ids &&
      include_external_user_ids == o.include_external_user_ids &&
      include_email_tokens == o.include_email_tokens &&
      include_phone_numbers == o.include_phone_numbers &&
      include_ios_tokens == o.include_ios_tokens &&
      include_wp_wns_uris == o.include_wp_wns_uris &&
      include_amazon_reg_ids == o.include_amazon_reg_ids &&
      include_chrome_reg_ids == o.include_chrome_reg_ids &&
      include_chrome_web_reg_ids == o.include_chrome_web_reg_ids &&
      include_android_reg_ids == o.include_android_reg_ids
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



408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
# File 'lib/onesignal/models/notification_target.rb', line 408

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



479
480
481
482
483
484
485
486
487
488
489
490
491
# File 'lib/onesignal/models/notification_target.rb', line 479

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



384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
# File 'lib/onesignal/models/notification_target.rb', line 384

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


364
365
366
# File 'lib/onesignal/models/notification_target.rb', line 364

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



370
371
372
# File 'lib/onesignal/models/notification_target.rb', line 370

def hash
  [included_segments, excluded_segments, last_session, first_session, session_count, session_time, amount_spent, bought_sku, tag, language, app_version, location, email, country, include_player_ids, include_external_user_ids, include_email_tokens, include_phone_numbers, include_ios_tokens, include_wp_wns_uris, include_amazon_reg_ids, include_chrome_reg_ids, include_chrome_web_reg_ids, include_android_reg_ids].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



308
309
310
311
# File 'lib/onesignal/models/notification_target.rb', line 308

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



455
456
457
# File 'lib/onesignal/models/notification_target.rb', line 455

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



461
462
463
464
465
466
467
468
469
470
471
472
473
# File 'lib/onesignal/models/notification_target.rb', line 461

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



449
450
451
# File 'lib/onesignal/models/notification_target.rb', line 449

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



315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
# File 'lib/onesignal/models/notification_target.rb', line 315

def valid?
  _any_of_found = false
  self.class.openapi_any_of.each do |_class|
    _any_of = OneSignal.const_get(_class).build_from_hash(self.to_hash)
    if _any_of.valid?
      _any_of_found = true
    end
  end

  if !_any_of_found
    return false
  end

  true
end