Class: Verizon::GlobalReportingController

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

Overview

GlobalReportingController

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

#deviceprovhistory_using_post(body) ⇒ ESIMRequestResponse

Retreive the provisioning history of a specific device or devices. Provisioning History

Parameters:

Returns:



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

def deviceprovhistory_using_post(body)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::POST,
                                 '/m2m/v2/devices/history/actions/list',
                                 Server::THINGSPACE)
               .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('thingspace_oauth')))
    .response(new_response_handler
               .deserializer(APIHelper.method(:custom_type_deserializer))
               .deserialize_into(ESIMRequestResponse.method(:from_hash))
               .is_api_response(true)
               .local_error('400',
                            'Bad request',
                            ESIMRestErrorResponseException)
               .local_error('401',
                            'Unauthorized',
                            ESIMRestErrorResponseException)
               .local_error('403',
                            'Forbidden',
                            ESIMRestErrorResponseException)
               .local_error('404',
                            'Not Found / Does not exist',
                            ESIMRestErrorResponseException)
               .local_error('406',
                            'Format / Request Unacceptable',
                            ESIMRestErrorResponseException)
               .local_error('429',
                            'Too many requests',
                            ESIMRestErrorResponseException)
               .local_error('default',
                            'Error response',
                            ESIMRestErrorResponseException))
    .execute
end

#requeststatususing_get(accountname, request_id) ⇒ ESIMStatusResponse

Get the status of a request made with the Device Actions.

Parameters:

  • accountname (String) —

    Required parameter: Example:

  • request_id (String) —

    Required parameter: Example:

Returns:



55
56
57
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
93
 
# File 'lib/verizon/controllers/global_reporting_controller.rb', line 55

def requeststatususing_get(accountname,
                           request_id)
  new_api_call_builder
    .request(new_request_builder(HttpMethodEnum::GET,
                                 '/m2m/v2/accounts/{accountname}/requests/{requestID}/status',
                                 Server::THINGSPACE)
               .template_param(new_parameter(accountname, key: 'accountname')
                                .should_encode(true))
               .template_param(new_parameter(request_id, key: 'requestID')
                                .should_encode(true))
               .header_param(new_parameter('application/json', key: 'accept'))
               .auth(Single.new('thingspace_oauth')))
    .response(new_response_handler
               .deserializer(APIHelper.method(:custom_type_deserializer))
               .deserialize_into(ESIMStatusResponse.method(:from_hash))
               .is_api_response(true)
               .local_error('400',
                            'Bad request',
                            ESIMRestErrorResponseException)
               .local_error('401',
                            'Unauthorized',
                            ESIMRestErrorResponseException)
               .local_error('403',
                            'Forbidden',
                            ESIMRestErrorResponseException)
               .local_error('404',
                            'Not Found / Does not exist',
                            ESIMRestErrorResponseException)
               .local_error('406',
                            'Format / Request Unacceptable',
                            ESIMRestErrorResponseException)
               .local_error('429',
                            'Too many requests',
                            ESIMRestErrorResponseException)
               .local_error('default',
                            'Error response',
                            ESIMRestErrorResponseException))
    .execute
end