Class: Bandwidth::RbmActionViewLocation

Inherits:
ApiModelBase show all
Defined in:
lib/bandwidth-sdk/models/rbm_action_view_location.rb

Defined Under Namespace

Classes: EnumAttributeValidator

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 = {}) ⇒ RbmActionViewLocation

Initializes the object

Parameters:

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

    Model attributes in the form of hash



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
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
 
# File 'lib/bandwidth-sdk/models/rbm_action_view_location.rb', line 106

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, 'The input argument (attributes) must be a hash in `Bandwidth::RbmActionViewLocation` 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 `Bandwidth::RbmActionViewLocation`. 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?(:'type')
    self.type = attributes[:'type']
  else
    self.type = nil
  end

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

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

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

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

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

Instance Attribute Details

#label ⇒ Object

The label of the location.



33
34
35
 
# File 'lib/bandwidth-sdk/models/rbm_action_view_location.rb', line 33

def label
  @label
end

#latitude ⇒ Object

The latitude of the location.



27
28
29
 
# File 'lib/bandwidth-sdk/models/rbm_action_view_location.rb', line 27

def latitude
  @latitude
end

#longitude ⇒ Object

The longitude of the location.



30
31
32
 
# File 'lib/bandwidth-sdk/models/rbm_action_view_location.rb', line 30

def longitude
  @longitude
end

#postback_data ⇒ Object

Base64 payload the customer receives when the reply is clicked.



24
25
26
 
# File 'lib/bandwidth-sdk/models/rbm_action_view_location.rb', line 24

def postback_data
  @postback_data
end

#text ⇒ Object

Displayed text for user to click



21
22
23
 
# File 'lib/bandwidth-sdk/models/rbm_action_view_location.rb', line 21

def text
  @text
end

#type ⇒ Object

Returns the value of attribute type.



18
19
20
 
# File 'lib/bandwidth-sdk/models/rbm_action_view_location.rb', line 18

def type
  @type
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



70
71
72
 
# File 'lib/bandwidth-sdk/models/rbm_action_view_location.rb', line 70

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



75
76
77
 
# File 'lib/bandwidth-sdk/models/rbm_action_view_location.rb', line 75

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.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/bandwidth-sdk/models/rbm_action_view_location.rb', line 58

def self.attribute_map
  {
    :'type' => :'type',
    :'text' => :'text',
    :'postback_data' => :'postbackData',
    :'latitude' => :'latitude',
    :'longitude' => :'longitude',
    :'label' => :'label'
  }
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



310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
 
# File 'lib/bandwidth-sdk/models/rbm_action_view_location.rb', line 310

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_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



98
99
100
101
102
 
# File 'lib/bandwidth-sdk/models/rbm_action_view_location.rb', line 98

def self.openapi_all_of
  [
  :'RbmActionBase'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



92
93
94
95
 
# File 'lib/bandwidth-sdk/models/rbm_action_view_location.rb', line 92

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

.openapi_types ⇒ Object

Attribute type mapping.



80
81
82
83
84
85
86
87
88
89
 
# File 'lib/bandwidth-sdk/models/rbm_action_view_location.rb', line 80

def self.openapi_types
  {
    :'type' => :'RbmActionTypeEnum',
    :'text' => :'String',
    :'postback_data' => :'String',
    :'latitude' => :'Float',
    :'longitude' => :'Float',
    :'label' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



284
285
286
287
288
289
290
291
292
293
 
# File 'lib/bandwidth-sdk/models/rbm_action_view_location.rb', line 284

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      type == o.type &&
      text == o.text &&
      postback_data == o.postback_data &&
      latitude == o.latitude &&
      longitude == o.longitude &&
      label == o.label
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


297
298
299
 
# File 'lib/bandwidth-sdk/models/rbm_action_view_location.rb', line 297

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



303
304
305
 
# File 'lib/bandwidth-sdk/models/rbm_action_view_location.rb', line 303

def hash
  [type, text, postback_data, latitude, longitude, label].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



157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/bandwidth-sdk/models/rbm_action_view_location.rb', line 157

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

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

  if @text.to_s.length > 25
    invalid_properties.push('invalid value for "text", the character length must be smaller than or equal to 25.')
  end

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

  if @postback_data.to_s.length > 2048
    invalid_properties.push('invalid value for "postback_data", the character length must be smaller than or equal to 2048.')
  end

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

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

  if !@label.nil? && @label.to_s.length > 100
    invalid_properties.push('invalid value for "label", the character length must be smaller than or equal to 100.')
  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



332
333
334
335
336
337
338
339
340
341
342
343
344
 
# File 'lib/bandwidth-sdk/models/rbm_action_view_location.rb', line 332

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



197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/bandwidth-sdk/models/rbm_action_view_location.rb', line 197

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @type.nil?
  return false if @text.nil?
  return false if @text.to_s.length > 25
  return false if @postback_data.nil?
  return false if @postback_data.to_s.length > 2048
  return false if @latitude.nil?
  return false if @longitude.nil?
  return false if !@label.nil? && @label.to_s.length > 100
  true
end