Class: TalonOne::CatalogRule

Inherits:
ApiModelBase show all
Defined in:
lib/talon_one_sdk/models/catalog_rule.rb

Overview

A rule template stored in a catalog entry. Rules in catalog entries only contain title (no description, as description is at the catalog entry level).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from ApiModelBase

_deserialize, #_to_hash, #to_body, #to_s

Constructor Details

#initialize(attributes = {}) ⇒ CatalogRule

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
106
107
108
109
110
 
# File 'lib/talon_one_sdk/models/catalog_rule.rb', line 69

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `TalonOne::CatalogRule` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `TalonOne::CatalogRule`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'title')
    self.title = attributes[:'title']
  else
    self.title = nil
  end

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

  if attributes.key?(:'condition')
    if (value = attributes[:'condition']).is_a?(Array)
      self.condition = value
    end
  else
    self.condition = nil
  end

  if attributes.key?(:'effects')
    if (value = attributes[:'effects']).is_a?(Array)
      self.effects = value
    end
  else
    self.effects = nil
  end
end

Instance Attribute Details

#bindings ⇒ Object

An array that provides objects with variable names (name) and talang expressions to whose result they are bound (expression) during rule evaluation. The order of the evaluation is decided by the position in the array.



23
24
25
 
# File 'lib/talon_one_sdk/models/catalog_rule.rb', line 23

def bindings
  @bindings
end

#condition ⇒ Object

A Talang expression that will be evaluated in the context of the given event.



26
27
28
 
# File 'lib/talon_one_sdk/models/catalog_rule.rb', line 26

def condition
  @condition
end

#effects ⇒ Object

An array of effectful Talang expressions in arrays that will be evaluated when a rule matches.



29
30
31
 
# File 'lib/talon_one_sdk/models/catalog_rule.rb', line 29

def effects
  @effects
end

#title ⇒ Object

A short description of the rule.



20
21
22
 
# File 'lib/talon_one_sdk/models/catalog_rule.rb', line 20

def title
  @title
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



42
43
44
 
# File 'lib/talon_one_sdk/models/catalog_rule.rb', line 42

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



47
48
49
 
# File 'lib/talon_one_sdk/models/catalog_rule.rb', line 47

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



32
33
34
35
36
37
38
39
 
# File 'lib/talon_one_sdk/models/catalog_rule.rb', line 32

def self.attribute_map
  {
    :'title' => :'title',
    :'bindings' => :'bindings',
    :'condition' => :'condition',
    :'effects' => :'effects'
  }
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
223
224
225
 
# File 'lib/talon_one_sdk/models/catalog_rule.rb', line 207

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



62
63
64
65
 
# File 'lib/talon_one_sdk/models/catalog_rule.rb', line 62

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

.openapi_types ⇒ Object

Attribute type mapping.



52
53
54
55
56
57
58
59
 
# File 'lib/talon_one_sdk/models/catalog_rule.rb', line 52

def self.openapi_types
  {
    :'title' => :'String',
    :'bindings' => :'Array<Binding>',
    :'condition' => :'Array<Object>',
    :'effects' => :'Array<Object>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



183
184
185
186
187
188
189
190
 
# File 'lib/talon_one_sdk/models/catalog_rule.rb', line 183

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      title == o.title &&
      bindings == o.bindings &&
      condition == o.condition &&
      effects == o.effects
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


194
195
196
 
# File 'lib/talon_one_sdk/models/catalog_rule.rb', line 194

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



200
201
202
 
# File 'lib/talon_one_sdk/models/catalog_rule.rb', line 200

def hash
  [title, bindings, condition, effects].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



114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/talon_one_sdk/models/catalog_rule.rb', line 114

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @title.nil?
    invalid_properties.push('invalid value for "title", title cannot be nil.')
  end

  if @condition.nil?
    invalid_properties.push('invalid value for "condition", condition cannot be nil.')
  end

  if @condition.length < 1
    invalid_properties.push('invalid value for "condition", number of items must be greater than or equal to 1.')
  end

  if @effects.nil?
    invalid_properties.push('invalid value for "effects", effects cannot be nil.')
  end

  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



229
230
231
232
233
234
235
236
237
238
239
240
241
 
# File 'lib/talon_one_sdk/models/catalog_rule.rb', line 229

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

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



138
139
140
141
142
143
144
145
 
# File 'lib/talon_one_sdk/models/catalog_rule.rb', line 138

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @title.nil?
  return false if @condition.nil?
  return false if @condition.length < 1
  return false if @effects.nil?
  true
end