Class: Verizon::DiagnosticsObservationsController

Inherits:
BaseController show all
Defined in:
lib/verizon/controllers/diagnostics_observations_controller.rb

Overview

DiagnosticsObservationsController

Constant Summary

Constants inherited from BaseController

BaseController::GLOBAL_ERRORS

Instance Attribute Summary

Attributes inherited from BaseController

#config, #http_call_back

Instance Method Summary collapse

Methods inherited from BaseController

#initialize, #new_api_call_builder, #new_parameter, #new_request_builder, #new_response_handler, user_agent

Constructor Details

This class inherits a constructor from Verizon::BaseController

Instance Method Details

#start_diagnostics_observation(body) ⇒ ApiResponse

This endpoint allows the user to start or change observe diagnostics. observation information.

Parameters:

Returns:

  • (ApiResponse) —

    the complete http response with raw body and status code.



13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'lib/verizon/controllers/diagnostics_observations_controller.rb', line 13

def start_diagnostics_observation(body)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/devices/attributes/actions/observe',
                                 Server::DEVICE_DIAGNOSTICS)
               .header_param(new_parameter('*/*', key: 'Content-Type'))
               .body_param(new_parameter(body))
               .header_param(new_parameter('application/json', key: 'accept'))
               .body_serializer(proc do |param| param.to_json unless param.nil? end)
               .auth(And.new('thingspace_oauth', 'VZ-M2M-Token')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(DiagnosticsObservationResult.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             DeviceDiagnosticsResultException))
    .execute
end

#stop_diagnostics_observation(transaction_id, account_name) ⇒ ApiResponse

This endpoint allows the user to stop or reset observe diagnostics. with the transaction. name.

Parameters:

  • transaction_id (String) —

    Required parameter: The ID value associated

  • account_name (String) —

    Required parameter: The numeric account

Returns:

  • (ApiResponse) —

    the complete http response with raw body and status code.



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
 
# File 'lib/verizon/controllers/diagnostics_observations_controller.rb', line 39

def stop_diagnostics_observation(transaction_id,
                                 )
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::DELETE,
                                 '/devices/attributes/actions/observe',
                                 Server::DEVICE_DIAGNOSTICS)
               .query_param(new_parameter(transaction_id, key: 'transactionId'))
               .query_param(new_parameter(, key: 'accountName'))
               .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(DiagnosticsObservationResult.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response.',
                             DeviceDiagnosticsResultException))
    .execute
end