specs-sdk 1.3.0

data/lib/verizon/controllers/cloud_connector_devices_controller.rb

@@ -0,0 +1,144 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # CloudConnectorDevicesController
+  class CloudConnectorDevicesController < BaseController
+    # Change configuration values on a device, such as setting how often a
+    # device records and reports sensor readings.
+    # @param [ChangeConfigurationRequest] body Required parameter: The request
+    # body changes configuration values on a device.
+    # @return [ChangeConfigurationResponse] response from the API call
+    def update_devices_configuration_value(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/devices/configuration/actions/set',
+                                     Server::CLOUD_CONNECTOR)
+                   .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(ChangeConfigurationResponse.method(:from_hash))
+                   .is_api_response(true))
+        .execute
+    end
+
+    # Find devices by property values. Returns an array of all matching device
+    # resources.
+    # @param [QuerySubscriptionRequest] body Required parameter: The request
+    # body specifies fields and values to match.
+    # @return [FindDeviceByPropertyResponseList] response from the API call
+    def find_device_by_property_values(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/devices/actions/query',
+                                     Server::CLOUD_CONNECTOR)
+                   .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(FindDeviceByPropertyResponseList.method(:from_hash))
+                   .is_api_response(true))
+        .execute
+    end
+
+    # Search for devices by property values. Returns an array of all matching
+    # device resources.
+    # @param [QuerySubscriptionRequest] body Required parameter: The request
+    # body specifies fields and values to match.
+    # @return [SearchDeviceByPropertyResponseList] response from the API call
+    def search_devices_resources_by_property_values(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/devices/actions/search',
+                                     Server::CLOUD_CONNECTOR)
+                   .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(SearchDeviceByPropertyResponseList.method(:from_hash))
+                   .is_api_response(true))
+        .execute
+    end
+
+    # Search device event history to find events that match criteria.Sensor
+    # readings, configuration changes, and other device data are all stored as
+    # events.
+    # @param [SearchDeviceEventHistoryRequest] body Required parameter: The
+    # device identifier and fields to match in the search.
+    # @return [SearchDeviceEventHistoryResponseList] response from the API call
+    def search_device_event_history(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/devices/fields/actions/history/search',
+                                     Server::CLOUD_CONNECTOR)
+                   .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(SearchDeviceEventHistoryResponseList.method(:from_hash))
+                   .is_api_response(true))
+        .execute
+    end
+
+    # Returns the readings of a specified sensor, with the most recent reading
+    # first. Sensor readings are stored as events; this request an array of
+    # events.
+    # @param [String] fieldname Required parameter: The name of the sensor.
+    # @param [SearchSensorHistoryRequest] body Required parameter: The device
+    # identifier and fields to match in the search.
+    # @return [SearchSensorHistoryResponseList] response from the API call
+    def search_sensor_readings(fieldname,
+                               body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/devices/fields/{fieldname}/actions/history',
+                                     Server::CLOUD_CONNECTOR)
+                   .template_param(new_parameter(fieldname, key: 'fieldname')
+                                    .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(SearchSensorHistoryResponseList.method(:from_hash))
+                   .is_api_response(true))
+        .execute
+    end
+
+    # Remove a device from a ThingSpace account.
+    # @param [RemoveDeviceRequest] body Required parameter: The request body
+    # identifies the device to delete.
+    # @return [void] response from the API call
+    def delete_device_from_account(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/devices/actions/delete',
+                                     Server::CLOUD_CONNECTOR)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .is_response_void(true)
+                   .is_api_response(true))
+        .execute
+    end
+  end
+end

data/lib/verizon/controllers/cloud_connector_subscriptions_controller.rb

@@ -0,0 +1,73 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # CloudConnectorSubscriptionsController
+  class CloudConnectorSubscriptionsController < BaseController
+    # Create a subscription to define a streaming channel that sends data from
+    # devices in the account to an endpoint defined in a target resource.
+    # @param [CreateSubscriptionRequest] body Required parameter: The request
+    # body provides the details of the subscription that you want to create.
+    # @return [Subscription] response from the API call
+    def create_subscription(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/subscriptions',
+                                     Server::CLOUD_CONNECTOR)
+                   .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(Subscription.method(:from_hash))
+                   .is_api_response(true))
+        .execute
+    end
+
+    # Search for subscriptions by property values. Returns an array of all
+    # matching subscription resources.
+    # @param [QuerySubscriptionRequest] body Required parameter: The request
+    # body specifies fields and values to match.
+    # @return [Array[Subscription]] response from the API call
+    def query_subscription(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/subscriptions/actions/query',
+                                     Server::CLOUD_CONNECTOR)
+                   .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(Subscription.method(:from_hash))
+                   .is_api_response(true)
+                   .is_response_array(true))
+        .execute
+    end
+
+    # Remove a subscription from a ThingSpace account.
+    # @param [DeleteSubscriptionRequest] body Required parameter: The request
+    # body identifies the subscription to delete.
+    # @return [void] response from the API call
+    def delete_subscription(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/subscriptions/actions/delete',
+                                     Server::CLOUD_CONNECTOR)
+                   .header_param(new_parameter('application/json', key: 'Content-Type'))
+                   .body_param(new_parameter(body))
+                   .body_serializer(proc do |param| param.to_json unless param.nil? end)
+                   .auth(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .is_response_void(true)
+                   .is_api_response(true))
+        .execute
+    end
+  end
+end

data/lib/verizon/controllers/configuration_files_controller.rb

@@ -0,0 +1,80 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # ConfigurationFilesController
+  class ConfigurationFilesController < BaseController
+    # You can retrieve a list of configuration or supplementary of files for an
+    # account.
+    # @param [String] acc Required parameter: Account identifier.
+    # @param [String] distribution_type Required parameter: Filter the
+    # distributionType to only retrieve files for a specific distribution
+    # type.
+    # @return [RetrievesAvailableFilesResponseList] response from the API call
+    def get_list_of_files(acc,
+                          distribution_type)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/files/{acc}',
+                                     Server::SOFTWARE_MANAGEMENT_V2)
+                   .template_param(new_parameter(acc, key: 'acc')
+                                    .should_encode(true))
+                   .query_param(new_parameter(distribution_type, key: 'distributionType'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(RetrievesAvailableFilesResponseList.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV2ResultException))
+        .execute
+    end
+
+    # Uploads a configuration/supplementary file for an account. ThingSpace
+    # generates a fileName after the upload and is returned in the response.
+    # @param [String] acc Required parameter: Account identifier.
+    # @param [File | UploadIO] fileupload Optional parameter: The file to
+    # upload.
+    # @param [String] file_version Optional parameter: Version of the file.
+    # @param [String] make Optional parameter: The software-applicable device
+    # make.
+    # @param [String] model Optional parameter: The software-applicable device
+    # model.
+    # @param [String] local_target_path Optional parameter: Local target path on
+    # the device.
+    # @return [UploadConfigurationFilesResponse] response from the API call
+    def upload_config_file(acc,
+                           fileupload: nil,
+                           file_version: nil,
+                           make: nil,
+                           model: nil,
+                           local_target_path: nil)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/files/{acc}',
+                                     Server::SOFTWARE_MANAGEMENT_V2)
+                   .template_param(new_parameter(acc, key: 'acc')
+                                    .should_encode(true))
+                   .multipart_param(new_parameter(fileupload, key: 'fileupload')
+                                     .default_content_type('application/octet-stream'))
+                   .form_param(new_parameter(file_version, key: 'fileVersion'))
+                   .form_param(new_parameter(make, key: 'make'))
+                   .form_param(new_parameter(model, key: 'model'))
+                   .form_param(new_parameter(local_target_path, key: 'localTargetPath'))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('oAuth2')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(UploadConfigurationFilesResponse.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Unexpected error.',
+                                FotaV2ResultException))
+        .execute
+    end
+  end
+end

data/lib/verizon/controllers/connectivity_callbacks_controller.rb

@@ -0,0 +1,89 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # ConnectivityCallbacksController
+  class ConnectivityCallbacksController < BaseController
+    # Returns the name and endpoint URL of the callback listening services
+    # registered for a given account.
+    # @param [String] aname Required parameter: Account name.
+    # @return [Array[ConnectivityManagementCallback]] response from the API call
+    def list_registered_callbacks(aname)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::GET,
+                                     '/m2m/v1/callbacks/{aname}',
+                                     Server::THINGSPACE)
+                   .template_param(new_parameter(aname, key: 'aname')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('thingspace_oauth')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(ConnectivityManagementCallback.method(:from_hash))
+                   .is_api_response(true)
+                   .is_response_array(true)
+                   .local_error('400',
+                                'Error response.',
+                                ConnectivityManagementResultException))
+        .execute
+    end
+
+    # You are responsible for creating and running a listening process on your
+    # server at that URL.
+    # @param [String] aname Required parameter: Account name.
+    # @param [RegisterCallbackRequest] body Required parameter: Request to
+    # register a callback.
+    # @return [CallbackActionResult] response from the API call
+    def register_callback(aname,
+                          body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/m2m/v1/callbacks/{aname}',
+                                     Server::THINGSPACE)
+                   .template_param(new_parameter(aname, key: 'aname')
+                                    .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('thingspace_oauth')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(CallbackActionResult.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Error response.',
+                                ConnectivityManagementResultException))
+        .execute
+    end
+
+    # Stops ThingSpace from sending callback messages for the specified account
+    # and service.
+    # @param [String] aname Required parameter: Account name.
+    # @param [String] sname Required parameter: Service name.
+    # @return [CallbackActionResult] response from the API call
+    def deregister_callback(aname,
+                            sname)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::DELETE,
+                                     '/m2m/v1/callbacks/{aname}/name/{sname}',
+                                     Server::THINGSPACE)
+                   .template_param(new_parameter(aname, key: 'aname')
+                                    .should_encode(true))
+                   .template_param(new_parameter(sname, key: 'sname')
+                                    .should_encode(true))
+                   .header_param(new_parameter('application/json', key: 'accept'))
+                   .auth(Single.new('thingspace_oauth')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(CallbackActionResult.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Error response.',
+                                ConnectivityManagementResultException))
+        .execute
+    end
+  end
+end

data/lib/verizon/controllers/device_actions_controller.rb

@@ -0,0 +1,84 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # DeviceActionsController
+  class DeviceActionsController < BaseController
+    # Allows the profile to fetch the complete device list. This works with
+    # Verizon US and Global profiles.
+    # @param [GetDeviceListWithProfilesRequest] body Required parameter: Device
+    # Profile Query
+    # @return [GIORequestResponse] response from the API call
+    def retrieve_the_global_device_list(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/m2m/v2/devices/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('thingspace_oauth')))
+        .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
+
+    # Retreive the provisioning history of a specific device or devices.
+    # @param [ProvhistoryRequest] body Required parameter: Device Provisioning
+    # History
+    # @return [GIORequestResponse] response from the API call
+    def retrieve_device_provisioning_history(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('thingspace_oauth')))
+        .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
+
+    # Get the status of an asynchronous request made with the Device Actions.
+    # @param [String] account_name Required parameter: Example:
+    # @param [String] request_id Required parameter: Example:
+    # @return [StatusResponse] response from the API call
+    def get_asynchronous_request_status(account_name,
+                                        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(account_name, 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('thingspace_oauth')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(StatusResponse.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('default',
+                                'Error response',
+                                GIORestErrorResponseException))
+        .execute
+    end
+  end
+end

data/lib/verizon/controllers/device_diagnostics_controller.rb

@@ -0,0 +1,58 @@
+# verizon
+#
+# This file was automatically generated by APIMATIC v2.0
+# ( https://apimatic.io ).
+
+module Verizon
+  # DeviceDiagnosticsController
+  class DeviceDiagnosticsController < BaseController
+    # If the devices do not already exist in the account, this API resource adds
+    # them before activation.
+    # @param [NotificationReportStatusRequest] body Required parameter: Retrieve
+    # Reachability Report Status for a device.
+    # @return [DeviceManagementResult] response from the API call
+    def device_reachability_status_using_post(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/m2m/v1/diagnostics/basic/devicereachability/status',
+                                     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('thingspace_oauth')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(DeviceManagementResult.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Error response.',
+                                ConnectivityManagementResultException))
+        .execute
+    end
+
+    # Retrieve all the active monitors.
+    # @param [RetrieveMonitorsRequest] body Required parameter: Retrieve Monitor
+    # Request.
+    # @return [DeviceManagementResult] response from the API call
+    def retrieve_active_monitors_using_post(body)
+      new_api_call_builder
+        .request(new_request_builder(HttpMethodEnum::POST,
+                                     '/m2m/v1/diagnostics/basic/devicereachability/monitors',
+                                     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('thingspace_oauth')))
+        .response(new_response_handler
+                   .deserializer(APIHelper.method(:custom_type_deserializer))
+                   .deserialize_into(DeviceManagementResult.method(:from_hash))
+                   .is_api_response(true)
+                   .local_error('400',
+                                'Error response.',
+                                ConnectivityManagementResultException))
+        .execute
+    end
+  end
+end