Class: Bandwidth::TwoFactorAuth::APIController

Inherits:
BaseController show all
Defined in:
lib/bandwidth/two_factor_auth_lib/two_factor_auth/controllers/api_controller.rb

Overview

APIController

Instance Attribute Summary

Attributes inherited from BaseController

#config, #http_call_back

Instance Method Summary collapse

Methods inherited from BaseController

#execute_request, #validate_parameters, #validate_response

Constructor Details

#initialize(config, http_call_back: nil) ⇒ APIController

Returns a new instance of APIController.



10
11
12
 
# File 'lib/bandwidth/two_factor_auth_lib/two_factor_auth/controllers/api_controller.rb', line 10

def initialize(config, http_call_back: nil)
  super(config, http_call_back: http_call_back)
end

Instance Method Details

#create_messaging_two_factor(account_id, body) ⇒ TwoFactorMessagingResponse

Two-Factor authentication with Bandwidth messaging services Messaging service enabled

Parameters:

  • account_id (String) —

    Required parameter: Bandwidth Account ID with

  • body (TwoFactorCodeRequestSchema) —

    Required parameter: Example:

Returns:



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
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/bandwidth/two_factor_auth_lib/two_factor_auth/controllers/api_controller.rb', line 66

def create_messaging_two_factor(,
                                body)
  # Prepare query url.
  _query_builder = config.get_base_uri(Server::TWOFACTORAUTHDEFAULT)
  _query_builder << '/accounts/{accountId}/code/messaging'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'accountId' => { 'value' => , 'encode' => false }
  )
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'accept' => 'application/json',
    'content-type' => 'application/json; charset=utf-8'
  }

  # Prepare and execute HttpRequest.
  _request = config.http_client.post(
    _query_url,
    headers: _headers,
    parameters: body.to_json
  )
  TwoFactorAuthBasicAuth.apply(config, _request)
  _response = execute_request(_request)

  # Validate response against endpoint and global error codes.
  if _response.status_code == 400
    raise InvalidRequestException.new(
      'client request error',
      _response
    )
  end
  validate_response(_response)

  # Return appropriate response type.
  decoded = APIHelper.json_deserialize(_response.raw_body)
  ApiResponse.new(
    _response,
    data: TwoFactorMessagingResponse.from_hash(decoded)
  )
end

#create_verify_two_factor(account_id, body) ⇒ TwoFactorVerifyCodeResponse

Verify a previously sent two-factor authentication code Two-Factor enabled

Parameters:

  • account_id (String) —

    Required parameter: Bandwidth Account ID with

  • body (TwoFactorVerifyRequestSchema) —

    Required parameter: Example:

Returns:



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
 
# File 'lib/bandwidth/two_factor_auth_lib/two_factor_auth/controllers/api_controller.rb', line 114

def create_verify_two_factor(,
                             body)
  # Prepare query url.
  _query_builder = config.get_base_uri(Server::TWOFACTORAUTHDEFAULT)
  _query_builder << '/accounts/{accountId}/code/verify'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'accountId' => { 'value' => , 'encode' => false }
  )
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'accept' => 'application/json',
    'content-type' => 'application/json; charset=utf-8'
  }

  # Prepare and execute HttpRequest.
  _request = config.http_client.post(
    _query_url,
    headers: _headers,
    parameters: body.to_json
  )
  TwoFactorAuthBasicAuth.apply(config, _request)
  _response = execute_request(_request)

  # Validate response against endpoint and global error codes.
  if _response.status_code == 400
    raise InvalidRequestException.new(
      'client request error',
      _response
    )
  end
  validate_response(_response)

  # Return appropriate response type.
  decoded = APIHelper.json_deserialize(_response.raw_body)
  ApiResponse.new(
    _response,
    data: TwoFactorVerifyCodeResponse.from_hash(decoded)
  )
end

#create_voice_two_factor(account_id, body) ⇒ TwoFactorVoiceResponse

Two-Factor authentication with Bandwidth Voice services Voice service enabled

Parameters:

  • account_id (String) —

    Required parameter: Bandwidth Account ID with

  • body (TwoFactorCodeRequestSchema) —

    Required parameter: Example:

Returns:



19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
 
# File 'lib/bandwidth/two_factor_auth_lib/two_factor_auth/controllers/api_controller.rb', line 19

def create_voice_two_factor(,
                            body)
  # Prepare query url.
  _query_builder = config.get_base_uri(Server::TWOFACTORAUTHDEFAULT)
  _query_builder << '/accounts/{accountId}/code/voice'
  _query_builder = APIHelper.append_url_with_template_parameters(
    _query_builder,
    'accountId' => { 'value' => , 'encode' => false }
  )
  _query_url = APIHelper.clean_url _query_builder

  # Prepare headers.
  _headers = {
    'accept' => 'application/json',
    'content-type' => 'application/json; charset=utf-8'
  }

  # Prepare and execute HttpRequest.
  _request = config.http_client.post(
    _query_url,
    headers: _headers,
    parameters: body.to_json
  )
  TwoFactorAuthBasicAuth.apply(config, _request)
  _response = execute_request(_request)

  # Validate response against endpoint and global error codes.
  if _response.status_code == 400
    raise InvalidRequestException.new(
      'client request error',
      _response
    )
  end
  validate_response(_response)

  # Return appropriate response type.
  decoded = APIHelper.json_deserialize(_response.raw_body)
  ApiResponse.new(
    _response, data: TwoFactorVoiceResponse.from_hash(decoded)
  )
end