nextbillionai 0.1.0.pre.alpha.4

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

@@ -0,0 +1,589 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module Optimization
+      class Shipment < Nextbillionai::Internal::Type::BaseModel
+        # @!attribute delivery
+        #   Specify the details of the delivery step of the shipment.
+        #
+        #   @return [Nextbillionai::Models::Optimization::Shipment::Delivery]
+        required :delivery, -> { Nextbillionai::Optimization::Shipment::Delivery }
+
+        # @!attribute pickup
+        #   Specify the details of the pickup step of the shipment.
+        #
+        #   @return [Nextbillionai::Models::Optimization::Shipment::Pickup]
+        required :pickup, -> { Nextbillionai::Optimization::Shipment::Pickup }
+
+        # @!attribute amount
+        #   This parameter defines the quantity that needs to be shipped. This attribute
+        #   supports multidimensional quantities, to support shipment of quantities of
+        #   different units/dimensions. It is recommended to keep the dimensions of amount
+        #   in shipments and that of capacity in vehicles consistent.
+        #
+        #   Please note that the amount will be added to the assigned vehicle’s initial
+        #   load.
+        #
+        #   Read more about the behavior of this attribute in the
+        #   [Multi-Dimensional Parameters](#multi-dimensional-parameters) section.
+        #
+        #   @return [Array<Integer>, nil]
+        optional :amount, Nextbillionai::Internal::Type::ArrayOf[Integer]
+
+        # @!attribute follow_lifo_order
+        #   Specify whether the shipment route should follow LIFO (last in, first out). Use
+        #   this parameter when the loading or unloading sequence of cargo is important. The
+        #   default value is \false\.
+        #
+        #   @return [Boolean, nil]
+        optional :follow_lifo_order, Nextbillionai::Internal::Type::Boolean
+
+        # @!attribute incompatible_load_types
+        #   Use this parameter to specify the type of loads which are incompatible with the
+        #   shipment’s load type. Once this property is configured, the shipment can only be
+        #   serviced by a vehicle which has not serviced any other task with an incompatible
+        #   load_types . Add multiple load types to indicate all the types which are
+        #   incompatible for this shipment. The incompatible load type considerations are
+        #   ignored for the first task of the route.
+        #
+        #   For example, an input value of \[“groceries”, “food”\] means that shipment’s
+        #   load is incompatible with both groceries and food type of loads. Consequently,
+        #   the optimizer will not assign this shipment to a vehicle which has served any
+        #   task with load_types as either groceries or food.
+        #
+        #   Please note that if the shipment is part of any relations then, configured
+        #   incompatible_load_types might be ignored.
+        #
+        #   @return [Array<String>, nil]
+        optional :incompatible_load_types, Nextbillionai::Internal::Type::ArrayOf[String]
+
+        # @!attribute joint_order
+        #   Specify a joint order group ID that this shipment is associated with. Tasks
+        #   having the same joint order group ID are treated as a single unit: either all
+        #   tasks in the group are assigned, or none are. Users can add tasks of both jobs
+        #   and shipments types to a single joint order group by using the same unique ID.
+        #   Please note that:
+        #
+        #   - Each shipment in a single joint order group will be fulfilled by a unique
+        #     vehicle.
+        #   - Shipments belonging to a joint order group can be served in any sequence while
+        #     maintaining the pickup -> delivery sequence for an individual shipment.
+        #   - Joint order settings will not be effective if \solution\ or \relations\
+        #     attributes are also provided in the input request.
+        #
+        #   @return [Integer, nil]
+        optional :joint_order, Integer
+
+        # @!attribute load_types
+        #   Use this parameter to specify the type of loads for the given shipment. Once
+        #   this property is configured, the shipment can not be served by a vehicle which
+        #   has serviced any task whose load is incompatible with any of theload_types
+        #   provided in this input. The load type considerations are ignored for the first
+        #   task of the route.
+        #
+        #   For example, an input value of \[“groceries”, “food”\] means that shipment’s
+        #   load characteristics belong to either one or both types. Consequently, the
+        #   optimizer will assign this shipment to a vehicle which has served other tasks
+        #   whose incompatible_load_types do not contain either groceries or food.
+        #
+        #   Please note that if the shipment is part of any relations then, configured
+        #   load_types might be ignored.
+        #
+        #   @return [Array<String>, nil]
+        optional :load_types, Nextbillionai::Internal::Type::ArrayOf[String]
+
+        # @!attribute max_time_in_vehicle
+        #   Use this parameter to limit the drive time for which a shipment stays in the
+        #   vehicle. The time-in-vehicle calculations start once the pickup leg of shipment
+        #   is completed after serving any setup and service time that may have been
+        #   configured for it. For the delivery leg, time-in-vehicle calculations wouldn’t
+        #   consider any setup and service time that needs to be served for completing the
+        #   delivery. The service or setup times of other tasks performed in between will
+        #   also be not accumulated against the time-in-vehicle limit.
+        #
+        #   Please note that this property would be overridden if any relations
+        #   configuration is used except for “precedence” type. If “precedence” type
+        #   relations is used then max_time_in_vehicle will override it.
+        #
+        #   @return [Integer, nil]
+        optional :max_time_in_vehicle, Integer
+
+        # @!attribute outsourcing_cost
+        #   Specify the cost of keeping this shipment unassigned, namely, the cost of
+        #   outsourcing the shipment. When provided, the optimizer weighs the cost of
+        #   assigning the shipment against the cost of keeping it unassigned and chooses a
+        #   solution with lower cost. In the solution, the outsourcing_cost of unassigned
+        #   shipments is added to the total cost of the solution.
+        #
+        #   If the outsourcing_cost is not provided, which is to say that the shipment can
+        #   not be outsourced, then the optimizer tries to fulfill the shipment irrespective
+        #   of the cost incurred, subject to other constraints.
+        #
+        #   Please note that revenue and outsourcing_cost can not be specified
+        #   simultaneously for a shipment. Also, the outsourcing_cost would override the
+        #   priority settings of the shipment.
+        #
+        #   @return [Integer, nil]
+        optional :outsourcing_cost, Integer
+
+        # @!attribute priority
+        #   Describe the priority of this shipment. The valid values are in the range of
+        #   \[0, 100\]. Default value is 0.
+        #
+        #   Please note that setting a priority will only decide whether this shipment will
+        #   be assigned or not, but has nothing to do with the sequence of fulfilling
+        #   shipments.
+        #
+        #   @return [Integer, nil]
+        optional :priority, Integer
+
+        # @!attribute revenue
+        #   Specify the revenue earned by completing this shipment. The optimizer uses the
+        #   revenue input to identify the potential profit earned by fulfilling this
+        #   shipment after taking into account the costs incurred to do so.
+        #   Theoptions.objective and vehicles.costs input are taken into account to identify
+        #   the costs of fulfilling the shipment.
+        #
+        #   In general, the optimizer will prefer fulfilling the tasks with higher profits
+        #   over the tasks with lower profits, should it need to reject some tasks in order
+        #   to honor other constraints. In case the profit from fulfilling a shipment is
+        #   negative, it will remain unassigned whatsoever.
+        #
+        #   @return [Integer, nil]
+        optional :revenue, Integer
+
+        # @!attribute skills
+        #   Define the skills needed to complete the shipment. This attribute supports
+        #   multidimensional skills allowing users to add multiple skills for a shipment.
+        #
+        #   Read more about the behavior of this attribute in the
+        #   [Multi-Dimensional Parameters](#multi-dimensional-parameters) section.
+        #
+        #   @return [Array<Integer>, nil]
+        optional :skills, Nextbillionai::Internal::Type::ArrayOf[Integer]
+
+        # @!attribute volume
+        #   Specify the dimensions and alignment configurations for the cargo associated
+        #   with the shipment. These inputs will be used to arrange the items into the
+        #   loading compartment of the vehicle to utilize the three-dimensional space. If a
+        #   shipment consists of several different items, each with its own dimensions,
+        #   please specify the final characteristics for the task: total height, total
+        #   depth, total width.
+        #
+        #   Please note that vehicles which contain the volume input, will only be
+        #   considered for arranging such items.
+        #
+        #   @return [Nextbillionai::Models::Optimization::Shipment::Volume, nil]
+        optional :volume, -> { Nextbillionai::Optimization::Shipment::Volume }
+
+        # @!attribute zones
+        #   An array of integers specifying the IDs of the zone(s) that this shipment
+        #   belongs to. The shipment can be fulfilled by all vehicles which are allowed to
+        #   complete tasks in the zone(s) assigned to this shipment. If the pickup and
+        #   delivery steps belong to different zones, then a vehicle should be allowed to
+        #   fulfil tasks in both zones to take up such shipments. Please note following
+        #   points about shipment zones:
+        #
+        #   - If zone IDs are provided for any one of the shipments, then all other
+        #     shipments should also be specified with zone IDs. Zone IDs provided here will
+        #     override any zone geometries provided in the zones attribute and these IDs
+        #     will be used for allocating appropriate vehicles.
+        #   - Shipment steps can be auto-allocated to zones if this parameter is not
+        #     specified while the zone geometries (either zones.geometry or
+        #     zones.geofence_id) are provided.
+        #   - Shipments not falling in any zones can be fulfilled by only those vehicles
+        #     which are allowed to take up tasks outside zones as well. Refer to vehicles
+        #     attribute for more information.
+        #
+        #   @return [Array<Integer>, nil]
+        optional :zones, Nextbillionai::Internal::Type::ArrayOf[Integer]
+
+        # @!method initialize(delivery:, pickup:, amount: nil, follow_lifo_order: nil, incompatible_load_types: nil, joint_order: nil, load_types: nil, max_time_in_vehicle: nil, outsourcing_cost: nil, priority: nil, revenue: nil, skills: nil, volume: nil, zones: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::Optimization::Shipment} for more details.
+        #
+        #   @param delivery [Nextbillionai::Models::Optimization::Shipment::Delivery] Specify the details of the delivery step of the shipment.
+        #
+        #   @param pickup [Nextbillionai::Models::Optimization::Shipment::Pickup] Specify the details of the pickup step of the shipment.
+        #
+        #   @param amount [Array<Integer>] This parameter defines the quantity that needs to be shipped. This attribute sup
+        #
+        #   @param follow_lifo_order [Boolean] Specify whether the shipment route should follow LIFO (last in, first out). Use
+        #
+        #   @param incompatible_load_types [Array<String>] Use this parameter to specify the type of loads which are incompatible with the
+        #
+        #   @param joint_order [Integer] Specify a joint order group ID that this shipment is associated with. Tasks havi
+        #
+        #   @param load_types [Array<String>] Use this parameter to specify the type of loads for the given shipment. Once thi
+        #
+        #   @param max_time_in_vehicle [Integer] Use this parameter to limit the drive time for which a shipment stays in the veh
+        #
+        #   @param outsourcing_cost [Integer] Specify the cost of keeping this shipment unassigned, namely, the cost of outsou
+        #
+        #   @param priority [Integer] Describe the priority of this shipment. The valid values are in the range of \[0
+        #
+        #   @param revenue [Integer] Specify the revenue earned by completing this shipment. The optimizer uses the r
+        #
+        #   @param skills [Array<Integer>] Define the skills needed to complete the shipment. This attribute supports multi
+        #
+        #   @param volume [Nextbillionai::Models::Optimization::Shipment::Volume] Specify the dimensions and alignment configurations for the cargo associated wit
+        #
+        #   @param zones [Array<Integer>] An array of integers specifying the IDs of the zone(s) that this shipment belong
+
+        # @see Nextbillionai::Models::Optimization::Shipment#delivery
+        class Delivery < Nextbillionai::Internal::Type::BaseModel
+          # @!attribute id
+          #   Indicate the ID of this shipment delivery step. An error will be reported if
+          #   there are duplicate IDs for multiple shipment deliveries. The IDs are case
+          #   sensitive. Please note id is mandatory when using the shipments attribute.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute location_index
+          #   Indicate the index of location for this shipment delivery. The index references
+          #   the locations present in the location array. The valid range of value is \[0,
+          #   length of location array).
+          #
+          #   Please note location_index is mandatory when using the shipment attribute.
+          #
+          #   @return [Integer]
+          required :location_index, Integer
+
+          # @!attribute description
+          #   Specify a custom description for the shipment delivery step.
+          #
+          #   @return [String, nil]
+          optional :description, String
+
+          # @!attribute max_visit_lateness
+          #   It determines the allowable delay, in seconds, to begin a shipment delivery
+          #   after its designated time window has concluded. Please note that this parameter
+          #   would override the constraint.max_visit_lateness (global) if both are specified.
+          #
+          #   @return [Integer, nil]
+          optional :max_visit_lateness, Integer
+
+          # @!attribute metadata
+          #   Specify any custom data that should be attached along with delivery fulfilment
+          #   details in the step attribute of the optimized solution. Users can leverage this
+          #   property to provide additional details/context when sharing information about
+          #   the delivery step with integrated systems (TMS, Fleet Management, Driver
+          #   dispatch etc).
+          #
+          #   Please note that the metadata content must always be specified in a key : value
+          #   pair format, where the “key” is always a string.
+          #
+          #   @return [Object, nil]
+          optional :metadata, Nextbillionai::Internal::Type::Unknown
+
+          # @!attribute sequence_order
+          #   Use this parameter to prioritize completing the shipment delivery relative to
+          #   certain other tasks. A task configured with a sequence_order of 2 will be done
+          #   after the task with sequence_order of 1, but before the task with sequence_order
+          #   of 3. Valid range of values for this input is \[0,100\].
+          #
+          #   Please note that:
+          #
+          #   - The shipment delivery's sequence order must be greater than or equal to its
+          #     corresponding pickup's sequence order.
+          #   - Only the tasks within the same route are compared and ordered as per their
+          #     sequence_order.
+          #   - Tasks without a sequence_order are not involved in the comparison.
+          #   - Following is the precedence of sequence_order when used along side some of the
+          #     other constraints:
+          #
+          #     - relations are prioritized over sequence_order comparisons.
+          #     - sequence_order will override order_grouping configurations.
+          #
+          #   @return [Integer, nil]
+          optional :sequence_order, Integer
+
+          # @!attribute service
+          #   Provide the time duration, in seconds, needed to complete the shipment delivery.
+          #   Default value is 0.
+          #
+          #   @return [Integer, nil]
+          optional :service, Integer
+
+          # @!attribute setup
+          #   Specify the set-up duration, in seconds, for the delivery. setup is the one-time
+          #   effort needed apart from working on the original task- for example, effort to
+          #   record some information for compliance, or effort to set-up the equipment, or
+          #   perform any other action for completing all steps required to fulfil the job.
+          #
+          #   Please note that setup time is applied only once for a given task location.
+          #   setup time, unlike service time, is not repeated in case there are multiple
+          #   tasks at the same location.
+          #
+          #   @return [Integer, nil]
+          optional :setup, Integer
+
+          # @!attribute time_windows
+          #   Describe time periods within which the shipment delivery should start. The time
+          #   periods should be expressed as a UNIX timestamp in seconds.
+          #
+          #   Please note that the time periods should not overlap with each other and should
+          #   always follow the format of \[start_timestamp, end_timestamp\].
+          #
+          #   @return [Array<Array<Integer>>, nil]
+          optional :time_windows,
+                   Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Internal::Type::ArrayOf[Integer]]
+
+          # @!method initialize(id:, location_index:, description: nil, max_visit_lateness: nil, metadata: nil, sequence_order: nil, service: nil, setup: nil, time_windows: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Nextbillionai::Models::Optimization::Shipment::Delivery} for more details.
+          #
+          #   Specify the details of the delivery step of the shipment.
+          #
+          #   @param id [String] Indicate the ID of this shipment delivery step. An error will be reported if the
+          #
+          #   @param location_index [Integer] Indicate the index of location for this shipment delivery. The index references
+          #
+          #   @param description [String] Specify a custom description for the shipment delivery step.
+          #
+          #   @param max_visit_lateness [Integer] It determines the allowable delay, in seconds, to begin a shipment delivery afte
+          #
+          #   @param metadata [Object] Specify any custom data that should be attached along with delivery fulfilment d
+          #
+          #   @param sequence_order [Integer] Use this parameter to prioritize completing the shipment delivery relative to ce
+          #
+          #   @param service [Integer] Provide the time duration, in seconds, needed to complete the shipment delivery.
+          #
+          #   @param setup [Integer] Specify the set-up duration, in seconds, for the delivery. setup is the one-time
+          #
+          #   @param time_windows [Array<Array<Integer>>] Describe time periods within which the shipment delivery should start. The time
+        end
+
+        # @see Nextbillionai::Models::Optimization::Shipment#pickup
+        class Pickup < Nextbillionai::Internal::Type::BaseModel
+          # @!attribute id
+          #   Indicate the ID of this shipment pickup step. An error will be reported if there
+          #   are duplicate IDs for multiple shipment pick-ups. The IDs are case-sensitive.
+          #   Please note id is mandatory when using the shipments attribute.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute location_index
+          #   Indicate the index of the location for this shipment pickup. The index
+          #   references the locations present in the location array. The valid range of value
+          #   is \[0, length of location array).
+          #
+          #   @return [Integer]
+          required :location_index, Integer
+
+          # @!attribute description
+          #   Specify a custom description for the shipment pickup step.
+          #
+          #   @return [String, nil]
+          optional :description, String
+
+          # @!attribute max_visit_lateness
+          #   It determines the allowable delay, in seconds, to begin a shipment pickup after
+          #   its designated time window has concluded. Please note that this parameter would
+          #   override the constraint.max_visit_lateness (global) if both are specified.
+          #
+          #   @return [Integer, nil]
+          optional :max_visit_lateness, Integer
+
+          # @!attribute metadata
+          #   Specify any custom data that should be attached along with pickup fulfilment
+          #   details in the steps attribute of the optimized solution. Users can leverage
+          #   this property to provide additional details/context when sharing information
+          #   about the pickup step with integrated systems (TMS, Fleet Management, Driver
+          #   dispatch etc).
+          #
+          #   Please note that the metadata content must always be specified in akey : value
+          #   pair format, where the “key” is always a string.
+          #
+          #   @return [Object, nil]
+          optional :metadata, Nextbillionai::Internal::Type::Unknown
+
+          # @!attribute sequence_order
+          #   Use this parameter to prioritize completing the shipment pickup relative to
+          #   certain other tasks. A task configured with a sequence_order of 2 will be done
+          #   after the task with sequence_order of 1, but before the task with sequence_order
+          #   of 3. Valid range of values for this input is \[0,100\].
+          #
+          #   Please note that:
+          #
+          #   - The shipment pickups's sequence order must be lesser than or equal to its
+          #     corresponding delivery's sequence order.
+          #   - Only the tasks within the same route are compared and ordered as per their
+          #     sequence_order.
+          #   - Tasks without a sequence_order are not involved in the comparison.
+          #   - Following is the precedence of sequence_order when used along side some of the
+          #     other constraints:
+          #
+          #     - relations are prioritized over sequence_order comparisons.
+          #     - sequence_order will override order_grouping configurations.
+          #
+          #   @return [Integer, nil]
+          optional :sequence_order, Integer
+
+          # @!attribute service
+          #   Provide the time duration, in seconds, needed to complete the shipment pickup.
+          #   Default value is 0.
+          #
+          #   @return [Integer, nil]
+          optional :service, Integer
+
+          # @!attribute setup
+          #   Specify the set-up duration, in seconds, for the pickup. setup is the one-time
+          #   effort needed apart from working on the original task- for example, effort to
+          #   record some information for compliance, or effort to set-up the equipment, or
+          #   perform any other action for completing all steps required to fulfil the job.
+          #
+          #   Please note that setup time is applied only once for a given task location.
+          #   setup time, unlike service time, is not repeated in case there are multiple
+          #   tasks at the same location.
+          #
+          #   @return [Integer, nil]
+          optional :setup, Integer
+
+          # @!attribute time_windows
+          #   Describe time periods within which the shipment pickup should be start. The time
+          #   periods should be expressed as a UNIX timestamp in seconds.
+          #
+          #   Please note that the time periods should not overlap with each other and should
+          #   always follow the format of \[start_timestamp, end_timestamp\]
+          #
+          #   @return [Array<Array<Integer>>, nil]
+          optional :time_windows,
+                   Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Internal::Type::ArrayOf[Integer]]
+
+          # @!method initialize(id:, location_index:, description: nil, max_visit_lateness: nil, metadata: nil, sequence_order: nil, service: nil, setup: nil, time_windows: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Nextbillionai::Models::Optimization::Shipment::Pickup} for more details.
+          #
+          #   Specify the details of the pickup step of the shipment.
+          #
+          #   @param id [String] Indicate the ID of this shipment pickup step. An error will be reported if there
+          #
+          #   @param location_index [Integer] Indicate the index of the location for this shipment pickup. The index reference
+          #
+          #   @param description [String] Specify a custom description for the shipment pickup step.
+          #
+          #   @param max_visit_lateness [Integer] It determines the allowable delay, in seconds, to begin a shipment pickup after
+          #
+          #   @param metadata [Object] Specify any custom data that should be attached along with pickup fulfilment det
+          #
+          #   @param sequence_order [Integer] Use this parameter to prioritize completing the shipment pickup relative to cert
+          #
+          #   @param service [Integer] Provide the time duration, in seconds, needed to complete the shipment pickup. D
+          #
+          #   @param setup [Integer] Specify the set-up duration, in seconds, for the pickup. setup is the one-time e
+          #
+          #   @param time_windows [Array<Array<Integer>>] Describe time periods within which the shipment pickup should be start. The time
+        end
+
+        # @see Nextbillionai::Models::Optimization::Shipment#volume
+        class Volume < Nextbillionai::Internal::Type::BaseModel
+          # @!attribute alignment
+          #   Refers to the orientation of the cargo in the loading compartment. It supports
+          #   the following values:
+          #
+          #   - **" "** : A blank space to indicate that the dimension check for the cargo
+          #     should be skipped. This is also the default value.
+          #   - **strict :** In this orientation, the cargo must fit within the vehicle’s
+          #     dimensions exactly as is—no rotation is allowed. All dimensions of the cargo
+          #     must be less than or equal to the corresponding dimensions of the vehicle. If
+          #     any dimension exceeds that of the vehicle, the cargo cannot be loaded.
+          #   - **parallel :** With parallel orientation, the cargo can be rotated around any
+          #     one of the axes to help it fit into the loading compartment. For example, if
+          #     the cargo is wider than the vehicle, it can still be loaded by rotating it
+          #     around the vertical axis (so the width aligns with the vehicle’s depth) or the
+          #     horizontal axis (so the width aligns with the vehicle’s height). Using this
+          #     orientation, even a cargo whose one dimension is larger than the corresponding
+          #     dimension of the vehicle but smaller than other dimensions, can also be
+          #     loaded.
+          #   - **fixed_bottom :** In this orientation, the cargo can only be rotated around
+          #     the vertical axis, meaning its base stays fixed and it cannot be tilted or
+          #     turned over. The height of the cargo remains aligned with the vehicle’s height
+          #     and cannot be adjusted. As a result, if the cargo’s height exceeds the
+          #     vehicle’s available height, it cannot be loaded into the compartment.
+          #
+          #   @return [Symbol, Nextbillionai::Models::Optimization::Shipment::Volume::Alignment, nil]
+          optional :alignment, enum: -> { Nextbillionai::Optimization::Shipment::Volume::Alignment }
+
+          # @!attribute depth
+          #   Cargo length, in meters.
+          #
+          #   @return [Float, nil]
+          optional :depth, Float
+
+          # @!attribute height
+          #   Cargo height, in meters.
+          #
+          #   @return [Float, nil]
+          optional :height, Float
+
+          # @!attribute width
+          #   Cargo width, in meters.
+          #
+          #   @return [Float, nil]
+          optional :width, Float
+
+          # @!method initialize(alignment: nil, depth: nil, height: nil, width: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Nextbillionai::Models::Optimization::Shipment::Volume} for more details.
+          #
+          #   Specify the dimensions and alignment configurations for the cargo associated
+          #   with the shipment. These inputs will be used to arrange the items into the
+          #   loading compartment of the vehicle to utilize the three-dimensional space. If a
+          #   shipment consists of several different items, each with its own dimensions,
+          #   please specify the final characteristics for the task: total height, total
+          #   depth, total width.
+          #
+          #   Please note that vehicles which contain the volume input, will only be
+          #   considered for arranging such items.
+          #
+          #   @param alignment [Symbol, Nextbillionai::Models::Optimization::Shipment::Volume::Alignment] Refers to the orientation of the cargo in the loading compartment. It supports t
+          #
+          #   @param depth [Float] Cargo length, in meters.
+          #
+          #   @param height [Float] Cargo height, in meters.
+          #
+          #   @param width [Float] Cargo width, in meters.
+
+          # Refers to the orientation of the cargo in the loading compartment. It supports
+          # the following values:
+          #
+          # - **" "** : A blank space to indicate that the dimension check for the cargo
+          #   should be skipped. This is also the default value.
+          # - **strict :** In this orientation, the cargo must fit within the vehicle’s
+          #   dimensions exactly as is—no rotation is allowed. All dimensions of the cargo
+          #   must be less than or equal to the corresponding dimensions of the vehicle. If
+          #   any dimension exceeds that of the vehicle, the cargo cannot be loaded.
+          # - **parallel :** With parallel orientation, the cargo can be rotated around any
+          #   one of the axes to help it fit into the loading compartment. For example, if
+          #   the cargo is wider than the vehicle, it can still be loaded by rotating it
+          #   around the vertical axis (so the width aligns with the vehicle’s depth) or the
+          #   horizontal axis (so the width aligns with the vehicle’s height). Using this
+          #   orientation, even a cargo whose one dimension is larger than the corresponding
+          #   dimension of the vehicle but smaller than other dimensions, can also be
+          #   loaded.
+          # - **fixed_bottom :** In this orientation, the cargo can only be rotated around
+          #   the vertical axis, meaning its base stays fixed and it cannot be tilted or
+          #   turned over. The height of the cargo remains aligned with the vehicle’s height
+          #   and cannot be adjusted. As a result, if the cargo’s height exceeds the
+          #   vehicle’s available height, it cannot be loaded into the compartment.
+          #
+          # @see Nextbillionai::Models::Optimization::Shipment::Volume#alignment
+          module Alignment
+            extend Nextbillionai::Internal::Type::Enum
+
+            STRICT = :strict
+            PARALLEL = :parallel
+            FIXED_BOTTOM = :fixed_bottom
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module Optimization
+      # @see Nextbillionai::Resources::Optimization::V2#retrieve_result
+      class V2RetrieveResultParams < Nextbillionai::Internal::Type::BaseModel
+        extend Nextbillionai::Internal::Type::RequestParameters::Converter
+        include Nextbillionai::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #   The unique ID that was returned on successful submission of the Optimization
+        #   POST request.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute key
+        #   A key is a unique identifier that is required to authenticate a request to the
+        #   API.
+        #
+        #   @return [String]
+        required :key, String
+
+        # @!method initialize(id:, key:, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Nextbillionai::Models::Optimization::V2RetrieveResultParams} for more details.
+        #
+        #   @param id [String] The unique ID that was returned on successful submission of the Optimization POS
+        #
+        #   @param key [String] A key is a unique identifier that is required to authenticate a request to the A
+        #
+        #   @param request_options [Nextbillionai::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end