Class: TalonOne::NewEventType

Inherits:
Object
  • Object
show all
Defined in:
lib/talon_one/models/new_event_type.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NewEventType

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/talon_one/models/new_event_type.rb', line 104

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'applicationIds')
    if (value = attributes[:'applicationIds']).is_a?(Array)
      self.application_ids = value
    end
  end

  if attributes.has_key?(:'title')
    self.title = attributes[:'title']
  end

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

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

  if attributes.has_key?(:'mimeType')
    self.mime_type = attributes[:'mimeType']
  end

  if attributes.has_key?(:'examplePayload')
    self.example_payload = attributes[:'examplePayload']
  end

  if attributes.has_key?(:'schema')
    self.schema = attributes[:'schema']
  end

  if attributes.has_key?(:'handlerLanguage')
    self.handler_language = attributes[:'handlerLanguage']
  end

  if attributes.has_key?(:'handler')
    self.handler = attributes[:'handler']
  end

  if attributes.has_key?(:'version')
    self.version = attributes[:'version']
  end
end

Instance Attribute Details

#application_ids ⇒ Object

The IDs of the applications that are related to this entity.



19
20
21
 
# File 'lib/talon_one/models/new_event_type.rb', line 19

def application_ids
  @application_ids
end

#description ⇒ Object

An explanation of when the event type is triggered. Write this with a campaign manager in mind. For example: > The "Payment Accepted" event is triggered after successful processing of a payment by our payment gateway.



28
29
30
 
# File 'lib/talon_one/models/new_event_type.rb', line 28

def description
  @description
end

#example_payload ⇒ Object

It is often helpful to include an example payload with the event type definition for documentation purposes.



34
35
36
 
# File 'lib/talon_one/models/new_event_type.rb', line 34

def example_payload
  @example_payload
end

#handler ⇒ Object

Code that will be run after successful parsing & validation of the payload for this event. This code may choose to evaluate campaign rules.



43
44
45
 
# File 'lib/talon_one/models/new_event_type.rb', line 43

def handler
  @handler
end

#handler_language ⇒ Object

The language of the handler code. Currently only ‘"talang"` is supported.



40
41
42
 
# File 'lib/talon_one/models/new_event_type.rb', line 40

def handler_language
  @handler_language
end

#mime_type ⇒ Object

This defines how the request payload will be parsed before your handler code is run.



31
32
33
 
# File 'lib/talon_one/models/new_event_type.rb', line 31

def mime_type
  @mime_type
end

#name ⇒ Object

The machine-friendly canonical name for this event type. This will be used in URLs, and cannot be changed after an event type has been created.



25
26
27
 
# File 'lib/talon_one/models/new_event_type.rb', line 25

def name
  @name
end

#schema ⇒ Object

It is strongly recommended to define a JSON schema that will be used to perform structural validation of request payloads after parsing.



37
38
39
 
# File 'lib/talon_one/models/new_event_type.rb', line 37

def schema
  @schema
end

#title ⇒ Object

The human-friendly display name for this event type. Use a short, past-tense, description of the event.



22
23
24
 
# File 'lib/talon_one/models/new_event_type.rb', line 22

def title
  @title
end

#version ⇒ Object

The version of this event type. When updating an existing event type this must be exactly ‘currentVersion + 1`.



46
47
48
 
# File 'lib/talon_one/models/new_event_type.rb', line 46

def version
  @version
end

Class Method Details

.attribute_map ⇒ Object

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



71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/talon_one/models/new_event_type.rb', line 71

def self.attribute_map
  {
    :'application_ids' => :'applicationIds',
    :'title' => :'title',
    :'name' => :'name',
    :'description' => :'description',
    :'mime_type' => :'mimeType',
    :'example_payload' => :'examplePayload',
    :'schema' => :'schema',
    :'handler_language' => :'handlerLanguage',
    :'handler' => :'handler',
    :'version' => :'version'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/talon_one/models/new_event_type.rb', line 87

def self.swagger_types
  {
    :'application_ids' => :'Array<Integer>',
    :'title' => :'String',
    :'name' => :'String',
    :'description' => :'String',
    :'mime_type' => :'String',
    :'example_payload' => :'String',
    :'schema' => :'Object',
    :'handler_language' => :'String',
    :'handler' => :'String',
    :'version' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/talon_one/models/new_event_type.rb', line 265

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      application_ids == o.application_ids &&
      title == o.title &&
      name == o.name &&
      description == o.description &&
      mime_type == o.mime_type &&
      example_payload == o.example_payload &&
      schema == o.schema &&
      handler_language == o.handler_language &&
      handler == o.handler &&
      version == o.version
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



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
348
349
350
351
352
 
# File 'lib/talon_one/models/new_event_type.rb', line 316

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = TalonOne.const_get(type).new
    temp_model.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



382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/talon_one/models/new_event_type.rb', line 382

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



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/talon_one/models/new_event_type.rb', line 295

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


282
283
284
 
# File 'lib/talon_one/models/new_event_type.rb', line 282

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



288
289
290
 
# File 'lib/talon_one/models/new_event_type.rb', line 288

def hash
  [application_ids, title, name, description, mime_type, example_payload, schema, handler_language, handler, version].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



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
 
# File 'lib/talon_one/models/new_event_type.rb', line 155

def list_invalid_properties
  invalid_properties = Array.new
  if @application_ids.nil?
    invalid_properties.push('invalid value for "application_ids", application_ids cannot be nil.')
  end

  if @title.nil?
    invalid_properties.push('invalid value for "title", title cannot be nil.')
  end

  if @title.to_s.length < 1
    invalid_properties.push('invalid value for "title", the character length must be great than or equal to 1.')
  end

  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  if @name.to_s.length < 1
    invalid_properties.push('invalid value for "name", the character length must be great than or equal to 1.')
  end

  if @description.nil?
    invalid_properties.push('invalid value for "description", description cannot be nil.')
  end

  if @mime_type.nil?
    invalid_properties.push('invalid value for "mime_type", mime_type cannot be nil.')
  end

  if @handler.nil?
    invalid_properties.push('invalid value for "handler", handler cannot be nil.')
  end

  if @version.nil?
    invalid_properties.push('invalid value for "version", version cannot be nil.')
  end

  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



362
363
364
 
# File 'lib/talon_one/models/new_event_type.rb', line 362

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



368
369
370
371
372
373
374
375
376
 
# File 'lib/talon_one/models/new_event_type.rb', line 368

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



356
357
358
 
# File 'lib/talon_one/models/new_event_type.rb', line 356

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



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/talon_one/models/new_event_type.rb', line 198

def valid?
  return false if @application_ids.nil?
  return false if @title.nil?
  return false if @title.to_s.length < 1
  return false if @name.nil?
  return false if @name.to_s.length < 1
  return false if @description.nil?
  return false if @mime_type.nil?
  mime_type_validator = EnumAttributeValidator.new('String', ['application/json', 'application/x-www-form-urlencoded', 'none'])
  return false unless mime_type_validator.valid?(@mime_type)
  handler_language_validator = EnumAttributeValidator.new('String', ['talang'])
  return false unless handler_language_validator.valid?(@handler_language)
  return false if @handler.nil?
  return false if @version.nil?
  true
end