Class: Verizon::FirmwareV1Controller

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

Overview

FirmwareV1Controller

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

#cancel_scheduled_firmware_upgrade(account, upgrade_id) ⇒ FotaV1SuccessResult

Cancel a scheduled firmware upgrade. “##########-#####”. upgrade that you want to cancel.

Parameters:

  • account (String) —

    Required parameter: Account identifier in

  • upgrade_id (String) —

    Required parameter: The UUID of the scheduled

Returns:



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

def cancel_scheduled_firmware_upgrade(,
                                      upgrade_id)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::DELETE,
                                 '/upgrades/{account}/upgrade/{upgradeId}',
                                 Server::SOFTWARE_MANAGEMENT_V1)
               .template_param(new_parameter(, key: 'account')
                                .should_encode(true))
               .template_param(new_parameter(upgrade_id, key: 'upgradeId')
                                .should_encode(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Single.new('oAuth2')))
    .response(new_response_handler
               .deserializer(APIHelper.method(:custom_type_deserializer))
               .deserialize_into(FotaV1SuccessResult.method(:from_hash))
               .is_api_response(true)
               .local_error('400',
                            'Unexpected error.',
                            FotaV1ResultException))
    .execute
end

#list_available_firmware(account) ⇒ Array[Firmware]

Lists all device firmware images available for an account, based on the devices registered to that account. “##########-#####”.

Parameters:

  • account (String) —

    Required parameter: Account identifier in

Returns:

  • (Array[Firmware]) —

    response from the API call



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

def list_available_firmware()
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/firmware/{account}',
                                 Server::SOFTWARE_MANAGEMENT_V1)
               .template_param(new_parameter(, key: 'account')
                                .should_encode(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Single.new('oAuth2')))
    .response(new_response_handler
               .deserializer(APIHelper.method(:custom_type_deserializer))
               .deserialize_into(Firmware.method(:from_hash))
               .is_api_response(true)
               .is_response_array(true)
               .local_error('400',
                            'Unexpected error.',
                            FotaV1ResultException))
    .execute
end

#list_firmware_upgrade_details(account, upgrade_id) ⇒ FirmwareUpgrade

Returns information about a specified upgrade, include the target date of the upgrade, the list of devices in the upgrade, and the status of the upgrade for each device. “##########-#####”. returned by POST /upgrades when the upgrade was scheduled.

Parameters:

  • account (String) —

    Required parameter: Account identifier in

  • upgrade_id (String) —

    Required parameter: The UUID of the upgrade,

Returns:



66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
 
# File 'lib/verizon/controllers/firmware_v1_controller.rb', line 66

def list_firmware_upgrade_details(,
                                  upgrade_id)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/upgrades/{account}/upgrade/{upgradeId}',
                                 Server::SOFTWARE_MANAGEMENT_V1)
               .template_param(new_parameter(, key: 'account')
                                .should_encode(true))
               .template_param(new_parameter(upgrade_id, key: 'upgradeId')
                                .should_encode(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Single.new('oAuth2')))
    .response(new_response_handler
               .deserializer(APIHelper.method(:custom_type_deserializer))
               .deserialize_into(FirmwareUpgrade.method(:from_hash))
               .is_api_response(true)
               .local_error('400',
                            'Unexpected error.',
                            FotaV1ResultException))
    .execute
end

#schedule_firmware_upgrade(body) ⇒ FirmwareUpgrade

Schedules a firmware upgrade for devices. firmware upgrade request.

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/firmware_v1_controller.rb', line 38

def schedule_firmware_upgrade(body)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/upgrades',
                                 Server::SOFTWARE_MANAGEMENT_V1)
               .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('oAuth2')))
    .response(new_response_handler
               .deserializer(APIHelper.method(:custom_type_deserializer))
               .deserialize_into(FirmwareUpgrade.method(:from_hash))
               .is_api_response(true)
               .local_error('400',
                            'Unexpected error.',
                            FotaV1ResultException))
    .execute
end

#update_firmware_upgrade_devices(account, upgrade_id, body) ⇒ FirmwareUpgradeChangeResult

Add or remove devices from a scheduled upgrade. “##########-#####”. returned by POST /upgrades when the upgrade was scheduled. devices to add or remove.

Parameters:

  • account (String) —

    Required parameter: Account identifier in

  • upgrade_id (String) —

    Required parameter: The UUID of the upgrade,

  • body (FirmwareUpgradeChangeRequest) —

    Required parameter: List of

Returns:



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/verizon/controllers/firmware_v1_controller.rb', line 96

def update_firmware_upgrade_devices(,
                                    upgrade_id,
                                    body)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::PUT,
                                 '/upgrades/{account}/upgrade/{upgradeId}',
                                 Server::SOFTWARE_MANAGEMENT_V1)
               .template_param(new_parameter(, key: 'account')
                                .should_encode(true))
               .template_param(new_parameter(upgrade_id, key: 'upgradeId')
                                .should_encode(true))
               .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(Single.new('oAuth2')))
    .response(new_response_handler
               .deserializer(APIHelper.method(:custom_type_deserializer))
               .deserialize_into(FirmwareUpgradeChangeResult.method(:from_hash))
               .is_api_response(true)
               .local_error('400',
                            'Unexpected error.',
                            FotaV1ResultException))
    .execute
end