sdksio-verizon-apis-sdk 1.5.0 → 1.5.1

data/lib/verizon/controllers/campaigns_v2_controller.rb

@@ -10,7 +10,7 @@ module Verizon
     # @param [String] account Required parameter: Account identifier.
     # @param [CampaignSoftwareUpgrade] body Required parameter: Software upgrade
     # information.
-    # @return [CampaignSoftware] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def schedule_campaign_firmware_upgrade(account,
                                            body)
       new_api_call_builder
@@ -25,12 +25,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(CampaignSoftware.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Unexpected error.',
-                                FotaV2ResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(CampaignSoftware.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Unexpected error.',
+                                 FotaV2ResultException))
         .execute
     end
 
@@ -38,7 +38,7 @@ module Verizon
     # @param [String] account Required parameter: Account identifier.
     # @param [String] campaign_id Required parameter: Software upgrade
     # identifier.
-    # @return [CampaignSoftware] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def get_campaign_information(account,
                                  campaign_id)
       new_api_call_builder
@@ -52,12 +52,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(CampaignSoftware.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Unexpected error.',
-                                FotaV2ResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(CampaignSoftware.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Unexpected error.',
+                                 FotaV2ResultException))
         .execute
     end
 
@@ -68,7 +68,7 @@ module Verizon
     # information.
     # @param [V2AddOrRemoveDeviceRequest] body Required parameter: Request to
     # add or remove device to existing software upgrade information.
-    # @return [V2AddOrRemoveDeviceResult] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def update_campaign_firmware_devices(account,
                                          campaign_id,
                                          body)
@@ -86,12 +86,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(V2AddOrRemoveDeviceResult.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Unexpected error.',
-                                FotaV2ResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(V2AddOrRemoveDeviceResult.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Unexpected error.',
+                                 FotaV2ResultException))
         .execute
     end
 
@@ -100,7 +100,7 @@ module Verizon
     # @param [String] account Required parameter: Account identifier.
     # @param [String] campaign_id Required parameter: Unique identifier of
     # campaign.
-    # @return [FotaV2SuccessResult] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def cancel_campaign(account,
                         campaign_id)
       new_api_call_builder
@@ -114,12 +114,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(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
 
@@ -130,7 +130,7 @@ module Verizon
     # information.
     # @param [V2ChangeCampaignDatesRequest] body Required parameter: New dates
     # and time windows.
-    # @return [CampaignSoftware] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def update_campaign_dates(account,
                               campaign_id,
                               body)
@@ -148,12 +148,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(CampaignSoftware.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Unexpected error.',
-                                FotaV2ResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(CampaignSoftware.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Unexpected error.',
+                                 FotaV2ResultException))
         .execute
     end
 
@@ -162,7 +162,7 @@ module Verizon
     # @param [String] acc Required parameter: Account identifier.
     # @param [UploadAndScheduleFileRequest] body Required parameter: Device
     # logging information.
-    # @return [UploadAndScheduleFileResponse] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def schedule_file_upgrade(acc,
                               body)
       new_api_call_builder
@@ -177,12 +177,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(UploadAndScheduleFileResponse.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Unexpected error.',
-                                FotaV2ResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(UploadAndScheduleFileResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Unexpected error.',
+                                 FotaV2ResultException))
         .execute
     end
 
@@ -191,7 +191,7 @@ module Verizon
     # @param [String] acc Required parameter: Account identifier.
     # @param [SchedulesSoftwareUpgradeRequest] body Required parameter: Device
     # logging information.
-    # @return [UploadAndScheduleFileResponse] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def schedule_sw_upgrade_http_devices(acc,
                                          body)
       new_api_call_builder
@@ -206,12 +206,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(UploadAndScheduleFileResponse.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Unexpected error.',
-                                FotaV2ResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(UploadAndScheduleFileResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Unexpected error.',
+                                 FotaV2ResultException))
         .execute
     end
   end

data/lib/verizon/controllers/campaigns_v3_controller.rb

@@ -8,17 +8,17 @@ module Verizon
   class CampaignsV3Controller < BaseController
     # This endpoint allows a user to schedule a firmware upgrade for a list of
     # devices.
-    # @param [String] acc Required parameter: Account identifier.
+    # @param [String] account_name Required parameter: Account identifier.
     # @param [CampaignFirmwareUpgrade] body Required parameter: Firmware upgrade
     # information.
-    # @return [FirmwareCampaign] response from the API call
-    def schedule_campaign_firmware_upgrade(acc,
+    # @return [ApiResponse]  the complete http response with raw body and status code.
+    def schedule_campaign_firmware_upgrade(account_name,
                                            body)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
-                                     '/campaigns/firmware/{acc}',
+                                     '/campaigns/firmware/{accountName}',
                                      Server::SOFTWARE_MANAGEMENT_V3)
-                   .template_param(new_parameter(acc, key: 'acc')
+                   .template_param(new_parameter(account_name, key: 'accountName')
                                     .should_encode(true))
                    .header_param(new_parameter('application/json', key: 'Content-Type'))
                    .body_param(new_parameter(body))
@@ -26,12 +26,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(FirmwareCampaign.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Unexpected error.',
-                                FotaV3ResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(FirmwareCampaign.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Unexpected error.',
+                                 FotaV3ResultException))
         .execute
     end
 
@@ -42,7 +42,7 @@ module Verizon
     # campaign.
     # @param [V3AddOrRemoveDeviceRequest] body Required parameter: Add or remove
     # device to existing upgrade information.
-    # @return [V3AddOrRemoveDeviceResult] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def update_campaign_firmware_devices(acc,
                                          campaign_id,
                                          body)
@@ -60,12 +60,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(V3AddOrRemoveDeviceResult.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Unexpected error.',
-                                FotaV3ResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(V3AddOrRemoveDeviceResult.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Unexpected error.',
+                                 FotaV3ResultException))
         .execute
     end
 
@@ -76,7 +76,7 @@ module Verizon
     # information.
     # @param [V3ChangeCampaignDatesRequest] body Required parameter: New dates
     # and time windows.
-    # @return [FirmwareCampaign] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def update_campaign_dates(acc,
                               campaign_id,
                               body)
@@ -94,68 +94,68 @@ 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(FirmwareCampaign.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Unexpected error.',
-                                FotaV3ResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(FirmwareCampaign.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Unexpected error.',
+                                 FotaV3ResultException))
         .execute
     end
 
     # This endpoint allows the user to retrieve campaign level information for a
     # specified campaign.
-    # @param [String] acc Required parameter: Account identifier.
+    # @param [String] account_name Required parameter: Account identifier.
     # @param [String] campaign_id Required parameter: Firmware upgrade
     # identifier.
-    # @return [Campaign] response from the API call
-    def get_campaign_information(acc,
+    # @return [ApiResponse]  the complete http response with raw body and status code.
+    def get_campaign_information(account_name,
                                  campaign_id)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
-                                     '/campaigns/{acc}/{campaignId}',
+                                     '/campaigns/{accountName}/{campaignId}',
                                      Server::SOFTWARE_MANAGEMENT_V3)
-                   .template_param(new_parameter(acc, key: 'acc')
+                   .template_param(new_parameter(account_name, key: 'accountName')
                                     .should_encode(true))
                    .template_param(new_parameter(campaign_id, key: 'campaignId')
                                     .should_encode(true))
                    .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(Campaign.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Unexpected error.',
-                                FotaV3ResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(Campaign.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Unexpected error.',
+                                 FotaV3ResultException))
         .execute
     end
 
     # This endpoint allows user to cancel a firmware campaign. A firmware
     # campaign already started can not be cancelled.
-    # @param [String] acc Required parameter: Account identifier.
+    # @param [String] account_name Required parameter: Account identifier.
     # @param [String] campaign_id Required parameter: Firmware upgrade
     # information.
-    # @return [FotaV3SuccessResult] response from the API call
-    def cancel_campaign(acc,
+    # @return [ApiResponse]  the complete http response with raw body and status code.
+    def cancel_campaign(account_name,
                         campaign_id)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::DELETE,
-                                     '/campaigns/{acc}/{campaignId}',
+                                     '/campaigns/{accountName}/{campaignId}',
                                      Server::SOFTWARE_MANAGEMENT_V3)
-                   .template_param(new_parameter(acc, key: 'acc')
+                   .template_param(new_parameter(account_name, key: 'accountName')
                                     .should_encode(true))
                    .template_param(new_parameter(campaign_id, key: 'campaignId')
                                     .should_encode(true))
                    .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(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

data/lib/verizon/controllers/client_logging_controller.rb

@@ -9,7 +9,7 @@ module Verizon
     # Returns an array of all devices in the specified account for which logging
     # is enabled.
     # @param [String] account Required parameter: Account identifier.
-    # @return [Array[DeviceLoggingStatus]] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_devices_with_logging_enabled(account)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -20,13 +20,13 @@ 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(DeviceLoggingStatus.method(:from_hash))
-                   .is_api_response(true)
-                   .is_response_array(true)
-                   .local_error('400',
-                                'Unexpected error.',
-                                FotaV2ResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(DeviceLoggingStatus.method(:from_hash))
+                    .is_api_response(true)
+                    .is_response_array(true)
+                    .local_error('400',
+                                 'Unexpected error.',
+                                 FotaV2ResultException))
         .execute
     end
 
@@ -34,7 +34,7 @@ module Verizon
     # @param [String] account Required parameter: Account identifier.
     # @param [DeviceLoggingRequest] body Required parameter: Device logging
     # information.
-    # @return [Array[DeviceLoggingStatus]] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def enable_logging_for_devices(account,
                                    body)
       new_api_call_builder
@@ -49,20 +49,20 @@ 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(DeviceLoggingStatus.method(:from_hash))
-                   .is_api_response(true)
-                   .is_response_array(true)
-                   .local_error('400',
-                                'Unexpected error.',
-                                FotaV2ResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(DeviceLoggingStatus.method(:from_hash))
+                    .is_api_response(true)
+                    .is_response_array(true)
+                    .local_error('400',
+                                 'Unexpected error.',
+                                 FotaV2ResultException))
         .execute
     end
 
     # Turn logging off for a list of devices.
     # @param [String] account Required parameter: Account identifier.
     # @param [String] device_ids Required parameter: The list of device IDs.
-    # @return [void] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def disable_logging_for_devices(account,
                                     device_ids)
       new_api_call_builder
@@ -74,18 +74,18 @@ module Verizon
                    .query_param(new_parameter(device_ids, key: 'deviceIds'))
                    .auth(And.new('thingspace_oauth', 'VZ-M2M-Token')))
         .response(new_response_handler
-                   .is_response_void(true)
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Unexpected error.',
-                                FotaV2ResultException))
+                    .is_response_void(true)
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Unexpected error.',
+                                 FotaV2ResultException))
         .execute
     end
 
     # Enables logging for a specific device.
     # @param [String] account Required parameter: Account identifier.
     # @param [String] device_id Required parameter: Device IMEI identifier.
-    # @return [DeviceLoggingStatus] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def enable_device_logging(account,
                               device_id)
       new_api_call_builder
@@ -99,19 +99,19 @@ 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(DeviceLoggingStatus.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Unexpected error.',
-                                FotaV2ResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(DeviceLoggingStatus.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Unexpected error.',
+                                 FotaV2ResultException))
         .execute
     end
 
     # Disables logging for a specific device.
     # @param [String] account Required parameter: Account identifier.
     # @param [String] device_id Required parameter: Device IMEI identifier.
-    # @return [void] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def disable_device_logging(account,
                                device_id)
       new_api_call_builder
@@ -124,18 +124,18 @@ module Verizon
                                     .should_encode(true))
                    .auth(And.new('thingspace_oauth', 'VZ-M2M-Token')))
         .response(new_response_handler
-                   .is_response_void(true)
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Unexpected error.',
-                                FotaV2ResultException))
+                    .is_response_void(true)
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Unexpected error.',
+                                 FotaV2ResultException))
         .execute
     end
 
     # Gets logs for a specific device.
     # @param [String] account Required parameter: Account identifier.
     # @param [String] device_id Required parameter: Device IMEI identifier.
-    # @return [Array[DeviceLog]] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_device_logs(account,
                          device_id)
       new_api_call_builder
@@ -149,13 +149,13 @@ 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(DeviceLog.method(:from_hash))
-                   .is_api_response(true)
-                   .is_response_array(true)
-                   .local_error('400',
-                                'Unexpected error.',
-                                FotaV2ResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(DeviceLog.method(:from_hash))
+                    .is_api_response(true)
+                    .is_response_array(true)
+                    .local_error('400',
+                                 'Unexpected error.',
+                                 FotaV2ResultException))
         .execute
     end
   end