Class: Verizon::DeviceActionsController

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

Overview

DeviceActionsController

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

#get_asynchronous_request_status(account_name, request_id) ⇒ StatusResponse

Get the status of an asynchronous request made with the Device Actions.

Parameters:

  • account_name (String) —

    Required parameter: Example:

  • request_id (String) —

    Required parameter: Example:

Returns:



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
 
# File 'lib/verizon/controllers/device_actions_controller.rb', line 62

def get_asynchronous_request_status(,
                                    request_id)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/m2m/v2/accounts/{accountName}/requests/{requestID}/status',
                                 Server::THINGSPACE)
               .template_param(new_parameter(, key: 'accountName')
                                .should_encode(true))
               .template_param(new_parameter(request_id, key: 'requestID')
                                .should_encode(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Single.new('thingspace_oauth')))
    .response(new_response_handler
               .deserializer(APIHelper.method(:custom_type_deserializer))
               .deserialize_into(StatusResponse.method(:from_hash))
               .is_api_response(true)
               .local_error('default',
                            'Error response',
                            GIORestErrorResponseException))
    .execute
end

#retrieve_device_provisioning_history(body) ⇒ GIORequestResponse

Retreive the provisioning history of a specific device or devices. History

Parameters:

Returns:



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

def retrieve_device_provisioning_history(body)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/m2m/v2/devices/history/actions/list',
                                 Server::THINGSPACE)
               .header_param(new_parameter('application/json', 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(Single.new('thingspace_oauth')))
    .response(new_response_handler
               .deserializer(APIHelper.method(:custom_type_deserializer))
               .deserialize_into(GIORequestResponse.method(:from_hash))
               .is_api_response(true)
               .local_error('default',
                            'Error response',
                            GIORestErrorResponseException))
    .execute
end

#retrieve_the_global_device_list(body) ⇒ GIORequestResponse

Allows the profile to fetch the complete device list. This works with Verizon US and Global profiles. Profile Query

Parameters:

Returns:



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

def retrieve_the_global_device_list(body)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/m2m/v2/devices/actions/list',
                                 Server::THINGSPACE)
               .header_param(new_parameter('application/json', 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(Single.new('thingspace_oauth')))
    .response(new_response_handler
               .deserializer(APIHelper.method(:custom_type_deserializer))
               .deserialize_into(GIORequestResponse.method(:from_hash))
               .is_api_response(true)
               .local_error('default',
                            'Error response',
                            GIORestErrorResponseException))
    .execute
end