Class: UntitledApi::PortalController

Inherits:
BaseController show all
Defined in:
lib/untitled_api/controllers/portal_controller.rb

Overview

PortalController

Constant Summary

Constants inherited from BaseController

BaseController::GLOBAL_ERRORS

Instance Attribute Summary

Attributes inherited from BaseController

#config, #http_call_back

Instance Method Summary collapse

Methods inherited from BaseController

#initialize, #new_api_call_builder, #new_parameter, #new_request_builder, #new_response_handler, user_agent

Constructor Details

This class inherits a constructor from UntitledApi::BaseController

Instance Method Details

#portal_about_retrieve ⇒ void

This method returns an undefined value.

TODO: type endpoint description here



37
38
39
40
41
42
43
44
45
46
 
# File 'lib/untitled_api/controllers/portal_controller.rb', line 37

def portal_about_retrieve
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/portal/about',
                                 Server::DEFAULT)
               .auth(Or.new('tokenAuth')))
    .response(new_response_handler
               .is_response_void(true))
    .execute
end

#portal_api_v1_self_retrieve ⇒ void

This method returns an undefined value.

Captive Portal API 

"captive": false,
"user-portal-url": "https://example.org/portal.html",
"venue-info-url": "https://flight.example.com/entertainment",
"seconds-remaining": 326,
"can-extend-session": true

@return:

Parameters:

  • request: 


59
60
61
62
63
64
65
66
67
68
 
# File 'lib/untitled_api/controllers/portal_controller.rb', line 59

def portal_api_v1_self_retrieve
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/portal/api/v1/self',
                                 Server::DEFAULT)
               .auth(Or.new('tokenAuth')))
    .response(new_response_handler
               .is_response_void(true))
    .execute
end

#portal_authorize_howto_retrieve ⇒ void

This method returns an undefined value.

TODO: type endpoint description here



85
86
87
88
89
90
91
92
93
94
 
# File 'lib/untitled_api/controllers/portal_controller.rb', line 85

def portal_authorize_howto_retrieve
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/portal/authorize-howto',
                                 Server::DEFAULT)
               .auth(Or.new('tokenAuth')))
    .response(new_response_handler
               .is_response_void(true))
    .execute
end

#portal_authorize_retrieve ⇒ void

This method returns an undefined value.

TODO: type endpoint description here



72
73
74
75
76
77
78
79
80
81
 
# File 'lib/untitled_api/controllers/portal_controller.rb', line 72

def portal_authorize_retrieve
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/portal/authorize',
                                 Server::DEFAULT)
               .auth(Or.new('tokenAuth')))
    .response(new_response_handler
               .is_response_void(true))
    .execute
end

#portal_authorize_test_retrieve ⇒ void

This method returns an undefined value.

TODO: type endpoint description here



98
99
100
101
102
103
104
105
106
107
 
# File 'lib/untitled_api/controllers/portal_controller.rb', line 98

def portal_authorize_test_retrieve
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/portal/authorize-test',
                                 Server::DEFAULT)
               .auth(Or.new('tokenAuth')))
    .response(new_response_handler
               .is_response_void(true))
    .execute
end

#portal_bgimage_retrieve ⇒ void

This method returns an undefined value.

TODO: type endpoint description here



111
112
113
114
115
116
117
118
119
120
 
# File 'lib/untitled_api/controllers/portal_controller.rb', line 111

def portal_bgimage_retrieve
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/portal/bgimage',
                                 Server::DEFAULT)
               .auth(Or.new('tokenAuth')))
    .response(new_response_handler
               .is_response_void(true))
    .execute
end

#portal_create ⇒ void

This method returns an undefined value.

TODO: type endpoint description here



24
25
26
27
28
29
30
31
32
33
 
# File 'lib/untitled_api/controllers/portal_controller.rb', line 24

def portal_create
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/portal/',
                                 Server::DEFAULT)
               .auth(Or.new('tokenAuth')))
    .response(new_response_handler
               .is_response_void(true))
    .execute
end

#portal_error_retrieve ⇒ void

This method returns an undefined value.

TODO: type endpoint description here



124
125
126
127
128
129
130
131
132
133
 
# File 'lib/untitled_api/controllers/portal_controller.rb', line 124

def portal_error_retrieve
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/portal/error',
                                 Server::DEFAULT)
               .auth(Or.new('tokenAuth')))
    .response(new_response_handler
               .is_response_void(true))
    .execute
end

#portal_i18n_retrieve ⇒ PortalI18nResponse1

Get internationalization of UI Labels.

Returns:



137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/untitled_api/controllers/portal_controller.rb', line 137

def portal_i18n_retrieve
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/portal/i18n',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Or.new('tokenAuth')))
    .response(new_response_handler
               .deserializer(APIHelper.method(:custom_type_deserializer))
               .deserialize_into(PortalI18nResponse1.method(:from_hash)))
    .execute
end

#portal_logo_retrieve ⇒ void

This method returns an undefined value.

TODO: type endpoint description here



152
153
154
155
156
157
158
159
160
161
 
# File 'lib/untitled_api/controllers/portal_controller.rb', line 152

def portal_logo_retrieve
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/portal/logo',
                                 Server::DEFAULT)
               .auth(Or.new('tokenAuth')))
    .response(new_response_handler
               .is_response_void(true))
    .execute
end

#portal_logon_create ⇒ void

This method returns an undefined value.

TODO: type endpoint description here



178
179
180
181
182
183
184
185
186
187
 
# File 'lib/untitled_api/controllers/portal_controller.rb', line 178

def portal_logon_create
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/portal/logon',
                                 Server::DEFAULT)
               .auth(Or.new('tokenAuth')))
    .response(new_response_handler
               .is_response_void(true))
    .execute
end

#portal_logon_retrieve ⇒ void

This method returns an undefined value.

TODO: type endpoint description here



165
166
167
168
169
170
171
172
173
174
 
# File 'lib/untitled_api/controllers/portal_controller.rb', line 165

def portal_logon_retrieve
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/portal/logon',
                                 Server::DEFAULT)
               .auth(Or.new('tokenAuth')))
    .response(new_response_handler
               .is_response_void(true))
    .execute
end

#portal_redirect_retrieve ⇒ void

This method returns an undefined value.

TODO: type endpoint description here



191
192
193
194
195
196
197
198
199
200
 
# File 'lib/untitled_api/controllers/portal_controller.rb', line 191

def portal_redirect_retrieve
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/portal/redirect',
                                 Server::DEFAULT)
               .auth(Or.new('tokenAuth')))
    .response(new_response_handler
               .is_response_void(true))
    .execute
end

#portal_retrieve ⇒ void

This method returns an undefined value.

TODO: type endpoint description here



11
12
13
14
15
16
17
18
19
20
 
# File 'lib/untitled_api/controllers/portal_controller.rb', line 11

def portal_retrieve
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/portal/',
                                 Server::DEFAULT)
               .auth(Or.new('tokenAuth')))
    .response(new_response_handler
               .is_response_void(true))
    .execute
end

#portal_saml_login_create(wlan_id) ⇒ void

This method returns an undefined value.

TODO: type endpoint description here

Parameters:

  • wlan_id (String) —

    Required parameter: Example:



205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/untitled_api/controllers/portal_controller.rb', line 205

def (wlan_id)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/portal/saml/{wlan_id}/login',
                                 Server::DEFAULT)
               .template_param(new_parameter(wlan_id, key: 'wlan_id')
                                .should_encode(true)))
    .response(new_response_handler
               .is_response_void(true))
    .execute
end

#portal_social_redirect_retrieve ⇒ void

This method returns an undefined value.

TODO: type endpoint description here



219
220
221
222
223
224
225
226
227
228
 
# File 'lib/untitled_api/controllers/portal_controller.rb', line 219

def portal_social_redirect_retrieve
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/portal/social_redirect',
                                 Server::DEFAULT)
               .auth(Or.new('tokenAuth')))
    .response(new_response_handler
               .is_response_void(true))
    .execute
end

#portal_sponsor_response_retrieve ⇒ void

This method returns an undefined value.

TODO: type endpoint description here



232
233
234
235
236
237
238
239
240
241
 
# File 'lib/untitled_api/controllers/portal_controller.rb', line 232

def portal_sponsor_response_retrieve
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/portal/sponsor-response',
                                 Server::DEFAULT)
               .auth(Or.new('tokenAuth')))
    .response(new_response_handler
               .is_response_void(true))
    .execute
end

#portal_sso_login_create(portal_id) ⇒ void

This method returns an undefined value.

TODO: type endpoint description here

Parameters:

  • portal_id (String) —

    Required parameter: Example:



246
247
248
249
250
251
252
253
254
255
256
 
# File 'lib/untitled_api/controllers/portal_controller.rb', line 246

def (portal_id)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/portal/sso/{portal_id}/login',
                                 Server::DEFAULT)
               .template_param(new_parameter(portal_id, key: 'portal_id')
                                .should_encode(true)))
    .response(new_response_handler
               .is_response_void(true))
    .execute
end

#portal_sso_redirect_retrieve ⇒ void

This method returns an undefined value.

AP redirects users to either

  • /sso_redirect when portal_auth is SSO, where we’d be initiating the

SSO/SAML flow

  • /logon, otherwise

@return:

Parameters:

  • request: 


265
266
267
268
269
270
271
272
273
274
 
# File 'lib/untitled_api/controllers/portal_controller.rb', line 265

def portal_sso_redirect_retrieve
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/portal/sso_redirect',
                                 Server::DEFAULT)
               .auth(Or.new('tokenAuth')))
    .response(new_response_handler
               .is_response_void(true))
    .execute
end

#portal_tos_retrieve ⇒ void

This method returns an undefined value.

TODO: type endpoint description here



278
279
280
281
282
283
284
285
286
287
 
# File 'lib/untitled_api/controllers/portal_controller.rb', line 278

def portal_tos_retrieve
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/portal/tos',
                                 Server::DEFAULT)
               .auth(Or.new('tokenAuth')))
    .response(new_response_handler
               .is_response_void(true))
    .execute
end

#portal_view_sponsor_response_retrieve ⇒ PortalViewSponsorResponseResponse1

TODO: type endpoint description here

Returns:



291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/untitled_api/controllers/portal_controller.rb', line 291

def portal_view_sponsor_response_retrieve
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/portal/view-sponsor-response',
                                 Server::DEFAULT)
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Or.new('tokenAuth')))
    .response(new_response_handler
               .deserializer(APIHelper.method(:custom_type_deserializer))
               .deserialize_into(PortalViewSponsorResponseResponse1.method(:from_hash)))
    .execute
end