Class: Verizon::SoftwareManagementCallbacksV3Controller

Inherits:
BaseController
  • Object
show all
Defined in:
lib/verizon/controllers/software_management_callbacks_v3_controller.rb

Overview

SoftwareManagementCallbacksV3Controller

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

#deregister_callback(acc) ⇒ FotaV3SuccessResult

This endpoint allows user to delete a previously registered callback URL.

Parameters:

  • acc (String) —

    Required parameter: Account identifier.

Returns:



90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/verizon/controllers/software_management_callbacks_v3_controller.rb', line 90

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

#list_registered_callbacks(acc) ⇒ FotaV3CallbackSummary

This endpoint allows user to get the registered callback information.

Parameters:

  • acc (String) —

    Required parameter: Account identifier.

Returns:



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

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

#register_callback(acc, body) ⇒ FotaV3CallbackRegistrationResult

This endpoint allows the user to create the HTTPS callback address. Callback URL registration.

Parameters:

Returns:



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

def register_callback(acc,
                      body)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/callbacks/{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(Single.new('oAuth2')))
    .response(new_response_handler
               .deserializer(APIHelper.method(:custom_type_deserializer))
               .deserialize_into(FotaV3CallbackRegistrationResult.method(:from_hash))
               .is_api_response(true)
               .local_error('400',
                            'Unexpected error.',
                            FotaV3ResultException))
    .execute
end

#update_callback(acc, body) ⇒ FotaV3CallbackRegistrationResult

This endpoint allows the user to update the HTTPS callback address. Callback URL registration.

Parameters:

Returns:



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

def update_callback(acc,
                    body)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::PUT,
                                 '/callbacks/{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(Single.new('oAuth2')))
    .response(new_response_handler
               .deserializer(APIHelper.method(:custom_type_deserializer))
               .deserialize_into(FotaV3CallbackRegistrationResult.method(:from_hash))
               .is_api_response(true)
               .local_error('400',
                            'Unexpected error.',
                            FotaV3ResultException))
    .execute
end