nextbillionai 0.1.0.pre.alpha.4

data/rbi/nextbillionai/models/skynet/trip_retrieve_response.rbi

@@ -0,0 +1,354 @@
+# typed: strong
+
+module Nextbillionai
+  module Models
+    module Skynet
+      class TripRetrieveResponse < Nextbillionai::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Nextbillionai::Models::Skynet::TripRetrieveResponse,
+              Nextbillionai::Internal::AnyHash
+            )
+          end
+
+        # An container for the trip returned by the service.
+        sig do
+          returns(
+            T.nilable(Nextbillionai::Models::Skynet::TripRetrieveResponse::Data)
+          )
+        end
+        attr_reader :data
+
+        sig do
+          params(
+            data:
+              Nextbillionai::Models::Skynet::TripRetrieveResponse::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::TripRetrieveResponse::Data::OrHash,
+            message: String,
+            status: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # An container for the trip returned by the service.
+          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::TripRetrieveResponse::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::TripRetrieveResponse::Data,
+                Nextbillionai::Internal::AnyHash
+              )
+            end
+
+          # An object containing the returned trip details.
+          sig do
+            returns(
+              T.nilable(
+                Nextbillionai::Models::Skynet::TripRetrieveResponse::Data::Trip
+              )
+            )
+          end
+          attr_reader :trip
+
+          sig do
+            params(
+              trip:
+                Nextbillionai::Models::Skynet::TripRetrieveResponse::Data::Trip::OrHash
+            ).void
+          end
+          attr_writer :trip
+
+          # An container for the trip returned by the service.
+          sig do
+            params(
+              trip:
+                Nextbillionai::Models::Skynet::TripRetrieveResponse::Data::Trip::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # An object containing the returned trip details.
+            trip: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                trip:
+                  Nextbillionai::Models::Skynet::TripRetrieveResponse::Data::Trip
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Trip < Nextbillionai::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Nextbillionai::Models::Skynet::TripRetrieveResponse::Data::Trip,
+                  Nextbillionai::Internal::AnyHash
+                )
+              end
+
+            # Returns the unique identifier of the trip.
+            sig { returns(T.nilable(String)) }
+            attr_reader :id
+
+            sig { params(id: String).void }
+            attr_writer :id
+
+            # Returns the ID of the asset linked to the trip when the trip was started or
+            # updated.
+            sig { returns(T.nilable(String)) }
+            attr_reader :asset_id
+
+            sig { params(asset_id: String).void }
+            attr_writer :asset_id
+
+            # Returns the attributes provided for the trip at the time of starting or updating
+            # it.
+            sig { returns(T.nilable(T.anything)) }
+            attr_reader :attributes
+
+            sig { params(attributes: T.anything).void }
+            attr_writer :attributes
+
+            # Returns the time, expressed as UNIX epoch timestamp in milliseconds, when the
+            # trip was created.
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :created_at
+
+            sig { params(created_at: Integer).void }
+            attr_writer :created_at
+
+            # Returns the custom description for the trip as provided at the time of starting
+            # or updating the trip.
+            sig { returns(T.nilable(String)) }
+            attr_reader :description
+
+            sig { params(description: String).void }
+            attr_writer :description
+
+            # Returns the time, expressed as UNIX epoch timestamp in milliseconds, when the
+            # trip ended.
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :ended_at
+
+            sig { params(ended_at: Integer).void }
+            attr_writer :ended_at
+
+            # Returns the metadata containing additional information about the trip as
+            # provided at the time of starting or updating the trip.
+            sig { returns(T.nilable(T.anything)) }
+            attr_reader :meta_data
+
+            sig { params(meta_data: T.anything).void }
+            attr_writer :meta_data
+
+            # Returns the name for the trip as provided at the time of starting or updating
+            # the trip.
+            sig { returns(T.nilable(String)) }
+            attr_reader :name
+
+            sig { params(name: String).void }
+            attr_writer :name
+
+            # An array of object returning the details of the locations tracked for the asset
+            # during the trip which has ended. Each object represents a single location that
+            # was tracked.
+            #
+            # Please note that this attribute will not be present in the response if no
+            # locations were tracked/uploaded during the trip.
+            sig do
+              returns(
+                T.nilable(T::Array[Nextbillionai::Skynet::Asset::TrackLocation])
+              )
+            end
+            attr_reader :route
+
+            sig do
+              params(
+                route:
+                  T::Array[Nextbillionai::Skynet::Asset::TrackLocation::OrHash]
+              ).void
+            end
+            attr_writer :route
+
+            # Returns the time, expressed as UNIX epoch timestamp in milliseconds, when the
+            # trip started.
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :started_at
+
+            sig { params(started_at: Integer).void }
+            attr_writer :started_at
+
+            # Returns the current state of the trip. The value will be "active" if the trip is
+            # still going on, otherwise the value returned would be "ended".
+            sig { returns(T.nilable(String)) }
+            attr_reader :state
+
+            sig { params(state: String).void }
+            attr_writer :state
+
+            # An array of objects returning the details of the stops made during the trip.
+            # Each object represents a single stop.
+            sig do
+              returns(T.nilable(T::Array[Nextbillionai::Skynet::TripStop]))
+            end
+            attr_reader :stops
+
+            sig do
+              params(
+                stops: T::Array[Nextbillionai::Skynet::TripStop::OrHash]
+              ).void
+            end
+            attr_writer :stops
+
+            # Returns the timeme, expressed as UNIX epoch timestamp in milliseconds, when the
+            # trip was last updated.
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :updated_at
+
+            sig { params(updated_at: Integer).void }
+            attr_writer :updated_at
+
+            # An object containing the returned trip details.
+            sig do
+              params(
+                id: String,
+                asset_id: String,
+                attributes: T.anything,
+                created_at: Integer,
+                description: String,
+                ended_at: Integer,
+                meta_data: T.anything,
+                name: String,
+                route:
+                  T::Array[Nextbillionai::Skynet::Asset::TrackLocation::OrHash],
+                started_at: Integer,
+                state: String,
+                stops: T::Array[Nextbillionai::Skynet::TripStop::OrHash],
+                updated_at: Integer
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Returns the unique identifier of the trip.
+              id: nil,
+              # Returns the ID of the asset linked to the trip when the trip was started or
+              # updated.
+              asset_id: nil,
+              # Returns the attributes provided for the trip at the time of starting or updating
+              # it.
+              attributes: nil,
+              # Returns the time, expressed as UNIX epoch timestamp in milliseconds, when the
+              # trip was created.
+              created_at: nil,
+              # Returns the custom description for the trip as provided at the time of starting
+              # or updating the trip.
+              description: nil,
+              # Returns the time, expressed as UNIX epoch timestamp in milliseconds, when the
+              # trip ended.
+              ended_at: nil,
+              # Returns the metadata containing additional information about the trip as
+              # provided at the time of starting or updating the trip.
+              meta_data: nil,
+              # Returns the name for the trip as provided at the time of starting or updating
+              # the trip.
+              name: nil,
+              # An array of object returning the details of the locations tracked for the asset
+              # during the trip which has ended. Each object represents a single location that
+              # was tracked.
+              #
+              # Please note that this attribute will not be present in the response if no
+              # locations were tracked/uploaded during the trip.
+              route: nil,
+              # Returns the time, expressed as UNIX epoch timestamp in milliseconds, when the
+              # trip started.
+              started_at: nil,
+              # Returns the current state of the trip. The value will be "active" if the trip is
+              # still going on, otherwise the value returned would be "ended".
+              state: nil,
+              # An array of objects returning the details of the stops made during the trip.
+              # Each object represents a single stop.
+              stops: nil,
+              # Returns the timeme, expressed as UNIX epoch timestamp in milliseconds, when the
+              # trip was last updated.
+              updated_at: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  id: String,
+                  asset_id: String,
+                  attributes: T.anything,
+                  created_at: Integer,
+                  description: String,
+                  ended_at: Integer,
+                  meta_data: T.anything,
+                  name: String,
+                  route: T::Array[Nextbillionai::Skynet::Asset::TrackLocation],
+                  started_at: Integer,
+                  state: String,
+                  stops: T::Array[Nextbillionai::Skynet::TripStop],
+                  updated_at: Integer
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/nextbillionai/models/skynet/trip_start_params.rbi

@@ -0,0 +1,279 @@
+# typed: strong
+
+module Nextbillionai
+  module Models
+    module Skynet
+      class TripStartParams < Nextbillionai::Internal::Type::BaseModel
+        extend Nextbillionai::Internal::Type::RequestParameters::Converter
+        include Nextbillionai::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Nextbillionai::Skynet::TripStartParams,
+              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
+
+        # Specify the ID of the asset which is making this trip. The asset will be linked
+        # to this trip.
+        sig { returns(String) }
+        attr_accessor :asset_id
+
+        # the cluster of the region you want to use
+        sig do
+          returns(
+            T.nilable(Nextbillionai::Skynet::TripStartParams::Cluster::OrSymbol)
+          )
+        end
+        attr_reader :cluster
+
+        sig do
+          params(
+            cluster: Nextbillionai::Skynet::TripStartParams::Cluster::OrSymbol
+          ).void
+        end
+        attr_writer :cluster
+
+        # attributes can be used to store custom information about a trip in key:value
+        # format. Use attributes to add any useful information or context to your trips
+        # like the driver name, destination etc.
+        #
+        # 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.
+        sig { returns(T.nilable(T.anything)) }
+        attr_reader :attributes
+
+        sig { params(attributes: T.anything).void }
+        attr_writer :attributes
+
+        # Set a unique ID for the new trip. If not provided, an ID will be automatically
+        # generated in UUID format. A valid custom_id can contain letters, numbers, “-”, &
+        # “\_” only.
+        #
+        # Please note that the ID of a trip can not be changed once it is created.
+        sig { returns(T.nilable(String)) }
+        attr_reader :custom_id
+
+        sig { params(custom_id: String).void }
+        attr_writer :custom_id
+
+        # Add a custom description for the trip.
+        sig { returns(T.nilable(String)) }
+        attr_reader :description
+
+        sig { params(description: String).void }
+        attr_writer :description
+
+        # An JSON object to collect additional details about the trip. Use this property
+        # to add any custom information / context about the trip. The input will be passed
+        # on to the response as-is and can be used to display useful information on, for
+        # example, a UI app.
+        sig { returns(T.nilable(T.anything)) }
+        attr_reader :meta_data
+
+        sig { params(meta_data: T.anything).void }
+        attr_writer :meta_data
+
+        # Specify a name for the trip.
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        # An array of objects to collect the details about all the stops that need to be
+        # made before the trip ends. Each object represents one stop.
+        sig do
+          returns(
+            T.nilable(T::Array[Nextbillionai::Skynet::TripStartParams::Stop])
+          )
+        end
+        attr_reader :stops
+
+        sig do
+          params(
+            stops:
+              T::Array[Nextbillionai::Skynet::TripStartParams::Stop::OrHash]
+          ).void
+        end
+        attr_writer :stops
+
+        sig do
+          params(
+            key: String,
+            asset_id: String,
+            cluster: Nextbillionai::Skynet::TripStartParams::Cluster::OrSymbol,
+            attributes: T.anything,
+            custom_id: String,
+            description: String,
+            meta_data: T.anything,
+            name: String,
+            stops:
+              T::Array[Nextbillionai::Skynet::TripStartParams::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:,
+          # Specify the ID of the asset which is making this trip. The asset will be linked
+          # to this trip.
+          asset_id:,
+          # the cluster of the region you want to use
+          cluster: nil,
+          # attributes can be used to store custom information about a trip in key:value
+          # format. Use attributes to add any useful information or context to your trips
+          # like the driver name, destination etc.
+          #
+          # 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.
+          attributes: nil,
+          # Set a unique ID for the new trip. If not provided, an ID will be automatically
+          # generated in UUID format. A valid custom_id can contain letters, numbers, “-”, &
+          # “\_” only.
+          #
+          # Please note that the ID of a trip can not be changed once it is created.
+          custom_id: nil,
+          # Add a custom description for the trip.
+          description: nil,
+          # An JSON object to collect additional details about the trip. Use this property
+          # to add any custom information / context about the trip. The input will be passed
+          # on to the response as-is and can be used to display useful information on, for
+          # example, a UI app.
+          meta_data: nil,
+          # Specify a name for the trip.
+          name: nil,
+          # An array of objects to collect the details about all the stops that need to be
+          # made before the trip ends. Each object represents one stop.
+          stops: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              key: String,
+              asset_id: String,
+              cluster:
+                Nextbillionai::Skynet::TripStartParams::Cluster::OrSymbol,
+              attributes: T.anything,
+              custom_id: String,
+              description: String,
+              meta_data: T.anything,
+              name: String,
+              stops: T::Array[Nextbillionai::Skynet::TripStartParams::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::TripStartParams::Cluster)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          AMERICA =
+            T.let(
+              :america,
+              Nextbillionai::Skynet::TripStartParams::Cluster::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Nextbillionai::Skynet::TripStartParams::Cluster::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class Stop < Nextbillionai::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Nextbillionai::Skynet::TripStartParams::Stop,
+                Nextbillionai::Internal::AnyHash
+              )
+            end
+
+          # Specify 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.
+          sig { returns(T.nilable(String)) }
+          attr_reader :geofence_id
+
+          sig { params(geofence_id: String).void }
+          attr_writer :geofence_id
+
+          # An JSON object to collect additional details about the stop. Use this property
+          # to add any custom information / context about the stop. The input will be passed
+          # on to the response as-is and can be used to display useful information on, for
+          # example, a UI app.
+          sig { returns(T.nilable(T.anything)) }
+          attr_reader :meta_data
+
+          sig { params(meta_data: T.anything).void }
+          attr_writer :meta_data
+
+          # Specify a custom name for 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(
+            # Specify 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.
+            geofence_id: nil,
+            # An JSON object to collect additional details about the stop. Use this property
+            # to add any custom information / context about the stop. The input will be passed
+            # on to the response as-is and can be used to display useful information on, for
+            # example, a UI app.
+            meta_data: nil,
+            # Specify a custom name for 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