nextbillionai 0.1.0.pre.alpha.4

data/rbi/nextbillionai/models/skynet/asset/location_list_response.rbi

@@ -0,0 +1,503 @@
+# typed: strong
+
+module Nextbillionai
+  module Models
+    module Skynet
+      module Asset
+        class LocationListResponse < Nextbillionai::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Nextbillionai::Models::Skynet::Asset::LocationListResponse,
+                Nextbillionai::Internal::AnyHash
+              )
+            end
+
+          sig do
+            returns(
+              T.nilable(
+                Nextbillionai::Models::Skynet::Asset::LocationListResponse::Data
+              )
+            )
+          end
+          attr_reader :data
+
+          sig do
+            params(
+              data:
+                Nextbillionai::Models::Skynet::Asset::LocationListResponse::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::Asset::LocationListResponse::Data::OrHash,
+              message: String,
+              status: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            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::Asset::LocationListResponse::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::Asset::LocationListResponse::Data,
+                  Nextbillionai::Internal::AnyHash
+                )
+              end
+
+            # Distance of the path, in meters, formed by connecting all tracked locations
+            # returned.
+            #
+            # Please note that distance is returned only when the mapmatch property of
+            # correction parameter is set to 1.
+            sig { returns(T.nilable(Float)) }
+            attr_reader :distance
+
+            sig { params(distance: Float).void }
+            attr_writer :distance
+
+            # An object with geoJSON details of the route. It is returned only when the
+            # mapmatch property of the correction parameter is set to 1 and geometry_type is
+            # geojson, otherwise it is not present in the response. The contents of this
+            # object follow the
+            # [geoJSON standard](https://datatracker.ietf.org/doc/html/rfc7946).
+            sig do
+              returns(
+                T.nilable(
+                  Nextbillionai::Models::Skynet::Asset::LocationListResponse::Data::Geojson
+                )
+              )
+            end
+            attr_reader :geojson
+
+            sig do
+              params(
+                geojson:
+                  Nextbillionai::Models::Skynet::Asset::LocationListResponse::Data::Geojson::OrHash
+              ).void
+            end
+            attr_writer :geojson
+
+            # Geometry of tracked locations in the requested format. It is returned only if
+            # the mapmatch property of the ‘correction’ parameter is set to 1.
+            sig { returns(T.nilable(T::Array[String])) }
+            attr_reader :geometry
+
+            sig { params(geometry: T::Array[String]).void }
+            attr_writer :geometry
+
+            # An array of objects with details of the tracked locations of the asset. Each
+            # object represents one tracked location.
+            sig do
+              returns(
+                T.nilable(T::Array[Nextbillionai::Skynet::Asset::TrackLocation])
+              )
+            end
+            attr_reader :list
+
+            sig do
+              params(
+                list:
+                  T::Array[Nextbillionai::Skynet::Asset::TrackLocation::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
+
+            # An array of objects with details about the snapped points for each of the
+            # tracked locations returned for the asset.
+            #
+            # Please note that this property is returned only when the mapmatch property of
+            # correction parameter is set to 1.
+            sig do
+              returns(
+                T.nilable(
+                  T::Array[
+                    Nextbillionai::Models::Skynet::Asset::LocationListResponse::Data::SnappedPoint
+                  ]
+                )
+              )
+            end
+            attr_reader :snapped_points
+
+            sig do
+              params(
+                snapped_points:
+                  T::Array[
+                    Nextbillionai::Models::Skynet::Asset::LocationListResponse::Data::SnappedPoint::OrHash
+                  ]
+              ).void
+            end
+            attr_writer :snapped_points
+
+            sig do
+              params(
+                distance: Float,
+                geojson:
+                  Nextbillionai::Models::Skynet::Asset::LocationListResponse::Data::Geojson::OrHash,
+                geometry: T::Array[String],
+                list:
+                  T::Array[Nextbillionai::Skynet::Asset::TrackLocation::OrHash],
+                page: Nextbillionai::Skynet::Pagination::OrHash,
+                snapped_points:
+                  T::Array[
+                    Nextbillionai::Models::Skynet::Asset::LocationListResponse::Data::SnappedPoint::OrHash
+                  ]
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Distance of the path, in meters, formed by connecting all tracked locations
+              # returned.
+              #
+              # Please note that distance is returned only when the mapmatch property of
+              # correction parameter is set to 1.
+              distance: nil,
+              # An object with geoJSON details of the route. It is returned only when the
+              # mapmatch property of the correction parameter is set to 1 and geometry_type is
+              # geojson, otherwise it is not present in the response. The contents of this
+              # object follow the
+              # [geoJSON standard](https://datatracker.ietf.org/doc/html/rfc7946).
+              geojson: nil,
+              # Geometry of tracked locations in the requested format. It is returned only if
+              # the mapmatch property of the ‘correction’ parameter is set to 1.
+              geometry: nil,
+              # An array of objects with details of the tracked locations of the asset. Each
+              # object represents one tracked location.
+              list: nil,
+              # An object with pagination details of the search results. Use this object to
+              # implement pagination in your application.
+              page: nil,
+              # An array of objects with details about the snapped points for each of the
+              # tracked locations returned for the asset.
+              #
+              # Please note that this property is returned only when the mapmatch property of
+              # correction parameter is set to 1.
+              snapped_points: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  distance: Float,
+                  geojson:
+                    Nextbillionai::Models::Skynet::Asset::LocationListResponse::Data::Geojson,
+                  geometry: T::Array[String],
+                  list: T::Array[Nextbillionai::Skynet::Asset::TrackLocation],
+                  page: Nextbillionai::Skynet::Pagination,
+                  snapped_points:
+                    T::Array[
+                      Nextbillionai::Models::Skynet::Asset::LocationListResponse::Data::SnappedPoint
+                    ]
+                }
+              )
+            end
+            def to_hash
+            end
+
+            class Geojson < Nextbillionai::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Nextbillionai::Models::Skynet::Asset::LocationListResponse::Data::Geojson,
+                    Nextbillionai::Internal::AnyHash
+                  )
+                end
+
+              # An object with details of the geoJSON geometry of the route.
+              sig do
+                returns(
+                  T.nilable(
+                    Nextbillionai::Models::Skynet::Asset::LocationListResponse::Data::Geojson::Geometry
+                  )
+                )
+              end
+              attr_reader :geometry
+
+              sig do
+                params(
+                  geometry:
+                    Nextbillionai::Models::Skynet::Asset::LocationListResponse::Data::Geojson::Geometry::OrHash
+                ).void
+              end
+              attr_writer :geometry
+
+              # Type of the geoJSON object.
+              sig { returns(T.nilable(String)) }
+              attr_reader :type
+
+              sig { params(type: String).void }
+              attr_writer :type
+
+              # An object with geoJSON details of the route. It is returned only when the
+              # mapmatch property of the correction parameter is set to 1 and geometry_type is
+              # geojson, otherwise it is not present in the response. The contents of this
+              # object follow the
+              # [geoJSON standard](https://datatracker.ietf.org/doc/html/rfc7946).
+              sig do
+                params(
+                  geometry:
+                    Nextbillionai::Models::Skynet::Asset::LocationListResponse::Data::Geojson::Geometry::OrHash,
+                  type: String
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # An object with details of the geoJSON geometry of the route.
+                geometry: nil,
+                # Type of the geoJSON object.
+                type: nil
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    geometry:
+                      Nextbillionai::Models::Skynet::Asset::LocationListResponse::Data::Geojson::Geometry,
+                    type: String
+                  }
+                )
+              end
+              def to_hash
+              end
+
+              class Geometry < Nextbillionai::Internal::Type::BaseModel
+                OrHash =
+                  T.type_alias do
+                    T.any(
+                      Nextbillionai::Models::Skynet::Asset::LocationListResponse::Data::Geojson::Geometry,
+                      Nextbillionai::Internal::AnyHash
+                    )
+                  end
+
+                # An array of coordinates in the [longitude, latitude] format, representing the
+                # route geometry.
+                sig { returns(T.nilable(T::Array[Float])) }
+                attr_reader :coordinates
+
+                sig { params(coordinates: T::Array[Float]).void }
+                attr_writer :coordinates
+
+                # Type of the geoJSON geometry.
+                sig { returns(T.nilable(String)) }
+                attr_reader :type
+
+                sig { params(type: String).void }
+                attr_writer :type
+
+                # An object with details of the geoJSON geometry of the route.
+                sig do
+                  params(coordinates: T::Array[Float], type: String).returns(
+                    T.attached_class
+                  )
+                end
+                def self.new(
+                  # An array of coordinates in the [longitude, latitude] format, representing the
+                  # route geometry.
+                  coordinates: nil,
+                  # Type of the geoJSON geometry.
+                  type: nil
+                )
+                end
+
+                sig do
+                  override.returns(
+                    { coordinates: T::Array[Float], type: String }
+                  )
+                end
+                def to_hash
+                end
+              end
+            end
+
+            class SnappedPoint < Nextbillionai::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Nextbillionai::Models::Skynet::Asset::LocationListResponse::Data::SnappedPoint,
+                    Nextbillionai::Internal::AnyHash
+                  )
+                end
+
+              # The bearing angle of the snapped point from the original tracked location, in
+              # radians. It indicates the direction of the snapped point.
+              sig { returns(T.nilable(String)) }
+              attr_reader :bearing
+
+              sig { params(bearing: String).void }
+              attr_writer :bearing
+
+              # The distance of the snapped point from the original tracked location, in meters.
+              sig { returns(T.nilable(Float)) }
+              attr_reader :distance
+
+              sig { params(distance: Float).void }
+              attr_writer :distance
+
+              # The latitude and longitude coordinates of the snapped point.
+              sig do
+                returns(
+                  T.nilable(
+                    Nextbillionai::Models::Skynet::Asset::LocationListResponse::Data::SnappedPoint::Location
+                  )
+                )
+              end
+              attr_reader :location
+
+              sig do
+                params(
+                  location:
+                    Nextbillionai::Models::Skynet::Asset::LocationListResponse::Data::SnappedPoint::Location::OrHash
+                ).void
+              end
+              attr_writer :location
+
+              # The name of the street or road of the snapped point.
+              sig { returns(T.nilable(String)) }
+              attr_reader :name
+
+              sig { params(name: String).void }
+              attr_writer :name
+
+              # The index of the tracked location to which this snapped point corresponds to.
+              sig { returns(T.nilable(String)) }
+              attr_reader :original_index
+
+              sig { params(original_index: String).void }
+              attr_writer :original_index
+
+              sig do
+                params(
+                  bearing: String,
+                  distance: Float,
+                  location:
+                    Nextbillionai::Models::Skynet::Asset::LocationListResponse::Data::SnappedPoint::Location::OrHash,
+                  name: String,
+                  original_index: String
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # The bearing angle of the snapped point from the original tracked location, in
+                # radians. It indicates the direction of the snapped point.
+                bearing: nil,
+                # The distance of the snapped point from the original tracked location, in meters.
+                distance: nil,
+                # The latitude and longitude coordinates of the snapped point.
+                location: nil,
+                # The name of the street or road of the snapped point.
+                name: nil,
+                # The index of the tracked location to which this snapped point corresponds to.
+                original_index: nil
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    bearing: String,
+                    distance: Float,
+                    location:
+                      Nextbillionai::Models::Skynet::Asset::LocationListResponse::Data::SnappedPoint::Location,
+                    name: String,
+                    original_index: String
+                  }
+                )
+              end
+              def to_hash
+              end
+
+              class Location < Nextbillionai::Internal::Type::BaseModel
+                OrHash =
+                  T.type_alias do
+                    T.any(
+                      Nextbillionai::Models::Skynet::Asset::LocationListResponse::Data::SnappedPoint::Location,
+                      Nextbillionai::Internal::AnyHash
+                    )
+                  end
+
+                # Latitude of the snapped point.
+                sig { returns(T.nilable(Float)) }
+                attr_reader :lat
+
+                sig { params(lat: Float).void }
+                attr_writer :lat
+
+                # Longitude of the snapped point.
+                sig { returns(T.nilable(Float)) }
+                attr_reader :lon
+
+                sig { params(lon: Float).void }
+                attr_writer :lon
+
+                # The latitude and longitude coordinates of the snapped point.
+                sig { params(lat: Float, lon: Float).returns(T.attached_class) }
+                def self.new(
+                  # Latitude of the snapped point.
+                  lat: nil,
+                  # Longitude of the snapped point.
+                  lon: nil
+                )
+                end
+
+                sig { override.returns({ lat: Float, lon: Float }) }
+                def to_hash
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/nextbillionai/models/skynet/asset/track_location.rbi

@@ -0,0 +1,209 @@
+# typed: strong
+
+module Nextbillionai
+  module Models
+    module Skynet
+      module Asset
+        class TrackLocation < Nextbillionai::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Nextbillionai::Skynet::Asset::TrackLocation,
+                Nextbillionai::Internal::AnyHash
+              )
+            end
+
+          # If available, this property returns the accuracy of the GPS information received
+          # at the tracked location. It is represented as an estimated horizontal accuracy
+          # radius, in meters, at the 68th percentile confidence level.
+          sig { returns(T.nilable(Float)) }
+          attr_reader :accuracy
+
+          sig { params(accuracy: Float).void }
+          attr_writer :accuracy
+
+          # If available in the GPS information, this property returns the altitude of the
+          # asset at the tracked location. It is represented as height, in meters, above the
+          # WGS84 reference ellipsoid.
+          sig { returns(T.nilable(Float)) }
+          attr_reader :altitude
+
+          sig { params(altitude: Float).void }
+          attr_writer :altitude
+
+          # Returns the battery level of the GPS device, as a percentage, when the location
+          # was tracked. It has 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
+
+          # If available in the GPS information, this property returns the heading of the
+          # asset calculated from true north in clockwise direction at the tracked location.
+          # Please note that the bearing is not affected by the device orientation.
+          #
+          # The bearing will always be in the range of [0, 360).
+          sig { returns(T.nilable(Float)) }
+          attr_reader :bearing
+
+          sig { params(bearing: Float).void }
+          attr_writer :bearing
+
+          # An object with the coordinates of the last tracked location.
+          sig do
+            returns(
+              T.nilable(Nextbillionai::Skynet::Asset::TrackLocation::Location)
+            )
+          end
+          attr_reader :location
+
+          sig do
+            params(
+              location:
+                Nextbillionai::Skynet::Asset::TrackLocation::Location::OrHash
+            ).void
+          end
+          attr_writer :location
+
+          # Specifies the custom data about the location that was added when the location
+          # was uploaded.
+          sig { returns(T.nilable(T.anything)) }
+          attr_reader :meta_data
+
+          sig { params(meta_data: T.anything).void }
+          attr_writer :meta_data
+
+          # If available in the GPS information, this property returns 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
+
+          # A UNIX epoch timestamp in milliseconds, representing the time at which the
+          # location was tracked.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :timestamp
+
+          sig { params(timestamp: Integer).void }
+          attr_writer :timestamp
+
+          # Internal parameter for tracking mode.
+          sig { returns(T.nilable(String)) }
+          attr_reader :tracking_mode
+
+          sig { params(tracking_mode: String).void }
+          attr_writer :tracking_mode
+
+          # An object with details of the tracked location. Please note that if there are no
+          # tracking records for an asset, no location data will be returned.
+          sig do
+            params(
+              accuracy: Float,
+              altitude: Float,
+              battery_level: Integer,
+              bearing: Float,
+              location:
+                Nextbillionai::Skynet::Asset::TrackLocation::Location::OrHash,
+              meta_data: T.anything,
+              speed: Float,
+              timestamp: Integer,
+              tracking_mode: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # If available, this property returns the accuracy of the GPS information received
+            # at the tracked location. It is represented as an estimated horizontal accuracy
+            # radius, in meters, at the 68th percentile confidence level.
+            accuracy: nil,
+            # If available in the GPS information, this property returns the altitude of the
+            # asset at the tracked location. It is represented as height, in meters, above the
+            # WGS84 reference ellipsoid.
+            altitude: nil,
+            # Returns the battery level of the GPS device, as a percentage, when the location
+            # was tracked. It has a minimum value of 0 and a maximum value of 100.
+            battery_level: nil,
+            # If available in the GPS information, this property returns the heading of the
+            # asset calculated from true north in clockwise direction at the tracked location.
+            # Please note that the bearing is not affected by the device orientation.
+            #
+            # The bearing will always be in the range of [0, 360).
+            bearing: nil,
+            # An object with the coordinates of the last tracked location.
+            location: nil,
+            # Specifies the custom data about the location that was added when the location
+            # was uploaded.
+            meta_data: nil,
+            # If available in the GPS information, this property returns the speed of the
+            # asset, in meters per second, at the tracked location.
+            speed: nil,
+            # A UNIX epoch timestamp in milliseconds, representing the time at which the
+            # location was tracked.
+            timestamp: nil,
+            # Internal parameter for tracking mode.
+            tracking_mode: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                accuracy: Float,
+                altitude: Float,
+                battery_level: Integer,
+                bearing: Float,
+                location: Nextbillionai::Skynet::Asset::TrackLocation::Location,
+                meta_data: T.anything,
+                speed: Float,
+                timestamp: Integer,
+                tracking_mode: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Location < Nextbillionai::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Nextbillionai::Skynet::Asset::TrackLocation::Location,
+                  Nextbillionai::Internal::AnyHash
+                )
+              end
+
+            # Latitude of the tracked location of the asset.
+            sig { returns(T.nilable(Float)) }
+            attr_reader :lat
+
+            sig { params(lat: Float).void }
+            attr_writer :lat
+
+            # Longitude of the tracked location of the asset.
+            sig { returns(T.nilable(Float)) }
+            attr_reader :lon
+
+            sig { params(lon: Float).void }
+            attr_writer :lon
+
+            # An object with the coordinates of the last tracked location.
+            sig { params(lat: Float, lon: Float).returns(T.attached_class) }
+            def self.new(
+              # Latitude of the tracked location of the asset.
+              lat: nil,
+              # Longitude of the tracked location of the asset.
+              lon: nil
+            )
+            end
+
+            sig { override.returns({ lat: Float, lon: Float }) }
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end