Class: BrevoRuby::CreateAttribute

Inherits:
Object
  • Object
show all
Defined in:
lib/brevo-ruby/models/create_attribute.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CreateAttribute

Initializes the object

Parameters:

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

    Model attributes in the form of hash



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/brevo-ruby/models/create_attribute.rb', line 73

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

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

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

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

Instance Attribute Details

#enumeration ⇒ Object

List of values and labels that the attribute can take. Use only if the attribute’s category is "category". For example, ["label":"male", "label":"female"]



24
25
26
 
# File 'lib/brevo-ruby/models/create_attribute.rb', line 24

def enumeration
  @enumeration
end

#is_recurring ⇒ Object

Type of the attribute. Use only if the attribute’s category is ‘calculated’ or ‘global’



21
22
23
 
# File 'lib/brevo-ruby/models/create_attribute.rb', line 21

def is_recurring
  @is_recurring
end

#type ⇒ Object

Type of the attribute. Use only if the attribute’s category is ‘normal’, ‘category’ or ‘transactional’ ( type ‘boolean’ is only available if the category is ‘normal’ attribute, type ‘id’ is only available if the category is ‘transactional’ attribute & type ‘category’ is only available if the category is ‘category’ attribute )



27
28
29
 
# File 'lib/brevo-ruby/models/create_attribute.rb', line 27

def type
  @type
end

#value ⇒ Object

Value of the attribute. Use only if the attribute’s category is ‘calculated’ or ‘global’



18
19
20
 
# File 'lib/brevo-ruby/models/create_attribute.rb', line 18

def value
  @value
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
 
# File 'lib/brevo-ruby/models/create_attribute.rb', line 52

def self.attribute_map
  {
    :'value' => :'value',
    :'is_recurring' => :'isRecurring',
    :'enumeration' => :'enumeration',
    :'type' => :'type'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



62
63
64
65
66
67
68
69
 
# File 'lib/brevo-ruby/models/create_attribute.rb', line 62

def self.swagger_types
  {
    :'value' => :'String',
    :'is_recurring' => :'BOOLEAN',
    :'enumeration' => :'Array<CreateAttributeEnumeration>',
    :'type' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



125
126
127
128
129
130
131
132
 
# File 'lib/brevo-ruby/models/create_attribute.rb', line 125

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      value == o.value &&
      is_recurring == o.is_recurring &&
      enumeration == o.enumeration &&
      type == o.type
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



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
 
# File 'lib/brevo-ruby/models/create_attribute.rb', line 170

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 = BrevoRuby.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



236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/brevo-ruby/models/create_attribute.rb', line 236

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



149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/brevo-ruby/models/create_attribute.rb', line 149

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


136
137
138
 
# File 'lib/brevo-ruby/models/create_attribute.rb', line 136

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



142
143
144
 
# File 'lib/brevo-ruby/models/create_attribute.rb', line 142

def hash
  [value, is_recurring, enumeration, type].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



100
101
102
103
 
# File 'lib/brevo-ruby/models/create_attribute.rb', line 100

def list_invalid_properties
  invalid_properties = Array.new
  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



216
217
218
 
# File 'lib/brevo-ruby/models/create_attribute.rb', line 216

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



222
223
224
225
226
227
228
229
230
 
# File 'lib/brevo-ruby/models/create_attribute.rb', line 222

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



210
211
212
 
# File 'lib/brevo-ruby/models/create_attribute.rb', line 210

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



107
108
109
110
111
 
# File 'lib/brevo-ruby/models/create_attribute.rb', line 107

def valid?
  type_validator = EnumAttributeValidator.new('String', ['text', 'date', 'float', 'boolean', 'id', 'category'])
  return false unless type_validator.valid?(@type)
  true
end