@lasuillard/raindrop-client/dist/index.d.ts

Axios client built with OpenAPI generator for Raindrop.io.

import { AxiosInstance } from 'axios';
import { AxiosPromise } from 'axios';
import { AxiosRequestConfig } from 'axios';
import { AxiosResponse } from 'axios';
import { RawAxiosRequestConfig } from 'axios';

/**
 *
 * @export
 * @interface AcceptInvitation200Response
 */
declare interface AcceptInvitation200Response {
    /**
     *
     * @type {boolean}
     * @memberof AcceptInvitation200Response
     */
    'result'?: boolean;
    /**
     *
     * @type {Role}
     * @memberof AcceptInvitation200Response
     */
    'role'?: Role;
}

declare class AuthenticationApi extends AuthenticationApi_2 {
    /**
     * Wrapper function of {@link _AuthenticationApi.getOrRefreshToken} for token exchange.
     * @param request {@link ObtainToken} but without `grant_type` field.
     * @param options Axios request configuration.
     * @returns API response.
     */
    exchangeToken(request: Omit<ObtainToken, "grant_type">, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<TokenResponse, any>>;
    /**
     * Wrapper function of {@link _AuthenticationApi.getOrRefreshToken} for token refresh.
     * @param request {@link RefreshToken} but without `grant_type` field.
     * @param options Axios request configuration.
     * @returns API response.
     */
    refreshToken(request: Omit<RefreshToken, "grant_type">, options?: AxiosRequestConfig<any>): Promise<AxiosResponse<TokenResponse, any>>;
}

/**
 * AuthenticationApi - object-oriented interface
 * @export
 * @class AuthenticationApi
 * @extends {BaseAPI}
 */
declare class AuthenticationApi_2 extends BaseAPI {
    /**
     *
     * @param {string} redirectUri
     * @param {string} clientId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AuthenticationApi
     */
    authorize(redirectUri: string, clientId: string, options?: RawAxiosRequestConfig): Promise<AxiosResponse<void, any>>;
    /**
     *
     * @param {GetOrRefreshTokenRequest} [getOrRefreshTokenRequest]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AuthenticationApi
     */
    getOrRefreshToken(getOrRefreshTokenRequest?: GetOrRefreshTokenRequest, options?: RawAxiosRequestConfig): Promise<AxiosResponse<GetOrRefreshToken200Response, any>>;
}

/**
 * AuthenticationApi - axios parameter creator
 * @export
 */
declare const AuthenticationApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @param {string} redirectUri
     * @param {string} clientId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    authorize: (redirectUri: string, clientId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @param {GetOrRefreshTokenRequest} [getOrRefreshTokenRequest]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getOrRefreshToken: (getOrRefreshTokenRequest?: GetOrRefreshTokenRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};

/**
 * AuthenticationApi - factory interface
 * @export
 */
declare const AuthenticationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @param {string} redirectUri
     * @param {string} clientId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    authorize(redirectUri: string, clientId: string, options?: any): AxiosPromise<void>;
    /**
     *
     * @param {GetOrRefreshTokenRequest} [getOrRefreshTokenRequest]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getOrRefreshToken(getOrRefreshTokenRequest?: GetOrRefreshTokenRequest, options?: any): AxiosPromise<GetOrRefreshToken200Response>;
};

/**
 * AuthenticationApi - functional programming interface
 * @export
 */
declare const AuthenticationApiFp: (configuration?: Configuration) => {
    /**
     *
     * @param {string} redirectUri
     * @param {string} clientId
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    authorize(redirectUri: string, clientId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @param {GetOrRefreshTokenRequest} [getOrRefreshTokenRequest]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getOrRefreshToken(getOrRefreshTokenRequest?: GetOrRefreshTokenRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetOrRefreshToken200Response>>;
};

/**
 *
 * @export
 * @class BaseAPI
 */
declare class BaseAPI {
    protected basePath: string;
    protected axios: AxiosInstance;
    protected configuration: Configuration | undefined;
    constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
}

/**
 *
 * @export
 * @interface ChangeCollaboratorAccessLevelRequest
 */
declare interface ChangeCollaboratorAccessLevelRequest {
    /**
     *
     * @type {Role}
     * @memberof ChangeCollaboratorAccessLevelRequest
     */
    'role'?: Role;
}

/**
 *
 * @export
 * @interface CheckURLsExistRequest
 */
declare interface CheckURLsExistRequest {
    /**
     *
     * @type {Array<string>}
     * @memberof CheckURLsExistRequest
     */
    'urls'?: Array<string>;
}

/**
 *
 * @export
 * @interface CheckURLsExistResponse
 */
declare interface CheckURLsExistResponse {
    /**
     *
     * @type {boolean}
     * @memberof CheckURLsExistResponse
     */
    'result': boolean;
    /**
     *
     * @type {Array<number>}
     * @memberof CheckURLsExistResponse
     */
    'ids': Array<number>;
    /**
     *
     * @type {Array<CheckURLsExistResponseDuplicatesInner>}
     * @memberof CheckURLsExistResponse
     */
    'duplicates': Array<CheckURLsExistResponseDuplicatesInner>;
    /**
     *
     * @type {number}
     * @memberof CheckURLsExistResponse
     */
    'id': number;
}

/**
 *
 * @export
 * @interface CheckURLsExistResponseDuplicatesInner
 */
declare interface CheckURLsExistResponseDuplicatesInner {
    /**
     *
     * @type {number}
     * @memberof CheckURLsExistResponseDuplicatesInner
     */
    '_id': number;
    /**
     *
     * @type {string}
     * @memberof CheckURLsExistResponseDuplicatesInner
     */
    'link': string;
}

declare namespace client {
    export {
        Raindrop
    }
}
export { client }

/**
 *
 * @export
 * @interface Collection
 */
declare interface Collection {
    /**
     *
     * @type {number}
     * @memberof Collection
     */
    '_id': number;
    /**
     *
     * @type {string}
     * @memberof Collection
     */
    'title': string;
    /**
     *
     * @type {string}
     * @memberof Collection
     */
    'description': string;
    /**
     *
     * @type {UserRef}
     * @memberof Collection
     */
    'user': UserRef;
    /**
     *
     * @type {boolean}
     * @memberof Collection
     */
    'public': boolean;
    /**
     *
     * @type {string}
     * @memberof Collection
     */
    'view': string;
    /**
     *
     * @type {number}
     * @memberof Collection
     */
    'count': number;
    /**
     *
     * @type {Array<string>}
     * @memberof Collection
     */
    'cover': Array<string>;
    /**
     *
     * @type {number}
     * @memberof Collection
     */
    'sort': number;
    /**
     *
     * @type {boolean}
     * @memberof Collection
     */
    'expanded': boolean;
    /**
     *
     * @type {CreatorRef}
     * @memberof Collection
     */
    'creatorRef': CreatorRef;
    /**
     *
     * @type {string}
     * @memberof Collection
     */
    'lastAction': string;
    /**
     *
     * @type {string}
     * @memberof Collection
     */
    'created': string;
    /**
     *
     * @type {string}
     * @memberof Collection
     */
    'lastUpdate': string;
    /**
     *
     * @type {string}
     * @memberof Collection
     */
    'slug': string;
    /**
     *
     * @type {string}
     * @memberof Collection
     */
    'color'?: string;
    /**
     *
     * @type {CollectionAccess}
     * @memberof Collection
     */
    'access': CollectionAccess;
    /**
     *
     * @type {boolean}
     * @memberof Collection
     */
    'author': boolean;
    /**
     *
     * @type {object}
     * @memberof Collection
     */
    'parent': object | null;
}

/**
 *
 * @export
 * @interface CollectionAccess
 */
declare interface CollectionAccess {
    /**
     *
     * @type {boolean}
     * @memberof CollectionAccess
     */
    'draggable': boolean;
    /**
     *
     * @type {number}
     * @memberof CollectionAccess
     */
    'for': number;
    /**
     *
     * @type {number}
     * @memberof CollectionAccess
     */
    'level': number;
    /**
     *
     * @type {boolean}
     * @memberof CollectionAccess
     */
    'root': boolean;
}

declare class CollectionApi extends CollectionApi_2 {
    /**
     * Create structured tree of collections.
     * @returns Root of tree.
     */
    getCollectionTree(): Promise<TreeNode<CollectionItem | null>>;
}

/**
 * CollectionApi - object-oriented interface
 * @export
 * @class CollectionApi
 * @extends {BaseAPI}
 */
declare class CollectionApi_2 extends BaseAPI {
    /**
     *
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CollectionApi
     */
    acceptInvitation(id: number, options?: RawAxiosRequestConfig): Promise<AxiosResponse<AcceptInvitation200Response, any>>;
    /**
     *
     * @param {number} userId
     * @param {number} id
     * @param {ChangeCollaboratorAccessLevelRequest} [changeCollaboratorAccessLevelRequest]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CollectionApi
     */
    changeCollaboratorAccessLevel(userId: number, id: number, changeCollaboratorAccessLevelRequest?: ChangeCollaboratorAccessLevelRequest, options?: RawAxiosRequestConfig): Promise<AxiosResponse<void, any>>;
    /**
     *
     * @param {CreateCollectionRequest} [createCollectionRequest]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CollectionApi
     */
    createCollection(createCollectionRequest?: CreateCollectionRequest, options?: RawAxiosRequestConfig): Promise<AxiosResponse<CreateCollectionResponse, any>>;
    /**
     *
     * @param {number} userId
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CollectionApi
     */
    deleteCollaborator(userId: number, id: number, options?: RawAxiosRequestConfig): Promise<AxiosResponse<SimpleResponse, any>>;
    /**
     *
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CollectionApi
     */
    emptyTrash(options?: RawAxiosRequestConfig): Promise<AxiosResponse<SimpleResponse, any>>;
    /**
     *
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CollectionApi
     */
    getChildCollections(options?: RawAxiosRequestConfig): Promise<AxiosResponse<GetChildCollectionsResponse, any>>;
    /**
     *
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CollectionApi
     */
    getCollaborators(id: number, options?: RawAxiosRequestConfig): Promise<AxiosResponse<void, any>>;
    /**
     *
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CollectionApi
     */
    getCollection(id: number, options?: RawAxiosRequestConfig): Promise<AxiosResponse<GetCollectionResponse, any>>;
    /**
     *
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CollectionApi
     */
    getFeaturedCovers(options?: RawAxiosRequestConfig): Promise<AxiosResponse<GetFeaturedCoversResponse, any>>;
    /**
     *
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CollectionApi
     */
    getRootCollections(options?: RawAxiosRequestConfig): Promise<AxiosResponse<GetRootCollectionsResponse, any>>;
    /**
     *
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CollectionApi
     */
    getSystemCollectionStats(options?: RawAxiosRequestConfig): Promise<AxiosResponse<GetSystemCollectionStatsResponse, any>>;
    /**
     *
     * @param {MergeCollectionsRequest} [mergeCollectionsRequest]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CollectionApi
     */
    mergeCollections(mergeCollectionsRequest?: MergeCollectionsRequest, options?: RawAxiosRequestConfig): Promise<AxiosResponse<MergeCollectionsResponse, any>>;
    /**
     *
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CollectionApi
     */
    removeAllEmptyCollections(options?: RawAxiosRequestConfig): Promise<AxiosResponse<RemoveAllEmptyCollectionsResponse, any>>;
    /**
     *
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CollectionApi
     */
    removeCollection(id: number, options?: RawAxiosRequestConfig): Promise<AxiosResponse<SimpleResponse, any>>;
    /**
     *
     * @param {RemoveCollectionsRequest} [removeCollectionsRequest]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CollectionApi
     */
    removeCollections(removeCollectionsRequest?: RemoveCollectionsRequest, options?: RawAxiosRequestConfig): Promise<AxiosResponse<RemoveCollectionsResponse, any>>;
    /**
     *
     * @param {ReorderAllCollectionsRequest} [reorderAllCollectionsRequest]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CollectionApi
     */
    reorderAllCollections(reorderAllCollectionsRequest?: ReorderAllCollectionsRequest, options?: RawAxiosRequestConfig): Promise<AxiosResponse<SimpleResponse, any>>;
    /**
     *
     * @param {string} text
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CollectionApi
     */
    searchCovers(text: string, options?: RawAxiosRequestConfig): Promise<AxiosResponse<SearchCoversResponse, any>>;
    /**
     *
     * @param {number} id
     * @param {ShareCollectionRequest} [shareCollectionRequest]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CollectionApi
     */
    shareCollection(id: number, shareCollectionRequest?: ShareCollectionRequest, options?: RawAxiosRequestConfig): Promise<AxiosResponse<ShareCollectionResponse, any>>;
    /**
     *
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CollectionApi
     */
    unshareOrLeaveCollection(id: number, options?: RawAxiosRequestConfig): Promise<AxiosResponse<SimpleResponse, any>>;
    /**
     *
     * @param {number} id
     * @param {UpdateCollectionRequest} [updateCollectionRequest]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CollectionApi
     */
    updateCollection(id: number, updateCollectionRequest?: UpdateCollectionRequest, options?: RawAxiosRequestConfig): Promise<AxiosResponse<UpdateCollectionResponse, any>>;
    /**
     *
     * @param {number} id
     * @param {File} [cover]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof CollectionApi
     */
    uploadCollectionCover(id: number, cover?: File, options?: RawAxiosRequestConfig): Promise<AxiosResponse<UploadCollectionCoverResponse, any>>;
}

/**
 * CollectionApi - axios parameter creator
 * @export
 */
declare const CollectionApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     *
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    acceptInvitation: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @param {number} userId
     * @param {number} id
     * @param {ChangeCollaboratorAccessLevelRequest} [changeCollaboratorAccessLevelRequest]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    changeCollaboratorAccessLevel: (userId: number, id: number, changeCollaboratorAccessLevelRequest?: ChangeCollaboratorAccessLevelRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @param {CreateCollectionRequest} [createCollectionRequest]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createCollection: (createCollectionRequest?: CreateCollectionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @param {number} userId
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteCollaborator: (userId: number, id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    emptyTrash: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getChildCollections: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getCollaborators: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getCollection: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getFeaturedCovers: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getRootCollections: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getSystemCollectionStats: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @param {MergeCollectionsRequest} [mergeCollectionsRequest]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    mergeCollections: (mergeCollectionsRequest?: MergeCollectionsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    removeAllEmptyCollections: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    removeCollection: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @param {RemoveCollectionsRequest} [removeCollectionsRequest]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    removeCollections: (removeCollectionsRequest?: RemoveCollectionsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @param {ReorderAllCollectionsRequest} [reorderAllCollectionsRequest]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    reorderAllCollections: (reorderAllCollectionsRequest?: ReorderAllCollectionsRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @param {string} text
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    searchCovers: (text: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @param {number} id
     * @param {ShareCollectionRequest} [shareCollectionRequest]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    shareCollection: (id: number, shareCollectionRequest?: ShareCollectionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    unshareOrLeaveCollection: (id: number, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @param {number} id
     * @param {UpdateCollectionRequest} [updateCollectionRequest]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateCollection: (id: number, updateCollectionRequest?: UpdateCollectionRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
    /**
     *
     * @param {number} id
     * @param {File} [cover]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    uploadCollectionCover: (id: number, cover?: File, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
};

/**
 * CollectionApi - factory interface
 * @export
 */
declare const CollectionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     *
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    acceptInvitation(id: number, options?: any): AxiosPromise<AcceptInvitation200Response>;
    /**
     *
     * @param {number} userId
     * @param {number} id
     * @param {ChangeCollaboratorAccessLevelRequest} [changeCollaboratorAccessLevelRequest]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    changeCollaboratorAccessLevel(userId: number, id: number, changeCollaboratorAccessLevelRequest?: ChangeCollaboratorAccessLevelRequest, options?: any): AxiosPromise<void>;
    /**
     *
     * @param {CreateCollectionRequest} [createCollectionRequest]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createCollection(createCollectionRequest?: CreateCollectionRequest, options?: any): AxiosPromise<CreateCollectionResponse>;
    /**
     *
     * @param {number} userId
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteCollaborator(userId: number, id: number, options?: any): AxiosPromise<SimpleResponse>;
    /**
     *
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    emptyTrash(options?: any): AxiosPromise<SimpleResponse>;
    /**
     *
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getChildCollections(options?: any): AxiosPromise<GetChildCollectionsResponse>;
    /**
     *
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getCollaborators(id: number, options?: any): AxiosPromise<void>;
    /**
     *
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getCollection(id: number, options?: any): AxiosPromise<GetCollectionResponse>;
    /**
     *
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getFeaturedCovers(options?: any): AxiosPromise<GetFeaturedCoversResponse>;
    /**
     *
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getRootCollections(options?: any): AxiosPromise<GetRootCollectionsResponse>;
    /**
     *
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getSystemCollectionStats(options?: any): AxiosPromise<GetSystemCollectionStatsResponse>;
    /**
     *
     * @param {MergeCollectionsRequest} [mergeCollectionsRequest]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    mergeCollections(mergeCollectionsRequest?: MergeCollectionsRequest, options?: any): AxiosPromise<MergeCollectionsResponse>;
    /**
     *
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    removeAllEmptyCollections(options?: any): AxiosPromise<RemoveAllEmptyCollectionsResponse>;
    /**
     *
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    removeCollection(id: number, options?: any): AxiosPromise<SimpleResponse>;
    /**
     *
     * @param {RemoveCollectionsRequest} [removeCollectionsRequest]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    removeCollections(removeCollectionsRequest?: RemoveCollectionsRequest, options?: any): AxiosPromise<RemoveCollectionsResponse>;
    /**
     *
     * @param {ReorderAllCollectionsRequest} [reorderAllCollectionsRequest]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    reorderAllCollections(reorderAllCollectionsRequest?: ReorderAllCollectionsRequest, options?: any): AxiosPromise<SimpleResponse>;
    /**
     *
     * @param {string} text
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    searchCovers(text: string, options?: any): AxiosPromise<SearchCoversResponse>;
    /**
     *
     * @param {number} id
     * @param {ShareCollectionRequest} [shareCollectionRequest]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    shareCollection(id: number, shareCollectionRequest?: ShareCollectionRequest, options?: any): AxiosPromise<ShareCollectionResponse>;
    /**
     *
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    unshareOrLeaveCollection(id: number, options?: any): AxiosPromise<SimpleResponse>;
    /**
     *
     * @param {number} id
     * @param {UpdateCollectionRequest} [updateCollectionRequest]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateCollection(id: number, updateCollectionRequest?: UpdateCollectionRequest, options?: any): AxiosPromise<UpdateCollectionResponse>;
    /**
     *
     * @param {number} id
     * @param {File} [cover]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    uploadCollectionCover(id: number, cover?: File, options?: any): AxiosPromise<UploadCollectionCoverResponse>;
};

/**
 * CollectionApi - functional programming interface
 * @export
 */
declare const CollectionApiFp: (configuration?: Configuration) => {
    /**
     *
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    acceptInvitation(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AcceptInvitation200Response>>;
    /**
     *
     * @param {number} userId
     * @param {number} id
     * @param {ChangeCollaboratorAccessLevelRequest} [changeCollaboratorAccessLevelRequest]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    changeCollaboratorAccessLevel(userId: number, id: number, changeCollaboratorAccessLevelRequest?: ChangeCollaboratorAccessLevelRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @param {CreateCollectionRequest} [createCollectionRequest]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createCollection(createCollectionRequest?: CreateCollectionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateCollectionResponse>>;
    /**
     *
     * @param {number} userId
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteCollaborator(userId: number, id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SimpleResponse>>;
    /**
     *
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    emptyTrash(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SimpleResponse>>;
    /**
     *
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getChildCollections(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetChildCollectionsResponse>>;
    /**
     *
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getCollaborators(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     *
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getCollection(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetCollectionResponse>>;
    /**
     *
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getFeaturedCovers(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetFeaturedCoversResponse>>;
    /**
     *
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getRootCollections(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetRootCollectionsResponse>>;
    /**
     *
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getSystemCollectionStats(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSystemCollectionStatsResponse>>;
    /**
     *
     * @param {MergeCollectionsRequest} [mergeCollectionsRequest]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    mergeCollections(mergeCollectionsRequest?: MergeCollectionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<MergeCollectionsResponse>>;
    /**
     *
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    removeAllEmptyCollections(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoveAllEmptyCollectionsResponse>>;
    /**
     *
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    removeCollection(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SimpleResponse>>;
    /**
     *
     * @param {RemoveCollectionsRequest} [removeCollectionsRequest]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    removeCollections(removeCollectionsRequest?: RemoveCollectionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RemoveCollectionsResponse>>;
    /**
     *
     * @param {ReorderAllCollectionsRequest} [reorderAllCollectionsRequest]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    reorderAllCollections(reorderAllCollectionsRequest?: ReorderAllCollectionsRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SimpleResponse>>;
    /**
     *
     * @param {string} text
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    searchCovers(text: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchCoversResponse>>;
    /**
     *
     * @param {number} id
     * @param {ShareCollectionRequest} [shareCollectionRequest]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    shareCollection(id: number, shareCollectionRequest?: ShareCollectionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ShareCollectionResponse>>;
    /**
     *
     * @param {number} id
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    unshareOrLeaveCollection(id: number, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SimpleResponse>>;
    /**
     *
     * @param {number} id
     * @param {UpdateCollectionRequest} [updateCollectionRequest]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    updateCollection(id: number, updateCollectionRequest?: UpdateCollectionRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateCollectionResponse>>;
    /**
     *
     * @param {number} id
     * @param {File} [cover]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    uploadCollectionCover(id: number, cover?: File, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UploadCollectionCoverResponse>>;
};

declare type CollectionItem = GetRootCollectionsResponseItem | GetChildCollectionsResponseItem;

/**
 *
 * @export
 * @interface CollectionRef
 */
declare interface CollectionRef {
    /**
     *
     * @type {string}
     * @memberof CollectionRef
     */
    '$ref': CollectionRefRefEnum;
    /**
     *
     * @type {number}
     * @memberof CollectionRef
     */
    '$id': number;
    /**
     *
     * @type {number}
     * @memberof CollectionRef
     */
    'oid'?: number;
}

declare const CollectionRefRefEnum: {
    readonly Collections: "collections";
};

declare type CollectionRefRefEnum = typeof CollectionRefRefEnum[keyof typeof CollectionRefRefEnum];

declare class Configuration {
    /**
     * parameter for apiKey security
     * @param name security name
     * @memberof Configuration
     */
    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
    /**
     * parameter for basic security
     *
     * @type {string}
     * @memberof Configuration
     */
    username?: string;
    /**
     * parameter for basic security
     *
     * @type {string}
     * @memberof Configuration
     */
    password?: string;
    /**
     * parameter for oauth2 security
     * @param name security name
     * @param scopes oauth2 scope
     * @memberof Configuration
     */
    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
    /**
     * override base path
     *
     * @type {string}
     * @memberof Configuration
     */
    basePath?: string;
    /**
     * override server index
     *
     * @type {number}
     * @memberof Configuration
     */
    serverIndex?: number;
    /**
     * base options for axios calls
     *
     * @type {any}
     * @memberof Configuration
     */
    baseOptions?: any;
    /**
     * The FormData constructor that will be used to create multipart form data
     * requests. You can inject this here so that execution environments that
     * do not support the FormData class can still run the generated client.
     *
     * @type {new () => FormData}
     */
    formDataCtor?: new () => any;
    constructor(param?: ConfigurationParameters);
    /**
     * 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.
     */
    isJsonMime(mime: string): boolean;
}

/**
 * Raindrop API (Unofficial)
 * **UNOFFICIAL** OpenAPI specification of Raindrop API.  This OpenAPI spec has been made by hand with reference to official documentation because it is not provided by Raindrop.io.  Because official documentation not maintained well, there are very (highly) likely to have mismatch in schemas. As we can\'t inspect and address all issues, schema being updated as we find issues.  Any contributions are welcome. Bug report, schema update, adding descriptions or functions, please don\'t hesitate to create an issue.
 *
 * The version of the OpenAPI document: 0.1.0
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
declare interface ConfigurationParameters {
    apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
    username?: string;
    password?: string;
    accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
    basePath?: string;
    serverIndex?: number;
    baseOptions?: any;
    formDataCtor?: new () => any;
}

/**
 * @export
 */
declare const ConnectSocialNetworkProviderProviderEnum: {
    readonly Facebook: "facebook";
    readonly Google: "google";
    readonly Twitter: "twitter";
    readonly Vkontate: "vkontate";
    readonly Dropbox: "dropbox";
    readonly Gdrive: "gdrive";
};

declare type ConnectSocialNetworkProviderProviderEnum = typeof ConnectSocialNetworkProviderProviderEnum[keyof typeof ConnectSocialNetworkProviderProviderEnum];

/**
 *
 * @export
 * @interface CreateCollectionRequest
 */
declare interface CreateCollectionRequest {
    /**
     *
     * @type {string}
     * @memberof CreateCollectionRequest
     */
    'view': string;
    /**
     *
     * @type {string}
     * @memberof CreateCollectionRequest
     */
    'title': string;
    /**
     *
     * @type {number}
     * @memberof CreateCollectionRequest
     */
    'sort': number;
    /**
     *
     * @type {boolean}
     * @memberof CreateCollectionRequest
     */
    'public': boolean;
    /**
     *
     * @type {CollectionRef}
     * @memberof CreateCollectionRequest
     */
    'parent'?: CollectionRef | null;
    /**
     *
     * @type {Array<string>}
     * @memberof CreateCollectionRequest
     */
    'cover': Array<string>;
}

/**
 *
 * @export
 * @interface CreateCollectionResponse
 */
declare interface CreateCollectionResponse {
    /**
     *
     * @type {boolean}
     * @memberof CreateCollectionResponse
     */
    'result': boolean;
    /**
     *
     * @type {CreateCollectionResponseItem}
     * @memberof CreateCollectionResponse
     */
    'item': CreateCollectionResponseItem;
}

/**
 *
 * @export
 * @interface CreateCollectionResponseItem
 */
declare interface CreateCollectionResponseItem {
    /**
     *
     * @type {number}
     * @memberof CreateCollectionResponseItem
     */
    '_id': number;
    /**
     *
     * @type {string}
     * @memberof CreateCollectionResponseItem
     */
    'title': string;
    /**
     *
     * @type {string}
     * @memberof CreateCollectionResponseItem
     */
    'description': string;
    /**
     *
     * @type {UserRef}
     * @memberof CreateCollectionResponseItem
     */
    'user': UserRef;
    /**
     *
     * @type {boolean}
     * @memberof CreateCollectionResponseItem
     */
    'public': boolean;
    /**
     *
     * @type {string}
     * @memberof CreateCollectionResponseItem
     */
    'view': string;
    /**
     *
     * @type {number}
     * @memberof CreateCollectionResponseItem
     */
    'count': number;
    /**
     *
     * @type {Array<string>}
     * @memberof CreateCollectionResponseItem
     */
    'cover': Array<string>;
    /**
     *
     * @type {number}
     * @memberof CreateCollectionResponseItem
     */
    'sort': number;
    /**
     *
     * @type {boolean}
     * @memberof CreateCollectionResponseItem
     */
    'expanded': boolean;
    /**
     *
     * @type {number}
     * @memberof CreateCollectionResponseItem
     */
    'creatorRef': number;
    /**
     *
     * @type {string}
     * @memberof CreateCollectionResponseItem
     */
    'lastAction': string;
    /**
     *
     * @type {string}
     * @memberof CreateCollectionResponseItem
     */
    'created': string;
    /**
     *
     * @type {string}
     * @memberof CreateCollectionResponseItem
     */
    'lastUpdate': string;
    /**
     *
     * @type {string}
     * @memberof CreateCollectionResponseItem
     */
    'slug': string;
    /**
     *
     * @type {string}
     * @memberof CreateCollectionResponseItem
     */
    'color'?: string;
    /**
     *
     * @type {CollectionAccess}
     * @memberof CreateCollectionResponseItem
     */
    'access': CollectionAccess;
    /**
     *
     * @type {boolean}
     * @memberof CreateCollectionResponseItem
     */
    'author': boolean;
    /**
     *
     * @type {object}
     * @memberof CreateCollectionResponseItem
     */
    'parent': object | null;
    /**
     *
     * @type {number}
     * @memberof CreateCollectionResponseItem
     */
    '__v': number;
}

/**
 *
 * @export
 * @interface CreateRaindropRequest
 */
declare interface CreateRaindropRequest {
    /**
     *
     * @type {object}
     * @memberof CreateRaindropRequest
     */
    'pleaseParse'?: object;
    /**
     *
     * @type {string}
     * @memberof CreateRaindropRequest
     */
    'created'?: string;
    /**
     *
     * @type {string}
     * @memberof CreateRaindropRequest
     */
    'lastUpdate'?: string;
    /**
     *
     * @type {number}
     * @memberof CreateRaindropRequest
     */
    'order'?: number;
    /**
     *
     * @type {boolean}
     * @memberof CreateRaindropRequest
     */
    'important'?: boolean;
    /**
     *
     * @type {Array<string>}
     * @memberof CreateRaindropRequest
     */
    'tags'?: Array<string>;
    /**
     *
     * @type {Array<ParseURLResponseItemMediaInner>}
     * @memberof CreateRaindropRequest
     */
    'media'?: Array<ParseURLResponseItemMediaInner>;
    /**
     *
     * @type {string}
     * @memberof CreateRaindropRequest
     */
    'cover'?: string;
    /**
     *
     * @type {CreateRaindropRequestCollection}
     * @memberof CreateRaindropRequest
     */
    'collection'?: CreateRaindropRequestCollection;
    /**
     *
     * @type {string}
     * @memberof CreateRaindropRequest
     */
    'type'?: string;
    /**
     *
     * @type {string}
     * @memberof CreateRaindropRequest
     */
    'excerpt'?: string;
    /**
     *
     * @type {string}
     * @memberof CreateRaindropRequest
     */
    'title'?: string;
    /**
     *
     * @type {string}
     * @memberof CreateRaindropRequest
     */
    'link': string;
    /**
     *
     * @type {Array<CreateRaindropRequestHighlightsInner>}
     * @memberof CreateRaindropRequest
     */
    'highlights'?: Array<CreateRaindropRequestHighlightsInner>;
    /**
     *
     * @type {object}
     * @memberof CreateRaindropRequest
     */
    'reminder'?: object;
}

/**
 *
 * @export
 * @interface CreateRaindropRequestCollection
 */
declare interface CreateRaindropRequestCollection {
    /**
     *
     * @type {number}
     * @memberof CreateRaindropRequestCollection
     */
    '$id': number;
}

/**
 *
 * @export
 * @interface CreateRaindropRequestHighlightsInner
 */
declare interface CreateRaindropRequestHighlightsInner {
    /**
     *
     * @type {string}
     * @memberof CreateRaindropRequestHighlightsInner
     */
    'text': string;
    /**
     *
     * @type {string}
     * @memberof CreateRaindropRequestHighlightsInner
     */
    'note': string;
}

/**
 *
 * @export
 * @interface CreateRaindropResponse
 */
declare interface CreateRaindropResponse {
    /**
     *
     * @type {boolean}
     * @memberof CreateRaindropResponse
     */
    'result': boolean;
    /**
     *
     * @type {CreateRaindropResponseItem}
     * @memberof CreateRaindropResponse
     */
    'item': CreateRaindropResponseItem;
}

/**
 *
 * @export
 * @interface CreateRaindropResponseItem
 */
declare interface CreateRaindropResponseItem {
    /**
     *
     * @type {number}
     * @memberof CreateRaindropResponseItem
     */
    '__v': number;
    /**
     *
     * @type {number}
     * @memberof CreateRaindropResponseItem
     */
    '_id': number;
    /**
     *
     * @type {CollectionRef}
     * @memberof CreateRaindropResponseItem
     */
    'collection': CollectionRef | null;
    /**
     *
     * @type {number}
     * @memberof CreateRaindropResponseItem
     */
    'collectionId': number;
    /**
     *
     * @type {string}
     * @memberof CreateRaindropResponseItem
     */
    'cover': string;
    /**
     *
     * @type {string}
     * @memberof CreateRaindropResponseItem
     */
    'created': string;
    /**
     *
     * @type {CreatorRef}
     * @memberof CreateRaindropResponseItem
     */
    'creatorRef': CreatorRef;
    /**
     *
     * @type {string}
     * @memberof CreateRaindropResponseItem
     */
    'domain': string;
    /**
     *
     * @type {string}
     * @memberof CreateRaindropResponseItem
     */
    'excerpt': string;
    /**
     *
     * @type {string}
     * @memberof CreateRaindropResponseItem
     */
    'lastUpdate': string;
    /**
     *
     * @type {string}
     * @memberof CreateRaindropResponseItem
     */
    'link': string;
    /**
     *
     * @type {Array<CreateRaindropResponseItemMediaInner>}
     * @memberof CreateRaindropResponseItem
     */
    'media': Array<CreateRaindropResponseItemMediaInner>;
    /**
     *
     * @type {string}
     * @memberof CreateRaindropResponseItem
     */
    'note': string;
    /**
     *
     * @type {boolean}
     * @memberof CreateRaindropResponseItem
     */
    'removed': boolean;
    /**
     *
     * @type {number}
     * @memberof CreateRaindropResponseItem
     */
    'sort': number;
    /**
     *
     * @type {Array<string>}
     * @memberof CreateRaindropResponseItem
     */
    'tags': Array<string>;
    /**
     *
     * @type {string}
     * @memberof CreateRaindropResponseItem
     */
    'title': string;
    /**
     *
     * @type {string}
     * @memberof CreateRaindropResponseItem
     */
    'type': string;
    /**
     *
     * @type {UserRef}
     * @memberof CreateRaindropResponseItem
     */
    'user': UserRef;
}

/**
 *
 * @export
 * @interface CreateRaindropResponseItemMediaInner
 */
declare interface CreateRaindropResponseItemMediaInner {
    /**
     *
     * @type {string}
     * @memberof CreateRaindropResponseItemMediaInner
     */
    'link': string;
    /**
     *
     * @type {string}
     * @memberof CreateRaindropResponseItemMediaInner
     */
    'type': string;
}

/**
 *
 * @export
 * @interface CreateRaindropsResponse
 */
declare interface CreateRaindropsResponse {
    /**
     *
     * @type {boolean}
     * @memberof CreateRaindropsResponse
     */
    'result': boolean;
    /**
     *
     * @type {Array<UpdateRaindropResponseItem>}
     * @memberof CreateRaindropsResponse
     */
    'items': Array<UpdateRaindropResponseIte