Class: DatadogAPIClient::V2::WebhooksIntegrationAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of WebhooksIntegrationAPI.



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

def api_client
  @api_client
end

Instance Method Details

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

Create an OAuth2 client credentials auth method.

See Also:



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

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

#create_o_auth2_client_credentials_with_http_info(body, opts = {}) ⇒ Array<(WebhooksOAuth2ClientCredentialsResponse, Integer, Hash)>

Create an OAuth2 client credentials auth method.

Create a new OAuth2 client credentials auth method for the Webhooks integration. The client_secret is stored securely and never returned.

Parameters:

Returns:



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/webhooks_integration_api.rb', line 42

def create_o_auth2_client_credentials_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksIntegrationAPI.create_o_auth2_client_credentials ...'
  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 WebhooksIntegrationAPI.create_o_auth2_client_credentials"
  end
  # resource path
  local_var_path = '/api/v2/integration/webhooks/configuration/auth-method/oauth2-client-credentials'

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

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

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

#delete_o_auth2_client_credentials(auth_method_id, opts = {}) ⇒ Object

Delete an OAuth2 client credentials auth method.

See Also:



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

def delete_o_auth2_client_credentials(auth_method_id, opts = {})
  delete_o_auth2_client_credentials_with_http_info(auth_method_id, opts)
  nil
end

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

Delete an OAuth2 client credentials auth method.

Delete an OAuth2 client credentials auth method by ID.

Parameters:

  • auth_method_id (String) —

    The UUID of the auth method.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def delete_o_auth2_client_credentials_with_http_info(auth_method_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksIntegrationAPI.delete_o_auth2_client_credentials ...'
  end
  # verify the required parameter 'auth_method_id' is set
  if @api_client.config.client_side_validation && auth_method_id.nil?
    fail ArgumentError, "Missing the required parameter 'auth_method_id' when calling WebhooksIntegrationAPI.delete_o_auth2_client_credentials"
  end
  # resource path
  local_var_path = '/api/v2/integration/webhooks/configuration/auth-method/oauth2-client-credentials/{auth_method_id}'.sub('{auth_method_id}', CGI.escape(auth_method_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_o_auth2_client_credentials,
    :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: WebhooksIntegrationAPI#delete_o_auth2_client_credentials\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_auth_methods(opts = {}) ⇒ Object

Get all auth methods.

See Also:



162
163
164
165
 
# File 'lib/datadog_api_client/v2/api/webhooks_integration_api.rb', line 162

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

#get_all_auth_methods_with_http_info(opts = {}) ⇒ Array<(WebhooksAuthMethodsResponse, Integer, Hash)>

Get all auth methods.

Get a list of all auth methods configured for the Webhooks integration in your organization.

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    WebhooksAuthMethodsResponse data, 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
220
221
222
223
224
 
# File 'lib/datadog_api_client/v2/api/webhooks_integration_api.rb', line 175

def get_all_auth_methods_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksIntegrationAPI.get_all_auth_methods ...'
  end
  allowable_values = ['oauth2-client-credentials']
  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/integration/webhooks/configuration/auth-method'

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

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

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

#get_o_auth2_client_credentials(auth_method_id, opts = {}) ⇒ Object

Get an OAuth2 client credentials auth method.

See Also:



229
230
231
232
 
# File 'lib/datadog_api_client/v2/api/webhooks_integration_api.rb', line 229

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

#get_o_auth2_client_credentials_with_http_info(auth_method_id, opts = {}) ⇒ Array<(WebhooksOAuth2ClientCredentialsResponse, Integer, Hash)>

Get an OAuth2 client credentials auth method.

Get a single OAuth2 client credentials auth method by ID.

Parameters:

  • auth_method_id (String) —

    The UUID of the auth method.

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

    the optional parameters

Returns:



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
285
286
287
288
289
 
# File 'lib/datadog_api_client/v2/api/webhooks_integration_api.rb', line 241

def get_o_auth2_client_credentials_with_http_info(auth_method_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksIntegrationAPI.get_o_auth2_client_credentials ...'
  end
  # verify the required parameter 'auth_method_id' is set
  if @api_client.config.client_side_validation && auth_method_id.nil?
    fail ArgumentError, "Missing the required parameter 'auth_method_id' when calling WebhooksIntegrationAPI.get_o_auth2_client_credentials"
  end
  # resource path
  local_var_path = '/api/v2/integration/webhooks/configuration/auth-method/oauth2-client-credentials/{auth_method_id}'.sub('{auth_method_id}', CGI.escape(auth_method_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'])

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

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

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

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

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

#update_o_auth2_client_credentials(auth_method_id, body, opts = {}) ⇒ Object

Update an OAuth2 client credentials auth method.

See Also:



294
295
296
297
 
# File 'lib/datadog_api_client/v2/api/webhooks_integration_api.rb', line 294

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

#update_o_auth2_client_credentials_with_http_info(auth_method_id, body, opts = {}) ⇒ Array<(WebhooksOAuth2ClientCredentialsResponse, Integer, Hash)>

Update an OAuth2 client credentials auth method.

Update an existing OAuth2 client credentials auth method.

Parameters:

Returns:



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
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/datadog_api_client/v2/api/webhooks_integration_api.rb', line 307

def update_o_auth2_client_credentials_with_http_info(auth_method_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: WebhooksIntegrationAPI.update_o_auth2_client_credentials ...'
  end
  # verify the required parameter 'auth_method_id' is set
  if @api_client.config.client_side_validation && auth_method_id.nil?
    fail ArgumentError, "Missing the required parameter 'auth_method_id' when calling WebhooksIntegrationAPI.update_o_auth2_client_credentials"
  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 WebhooksIntegrationAPI.update_o_auth2_client_credentials"
  end
  # resource path
  local_var_path = '/api/v2/integration/webhooks/configuration/auth-method/oauth2-client-credentials/{auth_method_id}'.sub('{auth_method_id}', CGI.escape(auth_method_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] || 'WebhooksOAuth2ClientCredentialsResponse'

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

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