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

#account_information(account_name) ⇒ ApiResponse

Retrieve all of the service plans, features and carriers associated with the account specified.

Parameters:

  • account_name (String) —

    Required parameter: Example:

Returns:

  • (ApiResponse) —

    the complete http response with raw body and status code.



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/verizon/controllers/device_actions_controller.rb', line 83

def ()
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/v1/accounts/{accountName}',
                                 Server::THINGSPACE)
               .template_param(new_parameter(, key: 'accountName')
                                .should_encode(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(AccountDetails.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             GIORestErrorResponseException))
    .execute
end

#aggregate_usage(body) ⇒ ApiResponse

Retrieve the aggregate usage for a device or a number of devices.

Parameters:

Returns:

  • (ApiResponse) —

    the complete http response with raw body and status code.



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

def aggregate_usage(body)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/v1/devices/usage/actions/list/aggregate',
                                 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(And.new('thingspace_oauth', 'VZ-M2M-Token')))
    .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

#daily_usage(body) ⇒ ApiResponse

Retrieve the daily usage for a device, for a specified period of time, segmented by day

Parameters:

  • body (DailyUsage) —

    Required parameter: Example:

Returns:

  • (ApiResponse) —

    the complete http response with raw body and status code.



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

def daily_usage(body)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/v1/devices/usage/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(And.new('thingspace_oauth', 'VZ-M2M-Token')))
    .response(new_response_handler
                .deserializer(APIHelper.method(:custom_type_deserializer))
                .deserialize_into(DailyUsageResponse.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             GIORestErrorResponseException))
    .execute
end

#get_asynchronous_request_status(account_name, request_id) ⇒ ApiResponse

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:

  • (ApiResponse) —

    the complete http response with raw body and status code.



155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
 
# File 'lib/verizon/controllers/device_actions_controller.rb', line 155

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(And.new('thingspace_oauth', 'VZ-M2M-Token')))
    .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) ⇒ ApiResponse

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

Parameters:

Returns:

  • (ApiResponse) —

    the complete http response with raw body and status code.



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
 
# File 'lib/verizon/controllers/device_actions_controller.rb', line 131

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(And.new('thingspace_oauth', 'VZ-M2M-Token')))
    .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) ⇒ ApiResponse

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

Parameters:

Returns:

  • (ApiResponse) —

    the complete http response with raw body and status code.



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/verizon/controllers/device_actions_controller.rb', line 107

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(And.new('thingspace_oauth', 'VZ-M2M-Token')))
    .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

#service_plan_list(account_name) ⇒ ApiResponse

Retrieve all of the service plans, features and carriers associated with the account specified.

Parameters:

  • account_name (String) —

    Required parameter: Example:

Returns:

  • (ApiResponse) —

    the complete http response with raw body and status code.



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

def service_plan_list()
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/v1/plans/{accountName}',
                                 Server::THINGSPACE)
               .template_param(new_parameter(, key: 'accountName')
                                .should_encode(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(AccountDetails.method(:from_hash))
                .is_api_response(true)
                .local_error('default',
                             'Error response',
                             GIORestErrorResponseException))
    .execute
end