/**
 * @license
 * @preserve
 *
 * Copyright 2026 KeeeX SAS
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy of
 * this software and associated documentation files (the "Software"), to deal in
 * the Software without restriction, including without limitation the rights to
 * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
 * of the Software, and to permit persons to whom the Software is furnished to do
 * so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 * 
 */
import { type AuthenticationMethod } from "./auth.js";
import { type ProgressHandlers } from "./progress.js";
import { type ValidateStatus } from "./status.js";
import type * as apifile from "./apifile.js";
import type * as hook from "./hook.js";
import type * as pagination from "./pagination.js";
import type * as utiltype from "@keeex/utils/types/types.js";
import type * as axios from "axios";
/** Convert from one type to another. */
export type DataFilter<Input, Output> = (input: Input) => utiltype.Awaitable<Output>;
/** Base parameters for all API calls */
export interface DefBase<RequestData, ResponseData> {
    /** Add authentication data */
    authentication?: AuthenticationMethod;
    /** Override `baseUrl` from the main config */
    baseUrl?: string;
    hooks?: hook.Hooks<RequestData, ResponseData>;
    /** HTTP method */
    method: axios.Method;
    /** Disable global hooks for this route */
    disableGlobalHooks?: boolean | hook.DisableHooks;
    /**
     * Queue name.
     *
     * Requests from different queues will be executed in parallel.
     */
    queue?: string;
    /**
     * Predicate to apply to the response.
     *
     * If it fails, the error propagate as if it was a request error.
     */
    responsePredicate?: utiltype.TypePredicate<ResponseData>;
    /**
     * Route to append to the base URL.
     *
     * Route parameters are declared with a `:` prefix
     */
    route: string;
    /**
     * HTTP status value that are accepted as valid.
     *
     * Defaults to accepting any 2XX status.
     */
    validateStatus?: ValidateStatus;
}
/** Used as a replacement type for `headersParams` and `queryParams` */
export type GenericKeyBasedArray = Array<string> | Set<string> | undefined;
export interface JsonInProps<InputType, InputJson> {
    /** Input values to put in headers */
    headersParams?: Array<keyof InputJson> | Set<keyof InputJson>;
    /** Convert the JavaScript data into JSON data */
    inputFilter?: DataFilter<InputType, InputJson>;
    /**
     * Sending a `multipart/form-data` body.
     *
     * If `true`, always send a `multipart/form-data`.
     * If `false`, or undefined, always send a JSON object.
     *
     * If a file is specified while `multipart` is set to `false`, the file will be encoded in a JSON
     * object with the `ApiFileJson` interface.
     * If a file is specified and `multipart` is `undefined`, throw an error.
     */
    multipart?: boolean;
    /** Properties to put in the query part of the URL */
    queryParams?: Array<keyof InputJson> | Set<keyof InputJson>;
}
export interface JsonOutProps<OutputType, OutputJson> {
    /** Convert the JSON data into a JavaScript object */
    outputFilter?: DataFilter<OutputJson, OutputType>;
}
/** Response with details */
export interface FullResponse<OutputType> {
    data: OutputType;
    httpCode: number;
    responseHeaders: axios.AxiosHeaders;
}
/** Response with details */
export interface FullNoResponse {
    httpCode: number;
    responseHeaders: axios.AxiosHeaders;
}
/** Definition of API call NoInNoOut */
export type DefNoInNoOut = DefBase<undefined, undefined>;
/** API call that takes no input, and produce no output */
export type NoInNoOutFn<Result = void> = (progress?: ProgressHandlers) => Promise<Result>;
/** Definition of API call JsonInJsonOut */
export interface DefJsonInJsonOut<InputType, OutputType, InputJson, OutputJson> extends DefBase<InputJson, OutputJson>, JsonInProps<InputType, InputJson>, JsonOutProps<OutputType, OutputJson> {
}
/** API call that takes a JSON in, and gets a JSON out */
export type JsonInJsonOutFn<InputType, OutputType> = (input: InputType, progress?: ProgressHandlers) => Promise<OutputType>;
/** Definition of API call NoInJsonOut */
export interface DefNoInJsonOut<OutputType, OutputJson> extends DefBase<undefined, OutputJson>, JsonOutProps<OutputType, OutputJson> {
}
/** API call that takes no input and gets a JSON out */
export type NoInJsonOutFn<OutputType> = (progress?: ProgressHandlers) => Promise<OutputType>;
/** Definition of API call JsonInNoOut */
export interface DefJsonInNoOut<InputType, InputJson> extends DefBase<InputJson, undefined>, JsonInProps<InputType, InputJson> {
}
/** API call that takes a JSON in and produce no output */
export type JsonInNoOutFn<InputType, Result> = (input: InputType, progress?: ProgressHandlers) => Promise<Result>;
export interface DefPaginatedJsonInJsonOut<InputType, OutputType, InputJson, OutputJson, ExtraProps, ExtraPropsJson, SortKeys, RequestData> extends Omit<DefBase<RequestData, pagination.PaginationOutputType<OutputJson, ExtraPropsJson, SortKeys>>, "responsePredicate">, JsonInProps<InputType, InputJson>, JsonOutProps<OutputType, OutputJson> {
    extraPropsPredicate?: utiltype.TypePredicate<ExtraPropsJson>;
    /** Convert custom top-level props from the response */
    extraPropsFilter?: DataFilter<ExtraPropsJson, ExtraProps>;
    responsePredicate?: utiltype.TypePredicate<OutputJson>;
    /** Check that the value of `SortKeys` are correct (defaults to `isString()`) */
    sortKeysPredicate?: utiltype.TypePredicate<SortKeys>;
}
/** API call that takes a JSON in, and gets a paginated JSON out */
export type PaginatedJsonInJsonOutFn<InputType, SortKeys, Result> = (input: pagination.PaginationInputType<InputType, SortKeys>, progress?: ProgressHandlers) => Promise<Result>;
/** Definition of API call JsonInBinOut */
export interface DefJsonInBinOut<InputType, InputJson> extends DefBase<InputJson, ArrayBuffer>, JsonInProps<InputType, InputJson> {
}
/** API call that takes a JSON in, and return a byte buffer */
export type JsonInBinOutFn<InputType, Result> = (input: InputType, progress?: ProgressHandlers) => Promise<Result>;
/** Definition of API call NoInBinOut */
export type DefNoInBinOut = DefBase<undefined, ArrayBuffer>;
/** Call with no input and a file output */
export type NoInBinOutFn<Result = apifile.ApiFile> = (progress?: ProgressHandlers) => Promise<Result>;
/** Definition of API call binInJsonOut */
export interface DefBinInJsonOut<OutputType, OutputJson> extends DefBase<Uint8Array | Blob, OutputJson>, JsonOutProps<OutputType, OutputJson> {
}
/** API call that takes a file input, and gets a JSON out */
export type BinInJsonOutFn<OutputType> = (input: apifile.SendableFile, headers?: Record<string, string>, progress?: ProgressHandlers) => Promise<OutputType>;
/** Definition of API call binInBinOut */
export type DefBinInBinOut = DefBase<Uint8Array | Blob, ArrayBuffer>;
/** API call that takes a byte buffer input, and return a byte buffer */
export type BinInBinOutFn<Result> = (input: apifile.SendableFile, headers?: Record<string, string>, progress?: ProgressHandlers) => Promise<Result>;
/** Definition of API call binInNoOut */
export type DefBinInNoOut = DefBase<Uint8Array | Blob, undefined>;
export type BinInNoOutFn<Result> = (input: apifile.SendableFile, headers?: Record<string, string>, progress?: ProgressHandlers) => Promise<Result>;