sdksio-verizon-apis-sdk 1.6.0 → 1.7.0

data/lib/verizon/controllers/device_monitoring_controller.rb

@@ -0,0 +1,56 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # DeviceMonitoringController
+  class DeviceMonitoringController < BaseController
+    # TODO: type endpoint description here
+    # @param [NotificationReportRequest] body Required parameter: Create
+    # Reachability Report Request
+    # @return [ApiResponse]  the complete http response with raw body and status code.
+    def device_reachability(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/m2m/v1/diagnostics/basic/devicereachability',
+                                     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(RequestResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Error Response',
+                                 RestErrorResponseException))
+        .execute
+    end
+
+    # TODO: type endpoint description here
+    # @param [StopMonitorRequest] body Optional parameter: Example:
+    # @return [ApiResponse]  the complete http response with raw body and status code.
+    def stop_device_reachability(body: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/m2m/v1/diagnostics/basic/devicereachability',
+                                     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(RequestResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Error Response',
+                                 RestErrorResponseException))
+        .execute
+    end
+  end
+end

data/lib/verizon/controllers/device_profile_management_controller.rb

@@ -0,0 +1,104 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # DeviceProfileManagementController
+  class DeviceProfileManagementController < BaseController
+    # Uses the profile to bring the device under management.
+    # @param [ActivateDeviceProfileRequest] body Required parameter: Device
+    # Profile Query
+    # @return [ApiResponse]  the complete http response with raw body and status code.
+    def activate_device_through_profile(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/m2m/v1/devices/profile/actions/activate_enable',
+                                     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(RequestResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad request',
+                                 RestErrorResponseException))
+        .execute
+    end
+
+    # Uses the profile to activate the device.
+    # @param [ProfileRequest] body Required parameter: Device Profile Query
+    # @return [ApiResponse]  the complete http response with raw body and status code.
+    def profile_to_activate_device(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/m2m/v1/devices/profile/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(And.new('thingspace_oauth', 'VZ-M2M-Token')))
+        .response(new_response_handler
+                    .deserializer(APIHelper.method(:custom_type_deserializer))
+                    .deserialize_into(RequestResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad request',
+                                 RestErrorResponseException))
+        .execute
+    end
+
+    # Uses the profile to deactivate the device.
+    # @param [DeactivateDeviceProfileRequest] body Required parameter: Device
+    # Profile Query
+    # @return [ApiResponse]  the complete http response with raw body and status code.
+    def profile_to_deactivate_device(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/m2m/v1/devices/profile/actions/deactivate',
+                                     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(RequestResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad request',
+                                 RestErrorResponseException))
+        .execute
+    end
+
+    # Allows the profile to set the fallback attribute to the device.
+    # @param [SetFallbackAttributeRequest] body Required parameter: Device
+    # Profile Query
+    # @return [ApiResponse]  the complete http response with raw body and status code.
+    def profile_to_set_fallback_attribute(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/m2m/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(RequestResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Bad request',
+                                 RestErrorResponseException))
+        .execute
+    end
+  end
+end

data/lib/verizon/controllers/device_reports_controller.rb

@@ -0,0 +1,131 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # DeviceReportsController
+  class DeviceReportsController < BaseController
+    # Calculate aggregated report per day with number of sessions and usage
+    # information. User will receive synchronous response for specified list of
+    # devices (Max 10) and date range (Max 180 days).
+    # @param [AggregateSessionReportRequest] body Required parameter: Aggregated
+    # report request.
+    # @return [ApiResponse]  the complete http response with raw body and status code.
+    def calculate_aggregated_report_synchronous(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/report/aggregate',
+                                     Server::HYPER_PRECISE_LOCATION)
+                   .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(AggregateSessionReport.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
+
+    # Calculate aggregated report per day with number of sessions and usage
+    # information. User will receive an asynchronous callback for the specified
+    # list of devices (Max 10000) and date range (Max 180 days).
+    # @param [AggregateSessionReportRequest] body Required parameter: Aggregated
+    # session report request.
+    # @return [ApiResponse]  the complete http response with raw body and status code.
+    def calculate_aggregated_report_asynchronous(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/report/async/aggregate',
+                                     Server::HYPER_PRECISE_LOCATION)
+                   .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(AggregatedReportCallbackResult.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
+
+    # Detailed report of session duration and number of bytes transferred per
+    # day.
+    # @param [SessionReportRequest] body Required parameter: Request for
+    # sessions report.
+    # @return [ApiResponse]  the complete http response with raw body and status code.
+    def get_sessions_report(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/report/sessions',
+                                     Server::HYPER_PRECISE_LOCATION)
+                   .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(SessionReport.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
+  end
+end

data/lib/verizon/controllers/device_service_management_controller.rb

@@ -0,0 +1,89 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # DeviceServiceManagementController
+  class DeviceServiceManagementController < BaseController
+    # Gets the list of a status for hyper-precise location devices.
+    # @param [String] imei Required parameter: A unique identifier for a
+    # device.
+    # @param [String] account_number Required parameter: A unique identifier for
+    # an account.
+    # @return [ApiResponse]  the complete http response with raw body and status code.
+    def get_device_hyper_precise_status(imei,
+                                        account_number)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/devices/services',
+                                     Server::HYPER_PRECISE_LOCATION)
+                   .query_param(new_parameter(imei, key: 'imei'))
+                   .query_param(new_parameter(account_number, key: 'accountNumber'))
+                   .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(BullseyeServiceResult.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
+
+    # Enable/disable hyper-precise service for a device.
+    # @param [BullseyeServiceRequest] body Required parameter: List of devices
+    # and hyper-precise required statuses.
+    # @return [ApiResponse]  the complete http response with raw body and status code.
+    def update_device_hyper_precise_status(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/devices/services',
+                                     Server::HYPER_PRECISE_LOCATION)
+                   .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(BullseyeServiceResult.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
+  end
+end

data/lib/verizon/controllers/device_sms_messaging_controller.rb

@@ -0,0 +1,108 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # DeviceSMSMessagingController
+  class DeviceSMSMessagingController < BaseController
+    # Sends an SMS message to one device. Messages are queued on the M2M MC
+    # Platform and sent as soon as possible, but they may be delayed due to
+    # traffic and routing considerations.
+    # @param [GIOSMSSendRequest] body Required parameter: SMS message to an
+    # indiividual device.
+    # @return [ApiResponse]  the complete http response with raw body and status code.
+    def send_an_sms_message(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/m2m/v1/sms',
+                                     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
+
+    # Retrieves queued SMS messages sent by all M2M MC devices associated with
+    # an account.
+    # @param [String] account_name Required parameter: Numeric account name
+    # @param [String] mnext Optional parameter: Continue the previous query from
+    # the pageUrl in Location Header
+    # @return [ApiResponse]  the complete http response with raw body and status code.
+    def get_sms_messages(account_name,
+                         mnext: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/m2m/v1/sms/{accountName}/history',
+                                     Server::THINGSPACE)
+                   .template_param(new_parameter(account_name, key: 'accountName')
+                                    .should_encode(true))
+                   .query_param(new_parameter(mnext, key: 'next'))
+                   .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(SmsMessagesResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Error response',
+                                 GIORestErrorResponseException))
+        .execute
+    end
+
+    # Starts delivery of SMS messages for the specified account.
+    # @param [String] account_name Required parameter: Numeric account name
+    # @return [ApiResponse]  the complete http response with raw body and status code.
+    def start_sms_message_delivery(account_name)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/m2m/v1/sms/{accountName}/startCallbacks',
+                                     Server::THINGSPACE)
+                   .template_param(new_parameter(account_name, key: 'accountName')
+                                    .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(SuccessResponse.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('default',
+                                 'Error response',
+                                 GIORestErrorResponseException))
+        .execute
+    end
+
+    # Returns a list of sms history for a given device during a specified time
+    # frame.
+    # @param [SMSEventHistoryRequest] body Required parameter: Device Query
+    # @return [ApiResponse]  the complete http response with raw body and status code.
+    def list_sms_message_history(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/m2m/v1/devices/sms/history/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(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
+  end
+end

data/lib/verizon/controllers/devices_location_subscriptions_controller.rb

@@ -0,0 +1,57 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # DevicesLocationSubscriptionsController
+  class DevicesLocationSubscriptionsController < BaseController
+    # This subscriptions endpoint retrieves an account's current location
+    # subscription status.
+    # @param [String] account_name Required parameter: Account identifier in
+    # "##########-#####".
+    # @return [ApiResponse]  the complete http response with raw body and status code.
+    def get_location_service_subscription_status(account_name)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/subscriptions/{accountName}',
+                                     Server::DEVICE_LOCATION)
+                   .template_param(new_parameter(account_name, key: 'accountName')
+                                    .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(DeviceLocationSubscription.method(:from_hash))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Unexpected error.',
+                                 DeviceLocationResultException))
+        .execute
+    end
+
+    # This endpoint allows user to search for billable usage for accounts based
+    # on the provided date range.
+    # @param [BillUsageRequest] body Required parameter: Request to obtain
+    # billable usage for accounts.
+    # @return [ApiResponse]  the complete http response with raw body and status code.
+    def get_location_service_usage(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/usage',
+                                     Server::DEVICE_LOCATION)
+                   .header_param(new_parameter('*/*', 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(:json_deserialize))
+                    .is_api_response(true)
+                    .local_error('400',
+                                 'Unexpected error.',
+                                 DeviceLocationResultException))
+        .execute
+    end
+  end
+end