@kloutit/kloutit-sdk
Version:
Kloutit SDK API for client integrations
81 lines (80 loc) • 1.98 kB
TypeScript
/**
* 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 { AxiosInstance, RawAxiosRequestConfig } from 'axios';
export declare const BASE_PATH: string;
/**
*
* @export
*/
export declare const COLLECTION_FORMATS: {
csv: string;
ssv: string;
tsv: string;
pipes: string;
};
/**
*
* @export
* @interface RequestArgs
*/
export interface RequestArgs {
url: string;
options: RawAxiosRequestConfig;
}
/**
*
* @export
*/
export declare enum KloutitEnvironment {
development = "development",
production = "production"
}
/**
*
* @export
* @class BaseAPI
*/
export declare class BaseAPI {
protected axios?: AxiosInstance;
protected configuration: Configuration | undefined;
protected basePath: string;
constructor(configuration?: Configuration, axios?: AxiosInstance);
/**
* Get the base path based on the environment.
* @param environment The environment ('development' or 'production').
* @returns The base path for the API.
*/
private getBasePath;
}
/**
*
* @export
* @class RequiredError
* @extends {Error}
*/
export declare class RequiredError extends Error {
field: string;
constructor(field: string, msg?: string);
}
interface ServerMap {
[key: string]: {
url: string;
description: string;
}[];
}
/**
*
* @export
*/
export declare const operationServerMap: ServerMap;
export {};