Class: TalonOne::TemplateDef

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TemplateDef

Initializes the object

Parameters:

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

    Model attributes in the form of hash



93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
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
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/talon_one/models/template_def.rb', line 93

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

  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

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

Instance Attribute Details

#application_id ⇒ Object

The ID of the application that owns this entity.



25
26
27
 
# File 'lib/talon_one/models/template_def.rb', line 25

def application_id
  @application_id
end

#args ⇒ Object

An array of argument definitions.



43
44
45
 
# File 'lib/talon_one/models/template_def.rb', line 43

def args
  @args
end

#category ⇒ Object

Used for grouping templates in the rule editor sidebar.



37
38
39
 
# File 'lib/talon_one/models/template_def.rb', line 37

def category
  @category
end

#created ⇒ Object

The time this entity was created.



22
23
24
 
# File 'lib/talon_one/models/template_def.rb', line 22

def created
  @created
end

#description ⇒ Object

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



31
32
33
 
# File 'lib/talon_one/models/template_def.rb', line 31

def description
  @description
end

#expose ⇒ Object

A flag to control exposure in Rule Builder.



46
47
48
 
# File 'lib/talon_one/models/template_def.rb', line 46

def expose
  @expose
end

#expr ⇒ Object

A Talang expression that contains variable bindings referring to args.



40
41
42
 
# File 'lib/talon_one/models/template_def.rb', line 40

def expr
  @expr
end

#help ⇒ Object

Extended help text for the template.



34
35
36
 
# File 'lib/talon_one/models/template_def.rb', line 34

def help
  @help
end

#id ⇒ Object

Internal ID of this entity.



19
20
21
 
# File 'lib/talon_one/models/template_def.rb', line 19

def id
  @id
end

#name ⇒ Object

The template name used in Talang.



49
50
51
 
# File 'lib/talon_one/models/template_def.rb', line 49

def name
  @name
end

#title ⇒ Object

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



28
29
30
 
# File 'lib/talon_one/models/template_def.rb', line 28

def title
  @title
end

Class Method Details

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/talon_one/models/template_def.rb', line 52

def self.attribute_map
  {
    :'id' => :'id',
    :'created' => :'created',
    :'application_id' => :'applicationId',
    :'title' => :'title',
    :'description' => :'description',
    :'help' => :'help',
    :'category' => :'category',
    :'expr' => :'expr',
    :'args' => :'args',
    :'expose' => :'expose',
    :'name' => :'name'
  }
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



310
311
312
 
# File 'lib/talon_one/models/template_def.rb', line 310

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



86
87
88
89
 
# File 'lib/talon_one/models/template_def.rb', line 86

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

.openapi_types ⇒ Object

Attribute type mapping.



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/talon_one/models/template_def.rb', line 69

def self.openapi_types
  {
    :'id' => :'Integer',
    :'created' => :'DateTime',
    :'application_id' => :'Integer',
    :'title' => :'String',
    :'description' => :'String',
    :'help' => :'String',
    :'category' => :'String',
    :'expr' => :'Array<Object>',
    :'args' => :'Array<TemplateArgDef>',
    :'expose' => :'Boolean',
    :'name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
 
# File 'lib/talon_one/models/template_def.rb', line 279

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      created == o.created &&
      application_id == o.application_id &&
      title == o.title &&
      description == o.description &&
      help == o.help &&
      category == o.category &&
      expr == o.expr &&
      args == o.args &&
      expose == o.expose &&
      name == o.name
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



338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/talon_one/models/template_def.rb', line 338

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

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



407
408
409
410
411
412
413
414
415
416
417
418
419
 
# File 'lib/talon_one/models/template_def.rb', line 407

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



317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
 
# File 'lib/talon_one/models/template_def.rb', line 317

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


297
298
299
 
# File 'lib/talon_one/models/template_def.rb', line 297

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



303
304
305
 
# File 'lib/talon_one/models/template_def.rb', line 303

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



159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
 
# File 'lib/talon_one/models/template_def.rb', line 159

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_id.nil?
    invalid_properties.push('invalid value for "application_id", application_id 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 @description.nil?
    invalid_properties.push('invalid value for "description", description cannot be nil.')
  end

  if @help.nil?
    invalid_properties.push('invalid value for "help", help cannot be nil.')
  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

  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

  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



383
384
385
 
# File 'lib/talon_one/models/template_def.rb', line 383

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



389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/talon_one/models/template_def.rb', line 389

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



377
378
379
 
# File 'lib/talon_one/models/template_def.rb', line 377

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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/talon_one/models/template_def.rb', line 218

def valid?
  return false if @id.nil?
  return false if @created.nil?
  return false if @application_id.nil?
  return false if @title.nil?
  return false if @title.to_s.length < 1
  return false if @description.nil?
  return false if @help.nil?
  return false if @category.nil?
  return false if @category.to_s.length < 1
  return false if @expr.nil?
  return false if @args.nil?
  return false if @name.nil?
  return false if @name.to_s.length < 1
  true
end