sdksio-verizon-apis-sdk 1.4.0 → 1.5.1

data/lib/verizon/controllers/managing_esim_profiles_controller.rb

@@ -6,9 +6,103 @@
 module Verizon
   # ManagingESIMProfilesController
   class ManagingESIMProfilesController < BaseController
+    # Resume service to a device with either a lead or local profile.
+    # @param [GIOProfileRequest] body Required parameter: Device Profile Query
+    # @return [ApiResponse]  the complete http response with raw body and status code.
+    def resume_profile(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/m2m/v1/devices/profile/actions/profile_resume',
+                                     Server::THINGSPACE)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .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(And.new('thingspace_oauth', 'VZ-M2M-Token')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GIORequestResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Error response',
+                                 GIORestErrorResponseException))
+        .execute
+    end
+
+    # Suspend a device's Global profile.
+    # @param [GIOProfileRequest] body Required parameter: Device Profile Query
+    # @return [ApiResponse]  the complete http response with raw body and status code.
+    def profile_suspend(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/m2m/v1/devices/profile/actions/profile_suspend',
+                                     Server::THINGSPACE)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .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(And.new('thingspace_oauth', 'VZ-M2M-Token')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GIORequestResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Error response',
+                                 GIORestErrorResponseException))
+        .execute
+    end
+
+    # Suspend all service to an eUICC device, including the lead and local
+    # profile.
+    # @param [GIOProfileRequest] body Required parameter: Device Profile Query
+    # @return [ApiResponse]  the complete http response with raw body and status code.
+    def device_suspend(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/m2m/v1/devices/profile/actions/device_suspend',
+                                     Server::THINGSPACE)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .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(And.new('thingspace_oauth', 'VZ-M2M-Token')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GIORequestResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Error response',
+                                 GIORestErrorResponseException))
+        .execute
+    end
+
+    # Enable a fallback profile to be set.
+    # @param [FallBack] body Required parameter: Set the fallback attributes to
+    # allow a fallback profile to be activated.
+    # @return [ApiResponse]  the complete http response with raw body and status code.
+    def set_fallback(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/v1/devices/profile/actions/setfallbackattribute',
+                                     Server::THINGSPACE)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .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(And.new('thingspace_oauth', 'VZ-M2M-Token')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GIORequestResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Error response',
+                                 GIORestErrorResponseException))
+        .execute
+    end
+
     # Activate a device with either a lead or local profile.
     # @param [GIOProfileRequest] body Required parameter: Device Profile Query
-    # @return [GIORequestResponse] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def activate_a_device_profile(body)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -18,21 +112,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(GIORequestResponse.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('default',
-                                'Error response',
-                                GIORestErrorResponseException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GIORequestResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Error response',
+                                 GIORestErrorResponseException))
         .execute
     end
 
     # Enable a device lead or local profile.
     # @param [DeviceProfileRequest] body Required parameter: Device Profile
     # Query
-    # @return [GIORequestResponse] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def enable_a_device_profile(body)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -42,14 +136,14 @@ module Verizon
                    .body_param(new_parameter(body))
                    .header_param(new_parameter('application/json', key: 'accept'))
                    .body_serializer(proc do |param| param.to_json unless param.nil? end)
-                   .auth(Single.new('oAuth2')))
+                   .auth(And.new('thingspace_oauth', 'VZ-M2M-Token')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(GIORequestResponse.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('default',
-                                'Error response',
-                                GIORestErrorResponseException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GIORequestResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Error response',
+                                 GIORestErrorResponseException))
         .execute
     end
 
@@ -57,7 +151,7 @@ module Verizon
     # use the **Activate** endpoint above.
     # @param [GIODeactivateDeviceProfileRequest] body Required parameter: Device
     # Profile Query
-    # @return [GIORequestResponse] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def deactivate_a_device_profile(body)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -67,21 +161,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(GIORequestResponse.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('default',
-                                'Error response',
-                                GIORestErrorResponseException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GIORequestResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Error response',
+                                 GIORestErrorResponseException))
         .execute
     end
 
     # Enable the Global IoT Orchestration device profile for download.
     # @param [DeviceProfileRequest] body Required parameter: Device Profile
     # Query
-    # @return [GIORequestResponse] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def enable_a_device_profile_for_download(body)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -91,21 +185,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(GIORequestResponse.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('default',
-                                'Error response',
-                                GIORestErrorResponseException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GIORequestResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Error response',
+                                 GIORestErrorResponseException))
         .execute
     end
 
     # Download a Global IoT Orchestration device profile.
     # @param [DeviceProfileRequest] body Required parameter: Device Profile
     # Query
-    # @return [GIORequestResponse] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def download_a_device_profile(body)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -115,14 +209,14 @@ module Verizon
                    .body_param(new_parameter(body))
                    .header_param(new_parameter('application/json', key: 'accept'))
                    .body_serializer(proc do |param| param.to_json unless param.nil? end)
-                   .auth(Single.new('oAuth2')))
+                   .auth(And.new('thingspace_oauth', 'VZ-M2M-Token')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(GIORequestResponse.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('default',
-                                'Error response',
-                                GIORestErrorResponseException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GIORequestResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Error response',
+                                 GIORestErrorResponseException))
         .execute
     end
 
@@ -130,7 +224,7 @@ module Verizon
     # profile must be deactivated first!
     # @param [DeviceProfileRequest] body Required parameter: Device Profile
     # Query
-    # @return [GIORequestResponse] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def delete_a_device_profile(body)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -140,14 +234,14 @@ module Verizon
                    .body_param(new_parameter(body))
                    .header_param(new_parameter('application/json', key: 'accept'))
                    .body_serializer(proc do |param| param.to_json unless param.nil? end)
-                   .auth(Single.new('oAuth2')))
+                   .auth(And.new('thingspace_oauth', 'VZ-M2M-Token')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(GIORequestResponse.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('default',
-                                'Error response',
-                                GIORestErrorResponseException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(GIORequestResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Error response',
+                                 GIORestErrorResponseException))
         .execute
     end
   end

data/lib/verizon/controllers/oauth_authorization_controller.rb

@@ -13,10 +13,10 @@ module Verizon
     # space-delimited list.
     # @param [Hash] _field_parameters Additional optional form parameters are
     # supported by this endpoint.
-    # @return [OauthToken] response from the API call
-    def request_token(authorization,
-                      scope: nil,
-                      _field_parameters: nil)
+    # @return [ApiResponse]  the complete http response with raw body and status code.
+    def request_token_thingspace_oauth(authorization,
+                                       scope: nil,
+                                       _field_parameters: nil)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
                                      '/oauth2/token',
@@ -28,15 +28,15 @@ module Verizon
                    .header_param(new_parameter('application/json', key: 'accept'))
                    .additional_form_params(_field_parameters))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(OauthToken.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'OAuth 2 provider returned an error.',
-                                OauthProviderException)
-                   .local_error('401',
-                                'OAuth 2 provider says client authentication failed.',
-                                OauthProviderException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(OauthToken.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'OAuth 2 provider returned an error.',
+                                 OauthProviderException)
+                    .local_error('401',
+                                 'OAuth 2 provider says client authentication failed.',
+                                 OauthProviderException))
         .execute
     end
   end

data/lib/verizon/controllers/performance_metrics_controller.rb

@@ -10,7 +10,7 @@ module Verizon
     # network availability, MEC hostnames and more.
     # @param [QueryMECPerformanceMetricsRequest] body Optional parameter:
     # Example:
-    # @return [MECPerformanceMetrics] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def query_mec_performance_metrics(body: nil)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -20,29 +20,29 @@ 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(MECPerformanceMetrics.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Bad Request.',
-                                EdgePerformanceResultException)
-                   .local_error('401',
-                                'Unauthorized request.',
-                                EdgePerformanceResultException)
-                   .local_error('403',
-                                'Request forbidden.',
-                                EdgePerformanceResultException)
-                   .local_error('404',
-                                'Resource Not Found.',
-                                EdgePerformanceResultException)
-                   .local_error('405',
-                                'Method Not Allowed.',
-                                EdgePerformanceResultException)
-                   .local_error('503',
-                                'Service Unavailable.',
-                                EdgePerformanceResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(MECPerformanceMetrics.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad Request.',
+                                 EdgePerformanceResultException)
+                    .local_error('401',
+                                 'Unauthorized request.',
+                                 EdgePerformanceResultException)
+                    .local_error('403',
+                                 'Request forbidden.',
+                                 EdgePerformanceResultException)
+                    .local_error('404',
+                                 'Resource Not Found.',
+                                 EdgePerformanceResultException)
+                    .local_error('405',
+                                 'Method Not Allowed.',
+                                 EdgePerformanceResultException)
+                    .local_error('503',
+                                 'Service Unavailable.',
+                                 EdgePerformanceResultException))
         .execute
     end
   end

data/lib/verizon/controllers/promotion_period_information_controller.rb

@@ -7,9 +7,9 @@ module Verizon
   # PromotionPeriodInformationController
   class PromotionPeriodInformationController < BaseController
     # Retrieves the usage history of a device during the promotion period.
-    # @param [RequestBodyForUsage] body Required parameter: Retrieve Aggregate
+    # @param [ARequestBodyForUsage] body Required parameter: Retrieve Aggregate
     # Usage
-    # @return [ResponseToUsageQuery] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def get_promo_device_usage_history(body)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -19,22 +19,22 @@ 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(ResponseToUsageQuery.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('default',
-                                'All error responses will be in this format',
-                                ReadySimRestErrorResponseException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ResponseToUsageQuery.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'All error responses will be in this format',
+                                 ReadySimRestErrorResponseException))
         .execute
     end
 
     # Retrieves the aggregate usage for an account using pseudo-MDN during the
     # promotional period using a callback.
-    # @param [UsageRequestBody] body Required parameter: Retrieve Aggregate
+    # @param [RequestBodyForUsage] body Required parameter: Retrieve Aggregate
     # Usage
-    # @return [UsageRequestResponse] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def get_promo_device_aggregate_usage_history(body)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -44,14 +44,14 @@ module Verizon
                    .body_param(new_parameter(body))
                    .header_param(new_parameter('application/json', key: 'accept'))
                    .body_serializer(proc do |param| param.to_json unless param.nil? end)
-                   .auth(Single.new('oAuth2')))
+                   .auth(And.new('thingspace_oauth', 'VZ-M2M-Token')))
         .response(new_response_handler
-                   .deserializer(APIHelper.method(:custom_type_deserializer))
-                   .deserialize_into(UsageRequestResponse.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('default',
-                                'Error response',
-                                ReadySimRestErrorResponseException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(UsageRequestResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Error response',
+                                 ReadySimRestErrorResponseException))
         .execute
     end
   end