Class: Athenian::RegistrationApi

Inherits:
Object
  • Object
show all
Defined in:
lib/athenian/api/registration_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RegistrationApi

Returns a new instance of RegistrationApi.



16
17
18
 
# File 'lib/athenian/api/registration_api.rb', line 16

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



14
15
16
 
# File 'lib/athenian/api/registration_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#accept_invitation(body, opts = {}) ⇒ InvitedUser

👤 Accept the account membership invitation and finish registration. The user must be already authorized in Auth0.

Parameters:

  • body (AcceptedInvitation) —

    Accepted invitation details.

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

    the optional parameters

Returns:



23
24
25
26
 
# File 'lib/athenian/api/registration_api.rb', line 23

def accept_invitation(body, opts = {})
  data, _status_code, _headers = accept_invitation_with_http_info(body, opts)
  data
end

#accept_invitation_with_http_info(body, opts = {}) ⇒ Array<(InvitedUser, Integer, Hash)>

👤 Accept the account membership invitation and finish registration. The user must be already authorized in Auth0.

Parameters:

  • body (AcceptedInvitation) —

    Accepted invitation details.

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

    the optional parameters

Returns:

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

    InvitedUser data, response status code and response headers



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
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/athenian/api/registration_api.rb', line 32

def accept_invitation_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RegistrationApi.accept_invitation ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling RegistrationApi.accept_invitation"
  end
  # resource path
  local_var_path = '/invite/accept'

  # 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(body)

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

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

  new_options = opts.merge(
    :operation => :"RegistrationApi.accept_invitation",
    :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(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RegistrationApi#accept_invitation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#check_invitation(body, opts = {}) ⇒ InvitationCheckResult

Given an invitation URL, get its type (admin or regular account member) and find whether it is correctly formed and is enabled or disabled.

Parameters:

  • body (InvitationLink) —

    Checked invitation details.

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

    the optional parameters

Returns:



89
90
91
92
 
# File 'lib/athenian/api/registration_api.rb', line 89

def check_invitation(body, opts = {})
  data, _status_code, _headers = check_invitation_with_http_info(body, opts)
  data
end

#check_invitation_with_http_info(body, opts = {}) ⇒ Array<(InvitationCheckResult, Integer, Hash)>

Given an invitation URL, get its type (admin or regular account member) and find whether it is correctly formed and is enabled or disabled.

Parameters:

  • body (InvitationLink) —

    Checked invitation details.

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

    the optional parameters

Returns:

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

    InvitationCheckResult data, response status code and response headers



98
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
149
 
# File 'lib/athenian/api/registration_api.rb', line 98

def check_invitation_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RegistrationApi.check_invitation ...'
  end
  # verify the required parameter 'body' is set
  if @api_client.config.client_side_validation && body.nil?
    fail ArgumentError, "Missing the required parameter 'body' when calling RegistrationApi.check_invitation"
  end
  # resource path
  local_var_path = '/invite/check'

  # 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(body)

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

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

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

#eval_jira_progress(id, opts = {}) ⇒ InstallationProgress

Return the current JIRA installation progress in Athenian.

Parameters:

  • id (Integer) —

    Numeric identifier of the account that is installing JIRA.

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

    the optional parameters

Returns:



155
156
157
158
 
# File 'lib/athenian/api/registration_api.rb', line 155

def eval_jira_progress(id, opts = {})
  data, _status_code, _headers = eval_jira_progress_with_http_info(id, opts)
  data
end

#eval_jira_progress_with_http_info(id, opts = {}) ⇒ Array<(InstallationProgress, Integer, Hash)>

Return the current JIRA installation progress in Athenian.

Parameters:

  • id (Integer) —

    Numeric identifier of the account that is installing JIRA.

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

    the optional parameters

Returns:

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

    InstallationProgress data, response status code and response headers



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
 
# File 'lib/athenian/api/registration_api.rb', line 164

def eval_jira_progress_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RegistrationApi.eval_jira_progress ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling RegistrationApi.eval_jira_progress"
  end
  # resource path
  local_var_path = '/invite/jira_progress/{id}'.sub('{' + 'id' + '}', CGI.escape(id.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'])

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuth', 'bearerAuth']

  new_options = opts.merge(
    :operation => :"RegistrationApi.eval_jira_progress",
    :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(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RegistrationApi#eval_jira_progress\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#eval_metadata_progress(id, opts = {}) ⇒ InstallationProgress

Return the current GitHub installation progress in Athenian.

Parameters:

  • id (Integer) —

    Numeric identifier of the account that is installing GitHub.

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

    the optional parameters

Returns:



216
217
218
219
 
# File 'lib/athenian/api/registration_api.rb', line 216

def eval_metadata_progress(id, opts = {})
  data, _status_code, _headers = eval_metadata_progress_with_http_info(id, opts)
  data
end

#eval_metadata_progress_with_http_info(id, opts = {}) ⇒ Array<(InstallationProgress, Integer, Hash)>

Return the current GitHub installation progress in Athenian.

Parameters:

  • id (Integer) —

    Numeric identifier of the account that is installing GitHub.

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

    the optional parameters

Returns:

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

    InstallationProgress data, response status code and response headers



225
226
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
270
271
 
# File 'lib/athenian/api/registration_api.rb', line 225

def eval_metadata_progress_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RegistrationApi.eval_metadata_progress ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling RegistrationApi.eval_metadata_progress"
  end
  # resource path
  local_var_path = '/invite/progress/{id}'.sub('{' + 'id' + '}', CGI.escape(id.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'])

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['apiKeyAuth', 'bearerAuth']

  new_options = opts.merge(
    :operation => :"RegistrationApi.eval_metadata_progress",
    :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(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RegistrationApi#eval_metadata_progress\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#gen_jira_link(id, opts = {}) ⇒ InvitationLink

👤 Generate a JIRA integration installation link. The caller must be an admin of the specified account.

Parameters:

  • id (Integer) —

    Numeric identifier of the account who is installing JIRA integration.

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

    the optional parameters

Returns:



277
278
279
280
 
# File 'lib/athenian/api/registration_api.rb', line 277

def gen_jira_link(id, opts = {})
  data, _status_code, _headers = gen_jira_link_with_http_info(id, opts)
  data
end

#gen_jira_link_with_http_info(id, opts = {}) ⇒ Array<(InvitationLink, Integer, Hash)>

👤 Generate a JIRA integration installation link. The caller must be an admin of the specified account.

Parameters:

  • id (Integer) —

    Numeric identifier of the account who is installing JIRA integration.

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

    the optional parameters

Returns:

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

    InvitationLink data, response status code and response headers



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
 
# File 'lib/athenian/api/registration_api.rb', line 286

def gen_jira_link_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RegistrationApi.gen_jira_link ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling RegistrationApi.gen_jira_link"
  end
  # resource path
  local_var_path = '/invite/jira/{id}'.sub('{' + 'id' + '}', CGI.escape(id.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'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"RegistrationApi.gen_jira_link",
    :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(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RegistrationApi#gen_jira_link\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#gen_user_invitation(id, opts = {}) ⇒ InvitationLink

👤 Create an account invitation link for regular users. The caller must be an admin of the specified account. The link is persistent, so multiple calls return the same result.

Parameters:

  • id (Integer) —

    Numeric identifier of the account where to invite new users.

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

    the optional parameters

Returns:



338
339
340
341
 
# File 'lib/athenian/api/registration_api.rb', line 338

def gen_user_invitation(id, opts = {})
  data, _status_code, _headers = gen_user_invitation_with_http_info(id, opts)
  data
end

#gen_user_invitation_with_http_info(id, opts = {}) ⇒ Array<(InvitationLink, Integer, Hash)>

👤 Create an account invitation link for regular users. The caller must be an admin of the specified account. The link is persistent, so multiple calls return the same result.

Parameters:

  • id (Integer) —

    Numeric identifier of the account where to invite new users.

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

    the optional parameters

Returns:

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

    InvitationLink data, response status code and response headers



347
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
 
# File 'lib/athenian/api/registration_api.rb', line 347

def gen_user_invitation_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RegistrationApi.gen_user_invitation ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling RegistrationApi.gen_user_invitation"
  end
  # resource path
  local_var_path = '/invite/generate/{id}'.sub('{' + 'id' + '}', CGI.escape(id.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'])

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

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

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

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

  new_options = opts.merge(
    :operation => :"RegistrationApi.gen_user_invitation",
    :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(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: RegistrationApi#gen_user_invitation\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end