sdksio-verizon-apis-sdk 1.5.0 → 1.5.1

data/lib/verizon/controllers/anomaly_triggers_controller.rb

@@ -7,7 +7,7 @@ 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,
@@ -16,38 +16,38 @@ module Verizon
                    .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(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,
@@ -59,37 +59,37 @@ module Verizon
                    .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(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,
@@ -101,36 +101,36 @@ module Verizon
                    .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(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,
@@ -141,38 +141,38 @@ module Verizon
                    .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(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,
@@ -183,12 +183,12 @@ module Verizon
                    .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(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

data/lib/verizon/controllers/anomaly_triggers_v2_controller.rb

@@ -9,7 +9,7 @@ module Verizon
     # Creates the trigger to identify an anomaly.
     # @param [Array[CreateTriggerRequestOptions]] body Required parameter:
     # Request to create an anomaly trigger.
-    # @return [AnomalyDetectionTrigger] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def create_anomaly_detection_trigger_v2(body)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -21,19 +21,19 @@ module Verizon
                    .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(AnomalyDetectionTrigger.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('default',
-                                'An error occurred.',
-                                IntelligenceResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AnomalyDetectionTrigger.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'An error occurred.',
+                                 IntelligenceResultException))
         .execute
     end
 
     # Updates an existing trigger using the account name.
     # @param [Array[UpdateTriggerRequestOptions]] body Required parameter:
     # Request to update existing trigger.
-    # @return [IntelligenceSuccessResult] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def update_anomaly_detection_trigger_v2(body)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::PUT,
@@ -45,19 +45,19 @@ module Verizon
                    .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(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 values for a specific trigger ID.
     # @param [String] trigger_id Required parameter: The trigger ID of a
     # specific trigger.
-    # @return [AnomalyTriggerResult] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_anomaly_detection_trigger_settings_v2(trigger_id)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -68,12 +68,12 @@ module Verizon
                    .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(AnomalyTriggerResult.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('default',
-                                'An error occurred.',
-                                IntelligenceResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(AnomalyTriggerResult.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'An error occurred.',
+                                 IntelligenceResultException))
         .execute
     end
   end

data/lib/verizon/controllers/base_controller.rb

@@ -30,15 +30,15 @@ module Verizon
     end
 
     # Creates a new builder for the Api Call instance.
-    # @return [ApiCall] The instance of ApiCall.
-    def new_api_call_builder
-      @api_call.new_builder
-    end
-
-    # Creates a new instance of the request builder.
-    # @param [String] http_method The HTTP method to use in the request.
-    # @param [String] path The endpoint path to use in the request.
-    # @param [String] server The server to extract the base uri for the request.
+    # @return [ApiCall] The instance of ApiCall.
+    def new_api_call_builder
+      @api_call.new_builder
+    end
+
+    # Creates a new instance of the request builder.
+    # @param [String] http_method The HTTP method to use in the request.
+    # @param [String] path The endpoint path to use in the request.
+    # @param [String] server The server to extract the base uri for the request.
     # @return [RequestBuilder] The instance of RequestBuilder.
     def new_request_builder(http_method, path, server)
       RequestBuilder.new

data/lib/verizon/controllers/billing_controller.rb

@@ -9,7 +9,7 @@ module Verizon
     # This endpoint allows user to add managed accounts to a primary account.
     # @param [ManagedAccountsAddRequest] body Required parameter: Service name
     # and list of accounts to add
-    # @return [ManagedAccountsAddResponse] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def add_account(body)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -21,12 +21,12 @@ module Verizon
                    .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(ManagedAccountsAddResponse.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Unexpected error',
-                                DeviceLocationResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ManagedAccountsAddResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Unexpected error',
+                                 DeviceLocationResultException))
         .execute
     end
 
@@ -34,7 +34,7 @@ module Verizon
     # and the primary account.
     # @param [ManagedAccountsProvisionRequest] body Required parameter: Service
     # name and list of accounts to add
-    # @return [ManagedAccountsProvisionResponse] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def managed_account_action(body)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -46,12 +46,12 @@ module Verizon
                    .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(ManagedAccountsProvisionResponse.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Unexpected error',
-                                DeviceLocationResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ManagedAccountsProvisionResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Unexpected error',
+                                 DeviceLocationResultException))
         .execute
     end
 
@@ -59,7 +59,7 @@ module Verizon
     # account and the primary account.
     # @param [ManagedAccountCancelRequest] body Required parameter: Service name
     # and list of accounts to add
-    # @return [ManagedAccountCancelResponse] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def cancel_managed_account_action(body)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -71,12 +71,12 @@ module Verizon
                    .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(ManagedAccountCancelResponse.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Unexpected error',
-                                DeviceLocationResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ManagedAccountCancelResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Unexpected error',
+                                 DeviceLocationResultException))
         .execute
     end
 
@@ -85,7 +85,7 @@ module Verizon
     # @param [String] account_name Required parameter: Primary account
     # identifier
     # @param [String] service_name Required parameter: Service name
-    # @return [ManagedAccountsGetAllResponse] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_managed_account(account_name,
                              service_name)
       new_api_call_builder
@@ -99,12 +99,12 @@ module Verizon
                    .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(ManagedAccountsGetAllResponse.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Unexpected error',
-                                DeviceLocationResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ManagedAccountsGetAllResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Unexpected error',
+                                 DeviceLocationResultException))
         .execute
     end
   end