Class: Bandwidth::VerificationWebhook

Inherits:
Object
  • Object
show all
Defined in:
lib/bandwidth-sdk/models/verification_webhook.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ VerificationWebhook

Initializes the object



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

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, 'The input argument (attributes) must be a hash in `Bandwidth::VerificationWebhook` initialize method'
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!self.class.attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `Bandwidth::VerificationWebhook`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

User’s account ID.



19
20
21
 
# File 'lib/bandwidth-sdk/models/verification_webhook.rb', line 19

def 
  @account_id
end

#internal_ticket_number ⇒ Object

Unique identifier (UUID) generated by Bandwidth to assist in tracking the verification status of a toll-free number.



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

def internal_ticket_number
  @internal_ticket_number
end

#phone_number ⇒ Object

Toll-free telephone number in E.164 format.



22
23
24
 
# File 'lib/bandwidth-sdk/models/verification_webhook.rb', line 22

def phone_number
  @phone_number
end

#status ⇒ Object

Returns the value of attribute status.



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

def status
  @status
end

Class Method Details

._deserialize(type, value) ⇒ Object

Deserializes the data based on type



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/bandwidth-sdk/models/verification_webhook.rb', line 218

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = Bandwidth.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



62
63
64
 
# File 'lib/bandwidth-sdk/models/verification_webhook.rb', line 62

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



52
53
54
55
56
57
58
59
 
# File 'lib/bandwidth-sdk/models/verification_webhook.rb', line 52

def self.attribute_map
  {
    :'account_id' => :'accountId',
    :'phone_number' => :'phoneNumber',
    :'status' => :'status',
    :'internal_ticket_number' => :'internalTicketNumber'
  }
end

.build_from_hash(attributes) ⇒ Object

Builds the object from hash



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/bandwidth-sdk/models/verification_webhook.rb', line 194

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

List of attributes with nullable: true



77
78
79
80
 
# File 'lib/bandwidth-sdk/models/verification_webhook.rb', line 77

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

.openapi_types ⇒ Object

Attribute type mapping.



67
68
69
70
71
72
73
74
 
# File 'lib/bandwidth-sdk/models/verification_webhook.rb', line 67

def self.openapi_types
  {
    :'account_id' => :'String',
    :'phone_number' => :'String',
    :'status' => :'TfvCallbackStatusEnum',
    :'internal_ticket_number' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.



170
171
172
173
174
175
176
177
 
# File 'lib/bandwidth-sdk/models/verification_webhook.rb', line 170

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      phone_number == o.phone_number &&
      status == o.status &&
      internal_ticket_number == o.internal_ticket_number
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value



289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/bandwidth-sdk/models/verification_webhook.rb', line 289

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

#eql?(o) ⇒ Boolean

See Also:

  • `==` method


181
182
183
 
# File 'lib/bandwidth-sdk/models/verification_webhook.rb', line 181

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.



187
188
189
 
# File 'lib/bandwidth-sdk/models/verification_webhook.rb', line 187

def hash
  [, phone_number, status, internal_ticket_number].hash
end

#list_invalid_properties ⇒ Object

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



116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
 
# File 'lib/bandwidth-sdk/models/verification_webhook.rb', line 116

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if !@phone_number.nil? && @phone_number.to_s.length > 12
    invalid_properties.push('invalid value for "phone_number", the character length must be smaller than or equal to 12.')
  end

  if !@phone_number.nil? && @phone_number.to_s.length < 12
    invalid_properties.push('invalid value for "phone_number", the character length must be great than or equal to 12.')
  end

  pattern = Regexp.new(/^\+1(800|833|844|855|866|877|888)[2-9]\d{6}$/)
  if !@phone_number.nil? && @phone_number !~ pattern
    invalid_properties.push("invalid value for \"phone_number\", must conform to the pattern #{pattern}.")
  end

  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)



265
266
267
 
# File 'lib/bandwidth-sdk/models/verification_webhook.rb', line 265

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash



271
272
273
274
275
276
277
278
279
280
281
282
283
 
# File 'lib/bandwidth-sdk/models/verification_webhook.rb', line 271

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

#to_s ⇒ String

Returns the string representation of the object



259
260
261
 
# File 'lib/bandwidth-sdk/models/verification_webhook.rb', line 259

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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



137
138
139
140
141
142
143
 
# File 'lib/bandwidth-sdk/models/verification_webhook.rb', line 137

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@phone_number.nil? && @phone_number.to_s.length > 12
  return false if !@phone_number.nil? && @phone_number.to_s.length < 12
  return false if !@phone_number.nil? && @phone_number !~ Regexp.new(/^\+1(800|833|844|855|866|877|888)[2-9]\d{6}$/)
  true
end