Class: OpenapiClient::Message

Inherits:
Object
  • Object
show all
Defined in:
lib/openapi_client/models/message.rb

Direct Known Subclasses

SMS, Viber, WhatsApp

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Message

Initializes the object

Parameters:

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

    Model attributes in the form of hash



50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
 
# File 'lib/openapi_client/models/message.rb', line 50

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

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

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

Instance Attribute Details

#channel ⇒ Object

Returns the value of attribute channel.



17
18
19
 
# File 'lib/openapi_client/models/message.rb', line 17

def channel
  @channel
end

#sender ⇒ Object

Phone number or alphanumeric sender name



20
21
22
 
# File 'lib/openapi_client/models/message.rb', line 20

def sender
  @sender
end

#validity ⇒ Object

After how many minutes this channel is considered as failed and the next channel is attempted



23
24
25
 
# File 'lib/openapi_client/models/message.rb', line 23

def validity
  @validity
end

Class Method Details

.attribute_map ⇒ Object

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



26
27
28
29
30
31
32
 
# File 'lib/openapi_client/models/message.rb', line 26

def self.attribute_map
  {
    :'channel' => :'channel',
    :'sender' => :'sender',
    :'validity' => :'validity'
  }
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



112
113
114
 
# File 'lib/openapi_client/models/message.rb', line 112

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

.openapi_discriminator_name ⇒ Object

discriminator’s property name in OpenAPI v3



44
45
46
 
# File 'lib/openapi_client/models/message.rb', line 44

def self.openapi_discriminator_name
  :'channel'
end

.openapi_types ⇒ Object

Attribute type mapping.



35
36
37
38
39
40
41
 
# File 'lib/openapi_client/models/message.rb', line 35

def self.openapi_types
  {
    :'channel' => :'String',
    :'sender' => :'String',
    :'validity' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



89
90
91
92
93
94
95
 
# File 'lib/openapi_client/models/message.rb', line 89

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      channel == o.channel &&
      sender == o.sender &&
      validity == o.validity
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



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
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/openapi_client/models/message.rb', line 140

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



205
206
207
208
209
210
211
212
213
214
215
216
217
 
# File 'lib/openapi_client/models/message.rb', line 205

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



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/openapi_client/models/message.rb', line 119

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


99
100
101
 
# File 'lib/openapi_client/models/message.rb', line 99

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



105
106
107
 
# File 'lib/openapi_client/models/message.rb', line 105

def hash
  [channel, sender, validity].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



71
72
73
74
75
76
77
78
 
# File 'lib/openapi_client/models/message.rb', line 71

def list_invalid_properties
  invalid_properties = Array.new
  if @channel.nil?
    invalid_properties.push('invalid value for "channel", channel cannot be nil.')
  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



185
186
187
 
# File 'lib/openapi_client/models/message.rb', line 185

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



191
192
193
194
195
196
197
198
199
 
# File 'lib/openapi_client/models/message.rb', line 191

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



179
180
181
 
# File 'lib/openapi_client/models/message.rb', line 179

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



82
83
84
85
 
# File 'lib/openapi_client/models/message.rb', line 82

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