nextbillionai 0.1.0.pre.alpha.4

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

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module Skynet
+      # @see Nextbillionai::Resources::Skynet::Trip#start
+      class TripStartParams < Nextbillionai::Internal::Type::BaseModel
+        extend Nextbillionai::Internal::Type::RequestParameters::Converter
+        include Nextbillionai::Internal::Type::RequestParameters
+
+        # @!attribute key
+        #   A key is a unique identifier that is required to authenticate a request to the
+        #   API.
+        #
+        #   @return [String]
+        required :key, String
+
+        # @!attribute asset_id
+        #   Specify the ID of the asset which is making this trip. The asset will be linked
+        #   to this trip.
+        #
+        #   @return [String]
+        required :asset_id, String
+
+        # @!attribute cluster
+        #   the cluster of the region you want to use
+        #
+        #   @return [Symbol, Nextbillionai::Models::Skynet::TripStartParams::Cluster, nil]
+        optional :cluster, enum: -> { Nextbillionai::Skynet::TripStartParams::Cluster }
+
+        # @!attribute attributes
+        #   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.
+        #
+        #   @return [Object, nil]
+        optional :attributes, Nextbillionai::Internal::Type::Unknown
+
+        # @!attribute custom_id
+        #   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.
+        #
+        #   @return [String, nil]
+        optional :custom_id, String
+
+        # @!attribute description
+        #   Add a custom description for the trip.
+        #
+        #   @return [String, nil]
+        optional :description, String
+
+        # @!attribute meta_data
+        #   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.
+        #
+        #   @return [Object, nil]
+        optional :meta_data, Nextbillionai::Internal::Type::Unknown
+
+        # @!attribute name
+        #   Specify a name for the trip.
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!attribute stops
+        #   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.
+        #
+        #   @return [Array<Nextbillionai::Models::Skynet::TripStartParams::Stop>, nil]
+        optional :stops,
+                 -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Skynet::TripStartParams::Stop] }
+
+        # @!method initialize(key:, asset_id:, cluster: nil, attributes: nil, custom_id: nil, description: nil, meta_data: nil, name: nil, stops: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::Skynet::TripStartParams} for more details.
+        #
+        #   @param key [String] A key is a unique identifier that is required to authenticate a request to the A
+        #
+        #   @param asset_id [String] Specify the ID of the asset which is making this trip. The asset will be linked
+        #
+        #   @param cluster [Symbol, Nextbillionai::Models::Skynet::TripStartParams::Cluster] the cluster of the region you want to use
+        #
+        #   @param attributes [Object] attributes can be used to store custom information about a trip in key:value for
+        #
+        #   @param custom_id [String] Set a unique ID for the new trip. If not provided, an ID will be automatically g
+        #
+        #   @param description [String] Add a custom description for the trip.
+        #
+        #   @param meta_data [Object] An JSON object to collect additional details about the trip. Use this property t
+        #
+        #   @param name [String] Specify a name for the trip.
+        #
+        #   @param stops [Array<Nextbillionai::Models::Skynet::TripStartParams::Stop>] An array of objects to collect the details about all the stops that need to be m
+        #
+        #   @param request_options [Nextbillionai::RequestOptions, Hash{Symbol=>Object}]
+
+        # the cluster of the region you want to use
+        module Cluster
+          extend Nextbillionai::Internal::Type::Enum
+
+          AMERICA = :america
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        class Stop < Nextbillionai::Internal::Type::BaseModel
+          # @!attribute geofence_id
+          #   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.
+          #
+          #   @return [String, nil]
+          optional :geofence_id, String
+
+          # @!attribute meta_data
+          #   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.
+          #
+          #   @return [Object, nil]
+          optional :meta_data, Nextbillionai::Internal::Type::Unknown
+
+          # @!attribute name
+          #   Specify a custom name for the stop.
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!method initialize(geofence_id: nil, meta_data: nil, name: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Nextbillionai::Models::Skynet::TripStartParams::Stop} for more details.
+          #
+          #   @param geofence_id [String] Specify the ID of the geofence indicating the area where the asset needs to make
+          #
+          #   @param meta_data [Object] An JSON object to collect additional details about the stop. Use this property t
+          #
+          #   @param name [String] Specify a custom name for the stop.
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module Skynet
+      # @see Nextbillionai::Resources::Skynet::Trip#start
+      class TripStartResponse < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Nextbillionai::Models::Skynet::TripStartResponse::Data, nil]
+        optional :data, -> { Nextbillionai::Models::Skynet::TripStartResponse::Data }
+
+        # @!attribute message
+        #   Displays the error message in case of a failed request. If the request is
+        #   successful, this field is not present in the response.
+        #
+        #   @return [String, nil]
+        optional :message, String
+
+        # @!attribute status
+        #   A string indicating the state of the response. On successful responses, the
+        #   value will be Ok. Indicative error messages are returned for different errors.
+        #   See the [API Error Codes](#api-error-codes) section below for more information.
+        #
+        #   @return [String, nil]
+        optional :status, String
+
+        # @!method initialize(data: nil, message: nil, status: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::Skynet::TripStartResponse} for more details.
+        #
+        #   @param data [Nextbillionai::Models::Skynet::TripStartResponse::Data]
+        #
+        #   @param message [String] Displays the error message in case of a failed request. If the request is succes
+        #
+        #   @param status [String] A string indicating the state of the response. On successful responses, the valu
+
+        # @see Nextbillionai::Models::Skynet::TripStartResponse#data
+        class Data < Nextbillionai::Internal::Type::BaseModel
+          # @!attribute id
+          #   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.
+          #
+          #   @return [String, nil]
+          optional :id, String
+
+          # @!method initialize(id: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Nextbillionai::Models::Skynet::TripStartResponse::Data} for more details.
+          #
+          #   @param id [String] Returns the ID of the newly created trip. It will be same as the custom_id if th
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module Skynet
+      class TripStop < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute geofence_id
+        #   Returns the ID of the geofence that was used to indicate the area to make a
+        #   stop.
+        #
+        #   @return [String, nil]
+        optional :geofence_id, String
+
+        # @!attribute meta_data
+        #   Returns any meta data that was added to provide additional information about the
+        #   stop.
+        #
+        #   @return [Object, nil]
+        optional :meta_data, Nextbillionai::Internal::Type::Unknown
+
+        # @!attribute name
+        #   Returns the name of the stop that was provided when configuring this stop for
+        #   the trip.
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!method initialize(geofence_id: nil, meta_data: nil, name: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::Skynet::TripStop} for more details.
+        #
+        #   @param geofence_id [String] Returns the ID of the geofence that was used to indicate the area to make a stop
+        #
+        #   @param meta_data [Object] Returns any meta data that was added to provide additional information about the
+        #
+        #   @param name [String] Returns the name of the stop that was provided when configuring this stop for th
+      end
+    end
+  end
+end

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

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module Skynet
+      # @see Nextbillionai::Resources::Skynet::Trip#update
+      class TripUpdateParams < Nextbillionai::Internal::Type::BaseModel
+        extend Nextbillionai::Internal::Type::RequestParameters::Converter
+        include Nextbillionai::Internal::Type::RequestParameters
+
+        # @!attribute key
+        #   A key is a unique identifier that is required to authenticate a request to the
+        #   API.
+        #
+        #   @return [String]
+        required :key, String
+
+        # @!attribute asset_id
+        #   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.
+        #
+        #   @return [String]
+        required :asset_id, String
+
+        # @!attribute cluster
+        #   the cluster of the region you want to use
+        #
+        #   @return [Symbol, Nextbillionai::Models::Skynet::TripUpdateParams::Cluster, nil]
+        optional :cluster, enum: -> { Nextbillionai::Skynet::TripUpdateParams::Cluster }
+
+        # @!attribute attributes
+        #   Use this field to update the attributes of the trip. Please note that when
+        #   updating the attributes field, previously added information will be overwritten.
+        #
+        #   @return [Object, nil]
+        optional :attributes, Nextbillionai::Internal::Type::Unknown
+
+        # @!attribute description
+        #   Use this parameter to update the custom description of the trip.
+        #
+        #   @return [String, nil]
+        optional :description, String
+
+        # @!attribute meta_data
+        #   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.
+        #
+        #   @return [Object, nil]
+        optional :meta_data, Nextbillionai::Internal::Type::Unknown
+
+        # @!attribute name
+        #   Use this property to update the name of the trip.
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!attribute stops
+        #   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.
+        #
+        #   @return [Array<Nextbillionai::Models::Skynet::TripUpdateParams::Stop>, nil]
+        optional :stops,
+                 -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Skynet::TripUpdateParams::Stop] }
+
+        # @!method initialize(key:, asset_id:, cluster: nil, attributes: nil, description: nil, meta_data: nil, name: nil, stops: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::Skynet::TripUpdateParams} for more details.
+        #
+        #   @param key [String] A key is a unique identifier that is required to authenticate a request to the A
+        #
+        #   @param asset_id [String] Use this param to update the ID of the asset which made this trip. Please be cau
+        #
+        #   @param cluster [Symbol, Nextbillionai::Models::Skynet::TripUpdateParams::Cluster] the cluster of the region you want to use
+        #
+        #   @param attributes [Object] Use this field to update the attributes of the trip. Please note that when updat
+        #
+        #   @param description [String] Use this parameter to update the custom description of the trip.
+        #
+        #   @param meta_data [Object] Use this JSON object to update additional details about the trip. This property
+        #
+        #   @param name [String] Use this property to update the name of the trip.
+        #
+        #   @param stops [Array<Nextbillionai::Models::Skynet::TripUpdateParams::Stop>] Use this object to update the details of the stops made during the trip. Each ob
+        #
+        #   @param request_options [Nextbillionai::RequestOptions, Hash{Symbol=>Object}]
+
+        # the cluster of the region you want to use
+        module Cluster
+          extend Nextbillionai::Internal::Type::Enum
+
+          AMERICA = :america
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        class Stop < Nextbillionai::Internal::Type::BaseModel
+          # @!attribute geofence_id
+          #   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.
+          #
+          #   @return [String, nil]
+          optional :geofence_id, String
+
+          # @!attribute meta_data
+          #   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.
+          #
+          #   @return [Object, nil]
+          optional :meta_data, Nextbillionai::Internal::Type::Unknown
+
+          # @!attribute name
+          #   Use this filed to update the name of the stop.
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!method initialize(geofence_id: nil, meta_data: nil, name: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Nextbillionai::Models::Skynet::TripUpdateParams::Stop} for more details.
+          #
+          #   @param geofence_id [String] Use this parameter to update the ID of the geofence indicating the area where th
+          #
+          #   @param meta_data [Object] Use this JSON object to update additional details about the stop. This property
+          #
+          #   @param name [String] Use this filed to update the name of the stop.
+        end
+      end
+    end
+  end
+end

data/lib/nextbillionai/models/skynet_subscribe_params.rb

@@ -0,0 +1,91 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    # @see Nextbillionai::Resources::Skynet#subscribe
+    class SkynetSubscribeParams < Nextbillionai::Internal::Type::BaseModel
+      extend Nextbillionai::Internal::Type::RequestParameters::Converter
+      include Nextbillionai::Internal::Type::RequestParameters
+
+      # @!attribute action
+      #   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.
+      #
+      #   @return [Symbol, Nextbillionai::Models::SkynetSubscribeParams::Action]
+      required :action, enum: -> { Nextbillionai::SkynetSubscribeParams::Action }
+
+      # @!attribute id
+      #   Specify a custom ID for the subscription. It can be used to reference a given
+      #   subscription in the downstream applications / systems.
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute params
+      #
+      #   @return [Nextbillionai::Models::SkynetSubscribeParams::Params, nil]
+      optional :params, -> { Nextbillionai::SkynetSubscribeParams::Params }
+
+      # @!method initialize(action:, id: nil, params: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Nextbillionai::Models::SkynetSubscribeParams} for more details.
+      #
+      #   @param action [Symbol, Nextbillionai::Models::SkynetSubscribeParams::Action] Specify the behavior that needs to be achieved for the subscription. Following v
+      #
+      #   @param id [String] Specify a custom ID for the subscription. It can be used to reference a given su
+      #
+      #   @param params [Nextbillionai::Models::SkynetSubscribeParams::Params]
+      #
+      #   @param request_options [Nextbillionai::RequestOptions, Hash{Symbol=>Object}]
+
+      # 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
+
+        TRIP_SUBSCRIBE = :TRIP_SUBSCRIBE
+        TRIP_UNSUBSCRIBE = :TRIP_UNSUBSCRIBE
+        HEARTBEAT = :HEARTBEAT
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      class Params < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute id
+        #   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"
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:)
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::SkynetSubscribeParams::Params} for more details.
+        #
+        #   @param id [String] Specify the ID of an active trip that needs to be subscribed. The ID of a trip i
+      end
+    end
+  end
+end

data/lib/nextbillionai/models/skynet_subscribe_response.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    # @see Nextbillionai::Resources::Skynet#subscribe
+    class SkynetSubscribeResponse < Nextbillionai::Internal::Type::BaseModel
+      # @!attribute id
+      #   Subscription ID as provided in the input action message.
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute error
+      #   Returns the error message when status: error. Otherwise, response doesn't
+      #   contain this field.
+      #
+      #   @return [String, nil]
+      optional :error, String
+
+      # @!attribute status
+      #   Status of the action. It can have only two values - "success" or "error".
+      #
+      #   @return [String, nil]
+      optional :status, String
+
+      # @!attribute timestamp
+      #   Returns the UNIX timestamp, in milliseconds format, when the web-socket returns
+      #   the action response.
+      #
+      #   @return [Integer, nil]
+      optional :timestamp, Integer
+
+      # @!method initialize(id: nil, error: nil, status: nil, timestamp: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Nextbillionai::Models::SkynetSubscribeResponse} for more details.
+      #
+      #   @param id [String] Subscription ID as provided in the input action message.
+      #
+      #   @param error [String] Returns the error message when status: error. Otherwise, response doesn't contai
+      #
+      #   @param status [String] Status of the action. It can have only two values - "success" or "error".
+      #
+      #   @param timestamp [Integer] Returns the UNIX timestamp, in milliseconds format, when the web-socket returns
+    end
+  end
+end