nextbillionai 0.1.0.pre.alpha.4

data/lib/nextbillionai/models/skynet/asset_track_params.rb

@@ -0,0 +1,184 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module Skynet
+      # @see Nextbillionai::Resources::Skynet::Asset#track
+      class AssetTrackParams < Nextbillionai::Internal::Type::BaseModel
+        extend Nextbillionai::Internal::Type::RequestParameters::Converter
+        include Nextbillionai::Internal::Type::RequestParameters
+
+        # @!attribute key
+        #   A key is a unique identifier that is required to authenticate a request to the
+        #   API.
+        #
+        #   @return [String]
+        required :key, String
+
+        # @!attribute device_id
+        #   ID of the device used to upload the tracking information of the asset.
+        #
+        #   Please note that the device_id used here must already be linked to the asset.
+        #   Use the _Bind Device to Asset_ method to link a device with your asset.
+        #
+        #   @return [String]
+        required :device_id, String
+
+        # @!attribute locations
+        #   An array of objects to collect the location tracking information for an asset.
+        #   Each object must correspond to details of only one location.
+        #
+        #   @return [Nextbillionai::Models::Skynet::AssetTrackParams::Locations]
+        required :locations, -> { Nextbillionai::Skynet::AssetTrackParams::Locations }
+
+        # @!attribute cluster
+        #   the cluster of the region you want to use
+        #
+        #   @return [Symbol, Nextbillionai::Models::Skynet::AssetTrackParams::Cluster, nil]
+        optional :cluster, enum: -> { Nextbillionai::Skynet::AssetTrackParams::Cluster }
+
+        # @!method initialize(key:, device_id:, locations:, cluster: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::Skynet::AssetTrackParams} for more details.
+        #
+        #   @param key [String] A key is a unique identifier that is required to authenticate a request to the A
+        #
+        #   @param device_id [String] ID of the device used to upload the tracking information of the asset.
+        #
+        #   @param locations [Nextbillionai::Models::Skynet::AssetTrackParams::Locations] An array of objects to collect the location tracking information for an asset. E
+        #
+        #   @param cluster [Symbol, Nextbillionai::Models::Skynet::AssetTrackParams::Cluster] the cluster of the region you want to use
+        #
+        #   @param request_options [Nextbillionai::RequestOptions, Hash{Symbol=>Object}]
+
+        class Locations < Nextbillionai::Internal::Type::BaseModel
+          # @!attribute location
+          #   An object to collect the coordinate details of the tracked location. Please note
+          #   this field is mandatory when uploading locations for an asset.
+          #
+          #   @return [Nextbillionai::Models::Skynet::AssetTrackParams::Locations::Location]
+          required :location, -> { Nextbillionai::Skynet::AssetTrackParams::Locations::Location }
+
+          # @!attribute timestamp
+          #   Use this parameter to provide the time, expressed as UNIX epoch timestamp in
+          #   milliseconds, when the location was tracked. Please note this field is mandatory
+          #   when uploading locations for an asset.
+          #
+          #   @return [Integer]
+          required :timestamp, Integer
+
+          # @!attribute accuracy
+          #   Use this parameter to provide the accuracy of the GPS information at the tracked
+          #   location. It is the estimated horizontal accuracy radius, in meters.
+          #
+          #   @return [Float, nil]
+          optional :accuracy, Float
+
+          # @!attribute altitude
+          #   Use this parameter to provide the altitude, in meters, of the asset at the
+          #   tracked location.
+          #
+          #   @return [Float, nil]
+          optional :altitude, Float
+
+          # @!attribute battery_level
+          #   Use this parameter to provide the battery level of the GPS device, as a
+          #   percentage, when the location is tracked. It should have a minimum value of 0
+          #   and a maximum value of 100.
+          #
+          #   @return [Integer, nil]
+          optional :battery_level, Integer
+
+          # @!attribute bearing
+          #   Use this parameter to provide the heading of the asset, in radians, calculated
+          #   from true north in clockwise direction. This should always be in the range of
+          #   [0, 360).
+          #
+          #   @return [Float, nil]
+          optional :bearing, Float
+
+          # @!attribute meta_data
+          #   Use this object to add any custom data about the location that is being
+          #   uploaded. Recommended to use the key:value format for adding the desired
+          #   information.
+          #
+          #   Please note that the maximum size of meta_data object should not exceed 65Kb.
+          #
+          #   @return [Object, nil]
+          optional :meta_data, Nextbillionai::Internal::Type::Unknown
+
+          # @!attribute speed
+          #   Use this parameter to provide the speed of the asset, in meters per second, at
+          #   the tracked location.
+          #
+          #   @return [Float, nil]
+          optional :speed, Float
+
+          # @!attribute tracking_mode
+          #   NB tracking mode.
+          #
+          #   @return [String, nil]
+          optional :tracking_mode, String
+
+          # @!method initialize(location:, timestamp:, accuracy: nil, altitude: nil, battery_level: nil, bearing: nil, meta_data: nil, speed: nil, tracking_mode: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Nextbillionai::Models::Skynet::AssetTrackParams::Locations} for more details.
+          #
+          #   An array of objects to collect the location tracking information for an asset.
+          #   Each object must correspond to details of only one location.
+          #
+          #   @param location [Nextbillionai::Models::Skynet::AssetTrackParams::Locations::Location] An object to collect the coordinate details of the tracked location. Please note
+          #
+          #   @param timestamp [Integer] Use this parameter to provide the time, expressed as UNIX epoch timestamp in mil
+          #
+          #   @param accuracy [Float] Use this parameter to provide the accuracy of the GPS information at the tracked
+          #
+          #   @param altitude [Float] Use this parameter to provide the altitude, in meters, of the asset at the track
+          #
+          #   @param battery_level [Integer] Use this parameter to provide the battery level of the GPS device, as a percenta
+          #
+          #   @param bearing [Float] Use this parameter to provide the heading of the asset, in radians, calculated f
+          #
+          #   @param meta_data [Object] Use this object to add any custom data about the location that is being uploaded
+          #
+          #   @param speed [Float] Use this parameter to provide the speed of the asset, in meters per second, at t
+          #
+          #   @param tracking_mode [String] NB tracking mode.
+
+          # @see Nextbillionai::Models::Skynet::AssetTrackParams::Locations#location
+          class Location < Nextbillionai::Internal::Type::BaseModel
+            # @!attribute lat
+            #   Latitude of the tracked location of the asset.
+            #
+            #   @return [Float]
+            required :lat, Float
+
+            # @!attribute lon
+            #   Longitude of the tracked location of the asset.
+            #
+            #   @return [Float]
+            required :lon, Float
+
+            # @!method initialize(lat:, lon:)
+            #   An object to collect the coordinate details of the tracked location. Please note
+            #   this field is mandatory when uploading locations for an asset.
+            #
+            #   @param lat [Float] Latitude of the tracked location of the asset.
+            #
+            #   @param lon [Float] Longitude of the tracked location of the asset.
+          end
+        end
+
+        # the cluster of the region you want to use
+        module Cluster
+          extend Nextbillionai::Internal::Type::Enum
+
+          AMERICA = :america
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/nextbillionai/models/skynet/asset_update_attributes_params.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module Skynet
+      # @see Nextbillionai::Resources::Skynet::Asset#update_attributes
+      class AssetUpdateAttributesParams < Nextbillionai::Internal::Type::BaseModel
+        extend Nextbillionai::Internal::Type::RequestParameters::Converter
+        include Nextbillionai::Internal::Type::RequestParameters
+
+        # @!attribute key
+        #   A key is a unique identifier that is required to authenticate a request to the
+        #   API.
+        #
+        #   @return [String]
+        required :key, String
+
+        # @!attribute attributes
+        #   attributes can be used to add any useful information or context to your assets
+        #   like the vehicle type, shift timing etc. These attributes can also be used to
+        #   filter assets in **Search**, **Monitor**, and _Get Asset List_ queries.
+        #
+        #   Provide the attributes to be added or updated, in key:value format. If an
+        #   existing key is provided in the input, then the value will be modified as per
+        #   the input value. If a new key is provided in the input, then the key would be
+        #   added to the existing set. The contents of any value field are neither altered
+        #   nor removed unless specifically referred to by its key in the input request.
+        #
+        #   Please note that the maximum number of key:value pairs that can be added to an
+        #   attributes object is 100. Also, the overall size of attributes object should not
+        #   exceed 65kb.
+        #
+        #   @return [Object]
+        required :attributes, Nextbillionai::Internal::Type::Unknown
+
+        # @!method initialize(key:, attributes:, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::Skynet::AssetUpdateAttributesParams} for more details.
+        #
+        #   @param key [String] A key is a unique identifier that is required to authenticate a request to the A
+        #
+        #   @param attributes [Object] attributes can be used to add any useful information or context to your assets l
+        #
+        #   @param request_options [Nextbillionai::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/nextbillionai/models/skynet/asset_update_params.rb

@@ -0,0 +1,104 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module Skynet
+      # @see Nextbillionai::Resources::Skynet::Asset#update
+      class AssetUpdateParams < Nextbillionai::Internal::Type::BaseModel
+        extend Nextbillionai::Internal::Type::RequestParameters::Converter
+        include Nextbillionai::Internal::Type::RequestParameters
+
+        # @!attribute key
+        #   A key is a unique identifier that is required to authenticate a request to the
+        #   API.
+        #
+        #   @return [String]
+        required :key, String
+
+        # @!attribute cluster
+        #   the cluster of the region you want to use
+        #
+        #   @return [Symbol, Nextbillionai::Models::Skynet::AssetUpdateParams::Cluster, nil]
+        optional :cluster, enum: -> { Nextbillionai::Skynet::AssetUpdateParams::Cluster }
+
+        # @!attribute attributes
+        #   Use this param to update the attributes of an asset in key:value format. Users
+        #   can maintain any useful information or context about the assets by utilising
+        #   this parameter.
+        #
+        #   Please be careful when using this parameter while updating an asset as the new
+        #   attributes object provided will completely overwrite the old attributes object.
+        #   Use the _Update Asset Attributes_ method to add new or modify existing
+        #   attributes.
+        #
+        #   Another point to note is that the overall size of the attributes object cannot
+        #   exceed 65kb and the maximum number of key:value pairs that can be added to this
+        #   object is 100.
+        #
+        #   @return [Object, nil]
+        optional :attributes, Nextbillionai::Internal::Type::Unknown
+
+        # @!attribute description
+        #   Use this param to update the description of an asset.
+        #
+        #   @return [String, nil]
+        optional :description, String
+
+        # @!attribute meta_data
+        #   Any valid json object data. Can be used to save customized data. Max size is
+        #   65kb.
+        #
+        #   @return [Object, nil]
+        optional :meta_data, Nextbillionai::Internal::Type::Unknown
+
+        # @!attribute name
+        #   Use this param to update the name of an asset. Users can assign meaningful
+        #   custom names to their assets.
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!attribute tags
+        #   **This parameter will be deprecated soon! Please use the attributes parameter to
+        #   add labels or markers for the asset.**
+        #
+        #   Use this param to update the tags of an asset. tags can be used to filter asset
+        #   in _Get Asset List_, **Search** and **Monitor** queries.
+        #
+        #   @return [Array<String>, nil]
+        optional :tags, Nextbillionai::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(key:, cluster: nil, attributes: nil, description: nil, meta_data: nil, name: nil, tags: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::Skynet::AssetUpdateParams} for more details.
+        #
+        #   @param key [String] A key is a unique identifier that is required to authenticate a request to the A
+        #
+        #   @param cluster [Symbol, Nextbillionai::Models::Skynet::AssetUpdateParams::Cluster] the cluster of the region you want to use
+        #
+        #   @param attributes [Object] Use this param to update the attributes of an asset in key:value format. Users c
+        #
+        #   @param description [String] Use this param to update the description of an asset.
+        #
+        #   @param meta_data [Object] Any valid json object data. Can be used to save customized data. Max size is 65k
+        #
+        #   @param name [String] Use this param to update the name of an asset. Users can assign meaningful custo
+        #
+        #   @param tags [Array<String>] \*\*This parameter will be deprecated soon! Please use the attributes parameter
+        #   to
+        #
+        #   @param request_options [Nextbillionai::RequestOptions, Hash{Symbol=>Object}]
+
+        # the cluster of the region you want to use
+        module Cluster
+          extend Nextbillionai::Internal::Type::Enum
+
+          AMERICA = :america
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/nextbillionai/models/skynet/config_retrieve_params.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module Skynet
+      # @see Nextbillionai::Resources::Skynet::Config#retrieve
+      class ConfigRetrieveParams < Nextbillionai::Internal::Type::BaseModel
+        extend Nextbillionai::Internal::Type::RequestParameters::Converter
+        include Nextbillionai::Internal::Type::RequestParameters
+
+        # @!attribute key
+        #   A key is a unique identifier that is required to authenticate a request to the
+        #   API.
+        #
+        #   @return [String]
+        required :key, String
+
+        # @!attribute cluster
+        #   the cluster of the region you want to use
+        #
+        #   @return [Symbol, Nextbillionai::Models::Skynet::ConfigRetrieveParams::Cluster, nil]
+        optional :cluster, enum: -> { Nextbillionai::Skynet::ConfigRetrieveParams::Cluster }
+
+        # @!method initialize(key:, cluster: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::Skynet::ConfigRetrieveParams} for more details.
+        #
+        #   @param key [String] A key is a unique identifier that is required to authenticate a request to the A
+        #
+        #   @param cluster [Symbol, Nextbillionai::Models::Skynet::ConfigRetrieveParams::Cluster] the cluster of the region you want to use
+        #
+        #   @param request_options [Nextbillionai::RequestOptions, Hash{Symbol=>Object}]
+
+        # the cluster of the region you want to use
+        module Cluster
+          extend Nextbillionai::Internal::Type::Enum
+
+          AMERICA = :america
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/nextbillionai/models/skynet/config_retrieve_response.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module Skynet
+      # @see Nextbillionai::Resources::Skynet::Config#retrieve
+      class ConfigRetrieveResponse < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute data
+        #   A data object containing the config response.
+        #
+        #   @return [Nextbillionai::Models::Skynet::ConfigRetrieveResponse::Data, nil]
+        optional :data, -> { Nextbillionai::Models::Skynet::ConfigRetrieveResponse::Data }
+
+        # @!attribute message
+        #   Displays the error message in case of a failed request. If the request is
+        #   successful, this field is not present in the response.
+        #
+        #   @return [String, nil]
+        optional :message, String
+
+        # @!attribute status
+        #   A string indicating the state of the response. On successful responses, the
+        #   value will be Ok. Indicative error messages are returned for different errors.
+        #   See the [API Error Codes](#api-error-codes) section below for more information.
+        #
+        #   @return [String, nil]
+        optional :status, String
+
+        # @!method initialize(data: nil, message: nil, status: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::Skynet::ConfigRetrieveResponse} for more details.
+        #
+        #   @param data [Nextbillionai::Models::Skynet::ConfigRetrieveResponse::Data] A data object containing the config response.
+        #
+        #   @param message [String] Displays the error message in case of a failed request. If the request is succes
+        #
+        #   @param status [String] A string indicating the state of the response. On successful responses, the valu
+
+        # @see Nextbillionai::Models::Skynet::ConfigRetrieveResponse#data
+        class Data < Nextbillionai::Internal::Type::BaseModel
+          # @!attribute config
+          #
+          #   @return [Nextbillionai::Models::Skynet::ConfigRetrieveResponse::Data::Config, nil]
+          optional :config, -> { Nextbillionai::Models::Skynet::ConfigRetrieveResponse::Data::Config }
+
+          # @!method initialize(config: nil)
+          #   A data object containing the config response.
+          #
+          #   @param config [Nextbillionai::Models::Skynet::ConfigRetrieveResponse::Data::Config]
+
+          # @see Nextbillionai::Models::Skynet::ConfigRetrieveResponse::Data#config
+          class Config < Nextbillionai::Internal::Type::BaseModel
+            # @!attribute webhook
+            #   An array of strings representing the list of webhooks. Webhooks are used to
+            #   receive information, through POST requests, whenever any event is triggered.
+            #
+            #   @return [Array<String>, nil]
+            optional :webhook, Nextbillionai::Internal::Type::ArrayOf[String]
+
+            # @!method initialize(webhook: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Nextbillionai::Models::Skynet::ConfigRetrieveResponse::Data::Config} for more
+            #   details.
+            #
+            #   @param webhook [Array<String>] An array of strings representing the list of webhooks. Webhooks are used to rece
+          end
+        end
+      end
+    end
+  end
+end

data/lib/nextbillionai/models/skynet/config_test_webhook_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module Skynet
+      # @see Nextbillionai::Resources::Skynet::Config#test_webhook
+      class ConfigTestWebhookParams < Nextbillionai::Internal::Type::BaseModel
+        extend Nextbillionai::Internal::Type::RequestParameters::Converter
+        include Nextbillionai::Internal::Type::RequestParameters
+
+        # @!attribute key
+        #   A key is a unique identifier that is required to authenticate a request to the
+        #   API.
+        #
+        #   @return [String]
+        required :key, String
+
+        # @!method initialize(key:, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::Skynet::ConfigTestWebhookParams} for more details.
+        #
+        #   @param key [String] A key is a unique identifier that is required to authenticate a request to the A
+        #
+        #   @param request_options [Nextbillionai::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/nextbillionai/models/skynet/config_test_webhook_response.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module Skynet
+      # @see Nextbillionai::Resources::Skynet::Config#test_webhook
+      class ConfigTestWebhookResponse < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute status
+        #   A string indicating the state of the response. Please note this value will
+        #   always be Ok.
+        #
+        #   The sample event information will be received on the webhook, if they were
+        #   successfully configured. If no event information is received by the webhook,
+        #   please reconfigure the webhook or else reach out to
+        #   [support@nextbillion.ai](mailto:support@nextbillion.ai) for help.
+        #
+        #   @return [String, nil]
+        optional :status, String
+
+        # @!method initialize(status: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::Skynet::ConfigTestWebhookResponse} for more details.
+        #
+        #   @param status [String] A string indicating the state of the response. Please note this value will alway
+      end
+    end
+  end
+end

data/lib/nextbillionai/models/skynet/config_update_params.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module Skynet
+      # @see Nextbillionai::Resources::Skynet::Config#update
+      class ConfigUpdateParams < Nextbillionai::Internal::Type::BaseModel
+        extend Nextbillionai::Internal::Type::RequestParameters::Converter
+        include Nextbillionai::Internal::Type::RequestParameters
+
+        # @!attribute key
+        #   A key is a unique identifier that is required to authenticate a request to the
+        #   API.
+        #
+        #   @return [String]
+        required :key, String
+
+        # @!attribute cluster
+        #   the cluster of the region you want to use
+        #
+        #   @return [Symbol, Nextbillionai::Models::Skynet::ConfigUpdateParams::Cluster, nil]
+        optional :cluster, enum: -> { Nextbillionai::Skynet::ConfigUpdateParams::Cluster }
+
+        # @!attribute webhook
+        #   Use this array to update information about the webhooks. Please note that the
+        #   webhooks will be overwritten every time this method is used.
+        #
+        #   @return [Array<String>, nil]
+        optional :webhook, Nextbillionai::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(key:, cluster: nil, webhook: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::Skynet::ConfigUpdateParams} for more details.
+        #
+        #   @param key [String] A key is a unique identifier that is required to authenticate a request to the A
+        #
+        #   @param cluster [Symbol, Nextbillionai::Models::Skynet::ConfigUpdateParams::Cluster] the cluster of the region you want to use
+        #
+        #   @param webhook [Array<String>] Use this array to update information about the webhooks. Please note that the we
+        #
+        #   @param request_options [Nextbillionai::RequestOptions, Hash{Symbol=>Object}]
+
+        # the cluster of the region you want to use
+        module Cluster
+          extend Nextbillionai::Internal::Type::Enum
+
+          AMERICA = :america
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/nextbillionai/models/skynet/meta_data.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module Skynet
+      # @type [Nextbillionai::Internal::Type::Converter]
+      MetaData = Nextbillionai::Internal::Type::Unknown
+    end
+  end
+end

data/lib/nextbillionai/models/skynet/metadata.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module Skynet
+      # @type [Nextbillionai::Internal::Type::Converter]
+      Metadata = Nextbillionai::Internal::Type::Unknown
+    end
+  end
+end