Class: OneSignal::NotificationTarget

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

Defined Under Namespace

Classes: EnumAttributeValidator

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



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
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/onesignal/models/notification_target.rb', line 144

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?(:'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

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

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

Instance Attribute Details

#excluded_segments ⇒ Object

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

#include_aliases ⇒ Object

Returns the value of attribute include_aliases.



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

def include_aliases
  @include_aliases
end

#include_amazon_reg_ids ⇒ Object

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



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

def include_amazon_reg_ids
  @include_amazon_reg_ids
end

#include_android_reg_ids ⇒ Object

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



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

def include_android_reg_ids
  @include_android_reg_ids
end

#include_chrome_reg_ids ⇒ Object

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



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

def include_chrome_reg_ids
  @include_chrome_reg_ids
end

#include_chrome_web_reg_ids ⇒ Object

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



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

def include_chrome_web_reg_ids
  @include_chrome_web_reg_ids
end

#include_email_tokens ⇒ Object

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



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

def include_email_tokens
  @include_email_tokens
end

#include_external_user_ids ⇒ Object

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.



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

def include_external_user_ids
  @include_external_user_ids
end

#include_ios_tokens ⇒ Object

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



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

def include_ios_tokens
  @include_ios_tokens
end

#include_phone_numbers ⇒ Object

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



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

def include_phone_numbers
  @include_phone_numbers
end

#include_player_ids ⇒ Object

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



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

def include_player_ids
  @include_player_ids
end

#include_wp_wns_uris ⇒ Object

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



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

def include_wp_wns_uris
  @include_wp_wns_uris
end

#included_segments ⇒ Object

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

#target_channel ⇒ Object

Returns the value of attribute target_channel.



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

def target_channel
  @target_channel
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



101
102
103
 
# File 'lib/onesignal/models/notification_target.rb', line 101

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/onesignal/models/notification_target.rb', line 81

def self.attribute_map
  {
    :'included_segments' => :'included_segments',
    :'excluded_segments' => :'excluded_segments',
    :'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',
    :'include_aliases' => :'include_aliases',
    :'target_channel' => :'target_channel'
  }
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



311
312
313
 
# File 'lib/onesignal/models/notification_target.rb', line 311

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

.openapi_any_of ⇒ Object

List of class defined in anyOf (OpenAPI v3)



135
136
137
138
139
140
 
# File 'lib/onesignal/models/notification_target.rb', line 135

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



126
127
128
129
130
131
132
 
# File 'lib/onesignal/models/notification_target.rb', line 126

def self.openapi_nullable
  Set.new([
    :'include_player_ids',
    :'include_external_user_ids',
    :'include_aliases',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'included_segments' => :'Array<String>',
    :'excluded_segments' => :'Array<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>',
    :'include_aliases' => :'PlayerNotificationTargetIncludeAliases',
    :'target_channel' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/onesignal/models/notification_target.rb', line 277

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      included_segments == o.included_segments &&
      excluded_segments == o.excluded_segments &&
      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 &&
      include_aliases == o.include_aliases &&
      target_channel == o.target_channel
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



342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
 
# File 'lib/onesignal/models/notification_target.rb', line 342

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



413
414
415
416
417
418
419
420
421
422
423
424
425
 
# File 'lib/onesignal/models/notification_target.rb', line 413

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



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/onesignal/models/notification_target.rb', line 318

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


298
299
300
 
# File 'lib/onesignal/models/notification_target.rb', line 298

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



304
305
306
 
# File 'lib/onesignal/models/notification_target.rb', line 304

def hash
  [included_segments, excluded_segments, 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, include_aliases, target_channel].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



240
241
242
243
 
# File 'lib/onesignal/models/notification_target.rb', line 240

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



389
390
391
 
# File 'lib/onesignal/models/notification_target.rb', line 389

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



395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/onesignal/models/notification_target.rb', line 395

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



383
384
385
 
# File 'lib/onesignal/models/notification_target.rb', line 383

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



247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/onesignal/models/notification_target.rb', line 247

def valid?
  target_channel_validator = EnumAttributeValidator.new('String', ["push", "email", "sms"])
  return false unless target_channel_validator.valid?(@target_channel)
  _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