Class: DatadogAPIClient::V2::GoogleChatIntegrationAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of GoogleChatIntegrationAPI.



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

def api_client
  @api_client
end

Instance Method Details

#create_organization_handle(organization_binding_id, body, opts = {}) ⇒ Object

Create organization handle.

See Also:



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

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

#create_organization_handle_with_http_info(organization_binding_id, body, opts = {}) ⇒ Array<(GoogleChatOrganizationHandleResponse, Integer, Hash)>

Create organization handle.

Create an organization handle in the Datadog Google Chat integration.

Parameters:

  • organization_binding_id (String) —

    Your organization binding ID.

  • body (GoogleChatCreateOrganizationHandleRequest) —

    Organization handle payload.

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

    the optional 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
93
94
95
96
 
# File 'lib/datadog_api_client/v2/api/google_chat_integration_api.rb', line 42

def create_organization_handle_with_http_info(organization_binding_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GoogleChatIntegrationAPI.create_organization_handle ...'
  end
  # verify the required parameter 'organization_binding_id' is set
  if @api_client.config.client_side_validation && organization_binding_id.nil?
    fail ArgumentError, "Missing the required parameter 'organization_binding_id' when calling GoogleChatIntegrationAPI.create_organization_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 GoogleChatIntegrationAPI.create_organization_handle"
  end
  # resource path
  local_var_path = '/api/v2/integration/google-chat/organizations/{organization_binding_id}/organization-handles'.sub('{organization_binding_id}', CGI.escape(organization_binding_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] || 'GoogleChatOrganizationHandleResponse'

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

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

#delete_organization_handle(organization_binding_id, handle_id, opts = {}) ⇒ Object

Delete organization handle.

See Also:



101
102
103
104
 
# File 'lib/datadog_api_client/v2/api/google_chat_integration_api.rb', line 101

def delete_organization_handle(organization_binding_id, handle_id, opts = {})
  delete_organization_handle_with_http_info(organization_binding_id, handle_id, opts)
  nil
end

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

Delete organization handle.

Delete an organization handle from the Datadog Google Chat integration.

Parameters:

  • organization_binding_id (String) —

    Your organization binding ID.

  • handle_id (String) —

    Your organization handle ID.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
160
161
162
163
164
165
166
 
# File 'lib/datadog_api_client/v2/api/google_chat_integration_api.rb', line 114

def delete_organization_handle_with_http_info(organization_binding_id, handle_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GoogleChatIntegrationAPI.delete_organization_handle ...'
  end
  # verify the required parameter 'organization_binding_id' is set
  if @api_client.config.client_side_validation && organization_binding_id.nil?
    fail ArgumentError, "Missing the required parameter 'organization_binding_id' when calling GoogleChatIntegrationAPI.delete_organization_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 GoogleChatIntegrationAPI.delete_organization_handle"
  end
  # resource path
  local_var_path = '/api/v2/integration/google-chat/organizations/{organization_binding_id}/organization-handles/{handle_id}'.sub('{organization_binding_id}', CGI.escape(organization_binding_id.to_s).gsub('%2F', '/')).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_organization_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: GoogleChatIntegrationAPI#delete_organization_handle\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_organization_handle(organization_binding_id, handle_id, opts = {}) ⇒ Object

Get organization handle.

See Also:



171
172
173
174
 
# File 'lib/datadog_api_client/v2/api/google_chat_integration_api.rb', line 171

def get_organization_handle(organization_binding_id, handle_id, opts = {})
  data, _status_code, _headers = get_organization_handle_with_http_info(organization_binding_id, handle_id, opts)
  data
end

#get_organization_handle_with_http_info(organization_binding_id, handle_id, opts = {}) ⇒ Array<(GoogleChatOrganizationHandleResponse, Integer, Hash)>

Get organization handle.

Get an organization handle from the Datadog Google Chat integration.

Parameters:

  • organization_binding_id (String) —

    Your organization binding ID.

  • handle_id (String) —

    Your organization handle ID.

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

    the optional parameters

Returns:



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
232
233
234
235
236
 
# File 'lib/datadog_api_client/v2/api/google_chat_integration_api.rb', line 184

def get_organization_handle_with_http_info(organization_binding_id, handle_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GoogleChatIntegrationAPI.get_organization_handle ...'
  end
  # verify the required parameter 'organization_binding_id' is set
  if @api_client.config.client_side_validation && organization_binding_id.nil?
    fail ArgumentError, "Missing the required parameter 'organization_binding_id' when calling GoogleChatIntegrationAPI.get_organization_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 GoogleChatIntegrationAPI.get_organization_handle"
  end
  # resource path
  local_var_path = '/api/v2/integration/google-chat/organizations/{organization_binding_id}/organization-handles/{handle_id}'.sub('{organization_binding_id}', CGI.escape(organization_binding_id.to_s).gsub('%2F', '/')).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] || 'GoogleChatOrganizationHandleResponse'

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

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

#get_space_by_display_name(domain_name, space_display_name, opts = {}) ⇒ Object

Get space information by display name.

See Also:



241
242
243
244
 
# File 'lib/datadog_api_client/v2/api/google_chat_integration_api.rb', line 241

def get_space_by_display_name(domain_name, space_display_name, opts = {})
  data, _status_code, _headers = get_space_by_display_name_with_http_info(domain_name, space_display_name, opts)
  data
end

#get_space_by_display_name_with_http_info(domain_name, space_display_name, opts = {}) ⇒ Array<(GoogleChatAppNamedSpaceResponse, Integer, Hash)>

Get space information by display name.

Get the resource name and organization binding ID of a space in the Datadog Google Chat integration.

Parameters:

  • domain_name (String) —

    The Google Chat domain name.

  • space_display_name (String) —

    The Google Chat space display name.

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

    the optional parameters

Returns:



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
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/datadog_api_client/v2/api/google_chat_integration_api.rb', line 254

def get_space_by_display_name_with_http_info(domain_name, space_display_name, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GoogleChatIntegrationAPI.get_space_by_display_name ...'
  end
  # verify the required parameter 'domain_name' is set
  if @api_client.config.client_side_validation && domain_name.nil?
    fail ArgumentError, "Missing the required parameter 'domain_name' when calling GoogleChatIntegrationAPI.get_space_by_display_name"
  end
  # verify the required parameter 'space_display_name' is set
  if @api_client.config.client_side_validation && space_display_name.nil?
    fail ArgumentError, "Missing the required parameter 'space_display_name' when calling GoogleChatIntegrationAPI.get_space_by_display_name"
  end
  # resource path
  local_var_path = '/api/v2/integration/google-chat/organizations/app/named-spaces/{domain_name}/{space_display_name}'.sub('{domain_name}', CGI.escape(domain_name.to_s).gsub('%2F', '/')).sub('{space_display_name}', CGI.escape(space_display_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] || 'GoogleChatAppNamedSpaceResponse'

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

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

#list_organization_handles(organization_binding_id, opts = {}) ⇒ Object

Get all organization handles.

See Also:



311
312
313
314
 
# File 'lib/datadog_api_client/v2/api/google_chat_integration_api.rb', line 311

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

#list_organization_handles_with_http_info(organization_binding_id, opts = {}) ⇒ Array<(GoogleChatOrganizationHandlesResponse, Integer, Hash)>

Get all organization handles.

Get a list of all organization handles from the Datadog Google Chat integration.

Parameters:

  • organization_binding_id (String) —

    Your organization binding ID.

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

    the optional parameters

Returns:



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
362
363
364
365
366
367
368
369
370
371
 
# File 'lib/datadog_api_client/v2/api/google_chat_integration_api.rb', line 323

def list_organization_handles_with_http_info(organization_binding_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GoogleChatIntegrationAPI.list_organization_handles ...'
  end
  # verify the required parameter 'organization_binding_id' is set
  if @api_client.config.client_side_validation && organization_binding_id.nil?
    fail ArgumentError, "Missing the required parameter 'organization_binding_id' when calling GoogleChatIntegrationAPI.list_organization_handles"
  end
  # resource path
  local_var_path = '/api/v2/integration/google-chat/organizations/{organization_binding_id}/organization-handles'.sub('{organization_binding_id}', CGI.escape(organization_binding_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] || 'GoogleChatOrganizationHandlesResponse'

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

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

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

Update organization handle.

See Also:



376
377
378
379
 
# File 'lib/datadog_api_client/v2/api/google_chat_integration_api.rb', line 376

def update_organization_handle(organization_binding_id, handle_id, body, opts = {})
  data, _status_code, _headers = update_organization_handle_with_http_info(organization_binding_id, handle_id, body, opts)
  data
end

#update_organization_handle_with_http_info(organization_binding_id, handle_id, body, opts = {}) ⇒ Array<(GoogleChatOrganizationHandleResponse, Integer, Hash)>

Update organization handle.

Update an organization handle from the Datadog Google Chat integration.

Parameters:

  • organization_binding_id (String) —

    Your organization binding ID.

  • handle_id (String) —

    Your organization handle ID.

  • body (GoogleChatUpdateOrganizationHandleRequest) —

    Organization handle payload.

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

    the optional parameters

Returns:



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
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/datadog_api_client/v2/api/google_chat_integration_api.rb', line 390

def update_organization_handle_with_http_info(organization_binding_id, handle_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: GoogleChatIntegrationAPI.update_organization_handle ...'
  end
  # verify the required parameter 'organization_binding_id' is set
  if @api_client.config.client_side_validation && organization_binding_id.nil?
    fail ArgumentError, "Missing the required parameter 'organization_binding_id' when calling GoogleChatIntegrationAPI.update_organization_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 GoogleChatIntegrationAPI.update_organization_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 GoogleChatIntegrationAPI.update_organization_handle"
  end
  # resource path
  local_var_path = '/api/v2/integration/google-chat/organizations/{organization_binding_id}/organization-handles/{handle_id}'.sub('{organization_binding_id}', CGI.escape(organization_binding_id.to_s).gsub('%2F', '/')).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] || 'GoogleChatOrganizationHandleResponse'

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

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