Class: DatadogAPIClient::V2::StatuspageIntegrationAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of StatuspageIntegrationAPI.



22
23
24
 
# File 'lib/datadog_api_client/v2/api/statuspage_integration_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/statuspage_integration_api.rb', line 20

def api_client
  @api_client
end

Instance Method Details

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

Create the Statuspage account.

See Also:



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

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

#create_statuspage_account_with_http_info(body, opts = {}) ⇒ Array<(StatuspageAccountResponse, Integer, Hash)>

Create the Statuspage account.

Create a Statuspage account for your organization. Only one Statuspage account can be configured per organization.

Parameters:

Returns:

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

    StatuspageAccountResponse data, response status code and response headers



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

def (body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatuspageIntegrationAPI.create_statuspage_account ...'
  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 StatuspageIntegrationAPI.create_statuspage_account"
  end
  # resource path
  local_var_path = '/api/v2/integration/statuspage/account'

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

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

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

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

Create a Statuspage URL setting.

See Also:



97
98
99
100
 
# File 'lib/datadog_api_client/v2/api/statuspage_integration_api.rb', line 97

def create_statuspage_url_setting(body, opts = {})
  data, _status_code, _headers = create_statuspage_url_setting_with_http_info(body, opts)
  data
end

#create_statuspage_url_setting_with_http_info(body, opts = {}) ⇒ Array<(StatuspageUrlSettingResponse, Integer, Hash)>

Create a Statuspage URL setting.

Create a Statuspage URL setting for your organization.

Parameters:

Returns:



109
110
111
112
113
114
115
116
117
118
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
 
# File 'lib/datadog_api_client/v2/api/statuspage_integration_api.rb', line 109

def create_statuspage_url_setting_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatuspageIntegrationAPI.create_statuspage_url_setting ...'
  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 StatuspageIntegrationAPI.create_statuspage_url_setting"
  end
  # resource path
  local_var_path = '/api/v2/integration/statuspage/url_settings'

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

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

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

#delete_statuspage_account(opts = {}) ⇒ Object

Delete the Statuspage account.

See Also:



164
165
166
167
 
# File 'lib/datadog_api_client/v2/api/statuspage_integration_api.rb', line 164

def (opts = {})
  (opts)
  nil
end

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

Delete the Statuspage account.

Delete the Statuspage account configured for your organization.

Parameters:

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
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
 
# File 'lib/datadog_api_client/v2/api/statuspage_integration_api.rb', line 175

def (opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatuspageIntegrationAPI.delete_statuspage_account ...'
  end
  # resource path
  local_var_path = '/api/v2/integration/statuspage/account'

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

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

#delete_statuspage_url_setting(statuspage_url_setting_id, opts = {}) ⇒ Object

Delete a Statuspage URL setting.

See Also:



224
225
226
227
 
# File 'lib/datadog_api_client/v2/api/statuspage_integration_api.rb', line 224

def delete_statuspage_url_setting(statuspage_url_setting_id, opts = {})
  delete_statuspage_url_setting_with_http_info(statuspage_url_setting_id, opts)
  nil
end

#delete_statuspage_url_setting_with_http_info(statuspage_url_setting_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete a Statuspage URL setting.

Delete a single Statuspage URL setting from your organization.

Parameters:

  • statuspage_url_setting_id (String) —

    The UUID of the Statuspage URL setting.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/datadog_api_client/v2/api/statuspage_integration_api.rb', line 236

def delete_statuspage_url_setting_with_http_info(statuspage_url_setting_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatuspageIntegrationAPI.delete_statuspage_url_setting ...'
  end
  # verify the required parameter 'statuspage_url_setting_id' is set
  if @api_client.config.client_side_validation && statuspage_url_setting_id.nil?
    fail ArgumentError, "Missing the required parameter 'statuspage_url_setting_id' when calling StatuspageIntegrationAPI.delete_statuspage_url_setting"
  end
  # resource path
  local_var_path = '/api/v2/integration/statuspage/url_settings/{statuspage_url_setting_id}'.sub('{statuspage_url_setting_id}', CGI.escape(statuspage_url_setting_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]

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

#get_statuspage_account(opts = {}) ⇒ Object

Get the Statuspage account.

See Also:



289
290
291
292
 
# File 'lib/datadog_api_client/v2/api/statuspage_integration_api.rb', line 289

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

#get_statuspage_account_with_http_info(opts = {}) ⇒ Array<(StatuspageAccountResponse, Integer, Hash)>

Get the Statuspage account.

Get the Statuspage account configured for your organization.

Parameters:

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

    the optional parameters

Returns:

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

    StatuspageAccountResponse 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
337
338
339
340
341
342
343
344
 
# File 'lib/datadog_api_client/v2/api/statuspage_integration_api.rb', line 300

def (opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatuspageIntegrationAPI.get_statuspage_account ...'
  end
  # resource path
  local_var_path = '/api/v2/integration/statuspage/account'

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

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

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

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

#list_statuspage_url_settings(opts = {}) ⇒ Object

Get all Statuspage URL settings.

See Also:



349
350
351
352
 
# File 'lib/datadog_api_client/v2/api/statuspage_integration_api.rb', line 349

def list_statuspage_url_settings(opts = {})
  data, _status_code, _headers = list_statuspage_url_settings_with_http_info(opts)
  data
end

#list_statuspage_url_settings_with_http_info(opts = {}) ⇒ Array<(StatuspageUrlSettingsResponse, Integer, Hash)>

Get all Statuspage URL settings.

Get all Statuspage URL settings configured for your organization.

Parameters:

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

    the optional parameters

Returns:



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

def list_statuspage_url_settings_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatuspageIntegrationAPI.list_statuspage_url_settings ...'
  end
  # resource path
  local_var_path = '/api/v2/integration/statuspage/url_settings'

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

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

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

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

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

Update the Statuspage account.

See Also:



409
410
411
412
 
# File 'lib/datadog_api_client/v2/api/statuspage_integration_api.rb', line 409

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

#update_statuspage_account_with_http_info(body, opts = {}) ⇒ Array<(StatuspageAccountResponse, Integer, Hash)>

Update the Statuspage account.

Update the Statuspage account configured for your organization.

Parameters:

Returns:

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

    StatuspageAccountResponse data, response status code and response headers



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
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/datadog_api_client/v2/api/statuspage_integration_api.rb', line 421

def (body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatuspageIntegrationAPI.update_statuspage_account ...'
  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 StatuspageIntegrationAPI.update_statuspage_account"
  end
  # resource path
  local_var_path = '/api/v2/integration/statuspage/account'

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

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

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

#update_statuspage_url_setting(statuspage_url_setting_id, body, opts = {}) ⇒ Object

Update a Statuspage URL setting.

See Also:



476
477
478
479
 
# File 'lib/datadog_api_client/v2/api/statuspage_integration_api.rb', line 476

def update_statuspage_url_setting(statuspage_url_setting_id, body, opts = {})
  data, _status_code, _headers = update_statuspage_url_setting_with_http_info(statuspage_url_setting_id, body, opts)
  data
end

#update_statuspage_url_setting_with_http_info(statuspage_url_setting_id, body, opts = {}) ⇒ Array<(StatuspageUrlSettingResponse, Integer, Hash)>

Update a Statuspage URL setting.

Update a single Statuspage URL setting in your organization.

Parameters:

  • statuspage_url_setting_id (String) —

    The UUID of the Statuspage URL setting.

  • body (StatuspageUrlSettingUpdateRequest) —

    Statuspage URL setting payload.

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

    the optional parameters

Returns:



489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
 
# File 'lib/datadog_api_client/v2/api/statuspage_integration_api.rb', line 489

def update_statuspage_url_setting_with_http_info(statuspage_url_setting_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: StatuspageIntegrationAPI.update_statuspage_url_setting ...'
  end
  # verify the required parameter 'statuspage_url_setting_id' is set
  if @api_client.config.client_side_validation && statuspage_url_setting_id.nil?
    fail ArgumentError, "Missing the required parameter 'statuspage_url_setting_id' when calling StatuspageIntegrationAPI.update_statuspage_url_setting"
  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 StatuspageIntegrationAPI.update_statuspage_url_setting"
  end
  # resource path
  local_var_path = '/api/v2/integration/statuspage/url_settings/{statuspage_url_setting_id}'.sub('{statuspage_url_setting_id}', CGI.escape(statuspage_url_setting_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] || 'StatuspageUrlSettingResponse'

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

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