Class: Bandwidth::TranscribeRecording

Inherits:
ApiModelBase show all
Defined in:
lib/bandwidth-sdk/models/transcribe_recording.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 = {}) ⇒ TranscribeRecording

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
154
155
156
157
 
# File 'lib/bandwidth-sdk/models/transcribe_recording.rb', line 110

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

  if attributes.key?(:'callback_method')
    self.callback_method = attributes[:'callback_method']
  else
    self.callback_method = 'POST'
  end

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

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

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

  if attributes.key?(:'callback_timeout')
    self.callback_timeout = attributes[:'callback_timeout']
  else
    self.callback_timeout = 15
  end

  if attributes.key?(:'detect_language')
    self.detect_language = attributes[:'detect_language']
  else
    self.detect_language = false
  end
end

Instance Attribute Details

#callback_method ⇒ Object

Returns the value of attribute callback_method.



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

def callback_method
  @callback_method
end

#callback_timeout ⇒ Object

This is the timeout (in seconds) to use when delivering the webhook to ‘callbackUrl`. Can be any numeric value (including decimals) between 1 and 25.



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

def callback_timeout
  @callback_timeout
end

#callback_url ⇒ Object

The URL to send the [TranscriptionAvailable](/docs/voice/webhooks/transcriptionAvailable) event to. You should not include sensitive or personally-identifiable information in the callbackUrl field! Always use the proper username and password fields for authorization.



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

def callback_url
  @callback_url
end

#detect_language ⇒ Object

A boolean value to indicate that the recording may not be in English, and the transcription service will need to detect the dominant language the recording is in and transcribe accordingly. Current supported languages are English, French, and Spanish.



36
37
38
 
# File 'lib/bandwidth-sdk/models/transcribe_recording.rb', line 36

def detect_language
  @detect_language
end

#password ⇒ Object

Basic auth password.



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

def password
  @password
end

#tag ⇒ Object

(optional) The tag specified on call creation. If no tag was specified or it was previously cleared, this field will not be present.



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

def tag
  @tag
end

#username ⇒ Object

Basic auth username.



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

def username
  @username
end

Class Method Details

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



74
75
76
 
# File 'lib/bandwidth-sdk/models/transcribe_recording.rb', line 74

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



79
80
81
 
# File 'lib/bandwidth-sdk/models/transcribe_recording.rb', line 79

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
 
# File 'lib/bandwidth-sdk/models/transcribe_recording.rb', line 61

def self.attribute_map
  {
    :'callback_url' => :'callbackUrl',
    :'callback_method' => :'callbackMethod',
    :'username' => :'username',
    :'password' => :'password',
    :'tag' => :'tag',
    :'callback_timeout' => :'callbackTimeout',
    :'detect_language' => :'detectLanguage'
  }
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



257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/bandwidth-sdk/models/transcribe_recording.rb', line 257

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



97
98
99
100
101
102
103
104
105
106
 
# File 'lib/bandwidth-sdk/models/transcribe_recording.rb', line 97

def self.openapi_nullable
  Set.new([
    :'callback_method',
    :'username',
    :'password',
    :'tag',
    :'callback_timeout',
    :'detect_language'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
 
# File 'lib/bandwidth-sdk/models/transcribe_recording.rb', line 84

def self.openapi_types
  {
    :'callback_url' => :'String',
    :'callback_method' => :'CallbackMethodEnum',
    :'username' => :'String',
    :'password' => :'String',
    :'tag' => :'String',
    :'callback_timeout' => :'Float',
    :'detect_language' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



230
231
232
233
234
235
236
237
238
239
240
 
# File 'lib/bandwidth-sdk/models/transcribe_recording.rb', line 230

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      callback_url == o.callback_url &&
      callback_method == o.callback_method &&
      username == o.username &&
      password == o.password &&
      tag == o.tag &&
      callback_timeout == o.callback_timeout &&
      detect_language == o.detect_language
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


244
245
246
 
# File 'lib/bandwidth-sdk/models/transcribe_recording.rb', line 244

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



250
251
252
 
# File 'lib/bandwidth-sdk/models/transcribe_recording.rb', line 250

def hash
  [callback_url, callback_method, username, password, tag, callback_timeout, detect_language].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



161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/bandwidth-sdk/models/transcribe_recording.rb', line 161

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

  if !@password.nil? && @password.to_s.length > 1024
    invalid_properties.push('invalid value for "password", the character length must be smaller than or equal to 1024.')
  end

  if !@callback_timeout.nil? && @callback_timeout > 25
    invalid_properties.push('invalid value for "callback_timeout", must be smaller than or equal to 25.')
  end

  if !@callback_timeout.nil? && @callback_timeout < 1
    invalid_properties.push('invalid value for "callback_timeout", must be greater than or equal to 1.')
  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



279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/bandwidth-sdk/models/transcribe_recording.rb', line 279

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



185
186
187
188
189
190
191
192
 
# File 'lib/bandwidth-sdk/models/transcribe_recording.rb', line 185

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if !@username.nil? && @username.to_s.length > 1024
  return false if !@password.nil? && @password.to_s.length > 1024
  return false if !@callback_timeout.nil? && @callback_timeout > 25
  return false if !@callback_timeout.nil? && @callback_timeout < 1
  true
end