Class: DatadogAPIClient::V2::IncidentTeamsAPI

Inherits:
Object
  • Object
show all
Defined in:
lib/datadog_api_client/v2/api/incident_teams_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = DatadogAPIClient::APIClient.default) ⇒ IncidentTeamsAPI

Returns a new instance of IncidentTeamsAPI.



22
23
24
 
# File 'lib/datadog_api_client/v2/api/incident_teams_api.rb', line 22

def initialize(api_client = DatadogAPIClient::APIClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



20
21
22
 
# File 'lib/datadog_api_client/v2/api/incident_teams_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

#create_incident_team(body, opts = {}) ⇒ Object

Create a new incident team.

See Also:



29
30
31
32
 
# File 'lib/datadog_api_client/v2/api/incident_teams_api.rb', line 29

def create_incident_team(body, opts = {})
  data, _status_code, _headers = create_incident_team_with_http_info(body, opts)
  data
end

#create_incident_team_with_http_info(body, opts = {}) ⇒ Array<(IncidentTeamResponse, Integer, Hash)>

Deprecated.

This API is deprecated.

Create a new incident team.

Creates a new incident team.

Parameters:

Returns:

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

    IncidentTeamResponse data, response status code and response headers



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/datadog_api_client/v2/api/incident_teams_api.rb', line 43

def create_incident_team_with_http_info(body, opts = {})
  warn "[DEPRECATION] `CreateIncidentTeam` is deprecated."
  unstable_enabled = @api_client.config.unstable_operations["v2.create_incident_team".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.create_incident_team")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.create_incident_team"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentTeamsAPI.create_incident_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 IncidentTeamsAPI.create_incident_team"
  end
  # resource path
  local_var_path = '/api/v2/teams'

  # 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[:debug_body] || @api_client.object_to_http_body(body)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :create_incident_team,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Post, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IncidentTeamsAPI#create_incident_team\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_incident_team(team_id, opts = {}) ⇒ Object

Delete an existing incident team.

See Also:



105
106
107
108
 
# File 'lib/datadog_api_client/v2/api/incident_teams_api.rb', line 105

def delete_incident_team(team_id, opts = {})
  delete_incident_team_with_http_info(team_id, opts)
  nil
end

#delete_incident_team_with_http_info(team_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Deprecated.

This API is deprecated.

Delete an existing incident team.

Deletes an existing incident team.

Parameters:

  • team_id (String) —

    The ID of the incident team.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
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
 
# File 'lib/datadog_api_client/v2/api/incident_teams_api.rb', line 119

def delete_incident_team_with_http_info(team_id, opts = {})
  warn "[DEPRECATION] `DeleteIncidentTeam` is deprecated."
  unstable_enabled = @api_client.config.unstable_operations["v2.delete_incident_team".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.delete_incident_team")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.delete_incident_team"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentTeamsAPI.delete_incident_team ...'
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    fail ArgumentError, "Missing the required parameter 'team_id' when calling IncidentTeamsAPI.delete_incident_team"
  end
  # resource path
  local_var_path = '/api/v2/teams/{team_id}'.sub('{team_id}', CGI.escape(team_id.to_s).gsub('%2F', '/'))

  # 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(['*/*'])

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

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

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :delete_incident_team,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Delete, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IncidentTeamsAPI#delete_incident_team\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_incident_team(team_id, opts = {}) ⇒ Object

Get details of an incident team.

See Also:



179
180
181
182
 
# File 'lib/datadog_api_client/v2/api/incident_teams_api.rb', line 179

def get_incident_team(team_id, opts = {})
  data, _status_code, _headers = get_incident_team_with_http_info(team_id, opts)
  data
end

#get_incident_team_with_http_info(team_id, opts = {}) ⇒ Array<(IncidentTeamResponse, Integer, Hash)>

Deprecated.

This API is deprecated.

Get details of an incident team.

Get details of an incident team. If the ‘include` query parameter is provided, the included attribute will contain the users related to these incident teams.

Parameters:

  • team_id (String) —

    The ID of the incident team.

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

    the optional parameters

Options Hash (opts):

  • :include (IncidentRelatedObject) —

    Specifies which types of related objects should be included in the response.

Returns:

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

    IncidentTeamResponse data, response status code and response headers



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
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/datadog_api_client/v2/api/incident_teams_api.rb', line 195

def get_incident_team_with_http_info(team_id, opts = {})
  warn "[DEPRECATION] `GetIncidentTeam` is deprecated."
  unstable_enabled = @api_client.config.unstable_operations["v2.get_incident_team".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_incident_team")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_incident_team"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentTeamsAPI.get_incident_team ...'
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    fail ArgumentError, "Missing the required parameter 'team_id' when calling IncidentTeamsAPI.get_incident_team"
  end
  allowable_values = ['users', 'attachments']
  if @api_client.config.client_side_validation && opts[:'include'] && !allowable_values.include?(opts[:'include'])
    fail ArgumentError, "invalid value for \"include\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/v2/teams/{team_id}'.sub('{team_id}', CGI.escape(team_id.to_s).gsub('%2F', '/'))

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include'] = opts[:'include'] if !opts[:'include'].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[:debug_body]

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

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :get_incident_team,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IncidentTeamsAPI#get_incident_team\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_incident_teams(opts = {}) ⇒ Object

Get a list of all incident teams.

See Also:



260
261
262
263
 
# File 'lib/datadog_api_client/v2/api/incident_teams_api.rb', line 260

def list_incident_teams(opts = {})
  data, _status_code, _headers = list_incident_teams_with_http_info(opts)
  data
end

#list_incident_teams_with_http_info(opts = {}) ⇒ Array<(IncidentTeamsResponse, Integer, Hash)>

Deprecated.

This API is deprecated.

Get a list of all incident teams.

Get all incident teams for the requesting user’s organization. If the ‘include` query parameter is provided, the included attribute will contain the users related to these incident teams.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :include (IncidentRelatedObject) —

    Specifies which types of related objects should be included in the response.

  • :page_size (Integer) —

    Size for a given page. The maximum allowed value is 100.

  • :page_offset (Integer) —

    Specific offset to use as the beginning of the returned page.

  • :filter (String) —

    A search query that filters teams by name.

Returns:

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

    IncidentTeamsResponse data, response status code and response headers



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
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/datadog_api_client/v2/api/incident_teams_api.rb', line 277

def list_incident_teams_with_http_info(opts = {})
  warn "[DEPRECATION] `ListIncidentTeams` is deprecated."
  unstable_enabled = @api_client.config.unstable_operations["v2.list_incident_teams".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.list_incident_teams")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.list_incident_teams"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentTeamsAPI.list_incident_teams ...'
  end
  allowable_values = ['users', 'attachments']
  if @api_client.config.client_side_validation && opts[:'include'] && !allowable_values.include?(opts[:'include'])
    fail ArgumentError, "invalid value for \"include\", must be one of #{allowable_values}"
  end
  # resource path
  local_var_path = '/api/v2/teams'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'include'] = opts[:'include'] if !opts[:'include'].nil?
  query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
  query_params[:'page[offset]'] = opts[:'page_offset'] if !opts[:'page_offset'].nil?
  query_params[:'filter'] = opts[:'filter'] if !opts[:'filter'].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[:debug_body]

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

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :list_incident_teams,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IncidentTeamsAPI#list_incident_teams\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_incident_team(team_id, body, opts = {}) ⇒ Object

Update an existing incident team.

See Also:



341
342
343
344
 
# File 'lib/datadog_api_client/v2/api/incident_teams_api.rb', line 341

def update_incident_team(team_id, body, opts = {})
  data, _status_code, _headers = update_incident_team_with_http_info(team_id, body, opts)
  data
end

#update_incident_team_with_http_info(team_id, body, opts = {}) ⇒ Array<(IncidentTeamResponse, Integer, Hash)>

Deprecated.

This API is deprecated.

Update an existing incident team.

Updates an existing incident team. Only provide the attributes which should be updated as this request is a partial update.

Parameters:

  • team_id (String) —

    The ID of the incident team.

  • body (IncidentTeamUpdateRequest) —

    Incident Team Payload.

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

    the optional parameters

Returns:

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

    IncidentTeamResponse data, response status code and response headers



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
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
 
# File 'lib/datadog_api_client/v2/api/incident_teams_api.rb', line 356

def update_incident_team_with_http_info(team_id, body, opts = {})
  warn "[DEPRECATION] `UpdateIncidentTeam` is deprecated."
  unstable_enabled = @api_client.config.unstable_operations["v2.update_incident_team".to_sym]
  if unstable_enabled
    @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.update_incident_team")
  else
    raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.update_incident_team"))
  end

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IncidentTeamsAPI.update_incident_team ...'
  end
  # verify the required parameter 'team_id' is set
  if @api_client.config.client_side_validation && team_id.nil?
    fail ArgumentError, "Missing the required parameter 'team_id' when calling IncidentTeamsAPI.update_incident_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 IncidentTeamsAPI.update_incident_team"
  end
  # resource path
  local_var_path = '/api/v2/teams/{team_id}'.sub('{team_id}', CGI.escape(team_id.to_s).gsub('%2F', '/'))

  # 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[:debug_body] || @api_client.object_to_http_body(body)

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

  # auth_names
  auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]

  new_options = opts.merge(
    :operation => :update_incident_team,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type,
    :api_version => "V2"
  )

  data, status_code, headers = @api_client.call_api(Net::HTTP::Patch, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IncidentTeamsAPI#update_incident_team\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end