nextbillionai 0.1.0.pre.alpha.4

data/rbi/nextbillionai/models/skynet/trip_start_response.rbi

@@ -0,0 +1,112 @@
+# typed: strong
+
+module Nextbillionai
+  module Models
+    module Skynet
+      class TripStartResponse < Nextbillionai::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Nextbillionai::Models::Skynet::TripStartResponse,
+              Nextbillionai::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T.nilable(Nextbillionai::Models::Skynet::TripStartResponse::Data)
+          )
+        end
+        attr_reader :data
+
+        sig do
+          params(
+            data: Nextbillionai::Models::Skynet::TripStartResponse::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::TripStartResponse::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::TripStartResponse::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::TripStartResponse::Data,
+                Nextbillionai::Internal::AnyHash
+              )
+            end
+
+          # Returns the ID of the newly created trip. It will be same as the custom_id if
+          # that input was provided in the input request. Use this ID to manage this trip
+          # using other available Trip methods.
+          sig { returns(T.nilable(String)) }
+          attr_reader :id
+
+          sig { params(id: String).void }
+          attr_writer :id
+
+          sig { params(id: String).returns(T.attached_class) }
+          def self.new(
+            # Returns the ID of the newly created trip. It will be same as the custom_id if
+            # that input was provided in the input request. Use this ID to manage this trip
+            # using other available Trip methods.
+            id: nil
+          )
+          end
+
+          sig { override.returns({ id: String }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/nextbillionai/models/skynet/trip_stop.rbi

@@ -0,0 +1,69 @@
+# typed: strong
+
+module Nextbillionai
+  module Models
+    module Skynet
+      class TripStop < Nextbillionai::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Nextbillionai::Skynet::TripStop,
+              Nextbillionai::Internal::AnyHash
+            )
+          end
+
+        # Returns the ID of the geofence that was used to indicate the area to make a
+        # stop.
+        sig { returns(T.nilable(String)) }
+        attr_reader :geofence_id
+
+        sig { params(geofence_id: String).void }
+        attr_writer :geofence_id
+
+        # Returns any meta data that was added to provide additional information about the
+        # stop.
+        sig { returns(T.nilable(T.anything)) }
+        attr_reader :meta_data
+
+        sig { params(meta_data: T.anything).void }
+        attr_writer :meta_data
+
+        # Returns the name of the stop that was provided when configuring this stop for
+        # the trip.
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        sig do
+          params(
+            geofence_id: String,
+            meta_data: T.anything,
+            name: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Returns the ID of the geofence that was used to indicate the area to make a
+          # stop.
+          geofence_id: nil,
+          # Returns any meta data that was added to provide additional information about the
+          # stop.
+          meta_data: nil,
+          # Returns the name of the stop that was provided when configuring this stop for
+          # the trip.
+          name: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            { geofence_id: String, meta_data: T.anything, name: String }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/nextbillionai/models/skynet/trip_update_params.rbi

@@ -0,0 +1,274 @@
+# typed: strong
+
+module Nextbillionai
+  module Models
+    module Skynet
+      class TripUpdateParams < Nextbillionai::Internal::Type::BaseModel
+        extend Nextbillionai::Internal::Type::RequestParameters::Converter
+        include Nextbillionai::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Nextbillionai::Skynet::TripUpdateParams,
+              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
+
+        # Use this param to update the ID of the asset which made this trip. Please be
+        # cautious when using this field as providing an ID other than what was provided
+        # at the time of starting the trip, will link a new asset to the trip and un-link
+        # the original asset, even if the trip is still active.
+        sig { returns(String) }
+        attr_accessor :asset_id
+
+        # the cluster of the region you want to use
+        sig do
+          returns(
+            T.nilable(
+              Nextbillionai::Skynet::TripUpdateParams::Cluster::OrSymbol
+            )
+          )
+        end
+        attr_reader :cluster
+
+        sig do
+          params(
+            cluster: Nextbillionai::Skynet::TripUpdateParams::Cluster::OrSymbol
+          ).void
+        end
+        attr_writer :cluster
+
+        # Use this field to update the attributes of the trip. Please note that when
+        # updating the attributes field, previously added information will be overwritten.
+        sig { returns(T.nilable(T.anything)) }
+        attr_reader :attributes
+
+        sig { params(attributes: T.anything).void }
+        attr_writer :attributes
+
+        # Use this parameter to update the custom description of the trip.
+        sig { returns(T.nilable(String)) }
+        attr_reader :description
+
+        sig { params(description: String).void }
+        attr_writer :description
+
+        # Use this JSON object to update additional details about the trip. This property
+        # is used to add any custom information / context about the trip.
+        #
+        # Please note that updating the meta_data field will overwrite the previously
+        # added information.
+        sig { returns(T.nilable(T.anything)) }
+        attr_reader :meta_data
+
+        sig { params(meta_data: T.anything).void }
+        attr_writer :meta_data
+
+        # Use this property to update the name of the trip.
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        # Use this object to update the details of the stops made during the trip. Each
+        # object represents a single stop.
+        #
+        # Please note that when updating this field, the new stops will overwrite any
+        # existing stops configured for the trip.
+        sig do
+          returns(
+            T.nilable(T::Array[Nextbillionai::Skynet::TripUpdateParams::Stop])
+          )
+        end
+        attr_reader :stops
+
+        sig do
+          params(
+            stops:
+              T::Array[Nextbillionai::Skynet::TripUpdateParams::Stop::OrHash]
+          ).void
+        end
+        attr_writer :stops
+
+        sig do
+          params(
+            key: String,
+            asset_id: String,
+            cluster: Nextbillionai::Skynet::TripUpdateParams::Cluster::OrSymbol,
+            attributes: T.anything,
+            description: String,
+            meta_data: T.anything,
+            name: String,
+            stops:
+              T::Array[Nextbillionai::Skynet::TripUpdateParams::Stop::OrHash],
+            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:,
+          # Use this param to update the ID of the asset which made this trip. Please be
+          # cautious when using this field as providing an ID other than what was provided
+          # at the time of starting the trip, will link a new asset to the trip and un-link
+          # the original asset, even if the trip is still active.
+          asset_id:,
+          # the cluster of the region you want to use
+          cluster: nil,
+          # Use this field to update the attributes of the trip. Please note that when
+          # updating the attributes field, previously added information will be overwritten.
+          attributes: nil,
+          # Use this parameter to update the custom description of the trip.
+          description: nil,
+          # Use this JSON object to update additional details about the trip. This property
+          # is used to add any custom information / context about the trip.
+          #
+          # Please note that updating the meta_data field will overwrite the previously
+          # added information.
+          meta_data: nil,
+          # Use this property to update the name of the trip.
+          name: nil,
+          # Use this object to update the details of the stops made during the trip. Each
+          # object represents a single stop.
+          #
+          # Please note that when updating this field, the new stops will overwrite any
+          # existing stops configured for the trip.
+          stops: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              key: String,
+              asset_id: String,
+              cluster:
+                Nextbillionai::Skynet::TripUpdateParams::Cluster::OrSymbol,
+              attributes: T.anything,
+              description: String,
+              meta_data: T.anything,
+              name: String,
+              stops: T::Array[Nextbillionai::Skynet::TripUpdateParams::Stop],
+              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::TripUpdateParams::Cluster)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          AMERICA =
+            T.let(
+              :america,
+              Nextbillionai::Skynet::TripUpdateParams::Cluster::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Nextbillionai::Skynet::TripUpdateParams::Cluster::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class Stop < Nextbillionai::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Nextbillionai::Skynet::TripUpdateParams::Stop,
+                Nextbillionai::Internal::AnyHash
+              )
+            end
+
+          # Use this parameter to update the ID of the geofence indicating the area where
+          # the asset needs to make a stop, during the trip. Only the IDs of geofences
+          # created using
+          # [NextBillion.ai's Geofence API](https://docs.nextbillion.ai/docs/tracking/api/geofence#create-a-geofence)
+          # are accepted.
+          #
+          # Please note that updating this field will overwrite the previously added
+          # information.
+          sig { returns(T.nilable(String)) }
+          attr_reader :geofence_id
+
+          sig { params(geofence_id: String).void }
+          attr_writer :geofence_id
+
+          # Use this JSON object to update additional details about the stop. This property
+          # is used to add any custom information / context about the stop.
+          #
+          # Please note that updating the meta_data field will overwrite the previously
+          # added information.
+          sig { returns(T.nilable(T.anything)) }
+          attr_reader :meta_data
+
+          sig { params(meta_data: T.anything).void }
+          attr_writer :meta_data
+
+          # Use this filed to update the name of the stop.
+          sig { returns(T.nilable(String)) }
+          attr_reader :name
+
+          sig { params(name: String).void }
+          attr_writer :name
+
+          sig do
+            params(
+              geofence_id: String,
+              meta_data: T.anything,
+              name: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Use this parameter to update the ID of the geofence indicating the area where
+            # the asset needs to make a stop, during the trip. Only the IDs of geofences
+            # created using
+            # [NextBillion.ai's Geofence API](https://docs.nextbillion.ai/docs/tracking/api/geofence#create-a-geofence)
+            # are accepted.
+            #
+            # Please note that updating this field will overwrite the previously added
+            # information.
+            geofence_id: nil,
+            # Use this JSON object to update additional details about the stop. This property
+            # is used to add any custom information / context about the stop.
+            #
+            # Please note that updating the meta_data field will overwrite the previously
+            # added information.
+            meta_data: nil,
+            # Use this filed to update the name of the stop.
+            name: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              { geofence_id: String, meta_data: T.anything, name: String }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/nextbillionai/models/skynet_subscribe_params.rbi

@@ -0,0 +1,170 @@
+# typed: strong
+
+module Nextbillionai
+  module Models
+    class SkynetSubscribeParams < Nextbillionai::Internal::Type::BaseModel
+      extend Nextbillionai::Internal::Type::RequestParameters::Converter
+      include Nextbillionai::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Nextbillionai::SkynetSubscribeParams,
+            Nextbillionai::Internal::AnyHash
+          )
+        end
+
+      # Specify the behavior that needs to be achieved for the subscription. Following
+      # values are accepted:
+      #
+      # - TRIP_SUBSCRIBE: Enable a trip subscription.
+      # - TRIP_UNSUBSCRIBE: Unsubscribe from a trip
+      # - HEARTBEAT: Enable heartbeat mechanism for a web-socket connection. The action
+      #   message need to be sent at a frequency higher than every 5 mins to keep the
+      #   connection alive. Alternatively, users can chose to respond to the ping frame
+      #   sent by web socket server to keep the connection alive. Refer to
+      #   [connection details](https://188--nbai-docs-stg.netlify.app/docs/tracking/api/live-tracking-api#connect-to-web-socket-server)
+      #   for more details.
+      sig { returns(Nextbillionai::SkynetSubscribeParams::Action::OrSymbol) }
+      attr_accessor :action
+
+      # Specify a custom ID for the subscription. It can be used to reference a given
+      # subscription in the downstream applications / systems.
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      sig { returns(T.nilable(Nextbillionai::SkynetSubscribeParams::Params)) }
+      attr_reader :params
+
+      sig do
+        params(
+          params: Nextbillionai::SkynetSubscribeParams::Params::OrHash
+        ).void
+      end
+      attr_writer :params
+
+      sig do
+        params(
+          action: Nextbillionai::SkynetSubscribeParams::Action::OrSymbol,
+          id: String,
+          params: Nextbillionai::SkynetSubscribeParams::Params::OrHash,
+          request_options: Nextbillionai::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Specify the behavior that needs to be achieved for the subscription. Following
+        # values are accepted:
+        #
+        # - TRIP_SUBSCRIBE: Enable a trip subscription.
+        # - TRIP_UNSUBSCRIBE: Unsubscribe from a trip
+        # - HEARTBEAT: Enable heartbeat mechanism for a web-socket connection. The action
+        #   message need to be sent at a frequency higher than every 5 mins to keep the
+        #   connection alive. Alternatively, users can chose to respond to the ping frame
+        #   sent by web socket server to keep the connection alive. Refer to
+        #   [connection details](https://188--nbai-docs-stg.netlify.app/docs/tracking/api/live-tracking-api#connect-to-web-socket-server)
+        #   for more details.
+        action:,
+        # Specify a custom ID for the subscription. It can be used to reference a given
+        # subscription in the downstream applications / systems.
+        id: nil,
+        params: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            action: Nextbillionai::SkynetSubscribeParams::Action::OrSymbol,
+            id: String,
+            params: Nextbillionai::SkynetSubscribeParams::Params,
+            request_options: Nextbillionai::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # Specify the behavior that needs to be achieved for the subscription. Following
+      # values are accepted:
+      #
+      # - TRIP_SUBSCRIBE: Enable a trip subscription.
+      # - TRIP_UNSUBSCRIBE: Unsubscribe from a trip
+      # - HEARTBEAT: Enable heartbeat mechanism for a web-socket connection. The action
+      #   message need to be sent at a frequency higher than every 5 mins to keep the
+      #   connection alive. Alternatively, users can chose to respond to the ping frame
+      #   sent by web socket server to keep the connection alive. Refer to
+      #   [connection details](https://188--nbai-docs-stg.netlify.app/docs/tracking/api/live-tracking-api#connect-to-web-socket-server)
+      #   for more details.
+      module Action
+        extend Nextbillionai::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Nextbillionai::SkynetSubscribeParams::Action)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        TRIP_SUBSCRIBE =
+          T.let(
+            :TRIP_SUBSCRIBE,
+            Nextbillionai::SkynetSubscribeParams::Action::TaggedSymbol
+          )
+        TRIP_UNSUBSCRIBE =
+          T.let(
+            :TRIP_UNSUBSCRIBE,
+            Nextbillionai::SkynetSubscribeParams::Action::TaggedSymbol
+          )
+        HEARTBEAT =
+          T.let(
+            :HEARTBEAT,
+            Nextbillionai::SkynetSubscribeParams::Action::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Nextbillionai::SkynetSubscribeParams::Action::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+
+      class Params < Nextbillionai::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Nextbillionai::SkynetSubscribeParams::Params,
+              Nextbillionai::Internal::AnyHash
+            )
+          end
+
+        # Specify the ID of an active trip that needs to be subscribed. The ID of a trip
+        # is returned in the response when _Start A Trip_ request is acknowledged.
+        #
+        # This attribute is mandatory when action is set to either "TRIP_SUBSCRIBE" or
+        # "TRIP_UNSUBSCRIBE"
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { params(id: String).returns(T.attached_class) }
+        def self.new(
+          # Specify the ID of an active trip that needs to be subscribed. The ID of a trip
+          # is returned in the response when _Start A Trip_ request is acknowledged.
+          #
+          # This attribute is mandatory when action is set to either "TRIP_SUBSCRIBE" or
+          # "TRIP_UNSUBSCRIBE"
+          id:
+        )
+        end
+
+        sig { override.returns({ id: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/nextbillionai/models/skynet_subscribe_response.rbi

@@ -0,0 +1,75 @@
+# typed: strong
+
+module Nextbillionai
+  module Models
+    class SkynetSubscribeResponse < Nextbillionai::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Nextbillionai::Models::SkynetSubscribeResponse,
+            Nextbillionai::Internal::AnyHash
+          )
+        end
+
+      # Subscription ID as provided in the input action message.
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      # Returns the error message when status: error. Otherwise, response doesn't
+      # contain this field.
+      sig { returns(T.nilable(String)) }
+      attr_reader :error
+
+      sig { params(error: String).void }
+      attr_writer :error
+
+      # Status of the action. It can have only two values - "success" or "error".
+      sig { returns(T.nilable(String)) }
+      attr_reader :status
+
+      sig { params(status: String).void }
+      attr_writer :status
+
+      # Returns the UNIX timestamp, in milliseconds format, when the web-socket returns
+      # the action response.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :timestamp
+
+      sig { params(timestamp: Integer).void }
+      attr_writer :timestamp
+
+      sig do
+        params(
+          id: String,
+          error: String,
+          status: String,
+          timestamp: Integer
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Subscription ID as provided in the input action message.
+        id: nil,
+        # Returns the error message when status: error. Otherwise, response doesn't
+        # contain this field.
+        error: nil,
+        # Status of the action. It can have only two values - "success" or "error".
+        status: nil,
+        # Returns the UNIX timestamp, in milliseconds format, when the web-socket returns
+        # the action response.
+        timestamp: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          { id: String, error: String, status: String, timestamp: Integer }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end