Class: Bandwidth::StirShaken

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

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

Initializes the object

Parameters:

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

    Model attributes in the form of hash



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
 
# File 'lib/bandwidth-sdk/models/stir_shaken.rb', line 63

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

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

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

Instance Attribute Details

#attestation_indicator ⇒ Object

(optional) The attestation level verified by Bandwidth. Possible values are A (full), B (partial) or C (gateway).



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

def attestation_indicator
  @attestation_indicator
end

#originating_id ⇒ Object

(optional) A unique origination identifier.



25
26
27
 
# File 'lib/bandwidth-sdk/models/stir_shaken.rb', line 25

def originating_id
  @originating_id
end

#verstat ⇒ Object

(optional) The verification status indicating whether the verification was successful or not. Possible values are TN-Validation-Passed and TN-Validation-Failed.



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

def verstat
  @verstat
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



37
38
39
 
# File 'lib/bandwidth-sdk/models/stir_shaken.rb', line 37

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



42
43
44
 
# File 'lib/bandwidth-sdk/models/stir_shaken.rb', line 42

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



28
29
30
31
32
33
34
 
# File 'lib/bandwidth-sdk/models/stir_shaken.rb', line 28

def self.attribute_map
  {
    :'verstat' => :'verstat',
    :'attestation_indicator' => :'attestationIndicator',
    :'originating_id' => :'originatingId'
  }
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



130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/bandwidth-sdk/models/stir_shaken.rb', line 130

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



56
57
58
59
 
# File 'lib/bandwidth-sdk/models/stir_shaken.rb', line 56

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

.openapi_types ⇒ Object

Attribute type mapping.



47
48
49
50
51
52
53
 
# File 'lib/bandwidth-sdk/models/stir_shaken.rb', line 47

def self.openapi_types
  {
    :'verstat' => :'String',
    :'attestation_indicator' => :'String',
    :'originating_id' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



107
108
109
110
111
112
113
 
# File 'lib/bandwidth-sdk/models/stir_shaken.rb', line 107

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      verstat == o.verstat &&
      attestation_indicator == o.attestation_indicator &&
      originating_id == o.originating_id
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


117
118
119
 
# File 'lib/bandwidth-sdk/models/stir_shaken.rb', line 117

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



123
124
125
 
# File 'lib/bandwidth-sdk/models/stir_shaken.rb', line 123

def hash
  [verstat, attestation_indicator, originating_id].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



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

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  invalid_properties
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



152
153
154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/bandwidth-sdk/models/stir_shaken.rb', line 152

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



100
101
102
103
 
# File 'lib/bandwidth-sdk/models/stir_shaken.rb', line 100

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end