Class: Verizon::DiagnosticsSettingsApi

Inherits:
BaseApi
  • Object
show all
Defined in:
lib/verizon/apis/diagnostics_settings_api.rb

Overview

DiagnosticsSettingsApi

Constant Summary

Constants inherited from BaseApi

BaseApi::GLOBAL_ERRORS

Instance Attribute Summary

Attributes inherited from BaseApi

#config, #http_call_back

Instance Method Summary collapse

Methods inherited from BaseApi

#initialize, #new_parameter, #new_request_builder, #new_response_handler, user_agent, user_agent_parameters

Constructor Details

This class inherits a constructor from Verizon::BaseApi

Instance Method Details

#list_diagnostics_settings(account_name, devices) ⇒ ApiResponse

This endpoint retrieves diagnostics settings synchronously. kind“

Parameters:

  • account_name (String) —

    Required parameter: Account identifier.

  • devices (String) —

    Required parameter: Devices list formatted as “id,

Returns:

  • (ApiResponse) —

    Complete http response with raw body and status code.



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/verizon/apis/diagnostics_settings_api.rb', line 14

def list_diagnostics_settings(,
                              devices)
  @api_call
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/devices/settings',
                                 Server::DEVICE_DIAGNOSTICS)
               .query_param(new_parameter(, key: 'accountName')
                             .is_required(true))
               .query_param(new_parameter(devices, key: 'devices')
                             .is_required(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(And.new('thingspace_oauth', 'VZ-M2M-Token')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(DiagnosticObservationSetting.method(:from_hash))
                .is_api_response(true)
                .is_response_array(true)
                .local_error('default',
                             'Error response.',
                             DeviceDiagnosticsResultException))
    .execute
end