Class: OpsgenieSdk::UserApi

Inherits:
Object
  • Object
show all
Defined in:
lib/opsgenie_sdk/api/user_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UserApi

Returns a new instance of UserApi.



19
20
21
 
# File 'lib/opsgenie_sdk/api/user_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/opsgenie_sdk/api/user_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#create_user(body, opts = {}) ⇒ SuccessResponse

Create User Creates a user with the given payload

Parameters:

  • body —

    Request payload of the user object

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

    the optional parameters

Returns:



27
28
29
30
 
# File 'lib/opsgenie_sdk/api/user_api.rb', line 27

def create_user(body, opts = {})
  data, _status_code, _headers = create_user_with_http_info(body, opts)
  data
end

#create_user_with_http_info(body, opts = {}) ⇒ Array<(SuccessResponse, Fixnum, Hash)>

Create User Creates a user with the given payload

Parameters:

  • body —

    Request payload of the user object

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

    the optional parameters

Returns:

  • (Array<(SuccessResponse, Fixnum, Hash)>) —

    SuccessResponse data, response status code and response headers



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
 
# File 'lib/opsgenie_sdk/api/user_api.rb', line 37

def create_user_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.create_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 UserApi.create_user"
  end
  # resource path
  local_var_path = '/v2/users'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  auth_names = ['GenieKey']
  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 => 'SuccessResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserApi#create_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_user(identifier, opts = {}) ⇒ SuccessResponse

Delete User Delete user with the given identifier

Parameters:

  • identifier —

    Identifier of the user to be searched

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

    the optional parameters

Returns:



79
80
81
82
 
# File 'lib/opsgenie_sdk/api/user_api.rb', line 79

def delete_user(identifier, opts = {})
  data, _status_code, _headers = delete_user_with_http_info(identifier, opts)
  data
end

#delete_user_with_http_info(identifier, opts = {}) ⇒ Array<(SuccessResponse, Fixnum, Hash)>

Delete User Delete user with the given identifier

Parameters:

  • identifier —

    Identifier of the user to be searched

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

    the optional parameters

Returns:

  • (Array<(SuccessResponse, Fixnum, Hash)>) —

    SuccessResponse data, response status code and response headers



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
 
# File 'lib/opsgenie_sdk/api/user_api.rb', line 89

def delete_user_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.delete_user ...'
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling UserApi.delete_user"
  end
  # resource path
  local_var_path = '/v2/users/{identifier}'.sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['GenieKey']
  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 => 'SuccessResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserApi#delete_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_user(identifier, opts = {}) ⇒ GetUserResponse

Get User Get user for the given identifier

Parameters:

  • identifier —

    Identifier of the user to be searched

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Comma separated list of strings to create a more detailed response. The only expandable field for user api is &#39;contact&#39;

Returns:



132
133
134
135
 
# File 'lib/opsgenie_sdk/api/user_api.rb', line 132

def get_user(identifier, opts = {})
  data, _status_code, _headers = get_user_with_http_info(identifier, opts)
  data
end

#get_user_with_http_info(identifier, opts = {}) ⇒ Array<(GetUserResponse, Fixnum, Hash)>

Get User Get user for the given identifier

Parameters:

  • identifier —

    Identifier of the user to be searched

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

    the optional parameters

Options Hash (opts):

  • :expand (Array<String>) —

    Comma separated list of strings to create a more detailed response. The only expandable field for user api is &#39;contact&#39;

Returns:

  • (Array<(GetUserResponse, Fixnum, Hash)>) —

    GetUserResponse data, response status code and response headers



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
177
178
179
180
 
# File 'lib/opsgenie_sdk/api/user_api.rb', line 143

def get_user_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.get_user ...'
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling UserApi.get_user"
  end
  # resource path
  local_var_path = '/v2/users/{identifier}'.sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :csv) if !opts[:'expand'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['GenieKey']
  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 => 'GetUserResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserApi#get_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_user_escalations(identifier, opts = {}) ⇒ ListUserEscalationsResponse

List User Escalations List escalations of the user for the given identifier

Parameters:

  • identifier —

    Identifier of the user to be searched

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

    the optional parameters

Returns:



186
187
188
189
 
# File 'lib/opsgenie_sdk/api/user_api.rb', line 186

def list_user_escalations(identifier, opts = {})
  data, _status_code, _headers = list_user_escalations_with_http_info(identifier, opts)
  data
end

#list_user_escalations_with_http_info(identifier, opts = {}) ⇒ Array<(ListUserEscalationsResponse, Fixnum, Hash)>

List User Escalations List escalations of the user for the given identifier

Parameters:

  • identifier —

    Identifier of the user to be searched

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

    the optional parameters

Returns:



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
 
# File 'lib/opsgenie_sdk/api/user_api.rb', line 196

def list_user_escalations_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.list_user_escalations ...'
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling UserApi.list_user_escalations"
  end
  # resource path
  local_var_path = '/v2/users/{identifier}/escalations'.sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['GenieKey']
  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 => 'ListUserEscalationsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserApi#list_user_escalations\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_user_forwarding_rules(identifier, opts = {}) ⇒ ListUserForwardingRulesResponse

List User Forwarding Rules List user forwarding rules for the given user identifier

Parameters:

  • identifier —

    Identifier of the user to be searched

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

    the optional parameters

Returns:



238
239
240
241
 
# File 'lib/opsgenie_sdk/api/user_api.rb', line 238

def list_user_forwarding_rules(identifier, opts = {})
  data, _status_code, _headers = list_user_forwarding_rules_with_http_info(identifier, opts)
  data
end

#list_user_forwarding_rules_with_http_info(identifier, opts = {}) ⇒ Array<(ListUserForwardingRulesResponse, Fixnum, Hash)>

List User Forwarding Rules List user forwarding rules for the given user identifier

Parameters:

  • identifier —

    Identifier of the user to be searched

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

    the optional parameters

Returns:



248
249
250
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
 
# File 'lib/opsgenie_sdk/api/user_api.rb', line 248

def list_user_forwarding_rules_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.list_user_forwarding_rules ...'
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling UserApi.list_user_forwarding_rules"
  end
  # resource path
  local_var_path = '/v2/users/{identifier}/forwarding-rules'.sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['GenieKey']
  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 => 'ListUserForwardingRulesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserApi#list_user_forwarding_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_user_schedules(identifier, opts = {}) ⇒ ListUserSchedulesResponse

List User Schedules List schedules of the user for the given identifier

Parameters:

  • identifier —

    Identifier of the user to be searched

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

    the optional parameters

Returns:



290
291
292
293
 
# File 'lib/opsgenie_sdk/api/user_api.rb', line 290

def list_user_schedules(identifier, opts = {})
  data, _status_code, _headers = list_user_schedules_with_http_info(identifier, opts)
  data
end

#list_user_schedules_with_http_info(identifier, opts = {}) ⇒ Array<(ListUserSchedulesResponse, Fixnum, Hash)>

List User Schedules List schedules of the user for the given identifier

Parameters:

  • identifier —

    Identifier of the user to be searched

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

    the optional parameters

Returns:

  • (Array<(ListUserSchedulesResponse, Fixnum, Hash)>) —

    ListUserSchedulesResponse data, response status code and response headers



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
334
335
336
 
# File 'lib/opsgenie_sdk/api/user_api.rb', line 300

def list_user_schedules_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.list_user_schedules ...'
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling UserApi.list_user_schedules"
  end
  # resource path
  local_var_path = '/v2/users/{identifier}/schedules'.sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['GenieKey']
  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 => 'ListUserSchedulesResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserApi#list_user_schedules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_user_teams(identifier, opts = {}) ⇒ ListUserTeamsResponse

List User Teams List user teams for the given user identifier

Parameters:

  • identifier —

    Identifier of the user to be searched

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

    the optional parameters

Returns:



342
343
344
345
 
# File 'lib/opsgenie_sdk/api/user_api.rb', line 342

def list_user_teams(identifier, opts = {})
  data, _status_code, _headers = list_user_teams_with_http_info(identifier, opts)
  data
end

#list_user_teams_with_http_info(identifier, opts = {}) ⇒ Array<(ListUserTeamsResponse, Fixnum, Hash)>

List User Teams List user teams for the given user identifier

Parameters:

  • identifier —

    Identifier of the user to be searched

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

    the optional parameters

Returns:

  • (Array<(ListUserTeamsResponse, Fixnum, Hash)>) —

    ListUserTeamsResponse data, response status code and response headers



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/opsgenie_sdk/api/user_api.rb', line 352

def list_user_teams_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.list_user_teams ...'
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling UserApi.list_user_teams"
  end
  # resource path
  local_var_path = '/v2/users/{identifier}/teams'.sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['GenieKey']
  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 => 'ListUserTeamsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserApi#list_user_teams\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_users(opts = {}) ⇒ ListUsersResponse

List users List users with given parameters

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of users to retrieve (default to 100)

  • :offset (Integer) —

    Number of users to skip from start (default to 0)

  • :sort_field (String) —

    Field to use in sorting. Should be one of &#39;username&#39;, &#39;fullName&#39; and &#39;insertedAt&#39;

  • :order (String) —

    Direction of sorting. Should be one of &#39;asc&#39; or &#39;desc&#39; (default to asc)

  • :query (String) —

    Field:value combinations with most of user fields to make more advanced searches. Possible fields are username, fullName, blocked, verified, role, locale, timeZone, userAddress and createdAt

Returns:



398
399
400
401
 
# File 'lib/opsgenie_sdk/api/user_api.rb', line 398

def list_users(opts = {})
  data, _status_code, _headers = list_users_with_http_info(opts)
  data
end

#list_users_with_http_info(opts = {}) ⇒ Array<(ListUsersResponse, Fixnum, Hash)>

List users List users with given parameters

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :limit (Integer) —

    Number of users to retrieve

  • :offset (Integer) —

    Number of users to skip from start

  • :sort_field (String) —

    Field to use in sorting. Should be one of &#39;username&#39;, &#39;fullName&#39; and &#39;insertedAt&#39;

  • :order (String) —

    Direction of sorting. Should be one of &#39;asc&#39; or &#39;desc&#39;

  • :query (String) —

    Field:value combinations with most of user fields to make more advanced searches. Possible fields are username, fullName, blocked, verified, role, locale, timeZone, userAddress and createdAt

Returns:

  • (Array<(ListUsersResponse, Fixnum, Hash)>) —

    ListUsersResponse data, response status code and response headers



412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
 
# File 'lib/opsgenie_sdk/api/user_api.rb', line 412

def list_users_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.list_users ...'
  end
  if @api_client.config.client_side_validation && opts[:'order'] && !['asc', 'desc'].include?(opts[:'order'])
    fail ArgumentError, 'invalid value for "order", must be one of asc, desc'
  end
  # resource path
  local_var_path = '/v2/users'

  # query parameters
  query_params = {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'sortField'] = opts[:'sort_field'] if !opts[:'sort_field'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'query'] = opts[:'query'] if !opts[:'query'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['GenieKey']
  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 => 'ListUsersResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserApi#list_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_user(identifier, opts = {}) ⇒ SuccessResponse

Update User (Partial) Update user with the given identifier

Parameters:

  • identifier —

    Identifier of the user to be searched

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

    the optional parameters

Options Hash (opts):

Returns:



459
460
461
462
 
# File 'lib/opsgenie_sdk/api/user_api.rb', line 459

def update_user(identifier, opts = {})
  data, _status_code, _headers = update_user_with_http_info(identifier, opts)
  data
end

#update_user_with_http_info(identifier, opts = {}) ⇒ Array<(SuccessResponse, Fixnum, Hash)>

Update User (Partial) Update user with the given identifier

Parameters:

  • identifier —

    Identifier of the user to be searched

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

    the optional parameters

Options Hash (opts):

Returns:

  • (Array<(SuccessResponse, Fixnum, Hash)>) —

    SuccessResponse data, response status code and response headers



470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/opsgenie_sdk/api/user_api.rb', line 470

def update_user_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: UserApi.update_user ...'
  end
  # verify the required parameter 'identifier' is set
  if @api_client.config.client_side_validation && identifier.nil?
    fail ArgumentError, "Missing the required parameter 'identifier' when calling UserApi.update_user"
  end
  # resource path
  local_var_path = '/v2/users/{identifier}'.sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(opts[:'body'])
  auth_names = ['GenieKey']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'SuccessResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UserApi#update_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end