sdksio-verizon-apis-sdk 1.4.0 → 1.5.1

data/lib/verizon/controllers/account_requests_controller.rb

@@ -11,7 +11,7 @@ module Verizon
     # @param [String] aname Required parameter: Account name.
     # @param [String] request_id Required parameter: UUID from synchronous
     # response.
-    # @return [AsynchronousRequestResult] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def get_current_asynchronous_request_status(aname,
                                                 request_id)
       new_api_call_builder
@@ -23,14 +23,14 @@ module Verizon
                    .template_param(new_parameter(request_id, key: 'requestId')
                                     .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(AsynchronousRequestResult.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Error response.',
-                                ConnectivityManagementResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AsynchronousRequestResult.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Error response.',
+                                 ConnectivityManagementResultException))
         .execute
     end
   end

data/lib/verizon/controllers/account_subscriptions_controller.rb

@@ -12,7 +12,7 @@ module Verizon
     # @param [SecuritySubscriptionRequest] body Required parameter: Request for
     # account subscription.
     # @param [String] x_request_id Optional parameter: Transaction Id.
-    # @return [SecuritySubscriptionResult] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_account_subscriptions(body,
                                    x_request_id: nil)
       new_api_call_builder
@@ -24,32 +24,32 @@ 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(SecuritySubscriptionResult.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(SecuritySubscriptionResult.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/accounts_controller.rb

@@ -8,7 +8,7 @@ module Verizon
   class AccountsController < BaseController
     # Returns information about a specified account.
     # @param [String] aname Required parameter: Account name.
-    # @return [Account] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def get_account_information(aname)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -17,21 +17,21 @@ 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(Account.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Error response.',
-                                ConnectivityManagementResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Account.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Error response.',
+                                 ConnectivityManagementResultException))
         .execute
     end
 
     # Returns a list and details of all custom services and states defined for a
     # specified account.
     # @param [String] aname Required parameter: Account name.
-    # @return [AccountStatesAndServices] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_account_states_and_services(aname)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -40,14 +40,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(AccountStatesAndServices.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Error response.',
-                                ConnectivityManagementResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AccountStatesAndServices.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Error response.',
+                                 ConnectivityManagementResultException))
         .execute
     end
 
@@ -57,7 +57,7 @@ module Verizon
     # @param [String] aname Required parameter: Account name.
     # @param [Integer] mnext Optional parameter: Continue the previous query
     # from the pageUrl in Location Header.
-    # @return [AccountLeadsResult] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_account_leads(aname,
                            mnext: nil)
       new_api_call_builder
@@ -68,14 +68,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(AccountLeadsResult.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Error response.',
-                                ConnectivityManagementResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AccountLeadsResult.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Error response.',
+                                 ConnectivityManagementResultException))
         .execute
     end
   end

data/lib/verizon/controllers/anomaly_settings_controller.rb

@@ -10,7 +10,7 @@ module Verizon
     # threshold values.
     # @param [AnomalyDetectionRequest] body Required parameter: Request to
     # activate anomaly detection.
-    # @return [IntelligenceSuccessResult] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def activate_anomaly_detection(body)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -20,21 +20,21 @@ 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(IntelligenceSuccessResult.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('default',
-                                'An error occurred.',
-                                IntelligenceResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(IntelligenceSuccessResult.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'An error occurred.',
+                                 IntelligenceResultException))
         .execute
     end
 
     # Retrieves the current anomaly detection settings for an account.
     # @param [String] account_name Required parameter: The name of the
     # subscribed account.
-    # @return [AnomalyDetectionSettings] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_anomaly_detection_settings(account_name)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -43,21 +43,21 @@ module Verizon
                    .template_param(new_parameter(account_name, key: 'accountName')
                                     .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(AnomalyDetectionSettings.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('default',
-                                'An error occurred.',
-                                IntelligenceResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AnomalyDetectionSettings.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'An error occurred.',
+                                 IntelligenceResultException))
         .execute
     end
 
     # Resets the thresholds to zero.
     # @param [String] account_name Required parameter: The name of the
     # subscribed account.
-    # @return [IntelligenceSuccessResult] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def reset_anomaly_detection_parameters(account_name)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::PUT,
@@ -66,14 +66,14 @@ module Verizon
                    .template_param(new_parameter(account_name, key: 'accountName')
                                     .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(IntelligenceSuccessResult.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('default',
-                                'An error occurred.',
-                                IntelligenceResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(IntelligenceSuccessResult.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'An error occurred.',
+                                 IntelligenceResultException))
         .execute
     end
   end

data/lib/verizon/controllers/anomaly_triggers_controller.rb

@@ -7,47 +7,47 @@ module Verizon
   # AnomalyTriggersController
   class AnomalyTriggersController < BaseController
     # This corresponds to the M2M-MC SOAP interface, ```GetTriggers```.
-    # @return [Array[GetTriggerResponseList]] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_anomaly_detection_triggers
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
                                      '/m2m/v1/triggers',
                                      Server::THINGSPACE)
                    .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(GetTriggerResponseList.method(:from_hash))
-                   .is_api_response(true)
-                   .is_response_array(true)
-                   .local_error('400',
-                                'Bad request',
-                                IntelligenceResultException)
-                   .local_error('401',
-                                'Unauthorized',
-                                IntelligenceResultException)
-                   .local_error('403',
-                                'Forbidden',
-                                IntelligenceResultException)
-                   .local_error('404',
-                                'Not Found / Does not exist',
-                                IntelligenceResultException)
-                   .local_error('406',
-                                'Format / Request Unacceptable',
-                                IntelligenceResultException)
-                   .local_error('429',
-                                'Too many requests',
-                                IntelligenceResultException)
-                   .local_error('default',
-                                'Error response',
-                                IntelligenceResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetTriggerResponseList.method(:from_hash))
+                    .is_api_response(true)
+                    .is_response_array(true)
+                    .local_error('400',
+                                 'Bad request',
+                                 IntelligenceResultException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 IntelligenceResultException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 IntelligenceResultException)
+                    .local_error('404',
+                                 'Not Found / Does not exist',
+                                 IntelligenceResultException)
+                    .local_error('406',
+                                 'Format / Request Unacceptable',
+                                 IntelligenceResultException)
+                    .local_error('429',
+                                 'Too many requests',
+                                 IntelligenceResultException)
+                    .local_error('default',
+                                 'Error response',
+                                 IntelligenceResultException))
         .execute
     end
 
     # This corresponds to the M2M-MC SOAP interface, ```UpdateTriggerRequest```.
     # @param [UpdateTriggerRequest] body Required parameter: Update Trigger
     # Request
-    # @return [AnomalyDetectionTrigger] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def update_anomaly_detection_trigger(body)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::PUT,
@@ -57,39 +57,39 @@ 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(AnomalyDetectionTrigger.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Bad request',
-                                IntelligenceResultException)
-                   .local_error('401',
-                                'Unauthorized',
-                                IntelligenceResultException)
-                   .local_error('403',
-                                'Forbidden',
-                                IntelligenceResultException)
-                   .local_error('404',
-                                'Not Found / Does not exist',
-                                IntelligenceResultException)
-                   .local_error('406',
-                                'Format / Request Unacceptable',
-                                IntelligenceResultException)
-                   .local_error('429',
-                                'Too many requests',
-                                IntelligenceResultException)
-                   .local_error('default',
-                                'Error response',
-                                IntelligenceResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AnomalyDetectionTrigger.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad request',
+                                 IntelligenceResultException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 IntelligenceResultException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 IntelligenceResultException)
+                    .local_error('404',
+                                 'Not Found / Does not exist',
+                                 IntelligenceResultException)
+                    .local_error('406',
+                                 'Format / Request Unacceptable',
+                                 IntelligenceResultException)
+                    .local_error('429',
+                                 'Too many requests',
+                                 IntelligenceResultException)
+                    .local_error('default',
+                                 'Error response',
+                                 IntelligenceResultException))
         .execute
     end
 
     # This corresponds to the M2M-MC SOAP interface, ```CreateTrigger```.
     # @param [CreateTriggerRequest] body Required parameter: Create Trigger
     # Request
-    # @return [AnomalyDetectionTrigger] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def create_anomaly_detection_trigger(body)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -99,38 +99,38 @@ 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(AnomalyDetectionTrigger.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Bad request',
-                                IntelligenceResultException)
-                   .local_error('401',
-                                'Unauthorized',
-                                IntelligenceResultException)
-                   .local_error('403',
-                                'Forbidden',
-                                IntelligenceResultException)
-                   .local_error('404',
-                                'Not Found / Does not exist',
-                                IntelligenceResultException)
-                   .local_error('406',
-                                'Format / Request Unacceptable',
-                                IntelligenceResultException)
-                   .local_error('429',
-                                'Too many requests',
-                                IntelligenceResultException)
-                   .local_error('default',
-                                'Error response',
-                                IntelligenceResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AnomalyDetectionTrigger.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad request',
+                                 IntelligenceResultException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 IntelligenceResultException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 IntelligenceResultException)
+                    .local_error('404',
+                                 'Not Found / Does not exist',
+                                 IntelligenceResultException)
+                    .local_error('406',
+                                 'Format / Request Unacceptable',
+                                 IntelligenceResultException)
+                    .local_error('429',
+                                 'Too many requests',
+                                 IntelligenceResultException)
+                    .local_error('default',
+                                 'Error response',
+                                 IntelligenceResultException))
         .execute
     end
 
     # This corresponds to the M2M-MC SOAP interface, ```GetTriggers```.
     # @param [String] trigger_id Required parameter: trigger ID
-    # @return [Array[GetTriggerResponseList]] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_anomaly_detection_trigger_settings(trigger_id)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -139,40 +139,40 @@ module Verizon
                    .template_param(new_parameter(trigger_id, key: 'triggerId')
                                     .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(GetTriggerResponseList.method(:from_hash))
-                   .is_api_response(true)
-                   .is_response_array(true)
-                   .local_error('400',
-                                'Bad request',
-                                IntelligenceResultException)
-                   .local_error('401',
-                                'Unauthorized',
-                                IntelligenceResultException)
-                   .local_error('403',
-                                'Forbidden',
-                                IntelligenceResultException)
-                   .local_error('404',
-                                'Not Found / Does not exist',
-                                IntelligenceResultException)
-                   .local_error('406',
-                                'Format / Request Unacceptable',
-                                IntelligenceResultException)
-                   .local_error('429',
-                                'Too many requests',
-                                IntelligenceResultException)
-                   .local_error('default',
-                                'Error response',
-                                IntelligenceResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GetTriggerResponseList.method(:from_hash))
+                    .is_api_response(true)
+                    .is_response_array(true)
+                    .local_error('400',
+                                 'Bad request',
+                                 IntelligenceResultException)
+                    .local_error('401',
+                                 'Unauthorized',
+                                 IntelligenceResultException)
+                    .local_error('403',
+                                 'Forbidden',
+                                 IntelligenceResultException)
+                    .local_error('404',
+                                 'Not Found / Does not exist',
+                                 IntelligenceResultException)
+                    .local_error('406',
+                                 'Format / Request Unacceptable',
+                                 IntelligenceResultException)
+                    .local_error('429',
+                                 'Too many requests',
+                                 IntelligenceResultException)
+                    .local_error('default',
+                                 'Error response',
+                                 IntelligenceResultException))
         .execute
     end
 
     # Deletes a specific trigger ID
     # @param [String] trigger_id Required parameter: The trigger ID to be
     # deleted
-    # @return [AnomalyDetectionTrigger] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def delete_anomaly_detection_trigger(trigger_id)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::DELETE,
@@ -181,14 +181,14 @@ module Verizon
                    .template_param(new_parameter(trigger_id, key: 'triggerId')
                                     .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(AnomalyDetectionTrigger.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('default',
-                                'Error response',
-                                IntelligenceResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AnomalyDetectionTrigger.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Error response',
+                                 IntelligenceResultException))
         .execute
     end
   end