nextbillionai 0.1.0.pre.alpha.4

data/rbi/nextbillionai/models/optimization_re_optimize_params.rbi

@@ -0,0 +1,439 @@
+# typed: strong
+
+module Nextbillionai
+  module Models
+    class OptimizationReOptimizeParams < Nextbillionai::Internal::Type::BaseModel
+      extend Nextbillionai::Internal::Type::RequestParameters::Converter
+      include Nextbillionai::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Nextbillionai::OptimizationReOptimizeParams,
+            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 unique request ID that needs to be re-optimized.
+      sig { returns(String) }
+      attr_accessor :existing_request_id
+
+      # This section gathers information on modifications to the number of jobs or their
+      # individual requirements for re-optimization. Any job from the original solution
+      # not specified here will be re-planned without alteration during the
+      # re-optimization process.
+      sig do
+        returns(
+          T.nilable(Nextbillionai::OptimizationReOptimizeParams::JobChanges)
+        )
+      end
+      attr_reader :job_changes
+
+      sig do
+        params(
+          job_changes:
+            Nextbillionai::OptimizationReOptimizeParams::JobChanges::OrHash
+        ).void
+      end
+      attr_writer :job_changes
+
+      # Provide the list of locations to be used during re-optimization process. Please
+      # note that
+      #
+      # - Providing the location input overwrites the list of locations used in the
+      #   original request.
+      # - The location_indexes associated with all tasks and vehicles (both from the
+      #   original and new re-optimization input requests) will follow the updated list
+      #   of locations.
+      #
+      # As a best practice:
+      #
+      # 1.  Don't provide the locations input when re-optimizing, if the original set
+      #     contains all the required location coordinates.
+      # 2.  If any new location coordinates are required for re-optimization, copy the
+      #     full, original location list and update it in the following manner before
+      #     adding it to the re-optimization input:
+      #
+      #     1.  Ensure to not update the indexes of locations which just need to be
+      #         "modified".
+      #     2.  Add new location coordinates towards the end of the list.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :locations
+
+      sig { params(locations: T::Array[String]).void }
+      attr_writer :locations
+
+      # This section gathers information on modifications to the number of shipments or
+      # their individual requirements for re-optimization. Any shipment from the
+      # original solution not specified here will be re-planned without alteration
+      # during the re-optimization process.
+      sig do
+        returns(
+          T.nilable(
+            Nextbillionai::OptimizationReOptimizeParams::ShipmentChanges
+          )
+        )
+      end
+      attr_reader :shipment_changes
+
+      sig do
+        params(
+          shipment_changes:
+            Nextbillionai::OptimizationReOptimizeParams::ShipmentChanges::OrHash
+        ).void
+      end
+      attr_writer :shipment_changes
+
+      # This section gathers information on modifications to the number of vehicles or
+      # individual vehicle configurations for re-optimizing an existing solution. Any
+      # vehicle from the original solution not specified here will be reused without
+      # alteration during the re-optimization process.
+      sig do
+        returns(
+          T.nilable(Nextbillionai::OptimizationReOptimizeParams::VehicleChanges)
+        )
+      end
+      attr_reader :vehicle_changes
+
+      sig do
+        params(
+          vehicle_changes:
+            Nextbillionai::OptimizationReOptimizeParams::VehicleChanges::OrHash
+        ).void
+      end
+      attr_writer :vehicle_changes
+
+      sig do
+        params(
+          key: String,
+          existing_request_id: String,
+          job_changes:
+            Nextbillionai::OptimizationReOptimizeParams::JobChanges::OrHash,
+          locations: T::Array[String],
+          shipment_changes:
+            Nextbillionai::OptimizationReOptimizeParams::ShipmentChanges::OrHash,
+          vehicle_changes:
+            Nextbillionai::OptimizationReOptimizeParams::VehicleChanges::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 unique request ID that needs to be re-optimized.
+        existing_request_id:,
+        # This section gathers information on modifications to the number of jobs or their
+        # individual requirements for re-optimization. Any job from the original solution
+        # not specified here will be re-planned without alteration during the
+        # re-optimization process.
+        job_changes: nil,
+        # Provide the list of locations to be used during re-optimization process. Please
+        # note that
+        #
+        # - Providing the location input overwrites the list of locations used in the
+        #   original request.
+        # - The location_indexes associated with all tasks and vehicles (both from the
+        #   original and new re-optimization input requests) will follow the updated list
+        #   of locations.
+        #
+        # As a best practice:
+        #
+        # 1.  Don't provide the locations input when re-optimizing, if the original set
+        #     contains all the required location coordinates.
+        # 2.  If any new location coordinates are required for re-optimization, copy the
+        #     full, original location list and update it in the following manner before
+        #     adding it to the re-optimization input:
+        #
+        #     1.  Ensure to not update the indexes of locations which just need to be
+        #         "modified".
+        #     2.  Add new location coordinates towards the end of the list.
+        locations: nil,
+        # This section gathers information on modifications to the number of shipments or
+        # their individual requirements for re-optimization. Any shipment from the
+        # original solution not specified here will be re-planned without alteration
+        # during the re-optimization process.
+        shipment_changes: nil,
+        # This section gathers information on modifications to the number of vehicles or
+        # individual vehicle configurations for re-optimizing an existing solution. Any
+        # vehicle from the original solution not specified here will be reused without
+        # alteration during the re-optimization process.
+        vehicle_changes: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            key: String,
+            existing_request_id: String,
+            job_changes:
+              Nextbillionai::OptimizationReOptimizeParams::JobChanges,
+            locations: T::Array[String],
+            shipment_changes:
+              Nextbillionai::OptimizationReOptimizeParams::ShipmentChanges,
+            vehicle_changes:
+              Nextbillionai::OptimizationReOptimizeParams::VehicleChanges,
+            request_options: Nextbillionai::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class JobChanges < Nextbillionai::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Nextbillionai::OptimizationReOptimizeParams::JobChanges,
+              Nextbillionai::Internal::AnyHash
+            )
+          end
+
+        # An array of objects to collect the details of the new jobs to be added during
+        # re-optimization. Each object represents one job. Please make sure the IDs
+        # provided for new jobs are unique with respect to the IDs of the jobs in the
+        # original request.
+        sig { returns(T.nilable(T::Array[Nextbillionai::Optimization::Job])) }
+        attr_reader :add
+
+        sig do
+          params(add: T::Array[Nextbillionai::Optimization::Job::OrHash]).void
+        end
+        attr_writer :add
+
+        # An array of objects to collect the modified details of existing jobs used in the
+        # original request. Each object represents one job. Please make sure all the job
+        # IDs provided here are same as the ones in the original request.
+        sig { returns(T.nilable(T::Array[Nextbillionai::Optimization::Job])) }
+        attr_reader :modify
+
+        sig do
+          params(
+            modify: T::Array[Nextbillionai::Optimization::Job::OrHash]
+          ).void
+        end
+        attr_writer :modify
+
+        # An array of job IDs to be removed when during re-optimization. All job IDs
+        # provided must have been part of the original request.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :remove
+
+        sig { params(remove: T::Array[String]).void }
+        attr_writer :remove
+
+        # This section gathers information on modifications to the number of jobs or their
+        # individual requirements for re-optimization. Any job from the original solution
+        # not specified here will be re-planned without alteration during the
+        # re-optimization process.
+        sig do
+          params(
+            add: T::Array[Nextbillionai::Optimization::Job::OrHash],
+            modify: T::Array[Nextbillionai::Optimization::Job::OrHash],
+            remove: T::Array[String]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # An array of objects to collect the details of the new jobs to be added during
+          # re-optimization. Each object represents one job. Please make sure the IDs
+          # provided for new jobs are unique with respect to the IDs of the jobs in the
+          # original request.
+          add: nil,
+          # An array of objects to collect the modified details of existing jobs used in the
+          # original request. Each object represents one job. Please make sure all the job
+          # IDs provided here are same as the ones in the original request.
+          modify: nil,
+          # An array of job IDs to be removed when during re-optimization. All job IDs
+          # provided must have been part of the original request.
+          remove: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              add: T::Array[Nextbillionai::Optimization::Job],
+              modify: T::Array[Nextbillionai::Optimization::Job],
+              remove: T::Array[String]
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class ShipmentChanges < Nextbillionai::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Nextbillionai::OptimizationReOptimizeParams::ShipmentChanges,
+              Nextbillionai::Internal::AnyHash
+            )
+          end
+
+        # An array of objects to collect the details of the new shipments to be added
+        # during re-optimization. Each object represents one shipment. Please make sure
+        # the IDs provided for new shipments are unique with respect to the IDs of the
+        # shipments in the original request.
+        sig do
+          returns(T.nilable(T::Array[Nextbillionai::Optimization::Shipment]))
+        end
+        attr_reader :add
+
+        sig do
+          params(
+            add: T::Array[Nextbillionai::Optimization::Shipment::OrHash]
+          ).void
+        end
+        attr_writer :add
+
+        # An array of objects to collect the modified details of existing shipments used
+        # in the original request. Each object represents one shipment. Please make sure
+        # all the shipment IDs provided here are same as the ones in the original request.
+        sig do
+          returns(T.nilable(T::Array[Nextbillionai::Optimization::Shipment]))
+        end
+        attr_reader :modify
+
+        sig do
+          params(
+            modify: T::Array[Nextbillionai::Optimization::Shipment::OrHash]
+          ).void
+        end
+        attr_writer :modify
+
+        # An array of shipment IDs to be removed when during re-optimization. All shipment
+        # IDs provided must have been part of the original request.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :remove
+
+        sig { params(remove: T::Array[String]).void }
+        attr_writer :remove
+
+        # This section gathers information on modifications to the number of shipments or
+        # their individual requirements for re-optimization. Any shipment from the
+        # original solution not specified here will be re-planned without alteration
+        # during the re-optimization process.
+        sig do
+          params(
+            add: T::Array[Nextbillionai::Optimization::Shipment::OrHash],
+            modify: T::Array[Nextbillionai::Optimization::Shipment::OrHash],
+            remove: T::Array[String]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # An array of objects to collect the details of the new shipments to be added
+          # during re-optimization. Each object represents one shipment. Please make sure
+          # the IDs provided for new shipments are unique with respect to the IDs of the
+          # shipments in the original request.
+          add: nil,
+          # An array of objects to collect the modified details of existing shipments used
+          # in the original request. Each object represents one shipment. Please make sure
+          # all the shipment IDs provided here are same as the ones in the original request.
+          modify: nil,
+          # An array of shipment IDs to be removed when during re-optimization. All shipment
+          # IDs provided must have been part of the original request.
+          remove: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              add: T::Array[Nextbillionai::Optimization::Shipment],
+              modify: T::Array[Nextbillionai::Optimization::Shipment],
+              remove: T::Array[String]
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class VehicleChanges < Nextbillionai::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Nextbillionai::OptimizationReOptimizeParams::VehicleChanges,
+              Nextbillionai::Internal::AnyHash
+            )
+          end
+
+        # An array of objects to collect the details of the new vehicles to be added for
+        # re-optimization. Each object represents one vehicle. Please make sure the IDs
+        # provided for new vehicles are unique with respect to the IDs of the vehicles in
+        # the original request.
+        sig do
+          returns(T.nilable(T::Array[Nextbillionai::Optimization::Vehicle]))
+        end
+        attr_reader :add
+
+        sig do
+          params(
+            add: T::Array[Nextbillionai::Optimization::Vehicle::OrHash]
+          ).void
+        end
+        attr_writer :add
+
+        sig { returns(T.nilable(Nextbillionai::Optimization::Vehicle)) }
+        attr_reader :modify
+
+        sig do
+          params(modify: Nextbillionai::Optimization::Vehicle::OrHash).void
+        end
+        attr_writer :modify
+
+        # An array of vehicle IDs to be removed when during re-optimization. All vehicle
+        # IDs provided must have been part of the original request.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :remove
+
+        sig { params(remove: T::Array[String]).void }
+        attr_writer :remove
+
+        # This section gathers information on modifications to the number of vehicles or
+        # individual vehicle configurations for re-optimizing an existing solution. Any
+        # vehicle from the original solution not specified here will be reused without
+        # alteration during the re-optimization process.
+        sig do
+          params(
+            add: T::Array[Nextbillionai::Optimization::Vehicle::OrHash],
+            modify: Nextbillionai::Optimization::Vehicle::OrHash,
+            remove: T::Array[String]
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # An array of objects to collect the details of the new vehicles to be added for
+          # re-optimization. Each object represents one vehicle. Please make sure the IDs
+          # provided for new vehicles are unique with respect to the IDs of the vehicles in
+          # the original request.
+          add: nil,
+          modify: nil,
+          # An array of vehicle IDs to be removed when during re-optimization. All vehicle
+          # IDs provided must have been part of the original request.
+          remove: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              add: T::Array[Nextbillionai::Optimization::Vehicle],
+              modify: Nextbillionai::Optimization::Vehicle,
+              remove: T::Array[String]
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/nextbillionai/models/position.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module Nextbillionai
+  module Models
+    class Position < Nextbillionai::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Nextbillionai::Position, Nextbillionai::Internal::AnyHash)
+        end
+
+      # The latitude of the searched place.
+      sig { returns(T.nilable(String)) }
+      attr_reader :lat
+
+      sig { params(lat: String).void }
+      attr_writer :lat
+
+      # The longitude of the searched place.
+      sig { returns(T.nilable(String)) }
+      attr_reader :lng
+
+      sig { params(lng: String).void }
+      attr_writer :lng
+
+      # Returns the location coordinates of the result.
+      sig { params(lat: String, lng: String).returns(T.attached_class) }
+      def self.new(
+        # The latitude of the searched place.
+        lat: nil,
+        # The longitude of the searched place.
+        lng: nil
+      )
+      end
+
+      sig { override.returns({ lat: String, lng: String }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/nextbillionai/models/post_response.rbi

@@ -0,0 +1,81 @@
+# typed: strong
+
+module Nextbillionai
+  module Models
+    class PostResponse < Nextbillionai::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Nextbillionai::PostResponse, Nextbillionai::Internal::AnyHash)
+        end
+
+      # A unique ID which can be used in the Optimization GET method to retrieve the
+      # result of optimization.
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      # Displays an acknowledgement message once the job is submitted.
+      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/codes are returned in case of
+      # 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
+
+      # Display the warnings for the given input parameters, values and constraints.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :warnings
+
+      sig { params(warnings: T::Array[String]).void }
+      attr_writer :warnings
+
+      sig do
+        params(
+          id: String,
+          message: String,
+          status: String,
+          warnings: T::Array[String]
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # A unique ID which can be used in the Optimization GET method to retrieve the
+        # result of optimization.
+        id: nil,
+        # Displays an acknowledgement message once the job is submitted.
+        message: nil,
+        # A string indicating the state of the response. On successful responses, the
+        # value will be Ok. Indicative error messages/codes are returned in case of
+        # errors. See the [API Error Codes](#api-error-codes) section below for more
+        # information.
+        status: nil,
+        # Display the warnings for the given input parameters, values and constraints.
+        warnings: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            message: String,
+            status: String,
+            warnings: T::Array[String]
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end