Class: BrevoRuby::Body

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Body

Initializes the object



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/brevo-ruby/models/body.rb', line 46

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

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

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

Instance Attribute Details

#attributes ⇒ Object

Attributes for company creation



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

def attributes
  @attributes
end

#country_code ⇒ Object

Country code if phone_number is passed in attributes.



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

def country_code
  @country_code
end

#name ⇒ Object

Name of company



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

def name
  @name
end

Class Method Details

.attribute_map ⇒ Object

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



27
28
29
30
31
32
33
 
# File 'lib/brevo-ruby/models/body.rb', line 27

def self.attribute_map
  {
    :'name' => :'name',
    :'attributes' => :'attributes',
    :'country_code' => :'countryCode'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



36
37
38
39
40
41
42
 
# File 'lib/brevo-ruby/models/body.rb', line 36

def self.swagger_types
  {
    :'name' => :'String',
    :'attributes' => :'Object',
    :'country_code' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



85
86
87
88
89
90
91
 
# File 'lib/brevo-ruby/models/body.rb', line 85

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      name == o.name &&
      attributes == o.attributes &&
      country_code == o.country_code
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type



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
156
157
158
159
160
161
162
163
164
165
 
# File 'lib/brevo-ruby/models/body.rb', line 129

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



195
196
197
198
199
200
201
202
203
204
205
206
207
 
# File 'lib/brevo-ruby/models/body.rb', line 195

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



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/brevo-ruby/models/body.rb', line 108

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

See Also:

  • `==` method


95
96
97
 
# File 'lib/brevo-ruby/models/body.rb', line 95

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.



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

def hash
  [name, attributes, country_code].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?



67
68
69
70
71
72
73
74
 
# File 'lib/brevo-ruby/models/body.rb', line 67

def list_invalid_properties
  invalid_properties = Array.new
  if @name.nil?
    invalid_properties.push('invalid value for "name", name cannot be nil.')
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



175
176
177
 
# File 'lib/brevo-ruby/models/body.rb', line 175

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



181
182
183
184
185
186
187
188
189
 
# File 'lib/brevo-ruby/models/body.rb', line 181

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



169
170
171
 
# File 'lib/brevo-ruby/models/body.rb', line 169

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



78
79
80
81
 
# File 'lib/brevo-ruby/models/body.rb', line 78

def valid?
  return false if @name.nil?
  true
end