nextbillionai 0.1.0.pre.alpha.4

data/lib/nextbillionai/models/fleetify/routes/route_steps_request.rb

@@ -0,0 +1,174 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module Fleetify
+      module Routes
+        class RouteStepsRequest < Nextbillionai::Internal::Type::BaseModel
+          # @!attribute arrival
+          #   Specify the scheduled arrival time of the driver, as an UNIX timestamp in
+          #   seconds, at the step. Please note that:
+          #
+          #   - Arrival time for each step should be equal to or greater than the previous
+          #     step.
+          #   - Past times can not be provided.
+          #   - The time provided is used only for informative display on the driver app and
+          #     it does not impact or get affected by the route generated.
+          #
+          #   @return [Integer]
+          required :arrival, Integer
+
+          # @!attribute location
+          #   Specify the location coordinates where the steps should be performed in
+          #   [latitude, longitude].
+          #
+          #   @return [Array<Float>]
+          required :location, Nextbillionai::Internal::Type::ArrayOf[Float]
+
+          # @!attribute type
+          #   Specify the step type. It can belong to one of the following: start, job ,
+          #   pickup, delivery, end. A duration is mandatory when the step type is either
+          #   layover or a break.
+          #
+          #   @return [Symbol, Nextbillionai::Models::Fleetify::Routes::RouteStepsRequest::Type]
+          required :type, enum: -> { Nextbillionai::Fleetify::Routes::RouteStepsRequest::Type }
+
+          # @!attribute address
+          #   Specify the postal address for the step.
+          #
+          #   @return [String, nil]
+          optional :address, String
+
+          # @!attribute completion_mode
+          #   Specify the mode of completion to be used for the step. Currently, following
+          #   values are allowed:
+          #
+          #   - manual: Steps must be marked as completed manually through the Driver App.
+          #   - geofence: Steps are marked as completed automatically based on the entry
+          #     conditions and geofence specified.
+          #   - geofence_manual_fallback: Steps will be marked as completed automatically
+          #     based on geofence and entry condition configurations but there will also be a
+          #     provision for manually updating the status in case, geofence detection fails.
+          #
+          #   @return [Symbol, Nextbillionai::Models::Fleetify::Routes::RouteStepCompletionMode, nil]
+          optional :completion_mode, enum: -> { Nextbillionai::Fleetify::Routes::RouteStepCompletionMode }
+
+          # @!attribute document_template_id
+          #   Specify the ID of the document template to be used for collecting proof of
+          #   completion for the step. If not specified, the document template specified at
+          #   the route level will be used for the step. Use the
+          #   [Documents API](https://docs.nextbillion.ai/docs/dispatches/documents-api) to
+          #   create, read and manage the document templates.
+          #
+          #   Please note that the document template ID can not be assigned to following step
+          #   types - start, end, break, layover.
+          #
+          #   @return [String, nil]
+          optional :document_template_id, String
+
+          # @!attribute duration
+          #   Specify the duration of the layover or break type steps, in seconds. Please note
+          #   it is mandatory when step type is either "layover" or "break".
+          #
+          #   @return [Integer, nil]
+          optional :duration, Integer
+
+          # @!attribute geofence_config
+          #   Specify the configurations of the geofence which will be used to detect presence
+          #   of the driver and complete the tasks automatically. Please note that this
+          #   attribute is required when completion_mode is either "geofence" or
+          #   "geofence_manual_fallback".
+          #
+          #   @return [Nextbillionai::Models::Fleetify::Routes::RouteStepGeofenceConfig, nil]
+          optional :geofence_config, -> { Nextbillionai::Fleetify::Routes::RouteStepGeofenceConfig }
+
+          # @!attribute meta
+          #   An object to specify any additional details about the task to be associated with
+          #   the step in the response. The information provided here will be available on the
+          #   Driver's app under step details. This attribute can be used to provide context
+          #   about or instructions to the driver for performing the task
+          #
+          #   @return [Nextbillionai::Models::Fleetify::Routes::RouteStepsRequest::Meta, nil]
+          optional :meta, -> { Nextbillionai::Fleetify::Routes::RouteStepsRequest::Meta }
+
+          # @!method initialize(arrival:, location:, type:, address: nil, completion_mode: nil, document_template_id: nil, duration: nil, geofence_config: nil, meta: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Nextbillionai::Models::Fleetify::Routes::RouteStepsRequest} for more details.
+          #
+          #   @param arrival [Integer] Specify the scheduled arrival time of the driver, as an UNIX timestamp in second
+          #
+          #   @param location [Array<Float>] Specify the location coordinates where the steps should be performed in [latitud
+          #
+          #   @param type [Symbol, Nextbillionai::Models::Fleetify::Routes::RouteStepsRequest::Type] Specify the step type. It can belong to one of the following: start, job , picku
+          #
+          #   @param address [String] Specify the postal address for the step.
+          #
+          #   @param completion_mode [Symbol, Nextbillionai::Models::Fleetify::Routes::RouteStepCompletionMode] Specify the mode of completion to be used for the step. Currently, following val
+          #
+          #   @param document_template_id [String] Specify the ID of the document template to be used for collecting proof of compl
+          #
+          #   @param duration [Integer] Specify the duration of the layover or break type steps, in seconds. Please note
+          #
+          #   @param geofence_config [Nextbillionai::Models::Fleetify::Routes::RouteStepGeofenceConfig] Specify the configurations of the geofence which will be used to detect presence
+          #
+          #   @param meta [Nextbillionai::Models::Fleetify::Routes::RouteStepsRequest::Meta] An object to specify any additional details about the task to be associated with
+
+          # Specify the step type. It can belong to one of the following: start, job ,
+          # pickup, delivery, end. A duration is mandatory when the step type is either
+          # layover or a break.
+          #
+          # @see Nextbillionai::Models::Fleetify::Routes::RouteStepsRequest#type
+          module Type
+            extend Nextbillionai::Internal::Type::Enum
+
+            START = :start
+            JOB = :job
+            PICKUP = :pickup
+            DELIVERY = :delivery
+            BREAK = :break
+            LAYOVER = :layover
+            END_ = :end
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
+          # @see Nextbillionai::Models::Fleetify::Routes::RouteStepsRequest#meta
+          class Meta < Nextbillionai::Internal::Type::BaseModel
+            # @!attribute customer_name
+            #   Specify the name of the customer for which the step has to be performed.
+            #
+            #   @return [String, nil]
+            optional :customer_name, String
+
+            # @!attribute customer_phone_number
+            #   Specify the phone number of the person to be contacted when at step location.
+            #
+            #   @return [String, nil]
+            optional :customer_phone_number, String
+
+            # @!attribute instructions
+            #   Specify custom instructions to be carried out while performing the step.
+            #
+            #   @return [String, nil]
+            optional :instructions, String
+
+            # @!method initialize(customer_name: nil, customer_phone_number: nil, instructions: nil)
+            #   An object to specify any additional details about the task to be associated with
+            #   the step in the response. The information provided here will be available on the
+            #   Driver's app under step details. This attribute can be used to provide context
+            #   about or instructions to the driver for performing the task
+            #
+            #   @param customer_name [String] Specify the name of the customer for which the step has to be performed.
+            #
+            #   @param customer_phone_number [String] Specify the phone number of the person to be contacted when at step location.
+            #
+            #   @param instructions [String] Specify custom instructions to be carried out while performing the step.
+          end
+        end
+      end
+
+      RouteStepsRequest = Routes::RouteStepsRequest
+    end
+  end
+end

data/lib/nextbillionai/models/fleetify/routes/route_steps_response.rb

@@ -0,0 +1,273 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module Fleetify
+      module Routes
+        class RouteStepsResponse < Nextbillionai::Internal::Type::BaseModel
+          # @!attribute id
+          #   Returns the unique ID of the step.
+          #
+          #   @return [String, nil]
+          optional :id, String
+
+          # @!attribute address
+          #   Returns the postal address where the step is executed. Its value is the same as
+          #   that specified in the input request when configuring the step details.
+          #
+          #   @return [String, nil]
+          optional :address, String
+
+          # @!attribute arrival
+          #   Returns the scheduled arrival time of the driver at the step as an UNIX
+          #   timestamp, in seconds precision. It is the same as that specified in the input
+          #   request while configuring the step details.
+          #
+          #   The timestamp returned here is only for informative display on the driver's app
+          #   and it does not impact or get affected by the route generated.
+          #
+          #   @return [Integer, nil]
+          optional :arrival, Integer
+
+          # @!attribute completion
+          #
+          #   @return [Nextbillionai::Models::Fleetify::Routes::RouteStepsResponse::Completion, nil]
+          optional :completion, -> { Nextbillionai::Fleetify::Routes::RouteStepsResponse::Completion }
+
+          # @!attribute created_at
+          #   Represents the timestamp of the creation in seconds since the Unix epoch.
+          #   Example: 1738743999.
+          #
+          #   @return [Integer, nil]
+          optional :created_at, Integer
+
+          # @!attribute document_snapshot
+          #   Returns the details of the document that was used for collecting the proof of
+          #   completion for the step. In case no document template ID was provided for the
+          #   given step, then a null value is returned. Each object represents a new field in
+          #   the document.
+          #
+          #   @return [Array<Object>, nil]
+          optional :document_snapshot,
+                   Nextbillionai::Internal::Type::ArrayOf[Nextbillionai::Internal::Type::Unknown]
+
+          # @!attribute duration
+          #   Returns the duration for layover or break type steps.
+          #
+          #   @return [Integer, nil]
+          optional :duration, Integer
+
+          # @!attribute location
+          #   Returns the location coordinates where the step is executed.
+          #
+          #   @return [Array<Float>, nil]
+          optional :location, Nextbillionai::Internal::Type::ArrayOf[Float]
+
+          # @!attribute meta
+          #   An object returning custom details about the step that were configured in the
+          #   input request while configuring the step details. The information returned here
+          #   will be available for display on the Driver's app under step details.
+          #
+          #   @return [Nextbillionai::Models::Fleetify::Routes::RouteStepsResponse::Meta, nil]
+          optional :meta, -> { Nextbillionai::Fleetify::Routes::RouteStepsResponse::Meta }
+
+          # @!attribute short_id
+          #   Returns a unique short ID of the step for easier referencing and displaying
+          #   purposes.
+          #
+          #   @return [String, nil]
+          optional :short_id, String
+
+          # @!attribute type
+          #   Returns the step type. It can belong to one of the following: start, job ,
+          #   pickup, delivery, break, layover , and end. For any given step, it would be the
+          #   same as that specified in the input request while configuring the step details.
+          #
+          #   @return [String, nil]
+          optional :type, String
+
+          # @!attribute updated_at
+          #   Represents the timestamp of the last update in seconds since the Unix epoch.
+          #   Example: 1738743999.
+          #
+          #   @return [Integer, nil]
+          optional :updated_at, Integer
+
+          # @!method initialize(id: nil, address: nil, arrival: nil, completion: nil, created_at: nil, document_snapshot: nil, duration: nil, location: nil, meta: nil, short_id: nil, type: nil, updated_at: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Nextbillionai::Models::Fleetify::Routes::RouteStepsResponse} for more details.
+          #
+          #   @param id [String] Returns the unique ID of the step.
+          #
+          #   @param address [String] Returns the postal address where the step is executed. Its value is the same as
+          #
+          #   @param arrival [Integer] Returns the scheduled arrival time of the driver at the step as an UNIX timestam
+          #
+          #   @param completion [Nextbillionai::Models::Fleetify::Routes::RouteStepsResponse::Completion]
+          #
+          #   @param created_at [Integer] Represents the timestamp of the creation in seconds since the Unix epoch. Exampl
+          #
+          #   @param document_snapshot [Array<Object>] Returns the details of the document that was used for collecting the proof of co
+          #
+          #   @param duration [Integer] Returns the duration for layover or break type steps.
+          #
+          #   @param location [Array<Float>] Returns the location coordinates where the step is executed.
+          #
+          #   @param meta [Nextbillionai::Models::Fleetify::Routes::RouteStepsResponse::Meta] An object returning custom details about the step that were configured in the in
+          #
+          #   @param short_id [String] Returns a unique short ID of the step for easier referencing and displaying purp
+          #
+          #   @param type [String] Returns the step type. It can belong to one of the following: start, job , picku
+          #
+          #   @param updated_at [Integer] Represents the timestamp of the last update in seconds since the Unix epoch. Exa
+
+          # @see Nextbillionai::Models::Fleetify::Routes::RouteStepsResponse#completion
+          class Completion < Nextbillionai::Internal::Type::BaseModel
+            # @!attribute completed_at
+            #   Represents the timestamp of the completion in seconds since the Unix epoch.
+            #   Example: 1738743999.
+            #
+            #   @return [Integer, nil]
+            optional :completed_at, Integer
+
+            # @!attribute completed_by_mode
+            #   Specify the mode of completion to be used for the step. Currently, following
+            #   values are allowed:
+            #
+            #   - manual: Steps must be marked as completed manually through the Driver App.
+            #   - geofence: Steps are marked as completed automatically based on the entry
+            #     conditions and geofence specified.
+            #   - geofence_manual_fallback: Steps will be marked as completed automatically
+            #     based on geofence and entry condition configurations but there will also be a
+            #     provision for manually updating the status in case, geofence detection fails.
+            #
+            #   @return [Symbol, Nextbillionai::Models::Fleetify::Routes::RouteStepCompletionMode, nil]
+            optional :completed_by_mode, enum: -> { Nextbillionai::Fleetify::Routes::RouteStepCompletionMode }
+
+            # @!attribute completion_mode
+            #   Specify the mode of completion to be used for the step. Currently, following
+            #   values are allowed:
+            #
+            #   - manual: Steps must be marked as completed manually through the Driver App.
+            #   - geofence: Steps are marked as completed automatically based on the entry
+            #     conditions and geofence specified.
+            #   - geofence_manual_fallback: Steps will be marked as completed automatically
+            #     based on geofence and entry condition configurations but there will also be a
+            #     provision for manually updating the status in case, geofence detection fails.
+            #
+            #   @return [Symbol, Nextbillionai::Models::Fleetify::Routes::RouteStepCompletionMode, nil]
+            optional :completion_mode, enum: -> { Nextbillionai::Fleetify::Routes::RouteStepCompletionMode }
+
+            # @!attribute document
+            #   A key-value map storing form submission data, where keys correspond to field
+            #   labels and values can be of any type depend on the type of according document
+            #   item.
+            #
+            #   @return [Object, nil]
+            optional :document, Nextbillionai::Internal::Type::Unknown
+
+            # @!attribute document_modified_at
+            #   Represents the timestamp of the last doc modification in seconds since the Unix
+            #   epoch. Example: 1738743999.
+            #
+            #   @return [Integer, nil]
+            optional :document_modified_at, Integer
+
+            # @!attribute geofence_config
+            #   Specify the configurations of the geofence which will be used to detect presence
+            #   of the driver and complete the tasks automatically. Please note that this
+            #   attribute is required when completion_mode is either "geofence" or
+            #   "geofence_manual_fallback".
+            #
+            #   @return [Nextbillionai::Models::Fleetify::Routes::RouteStepGeofenceConfig, nil]
+            optional :geofence_config, -> { Nextbillionai::Fleetify::Routes::RouteStepGeofenceConfig }
+
+            # @!attribute status
+            #   Status of the step.
+            #
+            #   @return [Symbol, Nextbillionai::Models::Fleetify::Routes::RouteStepsResponse::Completion::Status, nil]
+            optional :status,
+                     enum: -> {
+                       Nextbillionai::Fleetify::Routes::RouteStepsResponse::Completion::Status
+                     }
+
+            # @!method initialize(completed_at: nil, completed_by_mode: nil, completion_mode: nil, document: nil, document_modified_at: nil, geofence_config: nil, status: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Nextbillionai::Models::Fleetify::Routes::RouteStepsResponse::Completion} for
+            #   more details.
+            #
+            #   @param completed_at [Integer] Represents the timestamp of the completion in seconds since the Unix epoch. Exam
+            #
+            #   @param completed_by_mode [Symbol, Nextbillionai::Models::Fleetify::Routes::RouteStepCompletionMode] Specify the mode of completion to be used for the step. Currently, following val
+            #
+            #   @param completion_mode [Symbol, Nextbillionai::Models::Fleetify::Routes::RouteStepCompletionMode] Specify the mode of completion to be used for the step. Currently, following val
+            #
+            #   @param document [Object] A key-value map storing form submission data, where keys correspond to field lab
+            #
+            #   @param document_modified_at [Integer] Represents the timestamp of the last doc modification in seconds since the Unix
+            #
+            #   @param geofence_config [Nextbillionai::Models::Fleetify::Routes::RouteStepGeofenceConfig] Specify the configurations of the geofence which will be used to detect presence
+            #
+            #   @param status [Symbol, Nextbillionai::Models::Fleetify::Routes::RouteStepsResponse::Completion::Status] Status of the step.
+
+            # Status of the step.
+            #
+            # @see Nextbillionai::Models::Fleetify::Routes::RouteStepsResponse::Completion#status
+            module Status
+              extend Nextbillionai::Internal::Type::Enum
+
+              SCHEDULED = :scheduled
+              COMPLETED = :completed
+              CANCELED = :canceled
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          # @see Nextbillionai::Models::Fleetify::Routes::RouteStepsResponse#meta
+          class Meta < Nextbillionai::Internal::Type::BaseModel
+            # @!attribute customer_name
+            #   Returns the customer name associated with the step. It can configured in the
+            #   input request using the metadata attribute of the step.
+            #
+            #   @return [String, nil]
+            optional :customer_name, String
+
+            # @!attribute customer_phone_number
+            #   Returns the customer's phone number associated with the step. It can configured
+            #   in the input request using the metadata attribute of the step.
+            #
+            #   @return [String, nil]
+            optional :customer_phone_number, String
+
+            # @!attribute instructions
+            #   Returns the custom instructions to carry out while performing the task. These
+            #   instructions can be provided at the time of configuring the step details in the
+            #   input request.
+            #
+            #   @return [String, nil]
+            optional :instructions, String
+
+            # @!method initialize(customer_name: nil, customer_phone_number: nil, instructions: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Nextbillionai::Models::Fleetify::Routes::RouteStepsResponse::Meta} for more
+            #   details.
+            #
+            #   An object returning custom details about the step that were configured in the
+            #   input request while configuring the step details. The information returned here
+            #   will be available for display on the Driver's app under step details.
+            #
+            #   @param customer_name [String] Returns the customer name associated with the step. It can configured in the inp
+            #
+            #   @param customer_phone_number [String] Returns the customer's phone number associated with the step. It can configured
+            #
+            #   @param instructions [String] Returns the custom instructions to carry out while performing the task. These in
+          end
+        end
+      end
+
+      RouteStepsResponse = Routes::RouteStepsResponse
+    end
+  end
+end

data/lib/nextbillionai/models/fleetify/routes/step_complete_params.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Nextbillionai
+  module Models
+    module Fleetify
+      module Routes
+        # @see Nextbillionai::Resources::Fleetify::Routes::Steps#complete
+        class StepCompleteParams < Nextbillionai::Internal::Type::BaseModel
+          extend Nextbillionai::Internal::Type::RequestParameters::Converter
+          include Nextbillionai::Internal::Type::RequestParameters
+
+          # @!attribute route_id
+          #
+          #   @return [String]
+          required :route_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
+
+          # @!attribute document
+          #   A key-value map storing form submission data, where keys correspond to field
+          #   labels and values can be of any type depend on the type of according document
+          #   item.
+          #
+          #   @return [Object, nil]
+          optional :document, Nextbillionai::Internal::Type::Unknown
+
+          # @!attribute mode
+          #   Sets the status of the route step. Currently only completed is supported.
+          #
+          #   Note: once marked completed, a step cannot transition to other statuses. You can
+          #   only update the document afterwards.
+          #
+          #   @return [String, nil]
+          optional :mode, String
+
+          # @!attribute status
+          #   Sets the status of the route step. Currently only completed is supported.
+          #
+          #   Note: once marked completed, a step cannot transition to other statuses. You can
+          #   only update the document afterwards.
+          #
+          #   @return [String, nil]
+          optional :status, String
+
+          # @!method initialize(route_id:, key:, document: nil, mode: nil, status: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {Nextbillionai::Models::Fleetify::Routes::StepCompleteParams} for more details.
+          #
+          #   @param route_id [String]
+          #
+          #   @param key [String] A key is a unique identifier that is required to authenticate a request to the A
+          #
+          #   @param document [Object] A key-value map storing form submission data, where keys correspond to field lab
+          #
+          #   @param mode [String] Sets the status of the route step. Currently only completed is supported.
+          #
+          #   @param status [String] Sets the status of the route step. Currently only completed is supported.
+          #
+          #   @param request_options [Nextbillionai::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end