Class: Bandwidth::MFAApi

Inherits:
Object
  • Object
show all
Defined in:
lib/bandwidth-sdk/api/mfa_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MFAApi

Returns a new instance of MFAApi.

[View source]

19
20
21
 
# File 'lib/bandwidth-sdk/api/mfa_api.rb', line 19

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.


17
18
19
 
# File 'lib/bandwidth-sdk/api/mfa_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#generate_messaging_code(account_id, code_request, opts = {}) ⇒ MessagingCodeResponse

Messaging Authentication Code Send an MFA code via text message (SMS).

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • code_request (CodeRequest) —

    MFA code request body.

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

    the optional parameters

Returns:

[View source]

28
29
30
31
 
# File 'lib/bandwidth-sdk/api/mfa_api.rb', line 28

def generate_messaging_code(, code_request, opts = {})
  data, _status_code, _headers = generate_messaging_code_with_http_info(, code_request, opts)
  data
end

#generate_messaging_code_with_http_info(account_id, code_request, opts = {}) ⇒ Array<(MessagingCodeResponse, Integer, Hash)>

Messaging Authentication Code Send an MFA code via text message (SMS).

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • code_request (CodeRequest) —

    MFA code request body.

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

    the optional parameters

Returns:

  • (Array<(MessagingCodeResponse, Integer, Hash)>) —

    MessagingCodeResponse data, response status code and response headers

[View source]

39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
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
89
90
91
92
93
94
 
# File 'lib/bandwidth-sdk/api/mfa_api.rb', line 39

def generate_messaging_code_with_http_info(, code_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MFAApi.generate_messaging_code ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling MFAApi.generate_messaging_code"
  end
  # verify the required parameter 'code_request' is set
  if @api_client.config.client_side_validation && code_request.nil?
    fail ArgumentError, "Missing the required parameter 'code_request' when calling MFAApi.generate_messaging_code"
  end
  # resource path
  local_var_path = '/accounts/{accountId}/code/messaging'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(code_request)

  # return_type
  return_type = opts[:debug_return_type] || 'MessagingCodeResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic']

  new_options = opts.merge(
    :operation => :"MFAApi.generate_messaging_code",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MFAApi#generate_messaging_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#generate_voice_code(account_id, code_request, opts = {}) ⇒ VoiceCodeResponse

Voice Authentication Code Send an MFA Code via a phone call.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • code_request (CodeRequest) —

    MFA code request body.

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

    the optional parameters

Returns:

[View source]

102
103
104
105
 
# File 'lib/bandwidth-sdk/api/mfa_api.rb', line 102

def generate_voice_code(, code_request, opts = {})
  data, _status_code, _headers = generate_voice_code_with_http_info(, code_request, opts)
  data
end

#generate_voice_code_with_http_info(account_id, code_request, opts = {}) ⇒ Array<(VoiceCodeResponse, Integer, Hash)>

Voice Authentication Code Send an MFA Code via a phone call.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • code_request (CodeRequest) —

    MFA code request body.

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

    the optional parameters

Returns:

  • (Array<(VoiceCodeResponse, Integer, Hash)>) —

    VoiceCodeResponse data, response status code and response headers

[View source]

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
158
159
160
161
162
163
164
165
166
167
168
 
# File 'lib/bandwidth-sdk/api/mfa_api.rb', line 113

def generate_voice_code_with_http_info(, code_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MFAApi.generate_voice_code ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling MFAApi.generate_voice_code"
  end
  # verify the required parameter 'code_request' is set
  if @api_client.config.client_side_validation && code_request.nil?
    fail ArgumentError, "Missing the required parameter 'code_request' when calling MFAApi.generate_voice_code"
  end
  # resource path
  local_var_path = '/accounts/{accountId}/code/voice'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(code_request)

  # return_type
  return_type = opts[:debug_return_type] || 'VoiceCodeResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic']

  new_options = opts.merge(
    :operation => :"MFAApi.generate_voice_code",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MFAApi#generate_voice_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#verify_code(account_id, verify_code_request, opts = {}) ⇒ VerifyCodeResponse

Verify Authentication Code Verify a previously sent MFA code.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • verify_code_request (VerifyCodeRequest) —

    MFA code verify request body.

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

    the optional parameters

Returns:

[View source]

176
177
178
179
 
# File 'lib/bandwidth-sdk/api/mfa_api.rb', line 176

def verify_code(, verify_code_request, opts = {})
  data, _status_code, _headers = verify_code_with_http_info(, verify_code_request, opts)
  data
end

#verify_code_with_http_info(account_id, verify_code_request, opts = {}) ⇒ Array<(VerifyCodeResponse, Integer, Hash)>

Verify Authentication Code Verify a previously sent MFA code.

Parameters:

  • account_id (String) —

    Your Bandwidth Account ID.

  • verify_code_request (VerifyCodeRequest) —

    MFA code verify request body.

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

    the optional parameters

Returns:

  • (Array<(VerifyCodeResponse, Integer, Hash)>) —

    VerifyCodeResponse data, response status code and response headers

[View source]

187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
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
 
# File 'lib/bandwidth-sdk/api/mfa_api.rb', line 187

def verify_code_with_http_info(, verify_code_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MFAApi.verify_code ...'
  end
  # verify the required parameter 'account_id' is set
  if @api_client.config.client_side_validation && .nil?
    fail ArgumentError, "Missing the required parameter 'account_id' when calling MFAApi.verify_code"
  end
  # verify the required parameter 'verify_code_request' is set
  if @api_client.config.client_side_validation && verify_code_request.nil?
    fail ArgumentError, "Missing the required parameter 'verify_code_request' when calling MFAApi.verify_code"
  end
  # resource path
  local_var_path = '/accounts/{accountId}/code/verify'.sub('{' + 'accountId' + '}', CGI.escape(.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json']) unless header_params['Accept']
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
    header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(verify_code_request)

  # return_type
  return_type = opts[:debug_return_type] || 'VerifyCodeResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['Basic']

  new_options = opts.merge(
    :operation => :"MFAApi.verify_code",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: MFAApi#verify_code\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end