Class: Verizon::SIMSecureForIoTLicensesController

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

Overview

SIMSecureForIoTLicensesController

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

#assign_license_to_devices(body, x_request_id: nil) ⇒ ApiResponse

Assigns SIM-Secure for IoT licenses to SIMs. license to devices.

Parameters:

  • body (AssignLicenseRequest) —

    Required parameter: Request to assign

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

    Optional parameter: Transaction Id.

Returns:

  • (ApiResponse) —

    the complete http response with raw body and status code.



14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/verizon/controllers/sim_secure_for_io_t_licenses_controller.rb', line 14

def assign_license_to_devices(body,
                              x_request_id: nil)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/v1/devices/license/actions/assign',
                                 Server::M2M)
               .header_param(new_parameter('application/json', key: 'Content-Type'))
               .body_param(new_parameter(body))
               .header_param(new_parameter(x_request_id, key: 'X-Request-ID'))
               .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(SecuritySuccessResult.method(:from_hash))
                .is_api_response(true)
                .local_error('400',
                             'Bad request.',
                             SecurityResultException)
                .local_error('401',
                             'Unauthorized request.',
                             SecurityResultException)
                .local_error('403',
                             'Request Forbidden.',
                             SecurityResultException)
                .local_error('404',
                             'Not Found / Does not exist.',
                             SecurityResultException)
                .local_error('406',
                             'Format / Request Unacceptable.',
                             SecurityResultException)
                .local_error('429',
                             'Too many requests.',
                             SecurityResultException)
                .local_error('default',
                             'Error response.',
                             SecurityResultException))
    .execute
end

#unassign_license_to_devices(x_request_id) ⇒ ApiResponse

Unassigns SIM-Secure for IoT Flexible and Flexible Bundle license from SIMs.

Parameters:

  • x_request_id (String) —

    Required parameter: Transaction Id.

Returns:

  • (ApiResponse) —

    the complete http response with raw body and status code.



58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/verizon/controllers/sim_secure_for_io_t_licenses_controller.rb', line 58

def unassign_license_to_devices(x_request_id)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::DELETE,
                                 '/v1/devices/license/actions/assign',
                                 Server::M2M)
               .header_param(new_parameter(x_request_id, key: 'X-Request-ID'))
               .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(SecuritySuccessResult.method(:from_hash))
                .is_api_response(true)
                .local_error('400',
                             'Bad request.',
                             SecurityResultException)
                .local_error('401',
                             'Unauthorized request.',
                             SecurityResultException)
                .local_error('403',
                             'Request forbidden.',
                             SecurityResultException)
                .local_error('404',
                             'Not Found / Does not exist.',
                             SecurityResultException)
                .local_error('406',
                             'Format / Request Unacceptable.',
                             SecurityResultException)
                .local_error('429',
                             'Too many requests.',
                             SecurityResultException)
                .local_error('default',
                             'Error response.',
                             SecurityResultException))
    .execute
end