Class: SyncteraRubySdk::Event

Inherits:
Object
  • Object
show all
Defined in:
lib/synctera_ruby_sdk/models/event.rb

Overview

Webhook event object

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Event

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
164
165
166
167
168
169
 
# File 'lib/synctera_ruby_sdk/models/event.rb', line 115

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#event_resource ⇒ Object

Json string of object associated with the event. For example, if your event is ACCOUNT.CREATED, You can refer to Acccount to parse the account event to obtain the ID, status etc.



20
21
22
 
# File 'lib/synctera_ruby_sdk/models/event.rb', line 20

def event_resource
  @event_resource
end

#event_resource_changed_fields ⇒ Object

Json string of object associated with the event related to a resource change. This only contains those fields that have value changed on the event, and the field values are prior to the resource change event.



23
24
25
 
# File 'lib/synctera_ruby_sdk/models/event.rb', line 23

def event_resource_changed_fields
  @event_resource_changed_fields
end

#event_time ⇒ Object

Timestamp of the current event raised



26
27
28
 
# File 'lib/synctera_ruby_sdk/models/event.rb', line 26

def event_time
  @event_time
end

#id ⇒ Object

Unique event ID of the webhook request. Use event endpoints to get more event summary data



29
30
31
 
# File 'lib/synctera_ruby_sdk/models/event.rb', line 29

def id
  @id
end

#metadata ⇒ Object

Metadata that stored in the webhook subscription



32
33
34
 
# File 'lib/synctera_ruby_sdk/models/event.rb', line 32

def metadata
  @metadata
end

#response_history ⇒ Object

Response history of the webhook request



35
36
37
 
# File 'lib/synctera_ruby_sdk/models/event.rb', line 35

def response_history
  @response_history
end

#status ⇒ Object

Current event status. Failing event will keep retry until it is purged.



38
39
40
 
# File 'lib/synctera_ruby_sdk/models/event.rb', line 38

def status
  @status
end

#type ⇒ Object

Returns the value of attribute type.



40
41
42
 
# File 'lib/synctera_ruby_sdk/models/event.rb', line 40

def type
  @type
end

#url ⇒ Object

URL that the current event will be sent to



43
44
45
 
# File 'lib/synctera_ruby_sdk/models/event.rb', line 43

def url
  @url
end

#webhook_id ⇒ Object

Webhook the current event belongs to



46
47
48
 
# File 'lib/synctera_ruby_sdk/models/event.rb', line 46

def webhook_id
  @webhook_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



87
88
89
 
# File 'lib/synctera_ruby_sdk/models/event.rb', line 87

def self.acceptable_attributes
  attribute_map.values
end

.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/synctera_ruby_sdk/models/event.rb', line 71

def self.attribute_map
  {
    :'event_resource' => :'event_resource',
    :'event_resource_changed_fields' => :'event_resource_changed_fields',
    :'event_time' => :'event_time',
    :'id' => :'id',
    :'metadata' => :'metadata',
    :'response_history' => :'response_history',
    :'status' => :'status',
    :'type' => :'type',
    :'url' => :'url',
    :'webhook_id' => :'webhook_id'
  }
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



258
259
260
 
# File 'lib/synctera_ruby_sdk/models/event.rb', line 258

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



108
109
110
111
 
# File 'lib/synctera_ruby_sdk/models/event.rb', line 108

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

.openapi_types ⇒ Object

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/synctera_ruby_sdk/models/event.rb', line 92

def self.openapi_types
  {
    :'event_resource' => :'String',
    :'event_resource_changed_fields' => :'String',
    :'event_time' => :'Time',
    :'id' => :'String',
    :'metadata' => :'String',
    :'response_history' => :'Array<ResponseHistoryItem>',
    :'status' => :'String',
    :'type' => :'EventTypeExplicit',
    :'url' => :'String',
    :'webhook_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



228
229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/synctera_ruby_sdk/models/event.rb', line 228

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      event_resource == o.event_resource &&
      event_resource_changed_fields == o.event_resource_changed_fields &&
      event_time == o.event_time &&
      id == o.id &&
      metadata == o.metadata &&
      response_history == o.response_history &&
      status == o.status &&
      type == o.type &&
      url == o.url &&
      webhook_id == o.webhook_id
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



289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/synctera_ruby_sdk/models/event.rb', line 289

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 = SyncteraRubySdk.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



360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/synctera_ruby_sdk/models/event.rb', line 360

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



265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/synctera_ruby_sdk/models/event.rb', line 265

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


245
246
247
 
# File 'lib/synctera_ruby_sdk/models/event.rb', line 245

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



251
252
253
 
# File 'lib/synctera_ruby_sdk/models/event.rb', line 251

def hash
  [event_resource, event_resource_changed_fields, event_time, id, metadata, response_history, status, type, url, webhook_id].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



173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/synctera_ruby_sdk/models/event.rb', line 173

def list_invalid_properties
  invalid_properties = Array.new
  if !@metadata.nil? && @metadata.to_s.length > 1024
    invalid_properties.push('invalid value for "metadata", the character length must be smaller than or equal to 1024.')
  end

  if !@url.nil? && @url.to_s.length > 1024
    invalid_properties.push('invalid value for "url", the character length must be smaller than or equal to 1024.')
  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



336
337
338
 
# File 'lib/synctera_ruby_sdk/models/event.rb', line 336

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



342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/synctera_ruby_sdk/models/event.rb', line 342

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



330
331
332
 
# File 'lib/synctera_ruby_sdk/models/event.rb', line 330

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



188
189
190
191
192
193
194
 
# File 'lib/synctera_ruby_sdk/models/event.rb', line 188

def valid?
  return false if !@metadata.nil? && @metadata.to_s.length > 1024
  status_validator = EnumAttributeValidator.new('String', ["RUNNING", "SUCCESS", "RETRYING", "FAILED"])
  return false unless status_validator.valid?(@status)
  return false if !@url.nil? && @url.to_s.length > 1024
  true
end