=begin
#Synctera API
#
Let's build something great.
Welcome to the official reference documentation for Synctera APIs. Our APIs are the best way to automate your company's banking needs and are designed to be easy to understand and implement.
We're continuously growing this library and what you see here is just the start, but if you need something specific or have a question, contact us.
The version of the OpenAPI document: 0.60.0
Generated by: https://openapi-generator.tech
OpenAPI Generator version: 6.5.0
=end
require 'date'
require 'time'
module SyncteraRubySdk
# Webhook event object that will be returned after triggering the given event. Only id, type and event_time will have value.
class EventTrigger
# 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.
attr_accessor :event_resource
# 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.
attr_accessor :event_resource_changed_fields
# Timestamp of the current event raised
attr_accessor :event_time
# Unique event ID of the webhook request. Use event endpoints to get more event summary data
attr_accessor :id
# Metadata that stored in the webhook subscription
attr_accessor :metadata
# Response history of the webhook request
attr_accessor :response_history
# Current event status. Failing event will keep retry until it is purged.
attr_accessor :status
attr_accessor :type
# URL that the current event will be sent to
attr_accessor :url
# Webhook the current event belongs to
attr_accessor :webhook_id
class EnumAttributeValidator
attr_reader :datatype
attr_reader :allowable_values
def initialize(datatype, allowable_values)
@allowable_values = allowable_values.map do |value|
case datatype.to_s
when /Integer/i
value.to_i
when /Float/i
value.to_f
else
value
end
end
end
def valid?(value)
!value || allowable_values.include?(value)
end
end
# Attribute mapping from ruby-style variable name to JSON key.
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
# Returns all the JSON keys this model knows about
def self.acceptable_attributes
attribute_map.values
end
# Attribute type mapping.
def self.openapi_types
{
:'event_resource' => :'String',
:'event_resource_changed_fields' => :'String',
:'event_time' => :'Time',
:'id' => :'String',
:'metadata' => :'String',
:'response_history' => :'Array',
:'status' => :'String',
:'type' => :'EventTypeExplicit',
:'url' => :'String',
:'webhook_id' => :'String'
}
end
# List of attributes with nullable: true
def self.openapi_nullable
Set.new([
])
end
# Initializes the object
# @param [Hash] attributes Model attributes in the form of hash
def initialize(attributes = {})
if (!attributes.is_a?(Hash))
fail ArgumentError, "The input argument (attributes) must be a hash in `SyncteraRubySdk::EventTrigger` 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::EventTrigger`. 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
# Show invalid properties with the reasons. Usually used together with valid?
# @return Array for valid properties with the reasons
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
# Check to see if the all the properties in the model are valid
# @return true if the model is valid
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
# Custom attribute writer method with validation
# @param [Object] metadata Value to be assigned
def metadata=(metadata)
if !metadata.nil? && metadata.to_s.length > 1024
fail ArgumentError, 'invalid value for "metadata", the character length must be smaller than or equal to 1024.'
end
@metadata = metadata
end
# Custom attribute writer method checking allowed values (enum).
# @param [Object] status Object to be assigned
def status=(status)
validator = EnumAttributeValidator.new('String', ["RUNNING", "SUCCESS", "RETRYING", "FAILED"])
unless validator.valid?(status)
fail ArgumentError, "invalid value for \"status\", must be one of #{validator.allowable_values}."
end
@status = status
end
# Custom attribute writer method with validation
# @param [Object] url Value to be assigned
def url=(url)
if !url.nil? && url.to_s.length > 1024
fail ArgumentError, 'invalid value for "url", the character length must be smaller than or equal to 1024.'
end
@url = url
end
# Checks equality by comparing each attribute.
# @param [Object] Object to be compared
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
# @see the `==` method
# @param [Object] Object to be compared
def eql?(o)
self == o
end
# Calculates hash code according to all attributes.
# @return [Integer] Hash code
def hash
[event_resource, event_resource_changed_fields, event_time, id, metadata, response_history, status, type, url, webhook_id].hash
end
# Builds the object from hash
# @param [Hash] attributes Model attributes in the form of hash
# @return [Object] Returns the model itself
def self.build_from_hash(attributes)
new.build_from_hash(attributes)
end
# Builds the object from hash
# @param [Hash] attributes Model attributes in the form of hash
# @return [Object] Returns the model itself
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
# Deserializes the data based on type
# @param string type Data type
# @param string value Value to be deserialized
# @return [Object] Deserialized data
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<(?.+)>\z/
inner_type = Regexp.last_match[:inner_type]
value.map { |v| _deserialize(inner_type, v) }
when /\AHash<(?.+?), (?.+)>\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
# Returns the string representation of the object
# @return [String] String presentation of the object
def to_s
to_hash.to_s
end
# to_body is an alias to to_hash (backward compatibility)
# @return [Hash] Returns the object in the form of hash
def to_body
to_hash
end
# Returns the object in the form of hash
# @return [Hash] Returns the object in the form of hash
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
# Outputs non-array value in the form of hash
# For object, use to_hash. Otherwise, just return the value
# @param [Object] value Any valid value
# @return [Hash] Returns the value in the form of hash
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
end
end