Class: EjabberdHttpClient::OauthApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ejabberd_http_client/api/oauth_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ OauthApi

Returns a new instance of OauthApi.



19
20
21
 
# File 'lib/ejabberd_http_client/api/oauth_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/ejabberd_http_client/api/oauth_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_o_auth_client_implicit(add_o_auth_client_implicit_request, opts = {}) ⇒ nil

Add OAUTH client_id with implicit grant type.

Parameters:

Returns:

  • (nil) 


26
27
28
29
 
# File 'lib/ejabberd_http_client/api/oauth_api.rb', line 26

def add_o_auth_client_implicit(add_o_auth_client_implicit_request, opts = {})
  add_o_auth_client_implicit_with_http_info(add_o_auth_client_implicit_request, opts)
  nil
end

#add_o_auth_client_implicit_with_http_info(add_o_auth_client_implicit_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Add OAUTH client_id with implicit grant type.

Parameters:

Returns:

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

    nil, response status code and response headers



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
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
 
# File 'lib/ejabberd_http_client/api/oauth_api.rb', line 35

def add_o_auth_client_implicit_with_http_info(add_o_auth_client_implicit_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OauthApi.add_o_auth_client_implicit ...'
  end
  # verify the required parameter 'add_o_auth_client_implicit_request' is set
  if @api_client.config.client_side_validation && add_o_auth_client_implicit_request.nil?
    fail ArgumentError, "Missing the required parameter 'add_o_auth_client_implicit_request' when calling OauthApi.add_o_auth_client_implicit"
  end
  # resource path
  local_var_path = '/api/oauth_add_client_implicit'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(add_o_auth_client_implicit_request)

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"OauthApi.add_o_auth_client_implicit",
    :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: OauthApi#add_o_auth_client_implicit\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#add_o_auth_client_password(add_o_auth_client_password_request, opts = {}) ⇒ nil

Add OAUTH client_id with password grant type.

Parameters:

Returns:

  • (nil) 


90
91
92
93
 
# File 'lib/ejabberd_http_client/api/oauth_api.rb', line 90

def add_o_auth_client_password(add_o_auth_client_password_request, opts = {})
  add_o_auth_client_password_with_http_info(add_o_auth_client_password_request, opts)
  nil
end

#add_o_auth_client_password_with_http_info(add_o_auth_client_password_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Add OAUTH client_id with password grant type.

Parameters:

Returns:

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

    nil, response status code and response headers



99
100
101
102
103
104
105
106
107
108
109
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
 
# File 'lib/ejabberd_http_client/api/oauth_api.rb', line 99

def add_o_auth_client_password_with_http_info(add_o_auth_client_password_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OauthApi.add_o_auth_client_password ...'
  end
  # verify the required parameter 'add_o_auth_client_password_request' is set
  if @api_client.config.client_side_validation && add_o_auth_client_password_request.nil?
    fail ArgumentError, "Missing the required parameter 'add_o_auth_client_password_request' when calling OauthApi.add_o_auth_client_password"
  end
  # resource path
  local_var_path = '/api/oauth_add_client_password'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(add_o_auth_client_password_request)

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"OauthApi.add_o_auth_client_password",
    :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: OauthApi#add_o_auth_client_password\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#issue_o_auth_token(issue_o_auth_token_request, opts = {}) ⇒ IssueOAuthToken200Response

Issue an oauth token for the given jid.

Parameters:

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

    the optional parameters

Returns:



154
155
156
157
 
# File 'lib/ejabberd_http_client/api/oauth_api.rb', line 154

def issue_o_auth_token(issue_o_auth_token_request, opts = {})
  data, _status_code, _headers = issue_o_auth_token_with_http_info(issue_o_auth_token_request, opts)
  data
end

#issue_o_auth_token_with_http_info(issue_o_auth_token_request, opts = {}) ⇒ Array<(IssueOAuthToken200Response, Integer, Hash)>

Issue an oauth token for the given jid.

Parameters:

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

    the optional parameters

Returns:

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

    IssueOAuthToken200Response data, response status code and response headers



163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
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
 
# File 'lib/ejabberd_http_client/api/oauth_api.rb', line 163

def issue_o_auth_token_with_http_info(issue_o_auth_token_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OauthApi.issue_o_auth_token ...'
  end
  # verify the required parameter 'issue_o_auth_token_request' is set
  if @api_client.config.client_side_validation && issue_o_auth_token_request.nil?
    fail ArgumentError, "Missing the required parameter 'issue_o_auth_token_request' when calling OauthApi.issue_o_auth_token"
  end
  # resource path
  local_var_path = '/api/oauth_issue_token'

  # 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'])
  # 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(issue_o_auth_token_request)

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

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

  new_options = opts.merge(
    :operation => :"OauthApi.issue_o_auth_token",
    :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: OauthApi#issue_o_auth_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_o_auth_tokens(opts = {}) ⇒ Array<ListOAuthTokens200ResponseInner>

List OAuth tokens, their users and scopes, and their time until expiration.

Parameters:

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

    the optional parameters

Returns:



219
220
221
222
 
# File 'lib/ejabberd_http_client/api/oauth_api.rb', line 219

def list_o_auth_tokens(opts = {})
  data, _status_code, _headers = list_o_auth_tokens_with_http_info(opts)
  data
end

#list_o_auth_tokens_with_http_info(opts = {}) ⇒ Array<(Array<ListOAuthTokens200ResponseInner>, Integer, Hash)>

List OAuth tokens, their users and scopes, and their time until expiration.

Parameters:

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

    the optional parameters

Returns:

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

    Array<ListOAuthTokens200ResponseInner> data, response status code and response headers



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
 
# File 'lib/ejabberd_http_client/api/oauth_api.rb', line 227

def list_o_auth_tokens_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OauthApi.list_o_auth_tokens ...'
  end
  # resource path
  local_var_path = '/api/oauth_list_tokens'

  # 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'])

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

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<ListOAuthTokens200ResponseInner>'

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

  new_options = opts.merge(
    :operation => :"OauthApi.list_o_auth_tokens",
    :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: OauthApi#list_o_auth_tokens\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#remove_o_auth_client(remove_o_auth_client_request, opts = {}) ⇒ nil

Remove an OAuth client_id.

Parameters:

Returns:

  • (nil) 


275
276
277
278
 
# File 'lib/ejabberd_http_client/api/oauth_api.rb', line 275

def remove_o_auth_client(remove_o_auth_client_request, opts = {})
  remove_o_auth_client_with_http_info(remove_o_auth_client_request, opts)
  nil
end

#remove_o_auth_client_with_http_info(remove_o_auth_client_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Remove an OAuth client_id.

Parameters:

Returns:

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

    nil, response status code and response headers



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
 
# File 'lib/ejabberd_http_client/api/oauth_api.rb', line 284

def remove_o_auth_client_with_http_info(remove_o_auth_client_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OauthApi.remove_o_auth_client ...'
  end
  # verify the required parameter 'remove_o_auth_client_request' is set
  if @api_client.config.client_side_validation && remove_o_auth_client_request.nil?
    fail ArgumentError, "Missing the required parameter 'remove_o_auth_client_request' when calling OauthApi.remove_o_auth_client"
  end
  # resource path
  local_var_path = '/api/oauth_remove_client'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(remove_o_auth_client_request)

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"OauthApi.remove_o_auth_client",
    :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: OauthApi#remove_o_auth_client\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#revoke_o_auth_token(revoke_o_auth_token_request, opts = {}) ⇒ nil

Revoke an existing OAuth token.

Parameters:

Returns:

  • (nil) 


339
340
341
342
 
# File 'lib/ejabberd_http_client/api/oauth_api.rb', line 339

def revoke_o_auth_token(revoke_o_auth_token_request, opts = {})
  revoke_o_auth_token_with_http_info(revoke_o_auth_token_request, opts)
  nil
end

#revoke_o_auth_token_with_http_info(revoke_o_auth_token_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Revoke an existing OAuth token.

Parameters:

Returns:

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

    nil, response status code and response headers



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/ejabberd_http_client/api/oauth_api.rb', line 348

def revoke_o_auth_token_with_http_info(revoke_o_auth_token_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: OauthApi.revoke_o_auth_token ...'
  end
  # verify the required parameter 'revoke_o_auth_token_request' is set
  if @api_client.config.client_side_validation && revoke_o_auth_token_request.nil?
    fail ArgumentError, "Missing the required parameter 'revoke_o_auth_token_request' when calling OauthApi.revoke_o_auth_token"
  end
  # resource path
  local_var_path = '/api/oauth_revoke_token'

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

  # header parameters
  header_params = opts[:header_params] || {}
  # 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(revoke_o_auth_token_request)

  # return_type
  return_type = opts[:debug_return_type]

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

  new_options = opts.merge(
    :operation => :"OauthApi.revoke_o_auth_token",
    :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: OauthApi#revoke_o_auth_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end