sdksio-verizon-apis-sdk 1.5.0 → 1.5.1

data/lib/verizon/controllers/hyper_precise_location_callbacks_controller.rb

@@ -9,7 +9,7 @@ module Verizon
     # Find registered callback listener for account by account number.
     # @param [String] account_number Required parameter: A unique identifier for
     # an account.
-    # @return [Array[CallbackCreated]] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_registered_callbacks(account_number)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -19,28 +19,28 @@ 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(CallbackCreated.method(:from_hash))
-                   .is_api_response(true)
-                   .is_response_array(true)
-                   .local_error('400',
-                                'Bad request.',
-                                HyperPreciseLocationResultException)
-                   .local_error('401',
-                                'Unauthorized request. Access token is missing or invalid.',
-                                HyperPreciseLocationResultException)
-                   .local_error('403',
-                                'Forbidden request.',
-                                HyperPreciseLocationResultException)
-                   .local_error('404',
-                                'Bad request. Not found.',
-                                HyperPreciseLocationResultException)
-                   .local_error('409',
-                                'Bad request. Conflict state.',
-                                HyperPreciseLocationResultException)
-                   .local_error('500',
-                                'Internal Server Error.',
-                                HyperPreciseLocationResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(CallbackCreated.method(:from_hash))
+                    .is_api_response(true)
+                    .is_response_array(true)
+                    .local_error('400',
+                                 'Bad request.',
+                                 HyperPreciseLocationResultException)
+                    .local_error('401',
+                                 'Unauthorized request. Access token is missing or invalid.',
+                                 HyperPreciseLocationResultException)
+                    .local_error('403',
+                                 'Forbidden request.',
+                                 HyperPreciseLocationResultException)
+                    .local_error('404',
+                                 'Bad request. Not found.',
+                                 HyperPreciseLocationResultException)
+                    .local_error('409',
+                                 'Bad request. Conflict state.',
+                                 HyperPreciseLocationResultException)
+                    .local_error('500',
+                                 'Internal Server Error.',
+                                 HyperPreciseLocationResultException))
         .execute
     end
 
@@ -52,7 +52,7 @@ module Verizon
     # @param [String] account_number Required parameter: A unique identifier for
     # an account.
     # @param [HyperPreciseLocationCallback] body Required parameter: Example:
-    # @return [CallbackRegistered] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def register_callback(account_number,
                           body)
       new_api_call_builder
@@ -66,27 +66,27 @@ 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(CallbackRegistered.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Bad request.',
-                                HyperPreciseLocationResultException)
-                   .local_error('401',
-                                'Unauthorized request. Access token is missing or invalid.',
-                                HyperPreciseLocationResultException)
-                   .local_error('403',
-                                'Forbidden request.',
-                                HyperPreciseLocationResultException)
-                   .local_error('404',
-                                'Bad request. Not found.',
-                                HyperPreciseLocationResultException)
-                   .local_error('409',
-                                'Bad request. Conflict state.',
-                                HyperPreciseLocationResultException)
-                   .local_error('500',
-                                'Internal Server Error.',
-                                HyperPreciseLocationResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(CallbackRegistered.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad request.',
+                                 HyperPreciseLocationResultException)
+                    .local_error('401',
+                                 'Unauthorized request. Access token is missing or invalid.',
+                                 HyperPreciseLocationResultException)
+                    .local_error('403',
+                                 'Forbidden request.',
+                                 HyperPreciseLocationResultException)
+                    .local_error('404',
+                                 'Bad request. Not found.',
+                                 HyperPreciseLocationResultException)
+                    .local_error('409',
+                                 'Bad request. Conflict state.',
+                                 HyperPreciseLocationResultException)
+                    .local_error('500',
+                                 'Internal Server Error.',
+                                 HyperPreciseLocationResultException))
         .execute
     end
 
@@ -96,7 +96,7 @@ module Verizon
     # a account.
     # @param [String] service Required parameter: The name of the callback
     # service that will be deleted.
-    # @return [void] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def deregister_callback(account_number,
                             service)
       new_api_call_builder
@@ -107,26 +107,26 @@ module Verizon
                    .query_param(new_parameter(service, key: 'service'))
                    .auth(And.new('thingspace_oauth', 'VZ-M2M-Token')))
         .response(new_response_handler
-                   .is_response_void(true)
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Bad request.',
-                                HyperPreciseLocationResultException)
-                   .local_error('401',
-                                'Unauthorized request. Access token is missing or invalid.',
-                                HyperPreciseLocationResultException)
-                   .local_error('403',
-                                'Forbidden request.',
-                                HyperPreciseLocationResultException)
-                   .local_error('404',
-                                'Bad request. Not found.',
-                                HyperPreciseLocationResultException)
-                   .local_error('409',
-                                'Bad request. Conflict state.',
-                                HyperPreciseLocationResultException)
-                   .local_error('500',
-                                'Internal Server Error.',
-                                HyperPreciseLocationResultException))
+                    .is_response_void(true)
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad request.',
+                                 HyperPreciseLocationResultException)
+                    .local_error('401',
+                                 'Unauthorized request. Access token is missing or invalid.',
+                                 HyperPreciseLocationResultException)
+                    .local_error('403',
+                                 'Forbidden request.',
+                                 HyperPreciseLocationResultException)
+                    .local_error('404',
+                                 'Bad request. Not found.',
+                                 HyperPreciseLocationResultException)
+                    .local_error('409',
+                                 'Bad request. Conflict state.',
+                                 HyperPreciseLocationResultException)
+                    .local_error('500',
+                                 'Internal Server Error.',
+                                 HyperPreciseLocationResultException))
         .execute
     end
   end

data/lib/verizon/controllers/m_5g_bi_device_actions_controller.rb

@@ -0,0 +1,88 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # M5gBIDeviceActionsController
+  class M5gBIDeviceActionsController < BaseController
+    # Uses the decive's Integrated Circuit Card Identification Number (ICCID) to
+    # retrive and display the device's properties.
+    # @param [M5gBideviceId] body Required parameter: Device Profile Query
+    # @return [ApiResponse]  the complete http response with raw body and status code.
+    def business_internetlist_device_information(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/actions/list',
+                                     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(Or.new('thingspace_oauth', 'VZ-M2M-Token')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(M5gBideviceDetailsresponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Error response',
+                                 M5gBiRestErrorResponseException))
+        .execute
+    end
+
+    # Uses the device's ICCID and IMEI to activate service.
+    # @param [M5gBiactivateRequest] body Required parameter: Activate 5G BI
+    # service. Defining <code>publicIpRestriction</code> as "Unrestricted" or
+    # "Restricted" is required for activating as Public Static. Leave
+    # <code>publicIpRestriction</code> undefined to activate as Public Dynamic.
+    # Removing <code>publicIpRestriction</code> from the request will activate
+    # as Mobile Private Network (MPN).
+    # @return [ApiResponse]  the complete http response with raw body and status code.
+    def business_internetactivate_using_post(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/actions/activate',
+                                     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(Or.new('thingspace_oauth', 'VZ-M2M-Token')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(M5gBiRequestResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Error response',
+                                 M5gBiRestErrorResponseException))
+        .execute
+    end
+
+    # Change a device's service plan to use 5G BI.
+    # @param [M5gBichangeRequest] body Required parameter: This endpoint is for
+    # use when changing a device's service plan to a 5G BI service plan. The
+    # service plan can change for an active device up to four times per month
+    # but will require address validation for each change. The service plan
+    # cannot be changed for a device while its service is suspended.
+    # @return [ApiResponse]  the complete http response with raw body and status code.
+    def business_internet_serviceplanchange(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/actions/plan',
+                                     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(Or.new('thingspace_oauth', 'VZ-M2M-Token')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(M5gBiRequestResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Error response',
+                                 M5gBiRestErrorResponseException))
+        .execute
+    end
+  end
+end

data/lib/verizon/controllers/m_5g_edge_platforms_controller.rb

@@ -24,7 +24,7 @@ module Verizon
     # @param [String] ue_identity Optional parameter: The identifier value for
     # User Equipment. The type of identifier is defined by the 'UEIdentityType'
     # parameter. The`IPAddress`format can be IPv4 or IPv6.
-    # @return [ListMECPlatformsResult] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_mec_platforms(region: nil,
                            service_profile_id: nil,
                            subscriber_density: nil,
@@ -42,25 +42,25 @@ 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(ListMECPlatformsResult.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'HTTP 400 Bad Request.',
-                                EdgeDiscoveryResultException)
-                   .local_error('401',
-                                'HTTP 401 Unauthorized.',
-                                EdgeDiscoveryResultException)
-                   .local_error('default',
-                                'HTTP 500 Internal Server Error.',
-                                EdgeDiscoveryResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ListMECPlatformsResult.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'HTTP 400 Bad Request.',
+                                 EdgeDiscoveryResultException)
+                    .local_error('401',
+                                 'HTTP 401 Unauthorized.',
+                                 EdgeDiscoveryResultException)
+                    .local_error('default',
+                                 'HTTP 500 Internal Server Error.',
+                                 EdgeDiscoveryResultException))
         .execute
     end
 
     # List the geographical regions available, based on the user's bearer token.
     # **Note:** Country code, Metropolitan area, Area and Zone are future
     # functionality and will currently return a "null" value.
-    # @return [ListRegionsResult] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def list_regions
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::GET,
@@ -69,18 +69,18 @@ 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(ListRegionsResult.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'HTTP 400 Bad Request.',
-                                EdgeDiscoveryResultException)
-                   .local_error('401',
-                                'HTTP 401 Unauthorized.',
-                                EdgeDiscoveryResultException)
-                   .local_error('default',
-                                'HTTP 500 Internal Server Error.',
-                                EdgeDiscoveryResultException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(ListRegionsResult.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'HTTP 400 Bad Request.',
+                                 EdgeDiscoveryResultException)
+                    .local_error('401',
+                                 'HTTP 401 Unauthorized.',
+                                 EdgeDiscoveryResultException)
+                    .local_error('default',
+                                 'HTTP 500 Internal Server Error.',
+                                 EdgeDiscoveryResultException))
         .execute
     end
   end

data/lib/verizon/controllers/m_v2_triggers_controller.rb

@@ -8,7 +8,7 @@ module Verizon
   class MV2TriggersController < BaseController
     # This creates an individual change plan for account group share.
     # @param [CreateTriggerV2Request] body Required parameter: Example:
-    # @return [TriggerV2Response] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def create_trigger(body)
       new_api_call_builder
         .request(new_request_builder(HttpMethodEnum::POST,
@@ -20,12 +20,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(TriggerV2Response.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Error Response',
-                                RulesEngineRestErrorResponseException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TriggerV2Response.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Error Response',
+                                 RulesEngineRestErrorResponseException))
         .execute
     end
 
@@ -33,7 +33,7 @@ module Verizon
     # @param [String] vz_m2m_token Required parameter: M2M-MC Session Token
     # @param [UpdateTriggerV2Request] body Required parameter: Example:
     # @param [String] x_request_id Optional parameter: Transaction Id
-    # @return [TriggerV2Response] response from the API call
+    # @return [ApiResponse]  the complete http response with raw body and status code.
     def update_trigger(vz_m2m_token,
                        body,
                        x_request_id: nil)
@@ -49,12 +49,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(TriggerV2Response.method(:from_hash))
-                   .is_api_response(true)
-                   .local_error('400',
-                                'Error Response',
-                                RulesEngineRestErrorResponseException))
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(TriggerV2Response.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Error Response',
+                                 RulesEngineRestErrorResponseException))
         .execute
     end
   end