nextbillionai 0.1.0.pre.alpha.4

data/lib/nextbillionai/models/optimization/vehicle.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module Optimization
+      class Vehicle < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute id
+        #   Specify a unique ID for the vehicle.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute location
+        #   Specify the location coordinates where the vehicle is currently located. This
+        #   input is mandatory for each vehicle.
+        #
+        #   @return [Nextbillionai::Models::Optimization::Vehicle::Location]
+        required :location, -> { Nextbillionai::Optimization::Vehicle::Location }
+
+        # @!attribute attributes
+        #   Specify custom attributes for the vehicle. Each attribute should be created as a
+        #   key:value pair. These attributes can be used in the orders.vehicle_preferences
+        #   input to refine the search of vehicles for each order.
+        #
+        #   The maximum number of key:value pairs that can be specified under attributes for
+        #   a given vehicle, is limited to 30.
+        #
+        #   @return [Object, nil]
+        optional :attributes, Nextbillionai::Internal::Type::Unknown
+
+        # @!attribute priority
+        #   Specify the priority for this vehicle. A higher value indicates a higher
+        #   priority. When specified, it will override any priority score deduced from
+        #   vehicle_attribute_priority_mappings for this vehicle. Valid values are \[1, 10\]
+        #   and default is 0.
+        #
+        #   @return [Integer, nil]
+        optional :priority, Integer
+
+        # @!attribute remaining_waypoints
+        #   An array of objects to collect the location coordinates of the stops remaining
+        #   on an ongoing trip of the vehicle. The service can assign new orders to the
+        #   vehicle if they are cost-effective. Once a new order is assigned, the vehicle
+        #   must complete all the steps in the ongoing trip before proceeding to pickup the
+        #   newly assigned order.
+        #
+        #   Please note that a maximum of 10 waypoints can be specified for a given vehicle.
+        #
+        #   @return [Array<Nextbillionai::Models::Optimization::Location>, nil]
+        optional :remaining_waypoints,
+                 -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Optimization::Location] }
+
+        # @!method initialize(id:, location:, attributes: nil, priority: nil, remaining_waypoints: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::Optimization::Vehicle} for more details.
+        #
+        #   @param id [String] Specify a unique ID for the vehicle.
+        #
+        #   @param location [Nextbillionai::Models::Optimization::Vehicle::Location] Specify the location coordinates where the vehicle is currently located. This in
+        #
+        #   @param attributes [Object] Specify custom attributes for the vehicle. Each attribute should be created as a
+        #
+        #   @param priority [Integer] Specify the priority for this vehicle. A higher value indicates a higher priorit
+        #
+        #   @param remaining_waypoints [Array<Nextbillionai::Models::Optimization::Location>] An array of objects to collect the location coordinates of the stops remaining o
+
+        # @see Nextbillionai::Models::Optimization::Vehicle#location
+        class Location < Nextbillionai::Internal::Type::BaseModel
+          # @!attribute lat
+          #   Latitude of the vehicle's current location.
+          #
+          #   @return [Float, nil]
+          optional :lat, Float
+
+          # @!attribute lng
+          #   Longitude of the vehicle's current location.
+          #
+          #   @return [Float, nil]
+          optional :lng, Float
+
+          # @!method initialize(lat: nil, lng: nil)
+          #   Specify the location coordinates where the vehicle is currently located. This
+          #   input is mandatory for each vehicle.
+          #
+          #   @param lat [Float] Latitude of the vehicle's current location.
+          #
+          #   @param lng [Float] Longitude of the vehicle's current location.
+        end
+      end
+    end
+  end
+end

data/lib/nextbillionai/models/optimization_compute_params.rb

@@ -0,0 +1,212 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    # @see Nextbillionai::Resources::Optimization#compute
+    class OptimizationComputeParams < Nextbillionai::Internal::Type::BaseModel
+      extend Nextbillionai::Internal::Type::RequestParameters::Converter
+      include Nextbillionai::Internal::Type::RequestParameters
+
+      # @!attribute coordinates
+      #   This is a pipe-separated list of coordinates.
+      #
+      #   Minimum 3 pairs of coordinates and Maximum 12 pairs of coordinates are allowed.
+      #
+      #   @return [String]
+      required :coordinates, String
+
+      # @!attribute key
+      #   A key is a unique identifier that is required to authenticate a request to the
+      #   API.
+      #
+      #   @return [String]
+      required :key, String
+
+      # @!attribute approaches
+      #   A semicolon-separated list indicating the side of the road from which to
+      #   approach waypoints in a requested route. If provided, the number of approaches
+      #   must be the same as the number of coordinates. However, you can skip a
+      #   coordinate and show its position in the list with the ; separator.
+      #
+      #   @return [Symbol, Nextbillionai::Models::OptimizationComputeParams::Approaches, nil]
+      optional :approaches, enum: -> { Nextbillionai::OptimizationComputeParams::Approaches }
+
+      # @!attribute destination
+      #   Specify the destination coordinate of the returned route. If the input is last,
+      #   the last coordinate will be the destination.
+      #
+      #   @return [Symbol, Nextbillionai::Models::OptimizationComputeParams::Destination, nil]
+      optional :destination, enum: -> { Nextbillionai::OptimizationComputeParams::Destination }
+
+      # @!attribute geometries
+      #   Sets the output format of the route geometry in the response.
+      #
+      #   On providing polyline and polyline6 as input, respective encoded geometry is
+      #   returned. However, when geojson is provided as the input value, polyline encoded
+      #   geometry is returned in the response along with a geojson details of the route.
+      #
+      #   @return [Symbol, Nextbillionai::Models::OptimizationComputeParams::Geometries, nil]
+      optional :geometries, enum: -> { Nextbillionai::OptimizationComputeParams::Geometries }
+
+      # @!attribute mode
+      #   Set which driving mode the service should use to determine a route. For example,
+      #   if you use "car", the API will return a route that a car can take. Using "truck"
+      #   will return a route a truck can use, taking into account appropriate truck
+      #   routing restrictions.
+      #
+      #   When "mode=truck", following are the default dimensions that are used:
+      #
+      #   \- truck_height = 214 centimeters
+      #
+      #   \- truck_width = 183 centimeters
+      #
+      #   \- truck_length = 519 centimeters
+      #
+      #   \- truck_weight = 5000 kg
+      #
+      #   Please use the Directions Flexible version if you want to use custom truck
+      #   dimensions.
+      #
+      #   Note: Only the "car" profile is enabled by default. Please note that customized
+      #   profiles (including "truck") might not be available for all regions. Please
+      #   contact your [NextBillion.ai](http://NextBillion.ai) account manager, sales
+      #   representative or reach out at
+      #   [support@nextbillion.ai](mailto:support@nextbillion.ai) in case you need
+      #   additional profiles.
+      #
+      #   @return [Symbol, Nextbillionai::Models::OptimizationComputeParams::Mode, nil]
+      optional :mode, enum: -> { Nextbillionai::OptimizationComputeParams::Mode }
+
+      # @!attribute roundtrip
+      #   Indicates whether the returned route is a roundtrip.
+      #
+      #   @return [Boolean, nil]
+      optional :roundtrip, Nextbillionai::Internal::Type::Boolean
+
+      # @!attribute source
+      #   The coordinate at which to start the returned route. If this is not configured,
+      #   the return route’s destination will be the first coordinate.
+      #
+      #   @return [Symbol, Nextbillionai::Models::OptimizationComputeParams::Source, nil]
+      optional :source, enum: -> { Nextbillionai::OptimizationComputeParams::Source }
+
+      # @!attribute with_geometry
+      #   Indicates whether the return geometry should be computed or not.
+      #
+      #   @return [Boolean, nil]
+      optional :with_geometry, Nextbillionai::Internal::Type::Boolean
+
+      # @!method initialize(coordinates:, key:, approaches: nil, destination: nil, geometries: nil, mode: nil, roundtrip: nil, source: nil, with_geometry: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Nextbillionai::Models::OptimizationComputeParams} for more details.
+      #
+      #   @param coordinates [String] This is a pipe-separated list of coordinates.
+      #
+      #   @param key [String] A key is a unique identifier that is required to authenticate a request to the A
+      #
+      #   @param approaches [Symbol, Nextbillionai::Models::OptimizationComputeParams::Approaches] A semicolon-separated list indicating the side of the road from which to approac
+      #
+      #   @param destination [Symbol, Nextbillionai::Models::OptimizationComputeParams::Destination] Specify the destination coordinate of the returned route. If the input is last,
+      #
+      #   @param geometries [Symbol, Nextbillionai::Models::OptimizationComputeParams::Geometries] Sets the output format of the route geometry in the response.
+      #
+      #   @param mode [Symbol, Nextbillionai::Models::OptimizationComputeParams::Mode] Set which driving mode the service should use to determine a route. For example,
+      #
+      #   @param roundtrip [Boolean] Indicates whether the returned route is a roundtrip.
+      #
+      #   @param source [Symbol, Nextbillionai::Models::OptimizationComputeParams::Source] The coordinate at which to start the returned route. If this is not configured,
+      #
+      #   @param with_geometry [Boolean] Indicates whether the return geometry should be computed or not.
+      #
+      #   @param request_options [Nextbillionai::RequestOptions, Hash{Symbol=>Object}]
+
+      # A semicolon-separated list indicating the side of the road from which to
+      # approach waypoints in a requested route. If provided, the number of approaches
+      # must be the same as the number of coordinates. However, you can skip a
+      # coordinate and show its position in the list with the ; separator.
+      module Approaches
+        extend Nextbillionai::Internal::Type::Enum
+
+        UNRESTRICTED = :unrestricted
+        CURB = :curb
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Specify the destination coordinate of the returned route. If the input is last,
+      # the last coordinate will be the destination.
+      module Destination
+        extend Nextbillionai::Internal::Type::Enum
+
+        ANY = :any
+        LAST = :last
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Sets the output format of the route geometry in the response.
+      #
+      # On providing polyline and polyline6 as input, respective encoded geometry is
+      # returned. However, when geojson is provided as the input value, polyline encoded
+      # geometry is returned in the response along with a geojson details of the route.
+      module Geometries
+        extend Nextbillionai::Internal::Type::Enum
+
+        POLYLINE = :polyline
+        POLYLINE6 = :polyline6
+        GEOJSON = :geojson
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Set which driving mode the service should use to determine a route. For example,
+      # if you use "car", the API will return a route that a car can take. Using "truck"
+      # will return a route a truck can use, taking into account appropriate truck
+      # routing restrictions.
+      #
+      # When "mode=truck", following are the default dimensions that are used:
+      #
+      # \- truck_height = 214 centimeters
+      #
+      # \- truck_width = 183 centimeters
+      #
+      # \- truck_length = 519 centimeters
+      #
+      # \- truck_weight = 5000 kg
+      #
+      # Please use the Directions Flexible version if you want to use custom truck
+      # dimensions.
+      #
+      # Note: Only the "car" profile is enabled by default. Please note that customized
+      # profiles (including "truck") might not be available for all regions. Please
+      # contact your [NextBillion.ai](http://NextBillion.ai) account manager, sales
+      # representative or reach out at
+      # [support@nextbillion.ai](mailto:support@nextbillion.ai) in case you need
+      # additional profiles.
+      module Mode
+        extend Nextbillionai::Internal::Type::Enum
+
+        CAR = :car
+        TRUCK = :truck
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # The coordinate at which to start the returned route. If this is not configured,
+      # the return route’s destination will be the first coordinate.
+      module Source
+        extend Nextbillionai::Internal::Type::Enum
+
+        ANY = :any
+        FIRST = :first
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/nextbillionai/models/optimization_compute_response.rb

@@ -0,0 +1,347 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    # @see Nextbillionai::Resources::Optimization#compute
+    class OptimizationComputeResponse < Nextbillionai::Internal::Type::BaseModel
+      # @!attribute code
+      #   A string indicating the state of the response. This is a separate code than the
+      #   HTTP status code. On normal valid responses, the value will be Ok.
+      #
+      #   @return [String, nil]
+      optional :code, String
+
+      # @!attribute location
+      #   Contains the latitude and longitude of a location
+      #
+      #   @return [Nextbillionai::Models::OptimizationComputeResponse::Location, nil]
+      optional :location, -> { Nextbillionai::Models::OptimizationComputeResponse::Location }
+
+      # @!attribute trips
+      #   An array of 0 or 1 trip objects. Each object has the following schema.
+      #
+      #   @return [Array<Nextbillionai::Models::OptimizationComputeResponse::Trip>, nil]
+      optional :trips,
+               -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Models::OptimizationComputeResponse::Trip] }
+
+      # @!attribute waypoints
+      #   Each waypoint is an input coordinate snapped to the road and path network.
+      #
+      #   @return [Array<Nextbillionai::Models::OptimizationComputeResponse::Waypoint>, nil]
+      optional :waypoints,
+               -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Models::OptimizationComputeResponse::Waypoint] }
+
+      # @!method initialize(code: nil, location: nil, trips: nil, waypoints: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Nextbillionai::Models::OptimizationComputeResponse} for more details.
+      #
+      #   @param code [String] A string indicating the state of the response. This is a separate code than the
+      #
+      #   @param location [Nextbillionai::Models::OptimizationComputeResponse::Location] Contains the latitude and longitude of a location
+      #
+      #   @param trips [Array<Nextbillionai::Models::OptimizationComputeResponse::Trip>] An array of 0 or 1 trip objects. Each object has the following schema.
+      #
+      #   @param waypoints [Array<Nextbillionai::Models::OptimizationComputeResponse::Waypoint>] Each waypoint is an input coordinate snapped to the road and path network.
+
+      # @see Nextbillionai::Models::OptimizationComputeResponse#location
+      class Location < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute latitude
+        #   Latitude coordinate of the location.
+        #
+        #   @return [Float, nil]
+        optional :latitude, Float
+
+        # @!attribute longitude
+        #   Longitude coordinate of the location.
+        #
+        #   @return [Float, nil]
+        optional :longitude, Float
+
+        # @!method initialize(latitude: nil, longitude: nil)
+        #   Contains the latitude and longitude of a location
+        #
+        #   @param latitude [Float] Latitude coordinate of the location.
+        #
+        #   @param longitude [Float] Longitude coordinate of the location.
+      end
+
+      class Trip < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute distance
+        #   Distance of the trip in meters.
+        #
+        #   @return [Float, nil]
+        optional :distance, Float
+
+        # @!attribute duration
+        #   Duration of the trip in seconds
+        #
+        #   @return [Float, nil]
+        optional :duration, Float
+
+        # @!attribute geojson
+        #   The GeoJSON representation of the route.
+        #
+        #   @return [Nextbillionai::Models::OptimizationComputeResponse::Trip::Geojson, nil]
+        optional :geojson, -> { Nextbillionai::Models::OptimizationComputeResponse::Trip::Geojson }
+
+        # @!attribute geometry
+        #   polyline or polyline6 format of route geometry.
+        #
+        #   @return [String, nil]
+        optional :geometry, String
+
+        # @!attribute legs
+        #
+        #   @return [Array<Nextbillionai::Models::OptimizationComputeResponse::Trip::Leg>, nil]
+        optional :legs,
+                 -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Models::OptimizationComputeResponse::Trip::Leg] }
+
+        # @!method initialize(distance: nil, duration: nil, geojson: nil, geometry: nil, legs: nil)
+        #   @param distance [Float] Distance of the trip in meters.
+        #
+        #   @param duration [Float] Duration of the trip in seconds
+        #
+        #   @param geojson [Nextbillionai::Models::OptimizationComputeResponse::Trip::Geojson] The GeoJSON representation of the route.
+        #
+        #   @param geometry [String] polyline or polyline6 format of route geometry.
+        #
+        #   @param legs [Array<Nextbillionai::Models::OptimizationComputeResponse::Trip::Leg>]
+
+        # @see Nextbillionai::Models::OptimizationComputeResponse::Trip#geojson
+        class Geojson < Nextbillionai::Internal::Type::BaseModel
+          # @!attribute geometry
+          #   The encoded geometry of the geojson in the trip.
+          #
+          #   @return [String, nil]
+          optional :geometry, String
+
+          # @!attribute properties
+          #   Additional properties associated with the trip.
+          #
+          #   @return [String, nil]
+          optional :properties, String
+
+          # @!attribute type
+          #   The type of the GeoJSON object.
+          #
+          #   @return [Symbol, Nextbillionai::Models::OptimizationComputeResponse::Trip::Geojson::Type, nil]
+          optional :type, enum: -> { Nextbillionai::Models::OptimizationComputeResponse::Trip::Geojson::Type }
+
+          # @!method initialize(geometry: nil, properties: nil, type: nil)
+          #   The GeoJSON representation of the route.
+          #
+          #   @param geometry [String] The encoded geometry of the geojson in the trip.
+          #
+          #   @param properties [String] Additional properties associated with the trip.
+          #
+          #   @param type [Symbol, Nextbillionai::Models::OptimizationComputeResponse::Trip::Geojson::Type] The type of the GeoJSON object.
+
+          # The type of the GeoJSON object.
+          #
+          # @see Nextbillionai::Models::OptimizationComputeResponse::Trip::Geojson#type
+          module Type
+            extend Nextbillionai::Internal::Type::Enum
+
+            POINT = :Point
+            MULTI_POINT = :MultiPoint
+            LINE_STRING = :LineString
+            MULTI_LINE_STRING = :MultiLineString
+            POLYGON = :Polygon
+            MULTI_POLYGON = :MultiPolygon
+            GEOMETRY_COLLECTION = :GeometryCollection
+            FEATURE = :Feature
+            FEATURE_COLLECTION = :FeatureCollection
+            LINK = :Link
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+
+        class Leg < Nextbillionai::Internal::Type::BaseModel
+          # @!attribute distance
+          #   Distance of leg in metres.
+          #
+          #   @return [Float, nil]
+          optional :distance, Float
+
+          # @!attribute duration
+          #   Duration of leg in seconds.
+          #
+          #   @return [Float, nil]
+          optional :duration, Float
+
+          # @!attribute steps
+          #   An array of step objects.
+          #
+          #   @return [Array<Nextbillionai::Models::OptimizationComputeResponse::Trip::Leg::Step>, nil]
+          optional :steps,
+                   -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Models::OptimizationComputeResponse::Trip::Leg::Step] }
+
+          # @!attribute summary
+          #   Summary of the leg object.
+          #
+          #   @return [String, nil]
+          optional :summary, String
+
+          # @!method initialize(distance: nil, duration: nil, steps: nil, summary: nil)
+          #   @param distance [Float] Distance of leg in metres.
+          #
+          #   @param duration [Float] Duration of leg in seconds.
+          #
+          #   @param steps [Array<Nextbillionai::Models::OptimizationComputeResponse::Trip::Leg::Step>] An array of step objects.
+          #
+          #   @param summary [String] Summary of the leg object.
+
+          class Step < Nextbillionai::Internal::Type::BaseModel
+            # @!attribute distance
+            #   Distance of the step object in meters.
+            #
+            #   @return [Float, nil]
+            optional :distance, Float
+
+            # @!attribute duration
+            #   Duration of the step object in seconds.
+            #
+            #   @return [Float, nil]
+            optional :duration, Float
+
+            # @!attribute geojson
+            #   The GeoJSON representation of the step.
+            #
+            #   @return [Nextbillionai::Models::OptimizationComputeResponse::Trip::Leg::Step::Geojson, nil]
+            optional :geojson, -> { Nextbillionai::Models::OptimizationComputeResponse::Trip::Leg::Step::Geojson }
+
+            # @!attribute geometry
+            #   Encoded geometry of the step in the selected format.
+            #
+            #   @return [String, nil]
+            optional :geometry, String
+
+            # @!method initialize(distance: nil, duration: nil, geojson: nil, geometry: nil)
+            #   @param distance [Float] Distance of the step object in meters.
+            #
+            #   @param duration [Float] Duration of the step object in seconds.
+            #
+            #   @param geojson [Nextbillionai::Models::OptimizationComputeResponse::Trip::Leg::Step::Geojson] The GeoJSON representation of the step.
+            #
+            #   @param geometry [String] Encoded geometry of the step in the selected format.
+
+            # @see Nextbillionai::Models::OptimizationComputeResponse::Trip::Leg::Step#geojson
+            class Geojson < Nextbillionai::Internal::Type::BaseModel
+              # @!attribute geometry
+              #   The encoded geometry of the geojson in the step.
+              #
+              #   @return [String, nil]
+              optional :geometry, String
+
+              # @!attribute properties
+              #   Additional properties associated with the step.
+              #
+              #   @return [String, nil]
+              optional :properties, String
+
+              # @!attribute type
+              #   The type of the GeoJSON object.
+              #
+              #   @return [Symbol, Nextbillionai::Models::OptimizationComputeResponse::Trip::Leg::Step::Geojson::Type, nil]
+              optional :type,
+                       enum: -> { Nextbillionai::Models::OptimizationComputeResponse::Trip::Leg::Step::Geojson::Type }
+
+              # @!method initialize(geometry: nil, properties: nil, type: nil)
+              #   The GeoJSON representation of the step.
+              #
+              #   @param geometry [String] The encoded geometry of the geojson in the step.
+              #
+              #   @param properties [String] Additional properties associated with the step.
+              #
+              #   @param type [Symbol, Nextbillionai::Models::OptimizationComputeResponse::Trip::Leg::Step::Geojson::Type] The type of the GeoJSON object.
+
+              # The type of the GeoJSON object.
+              #
+              # @see Nextbillionai::Models::OptimizationComputeResponse::Trip::Leg::Step::Geojson#type
+              module Type
+                extend Nextbillionai::Internal::Type::Enum
+
+                POINT = :Point
+                MULTI_POINT = :MultiPoint
+                LINE_STRING = :LineString
+                MULTI_LINE_STRING = :MultiLineString
+                POLYGON = :Polygon
+                MULTI_POLYGON = :MultiPolygon
+                GEOMETRY_COLLECTION = :GeometryCollection
+                FEATURE = :Feature
+                FEATURE_COLLECTION = :FeatureCollection
+                LINK = :Link
+
+                # @!method self.values
+                #   @return [Array<Symbol>]
+              end
+            end
+          end
+        end
+      end
+
+      class Waypoint < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute location
+        #   Describes the location of the waypoint.
+        #
+        #   @return [Nextbillionai::Models::OptimizationComputeResponse::Waypoint::Location, nil]
+        optional :location, -> { Nextbillionai::Models::OptimizationComputeResponse::Waypoint::Location }
+
+        # @!attribute name
+        #   Name of the waypoint.
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!attribute trips_index
+        #   Denotes the ID of a trip. Starts with 0.
+        #
+        #   @return [Integer, nil]
+        optional :trips_index, Integer
+
+        # @!attribute waypoint_index
+        #   Denotes the id of a waypoint. The first waypoint is denoted with 0. And onwards
+        #   with 1, 2 etc.
+        #
+        #   @return [Integer, nil]
+        optional :waypoint_index, Integer
+
+        # @!method initialize(location: nil, name: nil, trips_index: nil, waypoint_index: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::OptimizationComputeResponse::Waypoint} for more details.
+        #
+        #   @param location [Nextbillionai::Models::OptimizationComputeResponse::Waypoint::Location] Describes the location of the waypoint.
+        #
+        #   @param name [String] Name of the waypoint.
+        #
+        #   @param trips_index [Integer] Denotes the ID of a trip. Starts with 0.
+        #
+        #   @param waypoint_index [Integer] Denotes the id of a waypoint. The first waypoint is denoted with 0. And onwards
+
+        # @see Nextbillionai::Models::OptimizationComputeResponse::Waypoint#location
+        class Location < Nextbillionai::Internal::Type::BaseModel
+          # @!attribute latitude
+          #   Latitude coordinate of the waypoint.
+          #
+          #   @return [Float, nil]
+          optional :latitude, Float
+
+          # @!attribute longitude
+          #   Longitude coordinate of the waypoint.
+          #
+          #   @return [Float, nil]
+          optional :longitude, Float
+
+          # @!method initialize(latitude: nil, longitude: nil)
+          #   Describes the location of the waypoint.
+          #
+          #   @param latitude [Float] Latitude coordinate of the waypoint.
+          #
+          #   @param longitude [Float] Longitude coordinate of the waypoint.
+        end
+      end
+    end
+  end
+end