Class: Verizon::AccountDevicesController

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

Overview

AccountDevicesController

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_account_device_information(acc, last_seen_device_id: nil, protocol: DevicesProtocolEnum::LW_M2M) ⇒ V3AccountDeviceList

Retrieve account device information such as reported firmware on the devices. identifier. retrieve a specific protocol type used.

Parameters:

  • acc (String) —

    Required parameter: Account identifier.

  • last_seen_device_id (String) (defaults to: nil) —

    Optional parameter: Last seen device

  • protocol (DevicesProtocolEnum) (defaults to: DevicesProtocolEnum::LW_M2M) —

    Optional parameter: Filter to

Returns:



17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/verizon/controllers/account_devices_controller.rb', line 17

def (acc,
                                   last_seen_device_id: nil,
                                   protocol: DevicesProtocolEnum::LW_M2M)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/devices/{acc}',
                                 Server::SOFTWARE_MANAGEMENT_V3)
               .template_param(new_parameter(acc, key: 'acc')
                                .should_encode(true))
               .query_param(new_parameter(last_seen_device_id, key: 'lastSeenDeviceId'))
               .query_param(new_parameter(protocol, key: 'protocol'))
               .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(V3AccountDeviceList.method(:from_hash))
               .is_api_response(true)
               .local_error('400',
                            'Unexpected error.',
                            FotaV3ResultException))
    .execute
end

#list_account_devices_information(acc, body) ⇒ DeviceListResult

Retrieve device information for a list of devices on an account. information.

Parameters:

  • acc (String) —

    Required parameter: Account identifier.

  • body (DeviceIMEI) —

    Required parameter: Request device list

Returns:



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
 
# File 'lib/verizon/controllers/account_devices_controller.rb', line 45

def (acc,
                                     body)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/devices/{acc}',
                                 Server::SOFTWARE_MANAGEMENT_V3)
               .template_param(new_parameter(acc, key: 'acc')
                                .should_encode(true))
               .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(DeviceListResult.method(:from_hash))
               .is_api_response(true)
               .local_error('400',
                            'Unexpected error.',
                            FotaV3ResultException))
    .execute
end