nextbillionai 0.1.0.pre.alpha.4

data/rbi/nextbillionai/models/skynet/asset_list_response.rbi

@@ -0,0 +1,140 @@
+# typed: strong
+
+module Nextbillionai
+  module Models
+    module Skynet
+      class AssetListResponse < Nextbillionai::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Nextbillionai::Models::Skynet::AssetListResponse,
+              Nextbillionai::Internal::AnyHash
+            )
+          end
+
+        # A data object containing the list of assets.
+        sig do
+          returns(
+            T.nilable(Nextbillionai::Models::Skynet::AssetListResponse::Data)
+          )
+        end
+        attr_reader :data
+
+        sig do
+          params(
+            data: Nextbillionai::Models::Skynet::AssetListResponse::Data::OrHash
+          ).void
+        end
+        attr_writer :data
+
+        # Displays the error message in case of a failed request. If the request is
+        # successful, this field is not present in the response.
+        sig { returns(T.nilable(String)) }
+        attr_reader :message
+
+        sig { params(message: String).void }
+        attr_writer :message
+
+        # 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.
+        sig { returns(T.nilable(String)) }
+        attr_reader :status
+
+        sig { params(status: String).void }
+        attr_writer :status
+
+        sig do
+          params(
+            data:
+              Nextbillionai::Models::Skynet::AssetListResponse::Data::OrHash,
+            message: String,
+            status: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # A data object containing the list of assets.
+          data: nil,
+          # Displays the error message in case of a failed request. If the request is
+          # successful, this field is not present in the response.
+          message: nil,
+          # 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.
+          status: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              data: Nextbillionai::Models::Skynet::AssetListResponse::Data,
+              message: String,
+              status: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Data < Nextbillionai::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Nextbillionai::Models::Skynet::AssetListResponse::Data,
+                Nextbillionai::Internal::AnyHash
+              )
+            end
+
+          # An array of objects, with each object representing one asset.
+          sig do
+            returns(T.nilable(T::Array[Nextbillionai::Skynet::AssetDetails]))
+          end
+          attr_reader :list
+
+          sig do
+            params(
+              list: T::Array[Nextbillionai::Skynet::AssetDetails::OrHash]
+            ).void
+          end
+          attr_writer :list
+
+          # An object with pagination details of the search results. Use this object to
+          # implement pagination in your application.
+          sig { returns(T.nilable(Nextbillionai::Skynet::Pagination)) }
+          attr_reader :page
+
+          sig { params(page: Nextbillionai::Skynet::Pagination::OrHash).void }
+          attr_writer :page
+
+          # A data object containing the list of assets.
+          sig do
+            params(
+              list: T::Array[Nextbillionai::Skynet::AssetDetails::OrHash],
+              page: Nextbillionai::Skynet::Pagination::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # An array of objects, with each object representing one asset.
+            list: nil,
+            # An object with pagination details of the search results. Use this object to
+            # implement pagination in your application.
+            page: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                list: T::Array[Nextbillionai::Skynet::AssetDetails],
+                page: Nextbillionai::Skynet::Pagination
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/nextbillionai/models/skynet/asset_retrieve_params.rbi

@@ -0,0 +1,101 @@
+# typed: strong
+
+module Nextbillionai
+  module Models
+    module Skynet
+      class AssetRetrieveParams < Nextbillionai::Internal::Type::BaseModel
+        extend Nextbillionai::Internal::Type::RequestParameters::Converter
+        include Nextbillionai::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Nextbillionai::Skynet::AssetRetrieveParams,
+              Nextbillionai::Internal::AnyHash
+            )
+          end
+
+        # A key is a unique identifier that is required to authenticate a request to the
+        # API.
+        sig { returns(String) }
+        attr_accessor :key
+
+        # the cluster of the region you want to use
+        sig do
+          returns(
+            T.nilable(
+              Nextbillionai::Skynet::AssetRetrieveParams::Cluster::OrSymbol
+            )
+          )
+        end
+        attr_reader :cluster
+
+        sig do
+          params(
+            cluster:
+              Nextbillionai::Skynet::AssetRetrieveParams::Cluster::OrSymbol
+          ).void
+        end
+        attr_writer :cluster
+
+        sig do
+          params(
+            key: String,
+            cluster:
+              Nextbillionai::Skynet::AssetRetrieveParams::Cluster::OrSymbol,
+            request_options: Nextbillionai::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # A key is a unique identifier that is required to authenticate a request to the
+          # API.
+          key:,
+          # the cluster of the region you want to use
+          cluster: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              key: String,
+              cluster:
+                Nextbillionai::Skynet::AssetRetrieveParams::Cluster::OrSymbol,
+              request_options: Nextbillionai::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # the cluster of the region you want to use
+        module Cluster
+          extend Nextbillionai::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Nextbillionai::Skynet::AssetRetrieveParams::Cluster)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          AMERICA =
+            T.let(
+              :america,
+              Nextbillionai::Skynet::AssetRetrieveParams::Cluster::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Nextbillionai::Skynet::AssetRetrieveParams::Cluster::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/nextbillionai/models/skynet/asset_retrieve_response.rbi

@@ -0,0 +1,122 @@
+# typed: strong
+
+module Nextbillionai
+  module Models
+    module Skynet
+      class AssetRetrieveResponse < Nextbillionai::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Nextbillionai::Models::Skynet::AssetRetrieveResponse,
+              Nextbillionai::Internal::AnyHash
+            )
+          end
+
+        # An object containing the information about the asset returned.
+        sig do
+          returns(
+            T.nilable(
+              Nextbillionai::Models::Skynet::AssetRetrieveResponse::Data
+            )
+          )
+        end
+        attr_reader :data
+
+        sig do
+          params(
+            data:
+              Nextbillionai::Models::Skynet::AssetRetrieveResponse::Data::OrHash
+          ).void
+        end
+        attr_writer :data
+
+        # Displays the error message in case of a failed request. If the request is
+        # successful, this field is not present in the response.
+        sig { returns(T.nilable(String)) }
+        attr_reader :message
+
+        sig { params(message: String).void }
+        attr_writer :message
+
+        # 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.
+        sig { returns(T.nilable(String)) }
+        attr_reader :status
+
+        sig { params(status: String).void }
+        attr_writer :status
+
+        sig do
+          params(
+            data:
+              Nextbillionai::Models::Skynet::AssetRetrieveResponse::Data::OrHash,
+            message: String,
+            status: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # An object containing the information about the asset returned.
+          data: nil,
+          # Displays the error message in case of a failed request. If the request is
+          # successful, this field is not present in the response.
+          message: nil,
+          # 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.
+          status: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              data: Nextbillionai::Models::Skynet::AssetRetrieveResponse::Data,
+              message: String,
+              status: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Data < Nextbillionai::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Nextbillionai::Models::Skynet::AssetRetrieveResponse::Data,
+                Nextbillionai::Internal::AnyHash
+              )
+            end
+
+          # An object with details of the asset properties.
+          sig { returns(T.nilable(Nextbillionai::Skynet::AssetDetails)) }
+          attr_reader :asset
+
+          sig do
+            params(asset: Nextbillionai::Skynet::AssetDetails::OrHash).void
+          end
+          attr_writer :asset
+
+          # An object containing the information about the asset returned.
+          sig do
+            params(asset: Nextbillionai::Skynet::AssetDetails::OrHash).returns(
+              T.attached_class
+            )
+          end
+          def self.new(
+            # An object with details of the asset properties.
+            asset: nil
+          )
+          end
+
+          sig do
+            override.returns({ asset: Nextbillionai::Skynet::AssetDetails })
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/nextbillionai/models/skynet/asset_track_params.rbi

@@ -0,0 +1,329 @@
+# typed: strong
+
+module Nextbillionai
+  module Models
+    module Skynet
+      class AssetTrackParams < Nextbillionai::Internal::Type::BaseModel
+        extend Nextbillionai::Internal::Type::RequestParameters::Converter
+        include Nextbillionai::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Nextbillionai::Skynet::AssetTrackParams,
+              Nextbillionai::Internal::AnyHash
+            )
+          end
+
+        # A key is a unique identifier that is required to authenticate a request to the
+        # API.
+        sig { returns(String) }
+        attr_accessor :key
+
+        # 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.
+        sig { returns(String) }
+        attr_accessor :device_id
+
+        # An array of objects to collect the location tracking information for an asset.
+        # Each object must correspond to details of only one location.
+        sig { returns(Nextbillionai::Skynet::AssetTrackParams::Locations) }
+        attr_reader :locations
+
+        sig do
+          params(
+            locations:
+              Nextbillionai::Skynet::AssetTrackParams::Locations::OrHash
+          ).void
+        end
+        attr_writer :locations
+
+        # the cluster of the region you want to use
+        sig do
+          returns(
+            T.nilable(
+              Nextbillionai::Skynet::AssetTrackParams::Cluster::OrSymbol
+            )
+          )
+        end
+        attr_reader :cluster
+
+        sig do
+          params(
+            cluster: Nextbillionai::Skynet::AssetTrackParams::Cluster::OrSymbol
+          ).void
+        end
+        attr_writer :cluster
+
+        sig do
+          params(
+            key: String,
+            device_id: String,
+            locations:
+              Nextbillionai::Skynet::AssetTrackParams::Locations::OrHash,
+            cluster: Nextbillionai::Skynet::AssetTrackParams::Cluster::OrSymbol,
+            request_options: Nextbillionai::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # A key is a unique identifier that is required to authenticate a request to the
+          # API.
+          key:,
+          # 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.
+          device_id:,
+          # An array of objects to collect the location tracking information for an asset.
+          # Each object must correspond to details of only one location.
+          locations:,
+          # the cluster of the region you want to use
+          cluster: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              key: String,
+              device_id: String,
+              locations: Nextbillionai::Skynet::AssetTrackParams::Locations,
+              cluster:
+                Nextbillionai::Skynet::AssetTrackParams::Cluster::OrSymbol,
+              request_options: Nextbillionai::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Locations < Nextbillionai::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Nextbillionai::Skynet::AssetTrackParams::Locations,
+                Nextbillionai::Internal::AnyHash
+              )
+            end
+
+          # An object to collect the coordinate details of the tracked location. Please note
+          # this field is mandatory when uploading locations for an asset.
+          sig do
+            returns(
+              Nextbillionai::Skynet::AssetTrackParams::Locations::Location
+            )
+          end
+          attr_reader :location
+
+          sig do
+            params(
+              location:
+                Nextbillionai::Skynet::AssetTrackParams::Locations::Location::OrHash
+            ).void
+          end
+          attr_writer :location
+
+          # 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.
+          sig { returns(Integer) }
+          attr_accessor :timestamp
+
+          # Use this parameter to provide the accuracy of the GPS information at the tracked
+          # location. It is the estimated horizontal accuracy radius, in meters.
+          sig { returns(T.nilable(Float)) }
+          attr_reader :accuracy
+
+          sig { params(accuracy: Float).void }
+          attr_writer :accuracy
+
+          # Use this parameter to provide the altitude, in meters, of the asset at the
+          # tracked location.
+          sig { returns(T.nilable(Float)) }
+          attr_reader :altitude
+
+          sig { params(altitude: Float).void }
+          attr_writer :altitude
+
+          # 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.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :battery_level
+
+          sig { params(battery_level: Integer).void }
+          attr_writer :battery_level
+
+          # 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).
+          sig { returns(T.nilable(Float)) }
+          attr_reader :bearing
+
+          sig { params(bearing: Float).void }
+          attr_writer :bearing
+
+          # 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.
+          sig { returns(T.nilable(T.anything)) }
+          attr_reader :meta_data
+
+          sig { params(meta_data: T.anything).void }
+          attr_writer :meta_data
+
+          # Use this parameter to provide the speed of the asset, in meters per second, at
+          # the tracked location.
+          sig { returns(T.nilable(Float)) }
+          attr_reader :speed
+
+          sig { params(speed: Float).void }
+          attr_writer :speed
+
+          # NB tracking mode.
+          sig { returns(T.nilable(String)) }
+          attr_reader :tracking_mode
+
+          sig { params(tracking_mode: String).void }
+          attr_writer :tracking_mode
+
+          # An array of objects to collect the location tracking information for an asset.
+          # Each object must correspond to details of only one location.
+          sig do
+            params(
+              location:
+                Nextbillionai::Skynet::AssetTrackParams::Locations::Location::OrHash,
+              timestamp: Integer,
+              accuracy: Float,
+              altitude: Float,
+              battery_level: Integer,
+              bearing: Float,
+              meta_data: T.anything,
+              speed: Float,
+              tracking_mode: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # An object to collect the coordinate details of the tracked location. Please note
+            # this field is mandatory when uploading locations for an asset.
+            location:,
+            # 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.
+            timestamp:,
+            # Use this parameter to provide the accuracy of the GPS information at the tracked
+            # location. It is the estimated horizontal accuracy radius, in meters.
+            accuracy: nil,
+            # Use this parameter to provide the altitude, in meters, of the asset at the
+            # tracked location.
+            altitude: nil,
+            # 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.
+            battery_level: nil,
+            # 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).
+            bearing: nil,
+            # 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.
+            meta_data: nil,
+            # Use this parameter to provide the speed of the asset, in meters per second, at
+            # the tracked location.
+            speed: nil,
+            # NB tracking mode.
+            tracking_mode: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                location:
+                  Nextbillionai::Skynet::AssetTrackParams::Locations::Location,
+                timestamp: Integer,
+                accuracy: Float,
+                altitude: Float,
+                battery_level: Integer,
+                bearing: Float,
+                meta_data: T.anything,
+                speed: Float,
+                tracking_mode: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Location < Nextbillionai::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Nextbillionai::Skynet::AssetTrackParams::Locations::Location,
+                  Nextbillionai::Internal::AnyHash
+                )
+              end
+
+            # Latitude of the tracked location of the asset.
+            sig { returns(Float) }
+            attr_accessor :lat
+
+            # Longitude of the tracked location of the asset.
+            sig { returns(Float) }
+            attr_accessor :lon
+
+            # An object to collect the coordinate details of the tracked location. Please note
+            # this field is mandatory when uploading locations for an asset.
+            sig { params(lat: Float, lon: Float).returns(T.attached_class) }
+            def self.new(
+              # Latitude of the tracked location of the asset.
+              lat:,
+              # Longitude of the tracked location of the asset.
+              lon:
+            )
+            end
+
+            sig { override.returns({ lat: Float, lon: Float }) }
+            def to_hash
+            end
+          end
+        end
+
+        # the cluster of the region you want to use
+        module Cluster
+          extend Nextbillionai::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Nextbillionai::Skynet::AssetTrackParams::Cluster)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          AMERICA =
+            T.let(
+              :america,
+              Nextbillionai::Skynet::AssetTrackParams::Cluster::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Nextbillionai::Skynet::AssetTrackParams::Cluster::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end