Class: Notifo::SystemUsersApi

Inherits:
Object
  • Object
show all
Defined in:
lib/notifo/api/system_users_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SystemUsersApi

Returns a new instance of SystemUsersApi.



16
17
18
 
# File 'lib/notifo/api/system_users_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/notifo/api/system_users_api.rb', line 14

def api_client
  @api_client
end

Instance Method Details

#system_users_delete_user(id, opts = {}) ⇒ nil

Delete the user.

Parameters:

  • id —

    The user ID.

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

    the optional parameters

Returns:

  • (nil) 


23
24
25
26
 
# File 'lib/notifo/api/system_users_api.rb', line 23

def system_users_delete_user(id, opts = {})
  system_users_delete_user_with_http_info(id, opts)
  nil
end

#system_users_delete_user_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete the user.

Parameters:

  • id —

    The user ID.

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

    the optional parameters

Returns:

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

    nil, 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
 
# File 'lib/notifo/api/system_users_api.rb', line 32

def system_users_delete_user_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SystemUsersApi.system_users_delete_user ...'
  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 SystemUsersApi.system_users_delete_user"
  end
  # resource path
  local_var_path = '/api/system-users/{id}'.sub('{' + 'id' + '}', 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[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SystemUsersApi#system_users_delete_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_users_get_user(id, opts = {}) ⇒ nil

Get a user.

Parameters:

  • id —

    The user ID.

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

    the optional parameters

Returns:

  • (nil) 


77
78
79
80
 
# File 'lib/notifo/api/system_users_api.rb', line 77

def system_users_get_user(id, opts = {})
  system_users_get_user_with_http_info(id, opts)
  nil
end

#system_users_get_user_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Get a user.

Parameters:

  • id —

    The user ID.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



86
87
88
89
90
91
92
93
94
95
96
97
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
 
# File 'lib/notifo/api/system_users_api.rb', line 86

def system_users_get_user_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SystemUsersApi.system_users_get_user ...'
  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 SystemUsersApi.system_users_get_user"
  end
  # resource path
  local_var_path = '/api/system-users/{id}'.sub('{' + 'id' + '}', 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[:body] 

  return_type = opts[:return_type] 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SystemUsersApi#system_users_get_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_users_get_users(opts = {}) ⇒ ListResponseDtoOfSystemUserDto

Query users.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :query (String) —

    The optional query to search for items.

  • :take (Integer) —

    The number of items to return.

  • :skip (Integer) —

    The number of items to skip.

Returns:



133
134
135
136
 
# File 'lib/notifo/api/system_users_api.rb', line 133

def system_users_get_users(opts = {})
  data, _status_code, _headers = system_users_get_users_with_http_info(opts)
  data
end

#system_users_get_users_with_http_info(opts = {}) ⇒ Array<(ListResponseDtoOfSystemUserDto, Integer, Hash)>

Query users.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :query (String) —

    The optional query to search for items.

  • :take (Integer) —

    The number of items to return.

  • :skip (Integer) —

    The number of items to skip.

Returns:



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
177
178
179
180
181
182
183
 
# File 'lib/notifo/api/system_users_api.rb', line 144

def system_users_get_users_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SystemUsersApi.system_users_get_users ...'
  end
  # resource path
  local_var_path = '/api/system-users'

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

  # 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[:body] 

  return_type = opts[:return_type] || 'ListResponseDtoOfSystemUserDto' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SystemUsersApi#system_users_get_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_users_lock_user(id, opts = {}) ⇒ SystemUserDto

Lock the user.

Parameters:

  • id —

    The user ID.

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

    the optional parameters

Returns:



188
189
190
191
 
# File 'lib/notifo/api/system_users_api.rb', line 188

def system_users_lock_user(id, opts = {})
  data, _status_code, _headers = system_users_lock_user_with_http_info(id, opts)
  data
end

#system_users_lock_user_with_http_info(id, opts = {}) ⇒ Array<(SystemUserDto, Integer, Hash)>

Lock the user.

Parameters:

  • id —

    The user ID.

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

    the optional parameters

Returns:

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

    SystemUserDto data, response status code and response headers



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
 
# File 'lib/notifo/api/system_users_api.rb', line 197

def system_users_lock_user_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SystemUsersApi.system_users_lock_user ...'
  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 SystemUsersApi.system_users_lock_user"
  end
  # resource path
  local_var_path = '/api/system-users/{id}/lock'.sub('{' + 'id' + '}', 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[:body] 

  return_type = opts[:return_type] || 'SystemUserDto' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SystemUsersApi#system_users_lock_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_users_post_user(body, opts = {}) ⇒ SystemUserDto

Create a user.

Parameters:

  • body —

    The create request.

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

    the optional parameters

Returns:



242
243
244
245
 
# File 'lib/notifo/api/system_users_api.rb', line 242

def system_users_post_user(body, opts = {})
  data, _status_code, _headers = system_users_post_user_with_http_info(body, opts)
  data
end

#system_users_post_user_with_http_info(body, opts = {}) ⇒ Array<(SystemUserDto, Integer, Hash)>

Create a user.

Parameters:

  • body —

    The create request.

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

    the optional parameters

Returns:

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

    SystemUserDto data, response status code and response headers



251
252
253
254
255
256
257
258
259
260
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
 
# File 'lib/notifo/api/system_users_api.rb', line 251

def system_users_post_user_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SystemUsersApi.system_users_post_user ...'
  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 SystemUsersApi.system_users_post_user"
  end
  # resource path
  local_var_path = '/api/system-users'

  # 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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'SystemUserDto' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SystemUsersApi#system_users_post_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_users_put_user(body, id, opts = {}) ⇒ SystemUserDto

Update the user.

Parameters:

  • body —

    The update request.

  • id —

    The user ID.

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

    the optional parameters

Returns:



299
300
301
302
 
# File 'lib/notifo/api/system_users_api.rb', line 299

def system_users_put_user(body, id, opts = {})
  data, _status_code, _headers = system_users_put_user_with_http_info(body, id, opts)
  data
end

#system_users_put_user_with_http_info(body, id, opts = {}) ⇒ Array<(SystemUserDto, Integer, Hash)>

Update the user.

Parameters:

  • body —

    The update request.

  • id —

    The user ID.

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

    the optional parameters

Returns:

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

    SystemUserDto data, response status code and response headers



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
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
 
# File 'lib/notifo/api/system_users_api.rb', line 309

def system_users_put_user_with_http_info(body, id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SystemUsersApi.system_users_put_user ...'
  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 SystemUsersApi.system_users_put_user"
  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 SystemUsersApi.system_users_put_user"
  end
  # resource path
  local_var_path = '/api/system-users/{id}'.sub('{' + 'id' + '}', 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'])
  # HTTP header 'Content-Type'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

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

  # http body (model)
  post_body = opts[:body] || @api_client.object_to_http_body(body) 

  return_type = opts[:return_type] || 'SystemUserDto' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SystemUsersApi#system_users_put_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#system_users_unlock_user(id, opts = {}) ⇒ SystemUserDto

Unlock the user.

Parameters:

  • id —

    The user ID.

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

    the optional parameters

Returns:



360
361
362
363
 
# File 'lib/notifo/api/system_users_api.rb', line 360

def system_users_unlock_user(id, opts = {})
  data, _status_code, _headers = system_users_unlock_user_with_http_info(id, opts)
  data
end

#system_users_unlock_user_with_http_info(id, opts = {}) ⇒ Array<(SystemUserDto, Integer, Hash)>

Unlock the user.

Parameters:

  • id —

    The user ID.

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

    the optional parameters

Returns:

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

    SystemUserDto data, response status code and response headers



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
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/notifo/api/system_users_api.rb', line 369

def system_users_unlock_user_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: SystemUsersApi.system_users_unlock_user ...'
  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 SystemUsersApi.system_users_unlock_user"
  end
  # resource path
  local_var_path = '/api/system-users/{id}/unlock'.sub('{' + 'id' + '}', 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[:body] 

  return_type = opts[:return_type] || 'SystemUserDto' 

  auth_names = opts[:auth_names] || []
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type)

  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SystemUsersApi#system_users_unlock_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end