Class: BrevoRuby::GetWhatsAppConfig

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ GetWhatsAppConfig

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
111
112
 
# File 'lib/brevo-ruby/models/get_whats_app_config.rb', line 83

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

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

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

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

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

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

Instance Attribute Details

#business_status ⇒ Object

Verification status information of the Business account



30
31
32
 
# File 'lib/brevo-ruby/models/get_whats_app_config.rb', line 30

def business_status
  @business_status
end

#phone_number_name_status ⇒ Object

Status of the name associated with WhatsApp Phone number



33
34
35
 
# File 'lib/brevo-ruby/models/get_whats_app_config.rb', line 33

def phone_number_name_status
  @phone_number_name_status
end

#phone_number_quality ⇒ Object

Quality status of phone number associated with WhatsApp account. There are three quality ratings. example - **High (GREEN) , Medium (YELLOW) and Low(RED)**



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

def phone_number_quality
  @phone_number_quality
end

#sending_limit ⇒ Object

Sending limit Information of the WhatsApp API account



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

def sending_limit
  @sending_limit
end

#whatsapp_business_account_id ⇒ Object

Id of the WhatsApp business account



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

def 
  @whatsapp_business_account_id
end

#whatsapp_business_account_status ⇒ Object

Status information related to WhatsApp Api account



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

def 
  @whatsapp_business_account_status
end

Class Method Details

.attribute_map ⇒ Object

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



58
59
60
61
62
63
64
65
66
67
 
# File 'lib/brevo-ruby/models/get_whats_app_config.rb', line 58

def self.attribute_map
  {
    :'whatsapp_business_account_id' => :'whatsappBusinessAccountId',
    :'sending_limit' => :'sendingLimit',
    :'phone_number_quality' => :'phoneNumberQuality',
    :'whatsapp_business_account_status' => :'whatsappBusinessAccountStatus',
    :'business_status' => :'businessStatus',
    :'phone_number_name_status' => :'phoneNumberNameStatus'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
 
# File 'lib/brevo-ruby/models/get_whats_app_config.rb', line 70

def self.swagger_types
  {
    :'whatsapp_business_account_id' => :'String',
    :'sending_limit' => :'String',
    :'phone_number_quality' => :'String',
    :'whatsapp_business_account_status' => :'String',
    :'business_status' => :'String',
    :'phone_number_name_status' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



153
154
155
156
157
158
159
160
161
162
 
# File 'lib/brevo-ruby/models/get_whats_app_config.rb', line 153

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      sending_limit == o.sending_limit &&
      phone_number_quality == o.phone_number_quality &&
       == o. &&
      business_status == o.business_status &&
      phone_number_name_status == o.phone_number_name_status
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



200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/brevo-ruby/models/get_whats_app_config.rb', line 200

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



266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/brevo-ruby/models/get_whats_app_config.rb', line 266

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



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
 
# File 'lib/brevo-ruby/models/get_whats_app_config.rb', line 179

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


166
167
168
 
# File 'lib/brevo-ruby/models/get_whats_app_config.rb', line 166

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



172
173
174
 
# File 'lib/brevo-ruby/models/get_whats_app_config.rb', line 172

def hash
  [, sending_limit, phone_number_quality, , business_status, phone_number_name_status].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



116
117
118
119
 
# File 'lib/brevo-ruby/models/get_whats_app_config.rb', line 116

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



246
247
248
 
# File 'lib/brevo-ruby/models/get_whats_app_config.rb', line 246

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



252
253
254
255
256
257
258
259
260
 
# File 'lib/brevo-ruby/models/get_whats_app_config.rb', line 252

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



240
241
242
 
# File 'lib/brevo-ruby/models/get_whats_app_config.rb', line 240

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



123
124
125
126
127
128
129
 
# File 'lib/brevo-ruby/models/get_whats_app_config.rb', line 123

def valid?
  phone_number_quality_validator = EnumAttributeValidator.new('String', ['GREEN', 'YELLOW', 'RED'])
  return false unless phone_number_quality_validator.valid?(@phone_number_quality)
  phone_number_name_status_validator = EnumAttributeValidator.new('String', ['APPROVED', 'PENDING', 'REJECTED'])
  return false unless phone_number_name_status_validator.valid?(@phone_number_name_status)
  true
end