sideshift-node-sdk/dist/types/common.d.ts

TypeScript Client for SideShift.ai API

export type RateCategory = 'shift' | 'quote' | 'default';
export interface RateConfig {
    shift: number;
    quote: number;
    default: number;
}
export interface SideShiftConfig {
    baseUrl: string;
    maxRequest: RateConfig;
    privateKey: string;
    affiliateId: string;
    verbose?: boolean;
}
export interface ApiResponse<T> {
    success: boolean;
    data: T | null;
    error?: string;
    status?: number;
}
export interface RateState {
    count: number;
    windowStart: number;
}
export interface RateMap {
    shift: RateState;
    quote: RateState;
    default: RateState;
}
export interface ExecuteOptions {
    auth?: boolean;
    affiliateId?: boolean;
    userIp?: string;
    category?: RateCategory;
    data?: any;
}
export type HttpMethod = 'GET' | 'POST';