Class: DatadogAPIClient::V2::MicrosoftTeamsIntegrationAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of MicrosoftTeamsIntegrationAPI.



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

def api_client
  @api_client
end

Instance Method Details

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

Create tenant-based handle.

See Also:



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

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

#create_tenant_based_handle_with_http_info(body, opts = {}) ⇒ Array<(MicrosoftTeamsTenantBasedHandleResponse, Integer, Hash)>

Create tenant-based handle.

Create a tenant-based handle in the Datadog Microsoft Teams integration.

Parameters:

Returns:



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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
 
# File 'lib/datadog_api_client/v2/api/microsoft_teams_integration_api.rb', line 41

def create_tenant_based_handle_with_http_info(body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MicrosoftTeamsIntegrationAPI.create_tenant_based_handle ...'
  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 MicrosoftTeamsIntegrationAPI.create_tenant_based_handle"
  end
  # resource path
  local_var_path = '/api/v2/integration/ms-teams/configuration/tenant-based-handles'

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

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

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

#delete_tenant_based_handle(handle_id, opts = {}) ⇒ Object

Delete tenant-based handle.

See Also:



96
97
98
99
 
# File 'lib/datadog_api_client/v2/api/microsoft_teams_integration_api.rb', line 96

def delete_tenant_based_handle(handle_id, opts = {})
  delete_tenant_based_handle_with_http_info(handle_id, opts)
  nil
end

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

Delete tenant-based handle.

Delete a tenant-based handle from the Datadog Microsoft Teams integration.

Parameters:

  • handle_id (String) —

    Your tenant-based handle id.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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

def delete_tenant_based_handle_with_http_info(handle_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MicrosoftTeamsIntegrationAPI.delete_tenant_based_handle ...'
  end
  # verify the required parameter 'handle_id' is set
  if @api_client.config.client_side_validation && handle_id.nil?
    fail ArgumentError, "Missing the required parameter 'handle_id' when calling MicrosoftTeamsIntegrationAPI.delete_tenant_based_handle"
  end
  # resource path
  local_var_path = '/api/v2/integration/ms-teams/configuration/tenant-based-handles/{handle_id}'.sub('{handle_id}', CGI.escape(handle_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_tenant_based_handle,
    :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: MicrosoftTeamsIntegrationAPI#delete_tenant_based_handle\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_channel_by_name(tenant_name, team_name, channel_name, opts = {}) ⇒ Object

Get channel information by name.

See Also:



161
162
163
164
 
# File 'lib/datadog_api_client/v2/api/microsoft_teams_integration_api.rb', line 161

def get_channel_by_name(tenant_name, team_name, channel_name, opts = {})
  data, _status_code, _headers = get_channel_by_name_with_http_info(tenant_name, team_name, channel_name, opts)
  data
end

#get_channel_by_name_with_http_info(tenant_name, team_name, channel_name, opts = {}) ⇒ Array<(MicrosoftTeamsGetChannelByNameResponse, Integer, Hash)>

Get channel information by name.

Get the tenant, team, and channel ID of a channel in the Datadog Microsoft Teams integration.

Parameters:

  • tenant_name (String) —

    Your tenant name.

  • team_name (String) —

    Your team name.

  • channel_name (String) —

    Your channel name.

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

    the optional parameters

Returns:



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
225
226
227
228
229
230
231
 
# File 'lib/datadog_api_client/v2/api/microsoft_teams_integration_api.rb', line 175

def get_channel_by_name_with_http_info(tenant_name, team_name, channel_name, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MicrosoftTeamsIntegrationAPI.get_channel_by_name ...'
  end
  # verify the required parameter 'tenant_name' is set
  if @api_client.config.client_side_validation && tenant_name.nil?
    fail ArgumentError, "Missing the required parameter 'tenant_name' when calling MicrosoftTeamsIntegrationAPI.get_channel_by_name"
  end
  # verify the required parameter 'team_name' is set
  if @api_client.config.client_side_validation && team_name.nil?
    fail ArgumentError, "Missing the required parameter 'team_name' when calling MicrosoftTeamsIntegrationAPI.get_channel_by_name"
  end
  # verify the required parameter 'channel_name' is set
  if @api_client.config.client_side_validation && channel_name.nil?
    fail ArgumentError, "Missing the required parameter 'channel_name' when calling MicrosoftTeamsIntegrationAPI.get_channel_by_name"
  end
  # resource path
  local_var_path = '/api/v2/integration/ms-teams/configuration/channel/{tenant_name}/{team_name}/{channel_name}'.sub('{tenant_name}', CGI.escape(tenant_name.to_s).gsub('%2F', '/')).sub('{team_name}', CGI.escape(team_name.to_s).gsub('%2F', '/')).sub('{channel_name}', CGI.escape(channel_name.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] || 'MicrosoftTeamsGetChannelByNameResponse'

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

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

#get_tenant_based_handle(handle_id, opts = {}) ⇒ Object

Get tenant-based handle information.

See Also:



236
237
238
239
 
# File 'lib/datadog_api_client/v2/api/microsoft_teams_integration_api.rb', line 236

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

#get_tenant_based_handle_with_http_info(handle_id, opts = {}) ⇒ Array<(MicrosoftTeamsTenantBasedHandleResponse, Integer, Hash)>

Get tenant-based handle information.

Get the tenant, team, and channel information of a tenant-based handle from the Datadog Microsoft Teams integration.

Parameters:

  • handle_id (String) —

    Your tenant-based handle id.

  • 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
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/datadog_api_client/v2/api/microsoft_teams_integration_api.rb', line 248

def get_tenant_based_handle_with_http_info(handle_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MicrosoftTeamsIntegrationAPI.get_tenant_based_handle ...'
  end
  # verify the required parameter 'handle_id' is set
  if @api_client.config.client_side_validation && handle_id.nil?
    fail ArgumentError, "Missing the required parameter 'handle_id' when calling MicrosoftTeamsIntegrationAPI.get_tenant_based_handle"
  end
  # resource path
  local_var_path = '/api/v2/integration/ms-teams/configuration/tenant-based-handles/{handle_id}'.sub('{handle_id}', CGI.escape(handle_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] || 'MicrosoftTeamsTenantBasedHandleResponse'

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

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

#list_tenant_based_handles(opts = {}) ⇒ Object

Get all tenant-based handles.

See Also:



301
302
303
304
 
# File 'lib/datadog_api_client/v2/api/microsoft_teams_integration_api.rb', line 301

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

#list_tenant_based_handles_with_http_info(opts = {}) ⇒ Array<(MicrosoftTeamsTenantBasedHandlesResponse, Integer, Hash)>

Get all tenant-based handles.

Get a list of all tenant-based handles from the Datadog Microsoft Teams integration.

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :tenant_id (String) —

    Your tenant id.

  • :name (String) —

    Your tenant-based handle name.

Returns:



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

def list_tenant_based_handles_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MicrosoftTeamsIntegrationAPI.list_tenant_based_handles ...'
  end
  # resource path
  local_var_path = '/api/v2/integration/ms-teams/configuration/tenant-based-handles'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'tenant_id'] = opts[:'tenant_id'] if !opts[:'tenant_id'].nil?
  query_params[:'name'] = opts[:'name'] if !opts[:'name'].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] || 'MicrosoftTeamsTenantBasedHandlesResponse'

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

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

#update_tenant_based_handle(handle_id, body, opts = {}) ⇒ Object

Update tenant-based handle.

See Also:



365
366
367
368
 
# File 'lib/datadog_api_client/v2/api/microsoft_teams_integration_api.rb', line 365

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

#update_tenant_based_handle_with_http_info(handle_id, body, opts = {}) ⇒ Array<(MicrosoftTeamsTenantBasedHandleResponse, Integer, Hash)>

Update tenant-based handle.

Update a tenant-based handle from the Datadog Microsoft Teams integration.

Parameters:

Returns:



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
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/datadog_api_client/v2/api/microsoft_teams_integration_api.rb', line 378

def update_tenant_based_handle_with_http_info(handle_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MicrosoftTeamsIntegrationAPI.update_tenant_based_handle ...'
  end
  # verify the required parameter 'handle_id' is set
  if @api_client.config.client_side_validation && handle_id.nil?
    fail ArgumentError, "Missing the required parameter 'handle_id' when calling MicrosoftTeamsIntegrationAPI.update_tenant_based_handle"
  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 MicrosoftTeamsIntegrationAPI.update_tenant_based_handle"
  end
  # resource path
  local_var_path = '/api/v2/integration/ms-teams/configuration/tenant-based-handles/{handle_id}'.sub('{handle_id}', CGI.escape(handle_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] || 'MicrosoftTeamsTenantBasedHandleResponse'

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

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