class TalonOne::NewTemplateDef
Attributes
An array of argument definitions.
Used for grouping templates in the rule editor sidebar.
A short description of the template that will be shown in the rule editor.
A flag to control exposure in Rule
Builder.
A Talang expression that contains variable bindings referring to args.
Extended help text for the template.
Campaigner-friendly name for the template that will be shown in the rule editor.
Public Class Methods
Attribute
mapping from ruby-style variable name to JSON key.
# File lib/talon_one/models/new_template_def.rb, line 39 def self.attribute_map { :'title' => :'title', :'description' => :'description', :'help' => :'help', :'category' => :'category', :'expr' => :'expr', :'args' => :'args', :'expose' => :'expose' } 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/new_template_def.rb, line 220 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/new_template_def.rb, line 72 def initialize(attributes = {}) if (!attributes.is_a?(Hash)) fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::NewTemplateDef` 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::NewTemplateDef`. 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?(:'title') self.title = attributes[:'title'] end if attributes.key?(:'description') self.description = attributes[:'description'] end if attributes.key?(:'help') self.help = attributes[:'help'] end if attributes.key?(:'category') self.category = attributes[:'category'] end if attributes.key?(:'expr') if (value = attributes[:'expr']).is_a?(Array) self.expr = value end end if attributes.key?(:'args') if (value = attributes[:'args']).is_a?(Array) self.args = value end end if attributes.key?(:'expose') self.expose = attributes[:'expose'] else self.expose = false end end
List of attributes with nullable: true
# File lib/talon_one/models/new_template_def.rb, line 65 def self.openapi_nullable Set.new([ ]) end
Attribute
type mapping.
# File lib/talon_one/models/new_template_def.rb, line 52 def self.openapi_types { :'title' => :'String', :'description' => :'String', :'help' => :'String', :'category' => :'String', :'expr' => :'Array<Object>', :'args' => :'Array<TemplateArgDef>', :'expose' => :'Boolean' } end
Public Instance Methods
Checks equality by comparing each attribute. @param [Object] Object to be compared
# File lib/talon_one/models/new_template_def.rb, line 193 def ==(o) return true if self.equal?(o) self.class == o.class && title == o.title && description == o.description && help == o.help && category == o.category && expr == o.expr && args == o.args && expose == o.expose 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/new_template_def.rb, line 248 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/new_template_def.rb, line 317 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/new_template_def.rb, line 227 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
Custom attribute writer method with validation @param [Object] category Value to be assigned
# File lib/talon_one/models/new_template_def.rb, line 179 def category=(category) if category.nil? fail ArgumentError, 'category cannot be nil' end if category.to_s.length < 1 fail ArgumentError, 'invalid value for "category", the character length must be great than or equal to 1.' end @category = category end
@see the `==` method @param [Object] Object to be compared
# File lib/talon_one/models/new_template_def.rb, line 207 def eql?(o) self == o end
Calculates hash code according to all attributes. @return [Integer] Hash code
# File lib/talon_one/models/new_template_def.rb, line 213 def hash [title, description, help, category, expr, args, expose].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/new_template_def.rb, line 122 def list_invalid_properties invalid_properties = Array.new 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 @category.nil? invalid_properties.push('invalid value for "category", category cannot be nil.') end if @category.to_s.length < 1 invalid_properties.push('invalid value for "category", the character length must be great than or equal to 1.') end if @expr.nil? invalid_properties.push('invalid value for "expr", expr cannot be nil.') end if @args.nil? invalid_properties.push('invalid value for "args", args cannot be nil.') end invalid_properties end
Custom attribute writer method with validation @param [Object] title Value to be assigned
# File lib/talon_one/models/new_template_def.rb, line 165 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/new_template_def.rb, line 299 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/new_template_def.rb, line 287 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/new_template_def.rb, line 153 def valid? return false if @title.nil? return false if @title.to_s.length < 1 return false if @category.nil? return false if @category.to_s.length < 1 return false if @expr.nil? return false if @args.nil? true end