sdksio-verizon-apis-sdk 1.0.0 → 1.3.0

data/lib/verizon/controllers/exclusions_controller.rb

@@ -0,0 +1,88 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # ExclusionsController
+  class ExclusionsController < BaseController
+    # This consents endpoint sets a new exclusion list.
+    # @param [ConsentRequest] body Required parameter: Request to update account
+    # consent exclusion list.
+    # @return [DeviceLocationSuccessResult] response from the API call
+    def exclude_devices(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/consents',
+                                     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(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(DeviceLocationSuccessResult.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                DeviceLocationResultException))
+        .execute
+    end
+
+    # Removes devices from the exclusion list so that they can be located with
+    # Device Location Services requests.
+    # @param [String] account_name Required parameter: The numeric name of the
+    # account.
+    # @param [String] device_list Required parameter: A list of the device IDs
+    # to remove from the exclusion list.
+    # @return [DeviceLocationSuccessResult] response from the API call
+    def remove_devices_from_exclusion_list(account_name,
+                                           device_list)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/consents',
+                                     Server::DEVICE_LOCATION)
+                   .query_param(new_parameter(account_name, key: 'accountName'))
+                   .query_param(new_parameter(device_list, key: 'deviceList'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(DeviceLocationSuccessResult.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                DeviceLocationResultException))
+        .execute
+    end
+
+    # This consents endpoint retrieves a list of excluded devices in an account.
+    # @param [String] account Required parameter: Account identifier in
+    # "##########-#####".
+    # @param [String] start_index Required parameter: Zero-based number of the
+    # first record to return.
+    # @return [DevicesConsentResult] response from the API call
+    def list_excluded_devices(account,
+                              start_index)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/consents/{account}/index/{startIndex}',
+                                     Server::DEVICE_LOCATION)
+                   .template_param(new_parameter(account, key: 'account')
+                                    .should_encode(true))
+                   .template_param(new_parameter(start_index, key: 'startIndex')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(DevicesConsentResult.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                DeviceLocationResultException))
+        .execute
+    end
+  end
+end

data/lib/verizon/controllers/firmware_v1_controller.rb

@@ -0,0 +1,150 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # FirmwareV1Controller
+  class FirmwareV1Controller < BaseController
+    # Lists all device firmware images available for an account, based on the
+    # devices registered to that account.
+    # @param [String] account Required parameter: Account identifier in
+    # "##########-#####".
+    # @return [Array[Firmware]] response from the API call
+    def list_available_firmware(account)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/firmware/{account}',
+                                     Server::SOFTWARE_MANAGEMENT_V1)
+                   .template_param(new_parameter(account, key: 'account')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(Firmware.method(:from_hash))
+                   .is_api_response(true)
+                   .is_response_array(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV1ResultException))
+        .execute
+    end
+
+    # Schedules a firmware upgrade for devices.
+    # @param [FirmwareUpgradeRequest] body Required parameter: Details of the
+    # firmware upgrade request.
+    # @return [FirmwareUpgrade] response from the API call
+    def schedule_firmware_upgrade(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/upgrades',
+                                     Server::SOFTWARE_MANAGEMENT_V1)
+                   .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(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(FirmwareUpgrade.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV1ResultException))
+        .execute
+    end
+
+    # Returns information about a specified upgrade, include the target date of
+    # the upgrade, the list of devices in the upgrade, and the status of the
+    # upgrade for each device.
+    # @param [String] account Required parameter: Account identifier in
+    # "##########-#####".
+    # @param [String] upgrade_id Required parameter: The UUID of the upgrade,
+    # returned by POST /upgrades when the upgrade was scheduled.
+    # @return [FirmwareUpgrade] response from the API call
+    def list_firmware_upgrade_details(account,
+                                      upgrade_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/upgrades/{account}/upgrade/{upgradeId}',
+                                     Server::SOFTWARE_MANAGEMENT_V1)
+                   .template_param(new_parameter(account, key: 'account')
+                                    .should_encode(true))
+                   .template_param(new_parameter(upgrade_id, key: 'upgradeId')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(FirmwareUpgrade.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV1ResultException))
+        .execute
+    end
+
+    # Add or remove devices from a scheduled upgrade.
+    # @param [String] account Required parameter: Account identifier in
+    # "##########-#####".
+    # @param [String] upgrade_id Required parameter: The UUID of the upgrade,
+    # returned by POST /upgrades when the upgrade was scheduled.
+    # @param [FirmwareUpgradeChangeRequest] body Required parameter: List of
+    # devices to add or remove.
+    # @return [FirmwareUpgradeChangeResult] response from the API call
+    def update_firmware_upgrade_devices(account,
+                                        upgrade_id,
+                                        body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/upgrades/{account}/upgrade/{upgradeId}',
+                                     Server::SOFTWARE_MANAGEMENT_V1)
+                   .template_param(new_parameter(account, key: 'account')
+                                    .should_encode(true))
+                   .template_param(new_parameter(upgrade_id, key: 'upgradeId')
+                                    .should_encode(true))
+                   .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(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(FirmwareUpgradeChangeResult.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV1ResultException))
+        .execute
+    end
+
+    # Cancel a scheduled firmware upgrade.
+    # @param [String] account Required parameter: Account identifier in
+    # "##########-#####".
+    # @param [String] upgrade_id Required parameter: The UUID of the scheduled
+    # upgrade that you want to cancel.
+    # @return [FotaV1SuccessResult] response from the API call
+    def cancel_scheduled_firmware_upgrade(account,
+                                          upgrade_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/upgrades/{account}/upgrade/{upgradeId}',
+                                     Server::SOFTWARE_MANAGEMENT_V1)
+                   .template_param(new_parameter(account, key: 'account')
+                                    .should_encode(true))
+                   .template_param(new_parameter(upgrade_id, key: 'upgradeId')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(FotaV1SuccessResult.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV1ResultException))
+        .execute
+    end
+  end
+end

data/lib/verizon/controllers/firmware_v3_controller.rb

@@ -0,0 +1,90 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # FirmwareV3Controller
+  class FirmwareV3Controller < BaseController
+    # This endpoint allows user to list the firmware of an account.
+    # @param [String] acc Required parameter: Account identifier.
+    # @param [FirmwareProtocolEnum] protocol Required parameter: Filter to
+    # retrieve a specific protocol type used.
+    # @return [Array[FirmwarePackage]] response from the API call
+    def list_available_firmware(acc,
+                                protocol)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/firmware/{acc}',
+                                     Server::SOFTWARE_MANAGEMENT_V3)
+                   .template_param(new_parameter(acc, key: 'acc')
+                                    .should_encode(true))
+                   .query_param(new_parameter(protocol, key: 'protocol'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(FirmwarePackage.method(:from_hash))
+                   .is_api_response(true)
+                   .is_response_array(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV3ResultException))
+        .execute
+    end
+
+    # Synchronize ThingSpace with the FOTA server for up to 100 devices.
+    # @param [String] acc Required parameter: Account identifier.
+    # @param [FirmwareIMEI] body Required parameter: DeviceIds to get firmware
+    # info synchronously.
+    # @return [DeviceFirmwareList] response from the API call
+    def synchronize_device_firmware(acc,
+                                    body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/firmware/{acc}/devices',
+                                     Server::SOFTWARE_MANAGEMENT_V3)
+                   .template_param(new_parameter(acc, key: 'acc')
+                                    .should_encode(true))
+                   .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(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(DeviceFirmwareList.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV3ResultException))
+        .execute
+    end
+
+    # Ask a device to report its firmware version asynchronously.
+    # @param [String] acc Required parameter: Account identifier.
+    # @param [String] device_id Required parameter: Device identifier.
+    # @return [DeviceFirmwareVersionUpdateResult] response from the API call
+    def report_device_firmware(acc,
+                               device_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::PUT,
+                                     '/firmware/{acc}/async/{deviceId}',
+                                     Server::SOFTWARE_MANAGEMENT_V3)
+                   .template_param(new_parameter(acc, key: 'acc')
+                                    .should_encode(true))
+                   .template_param(new_parameter(device_id, key: 'deviceId')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(DeviceFirmwareVersionUpdateResult.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV3ResultException))
+        .execute
+    end
+  end
+end

data/lib/verizon/controllers/fixed_wireless_qualification_controller.rb

@@ -0,0 +1,34 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # FixedWirelessQualificationController
+  class FixedWirelessQualificationController < BaseController
+    # Use this query for Fixed Wireless Qualification of an address. Network
+    # types include: LTE, C-BAND and MMWAVE.
+    # @param [GetWirelessCoverageRequestFWA] body Required parameter: Request
+    # for network coverage details.
+    # @return [WNPRequestResponse] response from the API call
+    def domestic4g_and_5g_fixed_wireless_qualification(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/m2m/intelligence/wireless-coverage',
+                                     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(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(WNPRequestResponse.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('default',
+                                'Error response',
+                                WNPRestErrorResponseException))
+        .execute
+    end
+  end
+end

data/lib/verizon/controllers/global_reporting_controller.rb

@@ -0,0 +1,95 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # GlobalReportingController
+  class GlobalReportingController < BaseController
+    # Retreive the provisioning history of a specific device or devices.
+    # @param [ESIMProvhistoryRequest] body Required parameter: Device
+    # Provisioning History
+    # @return [ESIMRequestResponse] response from the API call
+    def deviceprovhistory_using_post(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/m2m/v2/devices/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(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(ESIMRequestResponse.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Bad request',
+                                ESIMRestErrorResponseException)
+                   .local_error('401',
+                                'Unauthorized',
+                                ESIMRestErrorResponseException)
+                   .local_error('403',
+                                'Forbidden',
+                                ESIMRestErrorResponseException)
+                   .local_error('404',
+                                'Not Found / Does not exist',
+                                ESIMRestErrorResponseException)
+                   .local_error('406',
+                                'Format / Request Unacceptable',
+                                ESIMRestErrorResponseException)
+                   .local_error('429',
+                                'Too many requests',
+                                ESIMRestErrorResponseException)
+                   .local_error('default',
+                                'Error response',
+                                ESIMRestErrorResponseException))
+        .execute
+    end
+
+    # Get the status of a request made with the Device Actions.
+    # @param [String] accountname Required parameter: Example:
+    # @param [String] request_id Required parameter: Example:
+    # @return [ESIMStatusResponse] response from the API call
+    def requeststatususing_get(accountname,
+                               request_id)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/m2m/v2/accounts/{accountname}/requests/{requestID}/status',
+                                     Server::THINGSPACE)
+                   .template_param(new_parameter(accountname, key: 'accountname')
+                                    .should_encode(true))
+                   .template_param(new_parameter(request_id, key: 'requestID')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(ESIMStatusResponse.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Bad request',
+                                ESIMRestErrorResponseException)
+                   .local_error('401',
+                                'Unauthorized',
+                                ESIMRestErrorResponseException)
+                   .local_error('403',
+                                'Forbidden',
+                                ESIMRestErrorResponseException)
+                   .local_error('404',
+                                'Not Found / Does not exist',
+                                ESIMRestErrorResponseException)
+                   .local_error('406',
+                                'Format / Request Unacceptable',
+                                ESIMRestErrorResponseException)
+                   .local_error('429',
+                                'Too many requests',
+                                ESIMRestErrorResponseException)
+                   .local_error('default',
+                                'Error response',
+                                ESIMRestErrorResponseException))
+        .execute
+    end
+  end
+end

data/lib/verizon/controllers/hyper_precise_location_callbacks_controller.rb

@@ -0,0 +1,133 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # HyperPreciseLocationCallbacksController
+  class HyperPreciseLocationCallbacksController < BaseController
+    # 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
+    def list_registered_callbacks(account_number)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/callbacks',
+                                     Server::HYPER_PRECISE_LOCATION)
+                   .query_param(new_parameter(account_number, key: 'accountNumber'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oAuth2')))
+        .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))
+        .execute
+    end
+
+    # Registers a URL at which an account receives asynchronous responses and
+    # other messages from a ThingSpace Platform callback service. The messages
+    # are REST messages. You are responsible for creating and running a
+    # listening process on your server at that URL to receive and parse the
+    # messages.
+    # @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
+    def register_callback(account_number,
+                          body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/callbacks',
+                                     Server::HYPER_PRECISE_LOCATION)
+                   .query_param(new_parameter(account_number, key: 'accountNumber'))
+                   .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(Single.new('oAuth2')))
+        .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))
+        .execute
+    end
+
+    # Stops ThingSpace from sending callback messages for the specified account
+    # and listener name.
+    # @param [String] account_number Required parameter: A unique identifier for
+    # a account.
+    # @param [String] service Required parameter: The name of the callback
+    # service that will be deleted.
+    # @return [void] response from the API call
+    def deregister_callback(account_number,
+                            service)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/callbacks',
+                                     Server::HYPER_PRECISE_LOCATION)
+                   .query_param(new_parameter(account_number, key: 'accountNumber'))
+                   .query_param(new_parameter(service, key: 'service'))
+                   .auth(Single.new('oAuth2')))
+        .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))
+        .execute
+    end
+  end
+end