UNPKG

@kloutit/kloutit-sdk

Version:
62 lines (61 loc) 2.11 kB
/** * API Reference * The Kloutit API is organized around [REST](https://en.wikipedia.org/wiki/REST), it accepts and returns [JSON-encoded](https://www.json.org) bodies, returning standard [HTTP response codes](https://en.wikipedia.org/wiki/List_of_HTTP_status_codes). You can interact with the API directly using your preferred HTTP/REST library. * * The version of the OpenAPI document: 2.0 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import type { Configuration } from "./configuration"; import type { RequestArgs } from "./base"; import type { AxiosInstance, AxiosResponse } from 'axios'; /** * * @export */ export declare const DUMMY_BASE_URL = "https://example.com"; /** * * @throws {RequiredError} * @export */ export declare const assertParamExists: (functionName: string, paramName: string, paramValue: unknown) => void; /** * * @export */ export declare const setApiKeyToObject: (object: any, keyParamName: string, configuration?: Configuration) => Promise<void>; /** * * @export */ export declare const setSearchParams: (url: URL, ...objects: any[]) => void; /** * * @export */ export declare const serializeDataIfNeeded: (value: any, requestOptions: any, configuration?: Configuration) => any; /** * * @export */ export declare const toPathString: (url: URL) => string; /** * * @export */ export declare const createRequestFunction: (axiosArgs: RequestArgs, globalAxios: AxiosInstance, BASE_PATH: string, configuration?: Configuration) => <T = unknown, R = AxiosResponse<T, any>>(axios?: AxiosInstance, basePath?: string) => Promise<R>; /** * Check if the given MIME is a JSON MIME. * JSON MIME examples: * application/json * application/json; charset=UTF8 * APPLICATION/JSON * application/vnd.company+json * @param mime - MIME (Multipurpose Internet Mail Extensions) * @return True if the given MIME is JSON, false otherwise. */ export declare const isJsonMime: (mime: string) => boolean;