sdksio-verizon-apis-sdk 1.4.0 → 1.5.1

data/lib/verizon/controllers/sim_secure_for_io_t_licenses_controller.rb

@@ -10,7 +10,7 @@ module Verizon
     # @param [AssignLicenseRequest] body Required parameter: Request to assign
     # license to devices.
     # @param [String] x_request_id Optional parameter: Transaction Id.
-    # @return [SecuritySuccessResult] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def assign_license_to_devices(body,
                                   x_request_id: nil)
       new_api_call_builder
@@ -22,39 +22,39 @@ module Verizon
                    .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(Single.new('oAuth2')))
+                   .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))
+                    .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
 
     # Unassigns SIM-Secure for IoT Flexible and Flexible Bundle license from
     # SIMs.
     # @param [String] x_request_id Required parameter: Transaction Id.
-    # @return [SecuritySuccessResult] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def unassign_license_to_devices(x_request_id)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::DELETE,
@@ -62,32 +62,32 @@ module Verizon
                                      Server::M2M)
                    .header_param(new_parameter(x_request_id, key: 'X-Request-ID'))
                    .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('oAuth2')))
+                   .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))
+                    .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
   end

data/lib/verizon/controllers/sms_controller.rb

@@ -10,7 +10,7 @@ module Verizon
     # possible, but they may be delayed due to traffic and routing
     # considerations.
     # @param [SMSSendRequest] body Required parameter: Request to send SMS.
-    # @return [DeviceManagementResult] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def send_sms_to_device(body)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -20,14 +20,14 @@ module Verizon
                    .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')))
+                   .auth(And.new('thingspace_oauth', 'VZ-M2M-Token')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(DeviceManagementResult.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Error response.',
-                                ConnectivityManagementResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(DeviceManagementResult.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Error response.',
+                                 ConnectivityManagementResultException))
         .execute
     end
 
@@ -37,7 +37,7 @@ module Verizon
     # @param [String] aname Required parameter: Account name.
     # @param [Integer] mnext Optional parameter: Continue the previous query
     # from the URL in Location Header.
-    # @return [SMSMessagesQueryResult] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_devices_sms_messages(aname,
                                   mnext: nil)
       new_api_call_builder
@@ -48,14 +48,14 @@ module Verizon
                                     .should_encode(true))
                    .query_param(new_parameter(mnext, key: 'next'))
                    .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('oAuth2')))
+                   .auth(And.new('thingspace_oauth', 'VZ-M2M-Token')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(SMSMessagesQueryResult.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Error response.',
-                                ConnectivityManagementResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(SMSMessagesQueryResult.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Error response.',
+                                 ConnectivityManagementResultException))
         .execute
     end
 
@@ -65,7 +65,7 @@ module Verizon
     # application, either by callback or synchronously with GET
     # /sms/{accountName}/history.
     # @param [String] aname Required parameter: Account name.
-    # @return [ConnectivityManagementSuccessResult] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def start_queued_sms_delivery(aname)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::PUT,
@@ -74,14 +74,14 @@ module Verizon
                    .template_param(new_parameter(aname, key: 'aname')
                                     .should_encode(true))
                    .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('oAuth2')))
+                   .auth(And.new('thingspace_oauth', 'VZ-M2M-Token')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(ConnectivityManagementSuccessResult.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Error response.',
-                                ConnectivityManagementResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ConnectivityManagementSuccessResult.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Error response.',
+                                 ConnectivityManagementResultException))
         .execute
     end
   end

data/lib/verizon/controllers/software_management_callbacks_v1_controller.rb

@@ -10,7 +10,7 @@ module Verizon
     # registered for a given account.
     # @param [String] account Required parameter: Account identifier in
     # "##########-#####".
-    # @return [Array[RegisteredCallbacks]] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_registered_callbacks(account)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -19,15 +19,15 @@ module Verizon
                    .template_param(new_parameter(account, key: 'account')
                                     .should_encode(true))
                    .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('oAuth2')))
+                   .auth(And.new('thingspace_oauth', 'VZ-M2M-Token')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(RegisteredCallbacks.method(:from_hash))
-                   .is_api_response(true)
-                   .is_response_array(true)
-                   .local_error('400',
-                                'Unexpected error.',
-                                FotaV1ResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(RegisteredCallbacks.method(:from_hash))
+                    .is_api_response(true)
+                    .is_response_array(true)
+                    .local_error('400',
+                                 'Unexpected error.',
+                                 FotaV1ResultException))
         .execute
     end
 
@@ -37,7 +37,7 @@ module Verizon
     # "##########-#####".
     # @param [FotaV1CallbackRegistrationRequest] body Required parameter:
     # Callback details.
-    # @return [FotaV1CallbackRegistrationResult] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def register_callback(account,
                           body)
       new_api_call_builder
@@ -50,14 +50,14 @@ module Verizon
                    .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')))
+                   .auth(And.new('thingspace_oauth', 'VZ-M2M-Token')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(FotaV1CallbackRegistrationResult.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Unexpected error.',
-                                FotaV1ResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(FotaV1CallbackRegistrationResult.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Unexpected error.',
+                                 FotaV1ResultException))
         .execute
     end
 
@@ -67,7 +67,7 @@ module Verizon
     # "##########-#####".
     # @param [CallbackServiceEnum] service Required parameter: Callback type.
     # Must be 'Fota' for Software Management Services API.
-    # @return [FotaV1SuccessResult] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def deregister_callback(account,
                             service)
       new_api_call_builder
@@ -79,14 +79,14 @@ module Verizon
                    .template_param(new_parameter(service, key: 'service')
                                     .should_encode(true))
                    .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('oAuth2')))
+                   .auth(And.new('thingspace_oauth', 'VZ-M2M-Token')))
         .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))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(FotaV1SuccessResult.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Unexpected error.',
+                                 FotaV1ResultException))
         .execute
     end
   end

data/lib/verizon/controllers/software_management_callbacks_v2_controller.rb

@@ -8,7 +8,7 @@ module Verizon
   class SoftwareManagementCallbacksV2Controller < BaseController
     # This endpoint allows user to get the registered callback information.
     # @param [String] account Required parameter: Account identifier.
-    # @return [CallbackSummary] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_registered_callbacks(account)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -17,14 +17,14 @@ module Verizon
                    .template_param(new_parameter(account, key: 'account')
                                     .should_encode(true))
                    .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('oAuth2')))
+                   .auth(And.new('thingspace_oauth', 'VZ-M2M-Token')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(CallbackSummary.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Unexpected error.',
-                                FotaV2ResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(CallbackSummary.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Unexpected error.',
+                                 FotaV2ResultException))
         .execute
     end
 
@@ -32,7 +32,7 @@ module Verizon
     # @param [String] account Required parameter: Account identifier.
     # @param [FotaV2CallbackRegistrationRequest] body Required parameter:
     # Callback URL registration.
-    # @return [FotaV2CallbackRegistrationResult] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def update_callback(account,
                         body)
       new_api_call_builder
@@ -45,14 +45,14 @@ module Verizon
                    .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')))
+                   .auth(And.new('thingspace_oauth', 'VZ-M2M-Token')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(FotaV2CallbackRegistrationResult.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Unexpected error.',
-                                FotaV2ResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(FotaV2CallbackRegistrationResult.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Unexpected error.',
+                                 FotaV2ResultException))
         .execute
     end
 
@@ -60,7 +60,7 @@ module Verizon
     # @param [String] account Required parameter: Account identifier.
     # @param [FotaV2CallbackRegistrationRequest] body Required parameter:
     # Callback URL registration.
-    # @return [FotaV2CallbackRegistrationResult] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def register_callback(account,
                           body)
       new_api_call_builder
@@ -73,20 +73,20 @@ module Verizon
                    .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')))
+                   .auth(And.new('thingspace_oauth', 'VZ-M2M-Token')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(FotaV2CallbackRegistrationResult.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Unexpected error.',
-                                FotaV2ResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(FotaV2CallbackRegistrationResult.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Unexpected error.',
+                                 FotaV2ResultException))
         .execute
     end
 
     # This endpoint allows user to delete a previously registered callback URL.
     # @param [String] account Required parameter: Account identifier.
-    # @return [FotaV2SuccessResult] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def deregister_callback(account)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::DELETE,
@@ -95,14 +95,14 @@ module Verizon
                    .template_param(new_parameter(account, key: 'account')
                                     .should_encode(true))
                    .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('oAuth2')))
+                   .auth(And.new('thingspace_oauth', 'VZ-M2M-Token')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(FotaV2SuccessResult.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Unexpected error.',
-                                FotaV2ResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(FotaV2SuccessResult.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Unexpected error.',
+                                 FotaV2ResultException))
         .execute
     end
   end

data/lib/verizon/controllers/software_management_callbacks_v3_controller.rb

@@ -8,7 +8,7 @@ module Verizon
   class SoftwareManagementCallbacksV3Controller < BaseController
     # This endpoint allows user to get the registered callback information.
     # @param [String] acc Required parameter: Account identifier.
-    # @return [FotaV3CallbackSummary] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_registered_callbacks(acc)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -17,14 +17,14 @@ module Verizon
                    .template_param(new_parameter(acc, key: 'acc')
                                     .should_encode(true))
                    .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('oAuth2')))
+                   .auth(And.new('thingspace_oauth', 'VZ-M2M-Token')))
         .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))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(FotaV3CallbackSummary.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Unexpected error.',
+                                 FotaV3ResultException))
         .execute
     end
 
@@ -32,7 +32,7 @@ module Verizon
     # @param [String] acc Required parameter: Account identifier.
     # @param [FotaV3CallbackRegistrationRequest] body Required parameter:
     # Callback URL registration.
-    # @return [FotaV3CallbackRegistrationResult] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def update_callback(acc,
                         body)
       new_api_call_builder
@@ -45,14 +45,14 @@ module Verizon
                    .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')))
+                   .auth(And.new('thingspace_oauth', 'VZ-M2M-Token')))
         .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))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(FotaV3CallbackRegistrationResult.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Unexpected error.',
+                                 FotaV3ResultException))
         .execute
     end
 
@@ -60,7 +60,7 @@ module Verizon
     # @param [String] acc Required parameter: Account identifier.
     # @param [FotaV3CallbackRegistrationRequest] body Required parameter:
     # Callback URL registration.
-    # @return [FotaV3CallbackRegistrationResult] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def register_callback(acc,
                           body)
       new_api_call_builder
@@ -73,20 +73,20 @@ module Verizon
                    .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')))
+                   .auth(And.new('thingspace_oauth', 'VZ-M2M-Token')))
         .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))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(FotaV3CallbackRegistrationResult.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Unexpected error.',
+                                 FotaV3ResultException))
         .execute
     end
 
     # This endpoint allows user to delete a previously registered callback URL.
     # @param [String] acc Required parameter: Account identifier.
-    # @return [FotaV3SuccessResult] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def deregister_callback(acc)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::DELETE,
@@ -95,14 +95,14 @@ module Verizon
                    .template_param(new_parameter(acc, key: 'acc')
                                     .should_encode(true))
                    .header_param(new_parameter('application/json', key: 'accept'))
-                   .auth(Single.new('oAuth2')))
+                   .auth(And.new('thingspace_oauth', 'VZ-M2M-Token')))
         .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))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(FotaV3SuccessResult.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Unexpected error.',
+                                 FotaV3ResultException))
         .execute
     end
   end