class TalonOne::EventType
Attributes
The IDs of the applications that are related to this entity.
The exact moment this entity was created.
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.
It is often helpful to include an example payload with the event type definition for documentation purposes.
Code that will be run after successful parsing & validation of the payload for this event. This code may choose to evaluate campaign rules.
The language of the handler code. Currently only `"talang"` is supported.
Unique ID for this entity.
This defines how the request payload will be parsed before your handler code is run.
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.
It is strongly recommended to define a JSON schema that will be used to perform structural validation of request payloads after parsing.
The human-friendly display name for this event type. Use a short, past-tense, description of the event.
The version of this event type. When updating an existing event type this must be exactly `currentVersion + 1`.
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/talon_one/models/event_type.rb, line 77 def self.attribute_map { :'id' => :'id', :'created' => :'created', :'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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/talon_one/models/event_type.rb, line 338 def self.build_from_hash(attributes) new.build_from_hash(attributes) end
Initializes the object @param [Hash] attributes Model attributes in the form of hash
# File lib/talon_one/models/event_type.rb, line 120 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::EventType` 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 `TalonOne::EventType`. 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?(:'created') self.created = attributes[:'created'] end if attributes.key?(:'application_ids') if (value = attributes[:'application_ids']).is_a?(Array) self.application_ids = value end end if attributes.key?(:'title') self.title = attributes[:'title'] end if attributes.key?(:'name') self.name = attributes[:'name'] end if attributes.key?(:'description') self.description = attributes[:'description'] end if attributes.key?(:'mime_type') self.mime_type = attributes[:'mime_type'] end if attributes.key?(:'example_payload') self.example_payload = attributes[:'example_payload'] end if attributes.key?(:'schema') self.schema = attributes[:'schema'] end if attributes.key?(:'handler_language') self.handler_language = attributes[:'handler_language'] end if attributes.key?(:'handler') self.handler = attributes[:'handler'] end if attributes.key?(:'version') self.version = attributes[:'version'] end end
List of attributes with nullable: true
# File lib/talon_one/models/event_type.rb, line 113 def self.openapi_nullable Set.new([ ]) end
Attribute
type mapping.
# File lib/talon_one/models/event_type.rb, line 95 def self.openapi_types { :'id' => :'Integer', :'created' => :'DateTime', :'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
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/talon_one/models/event_type.rb, line 306 def ==(o) return true if self.equal?(o) self.class == o.class && id == o.id && created == o.created && 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
Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data
# File lib/talon_one/models/event_type.rb, line 366 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 TalonOne.const_get(type).build_from_hash(value) end 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
# File lib/talon_one/models/event_type.rb, line 435 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
Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself
# File lib/talon_one/models/event_type.rb, line 345 def build_from_hash(attributes) return nil unless attributes.is_a?(Hash) self.class.openapi_types.each_pair do |key, type| if 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 # or else data not found in attributes(hash), not an issue as the data can be optional end self end
@see the `==` method @param [Object] Object to be compared
# File lib/talon_one/models/event_type.rb, line 325 def eql?(o) self == o end
Custom attribute writer method checking allowed values (enum). @param [Object] handler_language
Object to be assigned
# File lib/talon_one/models/event_type.rb, line 296 def handler_language=(handler_language) validator = EnumAttributeValidator.new('String', ["talang"]) unless validator.valid?(handler_language) fail ArgumentError, "invalid value for \"handler_language\", must be one of #{validator.allowable_values}." end @handler_language = handler_language end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/talon_one/models/event_type.rb, line 331 def hash [id, created, application_ids, title, name, description, mime_type, example_payload, schema, handler_language, handler, version].hash end
Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons
# File lib/talon_one/models/event_type.rb, line 186 def list_invalid_properties invalid_properties = Array.new if @id.nil? invalid_properties.push('invalid value for "id", id cannot be nil.') end if @created.nil? invalid_properties.push('invalid value for "created", created cannot be nil.') end 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
Custom attribute writer method checking allowed values (enum). @param [Object] mime_type
Object to be assigned
# File lib/talon_one/models/event_type.rb, line 286 def mime_type=(mime_type) validator = EnumAttributeValidator.new('String', ["application/json", "application/x-www-form-urlencoded", "none"]) unless validator.valid?(mime_type) fail ArgumentError, "invalid value for \"mime_type\", must be one of #{validator.allowable_values}." end @mime_type = mime_type end
Custom attribute writer method with validation @param [Object] name Value to be assigned
# File lib/talon_one/models/event_type.rb, line 272 def name=(name) if name.nil? fail ArgumentError, 'name cannot be nil' end if name.to_s.length < 1 fail ArgumentError, 'invalid value for "name", the character length must be great than or equal to 1.' end @name = name end
Custom attribute writer method with validation @param [Object] title Value to be assigned
# File lib/talon_one/models/event_type.rb, line 258 def title=(title) if title.nil? fail ArgumentError, 'title cannot be nil' end if title.to_s.length < 1 fail ArgumentError, 'invalid value for "title", the character length must be great than or equal to 1.' end @title = title end
Returns the object in the form of hash @return [Hash] Returns the object in the form of hash
# File lib/talon_one/models/event_type.rb, line 417 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
Returns the string representation of the object @return [String] String presentation of the object
# File lib/talon_one/models/event_type.rb, line 405 def to_s to_hash.to_s end
Check to see if the all the properties in the model are valid @return true if the model is valid
# File lib/talon_one/models/event_type.rb, line 237 def valid? return false if @id.nil? return false if @created.nil? 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