Class: OpsgenieSdk::TeamApi

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ TeamApi

Returns a new instance of TeamApi.



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

def api_client
  @api_client
end

Instance Method Details

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

Create Team Creates a new team

Parameters:

  • body —

    Request payload of created team

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

    the optional parameters

Returns:



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

def create_team(body, opts = {})
  data, _status_code, _headers = create_team_with_http_info(body, opts)
  data
end

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

Create Team Creates a new team

Parameters:

  • body —

    Request payload of created team

  • 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/team_api.rb', line 37

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

  # 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: TeamApi#create_team\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Delete Team Delete team with given id or name

Parameters:

  • identifier —

    Identifier of the team

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

    the optional parameters

Options Hash (opts):

  • :identifier_type (String) —

    Type of the identifier. Possible values are &#39;id&#39; and &#39;name&#39;. Default value is &#39;id&#39; (default to id)

Returns:



80
81
82
83
 
# File 'lib/opsgenie_sdk/api/team_api.rb', line 80

def delete_team(identifier, opts = {})
  data, _status_code, _headers = delete_team_with_http_info(identifier, opts)
  data
end

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

Delete Team Delete team with given id or name

Parameters:

  • identifier —

    Identifier of the team

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

    the optional parameters

Options Hash (opts):

  • :identifier_type (String) —

    Type of the identifier. Possible values are &#39;id&#39; and &#39;name&#39;. Default value is &#39;id&#39;

Returns:

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

    SuccessResponse data, response status code and response headers



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
127
128
129
130
131
 
# File 'lib/opsgenie_sdk/api/team_api.rb', line 91

def delete_team_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamApi.delete_team ...'
  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 TeamApi.delete_team"
  end
  if @api_client.config.client_side_validation && opts[:'identifier_type'] && !['id', 'name'].include?(opts[:'identifier_type'])
    fail ArgumentError, 'invalid value for "identifier_type", must be one of id, name'
  end
  # resource path
  local_var_path = '/v2/teams/{identifier}'.sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'identifierType'] = opts[:'identifier_type'] if !opts[:'identifier_type'].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(: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: TeamApi#delete_team\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_team(identifier, opts = {}) ⇒ GetTeamResponse

Get Team Returns team with given ‘id’ or ‘name’

Parameters:

  • identifier —

    Identifier of the team

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

    the optional parameters

Options Hash (opts):

  • :identifier_type (String) —

    Type of the identifier. Possible values are &#39;id&#39; and &#39;name&#39;. Default value is &#39;id&#39; (default to id)

Returns:



138
139
140
141
 
# File 'lib/opsgenie_sdk/api/team_api.rb', line 138

def get_team(identifier, opts = {})
  data, _status_code, _headers = get_team_with_http_info(identifier, opts)
  data
end

#get_team_with_http_info(identifier, opts = {}) ⇒ Array<(GetTeamResponse, Fixnum, Hash)>

Get Team Returns team with given &#39;id&#39; or &#39;name&#39;

Parameters:

  • identifier —

    Identifier of the team

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

    the optional parameters

Options Hash (opts):

  • :identifier_type (String) —

    Type of the identifier. Possible values are &#39;id&#39; and &#39;name&#39;. Default value is &#39;id&#39;

Returns:

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

    GetTeamResponse data, response status code and response headers



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
184
185
186
187
188
189
 
# File 'lib/opsgenie_sdk/api/team_api.rb', line 149

def get_team_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamApi.get_team ...'
  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 TeamApi.get_team"
  end
  if @api_client.config.client_side_validation && opts[:'identifier_type'] && !['id', 'name'].include?(opts[:'identifier_type'])
    fail ArgumentError, 'invalid value for "identifier_type", must be one of id, name'
  end
  # resource path
  local_var_path = '/v2/teams/{identifier}'.sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'identifierType'] = opts[:'identifier_type'] if !opts[:'identifier_type'].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 => 'GetTeamResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamApi#get_team\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_team_logs(identifier, opts = {}) ⇒ ListTeamLogsResponse

List Team Logs Return logs of a team given with identifier

Parameters:

  • identifier —

    Identifier of the team

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

    the optional parameters

Options Hash (opts):

  • :identifier_type (String) —

    Type of the identifier. Possible values are &#39;id&#39; and &#39;name&#39;. Default value is &#39;id&#39; (default to id)

  • :limit (Integer) —

    Maximum number of items to provide in the result. Must be a positive integer value.

  • :order (String) —

    Sorting order of the result set (default to desc)

  • :offset (String) —

    Key which will be used in pagination

Returns:



199
200
201
202
 
# File 'lib/opsgenie_sdk/api/team_api.rb', line 199

def list_team_logs(identifier, opts = {})
  data, _status_code, _headers = list_team_logs_with_http_info(identifier, opts)
  data
end

#list_team_logs_with_http_info(identifier, opts = {}) ⇒ Array<(ListTeamLogsResponse, Fixnum, Hash)>

List Team Logs Return logs of a team given with identifier

Parameters:

  • identifier —

    Identifier of the team

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

    the optional parameters

Options Hash (opts):

  • :identifier_type (String) —

    Type of the identifier. Possible values are &#39;id&#39; and &#39;name&#39;. Default value is &#39;id&#39;

  • :limit (Integer) —

    Maximum number of items to provide in the result. Must be a positive integer value.

  • :order (String) —

    Sorting order of the result set

  • :offset (String) —

    Key which will be used in pagination

Returns:

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

    ListTeamLogsResponse data, response status code and response headers



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

def list_team_logs_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamApi.list_team_logs ...'
  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 TeamApi.list_team_logs"
  end
  if @api_client.config.client_side_validation && opts[:'identifier_type'] && !['id', 'name'].include?(opts[:'identifier_type'])
    fail ArgumentError, 'invalid value for "identifier_type", must be one of id, name'
  end
  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] > 100
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TeamApi.list_team_logs, must be smaller than or equal to 100.'
  end

  if @api_client.config.client_side_validation && !opts[:'limit'].nil? && opts[:'limit'] < 1
    fail ArgumentError, 'invalid value for "opts[:"limit"]" when calling TeamApi.list_team_logs, must be greater than or equal to 1.'
  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/teams/{identifier}/logs'.sub('{' + 'identifier' + '}', identifier.to_s)

  # query parameters
  query_params = {}
  query_params[:'identifierType'] = opts[:'identifier_type'] if !opts[:'identifier_type'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'order'] = opts[:'order'] if !opts[:'order'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].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 => 'ListTeamLogsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamApi#list_team_logs\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_teams(opts = {}) ⇒ ListTeamsResponse

List Teams Return list of teams

Parameters:

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

    the optional parameters

Returns:



272
273
274
275
 
# File 'lib/opsgenie_sdk/api/team_api.rb', line 272

def list_teams(opts = {})
  data, _status_code, _headers = list_teams_with_http_info(opts)
  data
end

#list_teams_with_http_info(opts = {}) ⇒ Array<(ListTeamsResponse, Fixnum, Hash)>

List Teams Return list of teams

Parameters:

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

    the optional parameters

Returns:

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

    ListTeamsResponse data, response status code and response headers



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

def list_teams_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamApi.list_teams ...'
  end
  # resource path
  local_var_path = '/v2/teams'

  # 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 => 'ListTeamsResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: TeamApi#list_teams\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

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

Update Team (Partial) Update team with given id

Parameters:

  • identifier —

    Identifier of the team

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

    the optional parameters

Options Hash (opts):

Returns:



320
321
322
323
 
# File 'lib/opsgenie_sdk/api/team_api.rb', line 320

def update_team(identifier, opts = {})
  data, _status_code, _headers = update_team_with_http_info(identifier, opts)
  data
end

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

Update Team (Partial) Update team with given id

Parameters:

  • identifier —

    Identifier of the team

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

    the optional parameters

Options Hash (opts):

Returns:

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

    SuccessResponse data, response status code and response headers



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
356
357
358
359
360
361
362
363
364
365
366
367
 
# File 'lib/opsgenie_sdk/api/team_api.rb', line 331

def update_team_with_http_info(identifier, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: TeamApi.update_team ...'
  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 TeamApi.update_team"
  end
  # resource path
  local_var_path = '/v2/teams/{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: TeamApi#update_team\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end