Class: Verizon::SoftwareManagementLicensesV3Controller

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

Overview

SoftwareManagementLicensesV3Controller

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_licenses_to_devices(acc, body) ⇒ ApiResponse

This endpoint allows user to assign licenses to a list of devices.

Parameters:

  • acc (String) —

    Required parameter: Account identifier.

  • body (V3LicenseIMEI) —

    Required parameter: License assignment.

Returns:

  • (ApiResponse) —

    the complete http response with raw body and status code.



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/verizon/controllers/software_management_licenses_v3_controller.rb', line 39

def assign_licenses_to_devices(acc,
                               body)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/licenses/{acc}/assign',
                                 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(V3LicenseAssignedRemovedResult.method(:from_hash))
                .is_api_response(true)
                .local_error('400',
                             'Unexpected error.',
                             FotaV3ResultException))
    .execute
end

#get_account_licenses_status(acc, last_seen_device_id: nil) ⇒ ApiResponse

The endpoint allows user to list license usage. identifier.

Parameters:

  • acc (String) —

    Required parameter: Account identifier.

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

    Optional parameter: Last seen device

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
 
# File 'lib/verizon/controllers/software_management_licenses_v3_controller.rb', line 14

def (acc,
                                last_seen_device_id: nil)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/licenses/{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'))
               .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(V3LicenseSummary.method(:from_hash))
                .is_api_response(true)
                .local_error('400',
                             'Unexpected error.',
                             FotaV3ResultException))
    .execute
end

#remove_licenses_from_devices(acc, body) ⇒ ApiResponse

This endpoint allows user to remove licenses from a list of devices.

Parameters:

  • acc (String) —

    Required parameter: Account identifier.

  • body (V3LicenseIMEI) —

    Required parameter: License removal.

Returns:

  • (ApiResponse) —

    the complete http response with raw body and status code.



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

def remove_licenses_from_devices(acc,
                                 body)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/licenses/{acc}/remove',
                                 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(V3LicenseAssignedRemovedResult.method(:from_hash))
                .is_api_response(true)
                .local_error('400',
                             'Unexpected error.',
                             FotaV3ResultException))
    .execute
end