sdksio-verizon-apis-sdk 1.5.0 → 1.5.1

data/lib/verizon/controllers/usage_trigger_management_controller.rb

@@ -11,7 +11,7 @@ module Verizon
     # monthly subscription amount.
     # @param [UsageTriggerAddRequest] body Optional parameter: License
     # assignment.
-    # @return [UsageTriggerResponse] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def create_new_trigger(body: nil)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -23,12 +23,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(UsageTriggerResponse.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Unexpected error',
-                                DeviceLocationResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(UsageTriggerResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Unexpected error',
+                                 DeviceLocationResultException))
         .execute
     end
 
@@ -36,7 +36,7 @@ module Verizon
     # @param [String] trigger_id Required parameter: Usage trigger ID
     # @param [UsageTriggerUpdateRequest] body Optional parameter: New trigger
     # values
-    # @return [UsageTriggerResponse] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def update_trigger(trigger_id,
                        body: nil)
       new_api_call_builder
@@ -51,19 +51,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(UsageTriggerResponse.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Unexpected error',
-                                DeviceLocationResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(UsageTriggerResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Unexpected error',
+                                 DeviceLocationResultException))
         .execute
     end
 
     # eletes the specified usage trigger from the given account
     # @param [String] account_name Required parameter: Account name
     # @param [String] trigger_id Required parameter: Usage trigger ID
-    # @return [DeviceLocationSuccessResult] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def delete_trigger(account_name,
                        trigger_id)
       new_api_call_builder
@@ -77,12 +77,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(DeviceLocationSuccessResult.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Unexpected error',
-                                DeviceLocationResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(DeviceLocationSuccessResult.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Unexpected error',
+                                 DeviceLocationResultException))
         .execute
     end
   end

data/lib/verizon/controllers/wireless_network_performance_controller.rb

@@ -9,7 +9,7 @@ module Verizon
     # WNP Query for current network condition.
     # @param [GetNetworkConditionsRequest] body Required parameter: Request for
     # current network health.
-    # @return [WNPRequestResponse] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def near_real_time_network_conditions(body)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -21,20 +21,21 @@ 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(WNPRequestResponse.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('default',
-                                'Error response',
-                                WNPRestErrorResponseException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(WNPRequestResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Error response',
+                                 WNPRestErrorResponseException))
         .execute
     end
 
     # Run a report to determine network types available and available coverage.
-    # Network types covered include: CAT-M, NB-IOT, LTE, LTE-AWS and 5GNW.
+    # Network types covered include: CAT-M, NB-IOT, LTE, LTE-AWS, 5GNW and
+    # C-BAND.
     # @param [GetWirelessCoverageRequest] body Required parameter: Request for
     # network coverage details.
-    # @return [WNPRequestResponse] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def domestic4g_and_5g_nationwide_network_coverage(body)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -46,12 +47,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(WNPRequestResponse.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('default',
-                                'Error response',
-                                WNPRestErrorResponseException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(WNPRequestResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Error response',
+                                 WNPRestErrorResponseException))
         .execute
     end
 
@@ -59,7 +60,7 @@ module Verizon
     # technology supported by the equipment.
     # @param [GetNetworkConditionsRequest] body Required parameter: Request for
     # cell site proximity.
-    # @return [WNPRequestResponse] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def site_proximity(body)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -71,19 +72,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(WNPRequestResponse.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('default',
-                                'Error response',
-                                WNPRestErrorResponseException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(WNPRequestResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Error response',
+                                 WNPRestErrorResponseException))
         .execute
     end
 
     # A report of a specific device's service scores over a 30 day period.
     # @param [GetDeviceExperienceScoreHistoryRequest] body Required parameter:
     # Request for a device's 30 day experience.
-    # @return [WNPRequestResponse] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def device_experience30days_history(body)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -95,12 +96,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(WNPRequestResponse.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('default',
-                                'Error response',
-                                WNPRestErrorResponseException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(WNPRequestResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Error response',
+                                 WNPRestErrorResponseException))
         .execute
     end
 
@@ -108,7 +109,7 @@ module Verizon
     # devices.
     # @param [GetDeviceExperienceScoreBulkRequest] body Required parameter:
     # Request for bulk latest history details.
-    # @return [WNPRequestResponse] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def device_experience_bulk_latest(body)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -120,12 +121,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(WNPRequestResponse.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('default',
-                                'Error response',
-                                WNPRestErrorResponseException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(WNPRequestResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Error response',
+                                 WNPRestErrorResponseException))
         .execute
     end
   end

data/lib/verizon/exceptions/connectivity_management_result_exception.rb

@@ -15,21 +15,21 @@ module Verizon
 
     # Details of the error.
     # @return [String]
-    attr_accessor :error_message
-
-    # The constructor.
-    # @param [String] The reason for raising an exception.
-    # @param [HttpResponse] The HttpReponse of the API call.
-    def initialize(reason, response)
-      super(reason, response)
-      hash = APIHelper.json_deserialize(@response.raw_body)
-      unbox(hash)
-    end
-
-    # Populates this object by extracting properties from a hash.
-    # @param [Hash] The deserialized response sent by the server in the
-    # response body.
-    def unbox(hash)
+    attr_accessor :error_message
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
       @error_code = hash.key?('errorCode') ? hash['errorCode'] : SKIP
       @error_message = hash.key?('errorMessage') ? hash['errorMessage'] : SKIP
     end

data/lib/verizon/exceptions/default_response_exception.rb

@@ -15,21 +15,21 @@ module Verizon
 
     # TODO: Write general description for this method
     # @return [String]
-    attr_accessor :error_message
-
-    # The constructor.
-    # @param [String] The reason for raising an exception.
-    # @param [HttpResponse] The HttpReponse of the API call.
-    def initialize(reason, response)
-      super(reason, response)
-      hash = APIHelper.json_deserialize(@response.raw_body)
-      unbox(hash)
-    end
-
-    # Populates this object by extracting properties from a hash.
-    # @param [Hash] The deserialized response sent by the server in the
-    # response body.
-    def unbox(hash)
+    attr_accessor :error_message
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
       @error_code = hash.key?('errorCode') ? hash['errorCode'] : SKIP
       @error_message = hash.key?('errorMessage') ? hash['errorMessage'] : SKIP
     end

data/lib/verizon/exceptions/device_diagnostics_result_exception.rb

@@ -17,21 +17,21 @@ module Verizon
 
     # Detailed error message.
     # @return [String]
-    attr_accessor :error_message
-
-    # The constructor.
-    # @param [String] The reason for raising an exception.
-    # @param [HttpResponse] The HttpReponse of the API call.
-    def initialize(reason, response)
-      super(reason, response)
-      hash = APIHelper.json_deserialize(@response.raw_body)
-      unbox(hash)
-    end
-
-    # Populates this object by extracting properties from a hash.
-    # @param [Hash] The deserialized response sent by the server in the
-    # response body.
-    def unbox(hash)
+    attr_accessor :error_message
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
       @error_code = hash.key?('errorCode') ? hash['errorCode'] : nil
       @error_message = hash.key?('errorMessage') ? hash['errorMessage'] : nil
     end

data/lib/verizon/exceptions/device_location_result_exception.rb

@@ -15,21 +15,21 @@ module Verizon
 
     # TODO: Write general description for this method
     # @return [String]
-    attr_accessor :error_message
-
-    # The constructor.
-    # @param [String] The reason for raising an exception.
-    # @param [HttpResponse] The HttpReponse of the API call.
-    def initialize(reason, response)
-      super(reason, response)
-      hash = APIHelper.json_deserialize(@response.raw_body)
-      unbox(hash)
-    end
-
-    # Populates this object by extracting properties from a hash.
-    # @param [Hash] The deserialized response sent by the server in the
-    # response body.
-    def unbox(hash)
+    attr_accessor :error_message
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
       @error_code = hash.key?('errorCode') ? hash['errorCode'] : nil
       @error_message = hash.key?('errorMessage') ? hash['errorMessage'] : nil
     end

data/lib/verizon/exceptions/edge_discovery_result_exception.rb

@@ -20,21 +20,21 @@ module Verizon
     # For cases where user input exceeds the boundary values an additional
     # 'data' key will be returned with a relevant description.
     # @return [EdgeDiscoveryResultData]
-    attr_accessor :data
-
-    # The constructor.
-    # @param [String] The reason for raising an exception.
-    # @param [HttpResponse] The HttpReponse of the API call.
-    def initialize(reason, response)
-      super(reason, response)
-      hash = APIHelper.json_deserialize(@response.raw_body)
-      unbox(hash)
-    end
-
-    # Populates this object by extracting properties from a hash.
-    # @param [Hash] The deserialized response sent by the server in the
-    # response body.
-    def unbox(hash)
+    attr_accessor :data
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
       @status = hash.key?('status') ? hash['status'] : nil
       @message = hash.key?('message') ? hash['message'] : nil
       @data = EdgeDiscoveryResultData.from_hash(hash['data']) if hash['data']

data/lib/verizon/exceptions/edge_performance_result_exception.rb

@@ -15,21 +15,21 @@ module Verizon
 
     # Error details.
     # @return [String]
-    attr_accessor :message
-
-    # The constructor.
-    # @param [String] The reason for raising an exception.
-    # @param [HttpResponse] The HttpReponse of the API call.
-    def initialize(reason, response)
-      super(reason, response)
-      hash = APIHelper.json_deserialize(@response.raw_body)
-      unbox(hash)
-    end
-
-    # Populates this object by extracting properties from a hash.
-    # @param [Hash] The deserialized response sent by the server in the
-    # response body.
-    def unbox(hash)
+    attr_accessor :message
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
       @status = hash.key?('status') ? hash['status'] : SKIP
       @message = hash.key?('message') ? hash['message'] : SKIP
     end

data/lib/verizon/exceptions/esim_rest_error_response_exception.rb

@@ -15,21 +15,21 @@ module Verizon
 
     # TODO: Write general description for this method
     # @return [String]
-    attr_accessor :error_message
-
-    # The constructor.
-    # @param [String] The reason for raising an exception.
-    # @param [HttpResponse] The HttpReponse of the API call.
-    def initialize(reason, response)
-      super(reason, response)
-      hash = APIHelper.json_deserialize(@response.raw_body)
-      unbox(hash)
-    end
-
-    # Populates this object by extracting properties from a hash.
-    # @param [Hash] The deserialized response sent by the server in the
-    # response body.
-    def unbox(hash)
+    attr_accessor :error_message
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
       @error_code = hash.key?('errorCode') ? hash['errorCode'] : SKIP
       @error_message = hash.key?('errorMessage') ? hash['errorMessage'] : SKIP
     end

data/lib/verizon/exceptions/fota_v1_result_exception.rb

@@ -15,21 +15,21 @@ module Verizon
 
     # Description of the error.
     # @return [String]
-    attr_accessor :error_message
-
-    # The constructor.
-    # @param [String] The reason for raising an exception.
-    # @param [HttpResponse] The HttpReponse of the API call.
-    def initialize(reason, response)
-      super(reason, response)
-      hash = APIHelper.json_deserialize(@response.raw_body)
-      unbox(hash)
-    end
-
-    # Populates this object by extracting properties from a hash.
-    # @param [Hash] The deserialized response sent by the server in the
-    # response body.
-    def unbox(hash)
+    attr_accessor :error_message
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
       @error_code = hash.key?('errorCode') ? hash['errorCode'] : nil
       @error_message = hash.key?('errorMessage') ? hash['errorMessage'] : nil
     end

data/lib/verizon/exceptions/fota_v2_result_exception.rb

@@ -15,21 +15,21 @@ module Verizon
 
     # Details of the error.
     # @return [String]
-    attr_accessor :error_message
-
-    # The constructor.
-    # @param [String] The reason for raising an exception.
-    # @param [HttpResponse] The HttpReponse of the API call.
-    def initialize(reason, response)
-      super(reason, response)
-      hash = APIHelper.json_deserialize(@response.raw_body)
-      unbox(hash)
-    end
-
-    # Populates this object by extracting properties from a hash.
-    # @param [Hash] The deserialized response sent by the server in the
-    # response body.
-    def unbox(hash)
+    attr_accessor :error_message
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
       @error_code = hash.key?('errorCode') ? hash['errorCode'] : nil
       @error_message = hash.key?('errorMessage') ? hash['errorMessage'] : nil
     end

data/lib/verizon/exceptions/fota_v3_result_exception.rb

@@ -15,21 +15,21 @@ module Verizon
 
     # Error message string.
     # @return [String]
-    attr_accessor :error_message
-
-    # The constructor.
-    # @param [String] The reason for raising an exception.
-    # @param [HttpResponse] The HttpReponse of the API call.
-    def initialize(reason, response)
-      super(reason, response)
-      hash = APIHelper.json_deserialize(@response.raw_body)
-      unbox(hash)
-    end
-
-    # Populates this object by extracting properties from a hash.
-    # @param [Hash] The deserialized response sent by the server in the
-    # response body.
-    def unbox(hash)
+    attr_accessor :error_message
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
       @error_code = hash.key?('errorCode') ? hash['errorCode'] : nil
       @error_message = hash.key?('errorMessage') ? hash['errorMessage'] : nil
     end

data/lib/verizon/exceptions/gio_rest_error_response_exception.rb

@@ -15,21 +15,21 @@ module Verizon
 
     # TODO: Write general description for this method
     # @return [String]
-    attr_accessor :error_message
-
-    # The constructor.
-    # @param [String] The reason for raising an exception.
-    # @param [HttpResponse] The HttpReponse of the API call.
-    def initialize(reason, response)
-      super(reason, response)
-      hash = APIHelper.json_deserialize(@response.raw_body)
-      unbox(hash)
-    end
-
-    # Populates this object by extracting properties from a hash.
-    # @param [Hash] The deserialized response sent by the server in the
-    # response body.
-    def unbox(hash)
+    attr_accessor :error_message
+
+    # The constructor.
+    # @param [String] The reason for raising an exception.
+    # @param [HttpResponse] The HttpReponse of the API call.
+    def initialize(reason, response)
+      super(reason, response)
+      hash = APIHelper.json_deserialize(@response.raw_body)
+      unbox(hash)
+    end
+
+    # Populates this object by extracting properties from a hash.
+    # @param [Hash] The deserialized response sent by the server in the
+    # response body.
+    def unbox(hash)
       @error_code = hash.key?('errorCode') ? hash['errorCode'] : SKIP
       @error_message = hash.key?('errorMessage') ? hash['errorMessage'] : SKIP
     end