Class: DatadogAPIClient::V2::CaseManagementAttributeAPI

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of CaseManagementAttributeAPI.



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

def api_client
  @api_client
end

Instance Method Details

#create_custom_attribute_config(case_type_id, body, opts = {}) ⇒ Object

Create custom attribute config for a case type.

See Also:



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

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

#create_custom_attribute_config_with_http_info(case_type_id, body, opts = {}) ⇒ Array<(CustomAttributeConfigResponse, Integer, Hash)>

Create custom attribute config for a case type.

Create custom attribute config for a case type

Parameters:

  • case_type_id (String) —

    The UUID of the case type.

  • body (CustomAttributeConfigCreateRequest) —

    Custom attribute config 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/case_management_attribute_api.rb', line 42

def create_custom_attribute_config_with_http_info(case_type_id, body, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CaseManagementAttributeAPI.create_custom_attribute_config ...'
  end
  # verify the required parameter 'case_type_id' is set
  if @api_client.config.client_side_validation && case_type_id.nil?
    fail ArgumentError, "Missing the required parameter 'case_type_id' when calling CaseManagementAttributeAPI.create_custom_attribute_config"
  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 CaseManagementAttributeAPI.create_custom_attribute_config"
  end
  # resource path
  local_var_path = '/api/v2/cases/types/{case_type_id}/custom_attributes'.sub('{case_type_id}', CGI.escape(case_type_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] || 'CustomAttributeConfigResponse'

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

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

#delete_custom_attribute_config(case_type_id, custom_attribute_id, opts = {}) ⇒ Object

Delete custom attributes config.

See Also:



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

def delete_custom_attribute_config(case_type_id, custom_attribute_id, opts = {})
  delete_custom_attribute_config_with_http_info(case_type_id, custom_attribute_id, opts)
  nil
end

#delete_custom_attribute_config_with_http_info(case_type_id, custom_attribute_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

Delete custom attributes config.

Delete custom attribute config

Parameters:

  • case_type_id (String) —

    The UUID of the case type.

  • custom_attribute_id (String) —

    Case Custom attribute's UUID

  • 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/case_management_attribute_api.rb', line 114

def delete_custom_attribute_config_with_http_info(case_type_id, custom_attribute_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CaseManagementAttributeAPI.delete_custom_attribute_config ...'
  end
  # verify the required parameter 'case_type_id' is set
  if @api_client.config.client_side_validation && case_type_id.nil?
    fail ArgumentError, "Missing the required parameter 'case_type_id' when calling CaseManagementAttributeAPI.delete_custom_attribute_config"
  end
  # verify the required parameter 'custom_attribute_id' is set
  if @api_client.config.client_side_validation && custom_attribute_id.nil?
    fail ArgumentError, "Missing the required parameter 'custom_attribute_id' when calling CaseManagementAttributeAPI.delete_custom_attribute_config"
  end
  # resource path
  local_var_path = '/api/v2/cases/types/{case_type_id}/custom_attributes/{custom_attribute_id}'.sub('{case_type_id}', CGI.escape(case_type_id.to_s).gsub('%2F', '/')).sub('{custom_attribute_id}', CGI.escape(custom_attribute_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_custom_attribute_config,
    :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: CaseManagementAttributeAPI#delete_custom_attribute_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_all_custom_attribute_configs_by_case_type(case_type_id, opts = {}) ⇒ Object

Get all custom attributes config of case type.

See Also:



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

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

#get_all_custom_attribute_configs_by_case_type_with_http_info(case_type_id, opts = {}) ⇒ Array<(CustomAttributeConfigsResponse, Integer, Hash)>

Get all custom attributes config of case type.

Get all custom attribute config of case type

Parameters:

  • case_type_id (String) —

    The UUID of the case type.

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

    the optional parameters

Returns:



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/case_management_attribute_api.rb', line 183

def get_all_custom_attribute_configs_by_case_type_with_http_info(case_type_id, opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CaseManagementAttributeAPI.get_all_custom_attribute_configs_by_case_type ...'
  end
  # verify the required parameter 'case_type_id' is set
  if @api_client.config.client_side_validation && case_type_id.nil?
    fail ArgumentError, "Missing the required parameter 'case_type_id' when calling CaseManagementAttributeAPI.get_all_custom_attribute_configs_by_case_type"
  end
  # resource path
  local_var_path = '/api/v2/cases/types/{case_type_id}/custom_attributes'.sub('{case_type_id}', CGI.escape(case_type_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] || 'CustomAttributeConfigsResponse'

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

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

#get_all_custom_attributes(opts = {}) ⇒ Object

Get all custom attributes.

See Also:



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

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

#get_all_custom_attributes_with_http_info(opts = {}) ⇒ Array<(CustomAttributeConfigsResponse, Integer, Hash)>

Get all custom attributes.

Get all custom attributes

Parameters:

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

    the optional parameters

Returns:



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
290
291
 
# File 'lib/datadog_api_client/v2/api/case_management_attribute_api.rb', line 247

def get_all_custom_attributes_with_http_info(opts = {})

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CaseManagementAttributeAPI.get_all_custom_attributes ...'
  end
  # resource path
  local_var_path = '/api/v2/cases/types/custom_attributes'

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

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

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

#update_custom_attribute_config(case_type_id, custom_attribute_id, body, opts = {}) ⇒ Object

Update custom attribute config.

See Also:



296
297
298
299
 
# File 'lib/datadog_api_client/v2/api/case_management_attribute_api.rb', line 296

def update_custom_attribute_config(case_type_id, custom_attribute_id, body, opts = {})
  data, _status_code, _headers = update_custom_attribute_config_with_http_info(case_type_id, custom_attribute_id, body, opts)
  data
end

#update_custom_attribute_config_with_http_info(case_type_id, custom_attribute_id, body, opts = {}) ⇒ Array<(CustomAttributeConfigResponse, Integer, Hash)>

Update custom attribute config.

Updates the display name, description, type, or options of an existing custom attribute configuration for a case type.

Parameters:

  • case_type_id (String) —

    The UUID of the case type.

  • custom_attribute_id (String) —

    Case Custom attribute's UUID

  • body (CustomAttributeConfigUpdateRequest) —

    Custom attribute config payload.

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

    the optional parameters

Returns:



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

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

  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: CaseManagementAttributeAPI.update_custom_attribute_config ...'
  end
  # verify the required parameter 'case_type_id' is set
  if @api_client.config.client_side_validation && case_type_id.nil?
    fail ArgumentError, "Missing the required parameter 'case_type_id' when calling CaseManagementAttributeAPI.update_custom_attribute_config"
  end
  # verify the required parameter 'custom_attribute_id' is set
  if @api_client.config.client_side_validation && custom_attribute_id.nil?
    fail ArgumentError, "Missing the required parameter 'custom_attribute_id' when calling CaseManagementAttributeAPI.update_custom_attribute_config"
  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 CaseManagementAttributeAPI.update_custom_attribute_config"
  end
  # resource path
  local_var_path = '/api/v2/cases/types/{case_type_id}/custom_attributes/{custom_attribute_id}'.sub('{case_type_id}', CGI.escape(case_type_id.to_s).gsub('%2F', '/')).sub('{custom_attribute_id}', CGI.escape(custom_attribute_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] || 'CustomAttributeConfigResponse'

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

  new_options = opts.merge(
    :operation => :update_custom_attribute_config,
    :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::Put, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: CaseManagementAttributeAPI#update_custom_attribute_config\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end