@vansite/ts-sharetribe-flex-sdk/dist/endpoints/marketplace/ProcessTransitions.d.ts

This is a TypeScript SDK for Sharetribe Flex API. It reduces the complexity of the API and provides a more user-friendly interface.

/**
 * @fileoverview Client for querying process transitions in the Sharetribe Marketplace API.
 *
 * Process transitions define the state machine of a transaction process (e.g. booking, sale).
 * Use this endpoint to inspect available transitions and their parameters.
 *
 * @see https://www.sharetribe.com/api-reference/marketplace.html#process-transitions
 */
import type { AxiosResponse } from "axios";
import MarketplaceApi from "./index";
import { ProcessTransitionsQueryParameter, ProcessTransitionsResponse } from "../../types";
/**
 * Process Transitions API client
 */
declare class ProcessTransitions {
    readonly authRequired = true;
    private readonly axios;
    private readonly endpoint;
    private readonly headers;
    constructor(api: MarketplaceApi);
    /**
     * Query available process transitions
     *
     * @template P
     * @param {P & ProcessTransitionsQueryParameter} params
     * @returns {Promise<AxiosResponse<ProcessTransitionsResponse<"query">>>}
     *
     * @example
     * // Fetch all transitions for the default booking process
     * const { data } = await sdk.processTransitions.query({
     *   processAlias: "default-booking"
     * });
     *
     * @example
     * // Inspect a specific transition
     * await sdk.processTransitions.query({
     *   lastTransition: "transition/confirm-payment"
     * });
     */
    query<P extends ProcessTransitionsQueryParameter>(params: P): Promise<AxiosResponse<ProcessTransitionsResponse<"query">>>;
}
export default ProcessTransitions;