@geoapify/route-planner-sdk/dist/models/entities/route-planner-result.d.ts

TypeScript SDK for the Geoapify Route Planner API. Supports route optimization, delivery planning, and timeline visualization in browser and Node.js

import { AgentData, JobData, RoutePlannerResultData, RoutePlannerResultResponseData, RoutePlannerResultResponseDataExtended, RoutingOptions, ShipmentData } from "../interfaces";
import { AgentPlan } from "./nested/result/agent-plan";
import { JobPlan } from "./nested/result/job-plan";
import { ShipmentPlan } from "./nested/result/shipment-plan";
import { RoutePlannerCallOptions } from "../interfaces/route-planner-call-options";
/**
 * Provides convenient methods for reading Route Planner API results.
 */
export declare class RoutePlannerResult {
    private readonly callOptions;
    private readonly rawData;
    private data;
    private agentPlans;
    private shipmentPlans;
    private jobPlans;
    constructor(callOptions: RoutePlannerCallOptions, rawData: RoutePlannerResultResponseData | RoutePlannerResultResponseDataExtended);
    /**
     * Returns the data returned by the Route Planner API.
     */
    getData(): RoutePlannerResultData;
    /**
     * Returns the raw data returned by the Route Planner API.
     */
    getRaw(): RoutePlannerResultResponseData;
    /**
     * Returns a list of all assigned agent solutions.
     */
    getAgentPlans(): (AgentPlan | undefined)[];
    /**
     * Finds an agent's solution by their ID.
     */
    getAgentPlan(agentIdOrIndex: string | number): AgentPlan | undefined;
    /**
     * Retrieves unassigned agents.
     */
    getUnassignedAgents(): AgentData[];
    /**
     * Retrieves unassigned jobs.
     */
    getUnassignedJobs(): JobData[];
    /**
     * Retrieves unassigned shipments.
     */
    getUnassignedShipments(): ShipmentData[];
    /**
     * Returns a list of all assigned jobs
     */
    getJobPlans(): JobPlan[];
    /**
     * Finds job solution by their ID or index.
     */
    getJobPlan(jobIdOrIndex: string | number): JobPlan | undefined;
    /**
     * Returns a list of all shipments
     */
    getShipmentPlans(): (ShipmentPlan)[];
    /**
     * Finds shipment solution by their ID or index.
     */
    getShipmentPlan(shipmentIdOrIndex: string | number): ShipmentPlan | undefined;
    getCallOptions(): RoutePlannerCallOptions;
    getRoutingOptions(): RoutingOptions;
    private getAgentViolations;
}