Class: TalonOne::NewTemplateDef

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ NewTemplateDef

Initializes the object

Parameters:

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

    Model attributes in the form of hash



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/talon_one/models/new_template_def.rb', line 66

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?(:'title')
    self.title = attributes[:'title']
  end

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

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

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

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

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

  if attributes.has_key?(:'expose')
    self.expose = attributes[:'expose']
  else
    self.expose = false
  end
end

Instance Attribute Details

#args ⇒ Object

An array of argument definitions.



33
34
35
 
# File 'lib/talon_one/models/new_template_def.rb', line 33

def args
  @args
end

#category ⇒ Object

Used for grouping templates in the rule editor sidebar.



27
28
29
 
# File 'lib/talon_one/models/new_template_def.rb', line 27

def category
  @category
end

#description ⇒ Object

A short description of the template that will be shown in the rule editor.



21
22
23
 
# File 'lib/talon_one/models/new_template_def.rb', line 21

def description
  @description
end

#expose ⇒ Object

A flag to control exposure in Rule Builder.



36
37
38
 
# File 'lib/talon_one/models/new_template_def.rb', line 36

def expose
  @expose
end

#expr ⇒ Object

A Talang expression that contains variable bindings referring to args.



30
31
32
 
# File 'lib/talon_one/models/new_template_def.rb', line 30

def expr
  @expr
end

#help ⇒ Object

Extended help text for the template.



24
25
26
 
# File 'lib/talon_one/models/new_template_def.rb', line 24

def help
  @help
end

#title ⇒ Object

Campaigner-friendly name for the template that will be shown in the rule editor.



18
19
20
 
# File 'lib/talon_one/models/new_template_def.rb', line 18

def title
  @title
end

Class Method Details

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
 
# 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

.swagger_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/talon_one/models/new_template_def.rb', line 52

def self.swagger_types
  {
    :'title' => :'String',
    :'description' => :'String',
    :'help' => :'String',
    :'category' => :'String',
    :'expr' => :'Array<Object>',
    :'args' => :'Array<TemplateArgDef>',
    :'expose' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/talon_one/models/new_template_def.rb', line 180

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

#_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



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
 
# File 'lib/talon_one/models/new_template_def.rb', line 228

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



294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/talon_one/models/new_template_def.rb', line 294

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



207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
 
# File 'lib/talon_one/models/new_template_def.rb', line 207

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


194
195
196
 
# File 'lib/talon_one/models/new_template_def.rb', line 194

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



200
201
202
 
# File 'lib/talon_one/models/new_template_def.rb', line 200

def hash
  [title, description, help, category, expr, args, expose].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



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

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

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



274
275
276
 
# File 'lib/talon_one/models/new_template_def.rb', line 274

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



280
281
282
283
284
285
286
287
288
 
# File 'lib/talon_one/models/new_template_def.rb', line 280

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



268
269
270
 
# File 'lib/talon_one/models/new_template_def.rb', line 268

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



140
141
142
143
144
145
146
147
148
 
# File 'lib/talon_one/models/new_template_def.rb', line 140

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