Class: OneSignal::Journey

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

Overview

Full journey representation returned by the detail, create, and update endpoints.

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Journey

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#app_id ⇒ Object

UUID of the app the journey belongs to. Read-only.



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

def app_id
  @app_id
end

#archived_at ⇒ Object

ISO 8601 time the journey was archived, or null. Read-only.



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

def archived_at
  @archived_at
end

#audience ⇒ Object

Returns the value of attribute audience.



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

def audience
  @audience
end

#concurrency_key ⇒ Object

Opaque optimistic-concurrency token. Read-only. Pass it back on update to guard against overwriting a concurrent change (409). Send it back exactly as read; do not construct or parse it.



60
61
62
 
# File 'lib/onesignal/models/journey.rb', line 60

def concurrency_key
  @concurrency_key
end

#created_at ⇒ Object

ISO 8601 creation time. Read-only.



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

def created_at
  @created_at
end

#created_source ⇒ Object

Origin of the journey, for example public_api or dashboard. Read-only.



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

def created_source
  @created_source
end

#description ⇒ Object

Journey description, up to 1024 characters. Defaults to an empty string.



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

def description
  @description
end

#early_exit ⇒ Object

Returns the value of attribute early_exit.



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

def early_exit
  @early_exit
end

#id ⇒ Object

Journey UUID. Read-only.



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

def id
  @id
end

#name ⇒ Object

Journey name, up to 300 characters.



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

def name
  @name
end

#nodes ⇒ Object

Ordered list of journey nodes.



57
58
59
 
# File 'lib/onesignal/models/journey.rb', line 57

def nodes
  @nodes
end

#reentry_rules ⇒ Object

Returns the value of attribute reentry_rules.



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

def reentry_rules
  @reentry_rules
end

#schedule ⇒ Object

Returns the value of attribute schedule.



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

def schedule
  @schedule
end

#started_at ⇒ Object

ISO 8601 time the journey was activated, or null. Read-only. May stay null briefly after you set state to active: activation is enqueued, and started_at populates once the journey finishes processing.



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

def started_at
  @started_at
end

#state ⇒ Object

Journey state. New journeys are created as draft. processing is transient while activation is in progress. archived is a journey that has been stopped. Change it through the state field on Update journey.



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

def state
  @state
end

#updated_at ⇒ Object

ISO 8601 last-update time. Read-only.



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

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



107
108
109
 
# File 'lib/onesignal/models/journey.rb', line 107

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/onesignal/models/journey.rb', line 85

def self.attribute_map
  {
    :'id' => :'id',
    :'app_id' => :'app_id',
    :'name' => :'name',
    :'description' => :'description',
    :'state' => :'state',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'started_at' => :'started_at',
    :'archived_at' => :'archived_at',
    :'created_source' => :'created_source',
    :'audience' => :'audience',
    :'early_exit' => :'early_exit',
    :'reentry_rules' => :'reentry_rules',
    :'schedule' => :'schedule',
    :'nodes' => :'nodes',
    :'concurrency_key' => :'concurrency_key'
  }
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



291
292
293
 
# File 'lib/onesignal/models/journey.rb', line 291

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/onesignal/models/journey.rb', line 134

def self.openapi_nullable
  Set.new([
    :'description',
    :'started_at',
    :'archived_at',
    :'created_source',
    :'early_exit',
    :'reentry_rules',
    :'schedule',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/onesignal/models/journey.rb', line 112

def self.openapi_types
  {
    :'id' => :'String',
    :'app_id' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'state' => :'String',
    :'created_at' => :'String',
    :'updated_at' => :'String',
    :'started_at' => :'String',
    :'archived_at' => :'String',
    :'created_source' => :'String',
    :'audience' => :'JourneyAudience',
    :'early_exit' => :'JourneyEarlyExit',
    :'reentry_rules' => :'JourneyReentryRules',
    :'schedule' => :'JourneySchedule',
    :'nodes' => :'Array<JourneyNode>',
    :'concurrency_key' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/onesignal/models/journey.rb', line 255

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      app_id == o.app_id &&
      name == o.name &&
      description == o.description &&
      state == o.state &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      started_at == o.started_at &&
      archived_at == o.archived_at &&
      created_source == o.created_source &&
      audience == o.audience &&
      early_exit == o.early_exit &&
      reentry_rules == o.reentry_rules &&
      schedule == o.schedule &&
      nodes == o.nodes &&
      concurrency_key == o.concurrency_key
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



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
348
349
350
351
352
353
354
355
356
357
358
359
 
# File 'lib/onesignal/models/journey.rb', line 322

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



393
394
395
396
397
398
399
400
401
402
403
404
405
 
# File 'lib/onesignal/models/journey.rb', line 393

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



298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/onesignal/models/journey.rb', line 298

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


278
279
280
 
# File 'lib/onesignal/models/journey.rb', line 278

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



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

def hash
  [id, app_id, name, description, state, created_at, updated_at, started_at, archived_at, created_source, audience, early_exit, reentry_rules, schedule, nodes, concurrency_key].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



230
231
232
233
 
# File 'lib/onesignal/models/journey.rb', line 230

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



369
370
371
 
# File 'lib/onesignal/models/journey.rb', line 369

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



375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/onesignal/models/journey.rb', line 375

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



363
364
365
 
# File 'lib/onesignal/models/journey.rb', line 363

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



237
238
239
240
241
 
# File 'lib/onesignal/models/journey.rb', line 237

def valid?
  state_validator = EnumAttributeValidator.new('String', ["draft", "scheduled", "processing", "active", "archived"])
  return false unless state_validator.valid?(@state)
  true
end