Class: Mudbase::RoleElevationApi

Inherits:
Object
  • Object
show all
Defined in:
lib/mudbase/api/role_elevation_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ RoleElevationApi

Returns a new instance of RoleElevationApi.



19
20
21
 
# File 'lib/mudbase/api/role_elevation_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/mudbase/api/role_elevation_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#approve_role_elevation(org_id, request_id, approve_role_elevation_request, opts = {}) ⇒ ApproveRoleElevation200Response

Approve/reject role elevation request (admin only) Admin approves or rejects a role elevation request

Parameters:

  • org_id (String)
  • request_id (String)
  • approve_role_elevation_request (ApproveRoleElevationRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



29
30
31
32
 
# File 'lib/mudbase/api/role_elevation_api.rb', line 29

def approve_role_elevation(org_id, request_id, approve_role_elevation_request, opts = {})
  data, _status_code, _headers = approve_role_elevation_with_http_info(org_id, request_id, approve_role_elevation_request, opts)
  data
end

#approve_role_elevation_with_http_info(org_id, request_id, approve_role_elevation_request, opts = {}) ⇒ Array<(ApproveRoleElevation200Response, Integer, Hash)>

Approve/reject role elevation request (admin only) Admin approves or rejects a role elevation request

Parameters:

  • org_id (String)
  • request_id (String)
  • approve_role_elevation_request (ApproveRoleElevationRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



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
95
96
97
98
99
100
 
# File 'lib/mudbase/api/role_elevation_api.rb', line 41

def approve_role_elevation_with_http_info(org_id, request_id, approve_role_elevation_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoleElevationApi.approve_role_elevation ...'
  end
  # verify the required parameter 'org_id' is set
  if @api_client.config.client_side_validation && org_id.nil?
    fail ArgumentError, "Missing the required parameter 'org_id' when calling RoleElevationApi.approve_role_elevation"
  end
  # verify the required parameter 'request_id' is set
  if @api_client.config.client_side_validation && request_id.nil?
    fail ArgumentError, "Missing the required parameter 'request_id' when calling RoleElevationApi.approve_role_elevation"
  end
  # verify the required parameter 'approve_role_elevation_request' is set
  if @api_client.config.client_side_validation && approve_role_elevation_request.nil?
    fail ArgumentError, "Missing the required parameter 'approve_role_elevation_request' when calling RoleElevationApi.approve_role_elevation"
  end
  # resource path
  local_var_path = '/api/orgs/{orgId}/role-elevation/{requestId}/approve'.sub('{' + 'orgId' + '}', CGI.escape(org_id.to_s)).sub('{' + 'requestId' + '}', CGI.escape(request_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']) 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(approve_role_elevation_request)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OrgBearerAuth', 'ProjectBearerAuth']

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

#get_pending_role_elevation_requests(org_id, opts = {}) ⇒ GetPendingRoleElevationRequests200Response

Get pending role elevation requests (admin only) Get all pending role elevation requests requiring admin approval

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :status (String) — default: default to 'pending'
  • :page (Integer) — default: default to 1
  • :limit (Integer) — default: default to 50

Returns:



110
111
112
113
 
# File 'lib/mudbase/api/role_elevation_api.rb', line 110

def get_pending_role_elevation_requests(org_id, opts = {})
  data, _status_code, _headers = get_pending_role_elevation_requests_with_http_info(org_id, opts)
  data
end

#get_pending_role_elevation_requests_with_http_info(org_id, opts = {}) ⇒ Array<(GetPendingRoleElevationRequests200Response, Integer, Hash)>

Get pending role elevation requests (admin only) Get all pending role elevation requests requiring admin approval

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :status (String) — default: default to 'pending'
  • :page (Integer) — default: default to 1
  • :limit (Integer) — default: default to 50

Returns:



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
169
170
171
172
173
174
175
176
 
# File 'lib/mudbase/api/role_elevation_api.rb', line 123

def get_pending_role_elevation_requests_with_http_info(org_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoleElevationApi.get_pending_role_elevation_requests ...'
  end
  # verify the required parameter 'org_id' is set
  if @api_client.config.client_side_validation && org_id.nil?
    fail ArgumentError, "Missing the required parameter 'org_id' when calling RoleElevationApi.get_pending_role_elevation_requests"
  end
  allowable_values = ["pending", "approved", "rejected"]
  if @api_client.config.client_side_validation && opts[:'status'] && !allowable_values.include?(opts[:'status'])
    fail ArgumentError, "invalid value for \"status\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/orgs/{orgId}/role-elevation/pending'.sub('{' + 'orgId' + '}', CGI.escape(org_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'status'] = opts[:'status'] if !opts[:'status'].nil?
  query_params[:'page'] = opts[:'page'] if !opts[:'page'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OrgBearerAuth', 'ProjectBearerAuth']

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

#get_role_elevation_status(project_id, opts = {}) ⇒ GetRoleElevationStatus200Response

Get role elevation status Get status of pending role elevation requests for current user

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :role_slug (String)

Returns:



184
185
186
187
 
# File 'lib/mudbase/api/role_elevation_api.rb', line 184

def get_role_elevation_status(project_id, opts = {})
  data, _status_code, _headers = get_role_elevation_status_with_http_info(project_id, opts)
  data
end

#get_role_elevation_status_with_http_info(project_id, opts = {}) ⇒ Array<(GetRoleElevationStatus200Response, Integer, Hash)>

Get role elevation status Get status of pending role elevation requests for current user

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :role_slug (String)

Returns:



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/mudbase/api/role_elevation_api.rb', line 195

def get_role_elevation_status_with_http_info(project_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoleElevationApi.get_role_elevation_status ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling RoleElevationApi.get_role_elevation_status"
  end
  # resource path
  local_var_path = '/api/projects/{projectId}/role-elevation/status'.sub('{' + 'projectId' + '}', CGI.escape(project_id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'roleSlug'] = opts[:'role_slug'] if !opts[:'role_slug'].nil?

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

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

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

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OrgBearerAuth', 'ProjectBearerAuth']

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

#request_role_elevation(project_id, request_role_elevation_request, opts = {}) ⇒ RequestRoleElevation200Response

Request role elevation User requests to upgrade to a specific role. May require payment, KYC, or admin approval based on role configuration.

Parameters:

  • project_id (String)
  • request_role_elevation_request (RequestRoleElevationRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



250
251
252
253
 
# File 'lib/mudbase/api/role_elevation_api.rb', line 250

def request_role_elevation(project_id, request_role_elevation_request, opts = {})
  data, _status_code, _headers = request_role_elevation_with_http_info(project_id, request_role_elevation_request, opts)
  data
end

#request_role_elevation_with_http_info(project_id, request_role_elevation_request, opts = {}) ⇒ Array<(RequestRoleElevation200Response, Integer, Hash)>

Request role elevation User requests to upgrade to a specific role. May require payment, KYC, or admin approval based on role configuration.

Parameters:

  • project_id (String)
  • request_role_elevation_request (RequestRoleElevationRequest)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
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
 
# File 'lib/mudbase/api/role_elevation_api.rb', line 261

def request_role_elevation_with_http_info(project_id, request_role_elevation_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoleElevationApi.request_role_elevation ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling RoleElevationApi.request_role_elevation"
  end
  # verify the required parameter 'request_role_elevation_request' is set
  if @api_client.config.client_side_validation && request_role_elevation_request.nil?
    fail ArgumentError, "Missing the required parameter 'request_role_elevation_request' when calling RoleElevationApi.request_role_elevation"
  end
  # resource path
  local_var_path = '/api/projects/{projectId}/role-elevation/request'.sub('{' + 'projectId' + '}', CGI.escape(project_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']) 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(request_role_elevation_request)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OrgBearerAuth', 'ProjectBearerAuth']

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

#upload_verification_documents(project_id, upload_verification_documents_request, opts = {}) ⇒ nil

Upload verification documents Upload KYC/verification documents for role elevation

Parameters:

Returns:

  • (nil) 


324
325
326
327
 
# File 'lib/mudbase/api/role_elevation_api.rb', line 324

def upload_verification_documents(project_id, upload_verification_documents_request, opts = {})
  upload_verification_documents_with_http_info(project_id, upload_verification_documents_request, opts)
  nil
end

#upload_verification_documents_with_http_info(project_id, upload_verification_documents_request, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Upload verification documents Upload KYC/verification documents for role elevation

Parameters:

Returns:

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

    nil, response status code and response headers



335
336
337
338
339
340
341
342
343
344
345
346
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
 
# File 'lib/mudbase/api/role_elevation_api.rb', line 335

def upload_verification_documents_with_http_info(project_id, upload_verification_documents_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: RoleElevationApi.upload_verification_documents ...'
  end
  # verify the required parameter 'project_id' is set
  if @api_client.config.client_side_validation && project_id.nil?
    fail ArgumentError, "Missing the required parameter 'project_id' when calling RoleElevationApi.upload_verification_documents"
  end
  # verify the required parameter 'upload_verification_documents_request' is set
  if @api_client.config.client_side_validation && upload_verification_documents_request.nil?
    fail ArgumentError, "Missing the required parameter 'upload_verification_documents_request' when calling RoleElevationApi.upload_verification_documents"
  end
  # resource path
  local_var_path = '/api/projects/{projectId}/role-elevation/documents'.sub('{' + 'projectId' + '}', CGI.escape(project_id.to_s))

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || ['OrgBearerAuth', 'ProjectBearerAuth']

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