nextbillionai 0.1.0.pre.alpha.4

data/lib/nextbillionai/models/optimization_re_optimize_params.rb

@@ -0,0 +1,217 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    # @see Nextbillionai::Resources::Optimization#re_optimize
+    class OptimizationReOptimizeParams < 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 existing_request_id
+      #   Specify the unique request ID that needs to be re-optimized.
+      #
+      #   @return [String]
+      required :existing_request_id, String
+
+      # @!attribute job_changes
+      #   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.
+      #
+      #   @return [Nextbillionai::Models::OptimizationReOptimizeParams::JobChanges, nil]
+      optional :job_changes, -> { Nextbillionai::OptimizationReOptimizeParams::JobChanges }
+
+      # @!attribute locations
+      #   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.
+      #
+      #   @return [Array<String>, nil]
+      optional :locations, Nextbillionai::Internal::Type::ArrayOf[String]
+
+      # @!attribute shipment_changes
+      #   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.
+      #
+      #   @return [Nextbillionai::Models::OptimizationReOptimizeParams::ShipmentChanges, nil]
+      optional :shipment_changes, -> { Nextbillionai::OptimizationReOptimizeParams::ShipmentChanges }
+
+      # @!attribute vehicle_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.
+      #
+      #   @return [Nextbillionai::Models::OptimizationReOptimizeParams::VehicleChanges, nil]
+      optional :vehicle_changes, -> { Nextbillionai::OptimizationReOptimizeParams::VehicleChanges }
+
+      # @!method initialize(key:, existing_request_id:, job_changes: nil, locations: nil, shipment_changes: nil, vehicle_changes: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Nextbillionai::Models::OptimizationReOptimizeParams} for more details.
+      #
+      #   @param key [String] A key is a unique identifier that is required to authenticate a request to the A
+      #
+      #   @param existing_request_id [String] Specify the unique request ID that needs to be re-optimized.
+      #
+      #   @param job_changes [Nextbillionai::Models::OptimizationReOptimizeParams::JobChanges] This section gathers information on modifications to the number of jobs or their
+      #
+      #   @param locations [Array<String>] Provide the list of locations to be used during re-optimization process. Please
+      #
+      #   @param shipment_changes [Nextbillionai::Models::OptimizationReOptimizeParams::ShipmentChanges] This section gathers information on modifications to the number of shipments or
+      #
+      #   @param vehicle_changes [Nextbillionai::Models::OptimizationReOptimizeParams::VehicleChanges] This section gathers information on modifications to the number of vehicles or i
+      #
+      #   @param request_options [Nextbillionai::RequestOptions, Hash{Symbol=>Object}]
+
+      class JobChanges < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute add
+        #   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.
+        #
+        #   @return [Array<Nextbillionai::Models::Optimization::Job>, nil]
+        optional :add, -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Optimization::Job] }
+
+        # @!attribute modify
+        #   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.
+        #
+        #   @return [Array<Nextbillionai::Models::Optimization::Job>, nil]
+        optional :modify, -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Optimization::Job] }
+
+        # @!attribute remove
+        #   An array of job IDs to be removed when during re-optimization. All job IDs
+        #   provided must have been part of the original request.
+        #
+        #   @return [Array<String>, nil]
+        optional :remove, Nextbillionai::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(add: nil, modify: nil, remove: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::OptimizationReOptimizeParams::JobChanges} for more
+        #   details.
+        #
+        #   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.
+        #
+        #   @param add [Array<Nextbillionai::Models::Optimization::Job>] An array of objects to collect the details of the new jobs to be added during re
+        #
+        #   @param modify [Array<Nextbillionai::Models::Optimization::Job>] An array of objects to collect the modified details of existing jobs used in the
+        #
+        #   @param remove [Array<String>] An array of job IDs to be removed when during re-optimization. All job IDs provi
+      end
+
+      class ShipmentChanges < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute add
+        #   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.
+        #
+        #   @return [Array<Nextbillionai::Models::Optimization::Shipment>, nil]
+        optional :add, -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Optimization::Shipment] }
+
+        # @!attribute modify
+        #   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.
+        #
+        #   @return [Array<Nextbillionai::Models::Optimization::Shipment>, nil]
+        optional :modify, -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Optimization::Shipment] }
+
+        # @!attribute remove
+        #   An array of shipment IDs to be removed when during re-optimization. All shipment
+        #   IDs provided must have been part of the original request.
+        #
+        #   @return [Array<String>, nil]
+        optional :remove, Nextbillionai::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(add: nil, modify: nil, remove: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::OptimizationReOptimizeParams::ShipmentChanges} for more
+        #   details.
+        #
+        #   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.
+        #
+        #   @param add [Array<Nextbillionai::Models::Optimization::Shipment>] An array of objects to collect the details of the new shipments to be added duri
+        #
+        #   @param modify [Array<Nextbillionai::Models::Optimization::Shipment>] An array of objects to collect the modified details of existing shipments used i
+        #
+        #   @param remove [Array<String>] An array of shipment IDs to be removed when during re-optimization. All shipment
+      end
+
+      class VehicleChanges < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute add
+        #   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.
+        #
+        #   @return [Array<Nextbillionai::Models::Optimization::Vehicle>, nil]
+        optional :add, -> { Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Optimization::Vehicle] }
+
+        # @!attribute modify
+        #
+        #   @return [Nextbillionai::Models::Optimization::Vehicle, nil]
+        optional :modify, -> { Nextbillionai::Optimization::Vehicle }
+
+        # @!attribute remove
+        #   An array of vehicle IDs to be removed when during re-optimization. All vehicle
+        #   IDs provided must have been part of the original request.
+        #
+        #   @return [Array<String>, nil]
+        optional :remove, Nextbillionai::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(add: nil, modify: nil, remove: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::OptimizationReOptimizeParams::VehicleChanges} for more
+        #   details.
+        #
+        #   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.
+        #
+        #   @param add [Array<Nextbillionai::Models::Optimization::Vehicle>] An array of objects to collect the details of the new vehicles to be added for r
+        #
+        #   @param modify [Nextbillionai::Models::Optimization::Vehicle]
+        #
+        #   @param remove [Array<String>] An array of vehicle IDs to be removed when during re-optimization. All vehicle I
+      end
+    end
+  end
+end

data/lib/nextbillionai/models/position.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    class Position < Nextbillionai::Internal::Type::BaseModel
+      # @!attribute lat
+      #   The latitude of the searched place.
+      #
+      #   @return [String, nil]
+      optional :lat, String
+
+      # @!attribute lng
+      #   The longitude of the searched place.
+      #
+      #   @return [String, nil]
+      optional :lng, String
+
+      # @!method initialize(lat: nil, lng: nil)
+      #   Returns the location coordinates of the result.
+      #
+      #   @param lat [String] The latitude of the searched place.
+      #
+      #   @param lng [String] The longitude of the searched place.
+    end
+  end
+end

data/lib/nextbillionai/models/post_response.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    # @see Nextbillionai::Resources::Optimization#re_optimize
+    class PostResponse < Nextbillionai::Internal::Type::BaseModel
+      # @!attribute id
+      #   A unique ID which can be used in the Optimization GET method to retrieve the
+      #   result of optimization.
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute message
+      #   Displays an acknowledgement message once the job is submitted.
+      #
+      #   @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/codes are returned in case of
+      #   errors. See the [API Error Codes](#api-error-codes) section below for more
+      #   information.
+      #
+      #   @return [String, nil]
+      optional :status, String
+
+      # @!attribute warnings
+      #   Display the warnings for the given input parameters, values and constraints.
+      #
+      #   @return [Array<String>, nil]
+      optional :warnings, Nextbillionai::Internal::Type::ArrayOf[String]
+
+      # @!method initialize(id: nil, message: nil, status: nil, warnings: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Nextbillionai::Models::PostResponse} for more details.
+      #
+      #   @param id [String] A unique ID which can be used in the Optimization GET method to retrieve the res
+      #
+      #   @param message [String] Displays an acknowledgement message once the job is submitted.
+      #
+      #   @param status [String] A string indicating the state of the response. On successful responses, the valu
+      #
+      #   @param warnings [Array<String>] Display the warnings for the given input parameters, values and constraints.
+    end
+  end
+end

data/lib/nextbillionai/models/postalcode_retrieve_coordinates_params.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    # @see Nextbillionai::Resources::Postalcode#retrieve_coordinates
+    class PostalcodeRetrieveCoordinatesParams < 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 at
+      #   Location coordinates that you want to get the postal code of. If not providing
+      #   postalcode in the request, at becomes mandatory. Please note that only 1 point
+      #   can be requested. [See this example](#note).
+      #
+      #   @return [Nextbillionai::Models::PostalcodeRetrieveCoordinatesParams::At, nil]
+      optional :at, -> { Nextbillionai::PostalcodeRetrieveCoordinatesParams::At }
+
+      # @!attribute country
+      #   Country containing the postal code or the location. It is mandatory if
+      #   postalcode is provided in the request. [See this example](#note).
+      #
+      #   Please check the [API Query Limits](#api-query-limits) section below for a list
+      #   of the countries covered by the Geocode Postcode API. Users can provide either
+      #   the name or the alpha-2/3 code as per the
+      #   [ISO 3166-1 standard](https://en.wikipedia.org/wiki/ISO_3166-1) of a country
+      #   covered by the API as input for this parameter.
+      #
+      #   @return [String, nil]
+      optional :country, String
+
+      # @!attribute format_
+      #   Specify the format in which the boundary details of the post code will be
+      #   returned. When specified, the boundary details will be returned in the geojson
+      #   format. When not specified, the boundary details are returned in general format.
+      #
+      #   @return [Symbol, Nextbillionai::Models::PostalcodeRetrieveCoordinatesParams::Format, nil]
+      optional :format_,
+               enum: -> { Nextbillionai::PostalcodeRetrieveCoordinatesParams::Format },
+               api_name: :format
+
+      # @!attribute postalcode
+      #   Provide the postal code for which the information is needed. At least one of
+      #   (postalcode + country) or at needs to be provided. Please note that only 1
+      #   postal code can be requested. [See this example](#note).
+      #
+      #   @return [String, nil]
+      optional :postalcode, String
+
+      # @!method initialize(key:, at: nil, country: nil, format_: nil, postalcode: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Nextbillionai::Models::PostalcodeRetrieveCoordinatesParams} for more details.
+      #
+      #   @param key [String] A key is a unique identifier that is required to authenticate a request to the A
+      #
+      #   @param at [Nextbillionai::Models::PostalcodeRetrieveCoordinatesParams::At] Location coordinates that you want to get the postal code of. If not providing p
+      #
+      #   @param country [String] Country containing the postal code or the location. It is mandatory if postalcod
+      #
+      #   @param format_ [Symbol, Nextbillionai::Models::PostalcodeRetrieveCoordinatesParams::Format] Specify the format in which the boundary details of the post code will be return
+      #
+      #   @param postalcode [String] Provide the postal code for which the information is needed. At least one of (po
+      #
+      #   @param request_options [Nextbillionai::RequestOptions, Hash{Symbol=>Object}]
+
+      class At < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute lat
+        #   Latitude of the location.
+        #
+        #   @return [Float, nil]
+        optional :lat, Float
+
+        # @!attribute lng
+        #   Longitude of the location.
+        #
+        #   @return [Float, nil]
+        optional :lng, Float
+
+        # @!method initialize(lat: nil, lng: nil)
+        #   Location coordinates that you want to get the postal code of. If not providing
+        #   postalcode in the request, at becomes mandatory. Please note that only 1 point
+        #   can be requested. [See this example](#note).
+        #
+        #   @param lat [Float] Latitude of the location.
+        #
+        #   @param lng [Float] Longitude of the location.
+      end
+
+      # Specify the format in which the boundary details of the post code will be
+      # returned. When specified, the boundary details will be returned in the geojson
+      # format. When not specified, the boundary details are returned in general format.
+      module Format
+        extend Nextbillionai::Internal::Type::Enum
+
+        GEOJSON = :geojson
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end