@kwikpik/kwikpik.js/dist/api/requests.d.ts

Javascript/Typescript convenience library that interfaces with the Kwik Pik business API

interface Request {
    /**
     * Latitude of the pickup location.
     */
    latitude: number;
    /**
     * Longitude of the pickup location.
     */
    longitude: number;
    /**
     * Product category e.g food
     */
    category: string;
    /**
     * Exact product e.g rice & chicken
     */
    product: string;
    /**
     * A description of the product
     */
    description?: string;
    /**
     * Product weight (in KG)
     */
    weight?: number;
    /**
     * How many of this product are you putting up for delivery?
     */
    quantity?: number;
    /**
     * Base64-encoded string representation of the product's image
     */
    image?: string;
    /**
     * Latitude of the delivery location.
     */
    destinationLatitude: number;
    /**
     * Longitude of the delivery location.
     */
    destinationLongitude: number;
    /**
     * Preferred vehicle for the delivery
     */
    vehicleType: "car" | "bus" | "bicycle" | "truck" | "van" | "motorcycle";
    /**
     * Name of the recipient to deliver this pacakge to
     */
    recipientName: string;
    /**
     * Phone number of the recipient to deliver this package to
     */
    recipientPhoneNumber: string;
    /**
     * How much this package costs in the market
     */
    packageValue?: number;
    /**
     * This number would receive the protection code for this delivery
     */
    phoneNumber: number;
    /**
     * The name of the sender of this package
     */
    senderName: string;
}
export interface RequestMessage {
    location: {
        latitude: number;
        longitude: number;
    };
    userId: string;
    packageDetails: {
        category: string;
        product: string;
        description: string;
        weight: number | null;
        quantity: number;
        image: string;
        value: number | null;
    };
    selectedVehicleType: "car" | "bus" | "bicycle" | "truck" | "van" | "motorcycle";
    userType: "BUSINESS" | "REGULAR_USER";
    destination: {
        latitude: number;
        longitude: number;
    };
    recipientPhoneNumber: string;
    recipientName: string;
    phoneNumber: string;
    senderName: string;
}
interface SingleRequestResponse extends RequestMessage {
    status: "CANCELLED" | "DELIVERED" | "INIT_RIDE_REQUEST" | "CONFIRMED_RIDE_REQUEST";
    riderId: string | null;
    isInTransit: boolean;
    createdAt: string;
    updatedAt: string;
    id: string;
    amount: number;
}
interface InitRequestResponse {
    id: string;
    data: RequestMessage;
    type: string;
    amount?: number;
}
interface ConfirmRequestResponse {
    id: string;
    data: string;
    type: string;
}
interface DeleteRequestResponse {
    id: string;
    data: {
        requestMessageId: string;
    };
    type: string;
}
interface UpdateRequestResponse {
    id: string;
    type: string;
    data: {
        requestId: string;
        [key: string]: any;
    };
}
export declare class Requests {
    private agent;
    protected constructor(apiKey: string, environment?: "dev" | "prod");
    /**
     *
     * @param apiKey Your Kwik-Pik API key
     * @param environment dev or prod (development or production)
     * @description Intializes a request object
     * @returns
     */
    static initialize(apiKey: string, environment?: "dev" | "prod"): Requests;
    /**
     *
     * @param requests A single request
     * @returns
     * @description Initializes new dispatch requests but does not broadcast them.
     */
    createDispatchRequest(request: Request): import("../https").KwikPikSendableHTTPsService<InitRequestResponse>;
    /**
     *
     * @param requestId ID of initialized request
     * @returns
     * @description Confirms initialized dispatch requests after user has paid from their wallet. Throws an error for a request that wasn't paid for
     */
    confirmDispatchRequest(requestId: string): import("../https").KwikPikSendableHTTPsService<ConfirmRequestResponse>;
    /**
     *
     * @param requestId The request ID
     * @description Retrieves a single request using its ID
     * @returns
     */
    getSingleRequest(requestId: string): import("../https").KwikPikCallableHTTPsService<SingleRequestResponse>;
    /**
     *
     * @param requestId The ID of the request to delete
     * @description Deletes a request. Throws an error if the utilizer is attempting to delete a request they did not create or a request that has already been confirmed.
     * @returns
     */
    deleteRequest(requestId: string): import("../https").KwikPikSendableHTTPsService<DeleteRequestResponse>;
    /**
     *
     * @param requestId ID of the request you want to update
     * @param body Parameters for the request
     * @description Update a request. Must be an unconfirmed request
     * @returns
     */
    updateRequest(requestId: string, body: Partial<Omit<RequestMessage, "userType" | "userId">>): import("../https").KwikPikSendableHTTPsService<UpdateRequestResponse>;
}
export {};
//# sourceMappingURL=requests.d.ts.map