@lasuillard/raindrop-client
Version:
An Axios client for Raindrop.io, generated with OpenAPI Generator.
1,506 lines (1,502 loc) • 119 kB
TypeScript
import * as axios from 'axios';
import { AxiosInstance, RawAxiosRequestConfig, AxiosPromise, AxiosRequestConfig, AxiosResponse } from 'axios';
/**
* 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.
*/
interface AWSv4Configuration {
options?: {
region?: string;
service?: string;
};
credentials?: {
accessKeyId?: string;
secretAccessKey?: string;
sessionToken?: string;
};
}
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>);
awsv4?: AWSv4Configuration;
basePath?: string;
serverIndex?: number;
baseOptions?: any;
formDataCtor?: new () => any;
}
declare class Configuration {
/**
* parameter for apiKey security
* @param name security name
*/
apiKey?: string | Promise<string> | ((name: string) => string) | ((name: string) => Promise<string>);
/**
* parameter for basic security
*/
username?: string;
/**
* parameter for basic security
*/
password?: string;
/**
* parameter for oauth2 security
* @param name security name
* @param scopes oauth2 scope
*/
accessToken?: string | Promise<string> | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise<string>);
/**
* parameter for aws4 signature security
* @param {Object} AWS4Signature - AWS4 Signature security
* @param {string} options.region - aws region
* @param {string} options.service - name of the service.
* @param {string} credentials.accessKeyId - aws access key id
* @param {string} credentials.secretAccessKey - aws access key
* @param {string} credentials.sessionToken - aws session token
* @memberof Configuration
*/
awsv4?: AWSv4Configuration;
/**
* override base path
*/
basePath?: string;
/**
* override server index
*/
serverIndex?: number;
/**
* base options for axios calls
*/
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.
*/
interface RequestArgs {
url: string;
options: RawAxiosRequestConfig;
}
declare class BaseAPI {
protected basePath: string;
protected axios: AxiosInstance;
protected configuration: Configuration | undefined;
constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance);
}
interface AcceptInvitation200Response {
'result'?: boolean;
'role'?: Role;
}
interface ChangeCollaboratorAccessLevelRequest {
'role'?: Role;
}
interface CheckURLsExistRequest {
'urls'?: Array<string>;
}
interface CheckURLsExistResponse {
'result': boolean;
'ids': Array<number>;
'duplicates': Array<CheckURLsExistResponseDuplicatesInner>;
'id': number;
}
interface CheckURLsExistResponseDuplicatesInner {
'_id': number;
'link': string;
}
interface Collection {
'_id': number;
'title': string;
'description': string;
'user': UserRef;
'public': boolean;
'view': string;
'count': number;
'cover': Array<string>;
'sort': number;
'expanded': boolean;
'creatorRef': CreatorRef;
'lastAction': string;
'created': string;
'lastUpdate': string;
'slug': string;
'color'?: string;
'access': CollectionAccess;
'author': boolean;
'parent': object | null;
}
interface CollectionAccess {
'draggable': boolean;
'for': number;
'level': number;
'root': boolean;
}
interface CollectionRef {
'$ref': CollectionRefRefEnum;
'$id': number;
'oid'?: number;
}
declare const CollectionRefRefEnum: {
readonly Collections: "collections";
};
type CollectionRefRefEnum = typeof CollectionRefRefEnum[keyof typeof CollectionRefRefEnum];
interface CreateCollectionRequest {
'view': string;
'title': string;
'sort': number;
'public': boolean;
'parent'?: CollectionRef | null;
'cover': Array<string>;
}
interface CreateCollectionResponse {
'result': boolean;
'item': CreateCollectionResponseItem;
}
interface CreateCollectionResponseItem {
'_id': number;
'title': string;
'description': string;
'user': UserRef;
'public': boolean;
'view': string;
'count': number;
'cover': Array<string>;
'sort': number;
'expanded': boolean;
'creatorRef': CreatorRef;
'lastAction': string;
'created': string;
'lastUpdate': string;
'slug': string;
'color'?: string;
'access': CollectionAccess;
'author': boolean;
'parent': object | null;
'__v': number;
}
interface CreateRaindropRequest {
'pleaseParse'?: object;
'created'?: string;
'lastUpdate'?: string;
'order'?: number;
'important'?: boolean;
'tags'?: Array<string>;
'media'?: Array<ParseURLResponseItemMediaInner>;
'cover'?: string;
'collection'?: CreateRaindropRequestCollection;
'type'?: string;
'excerpt'?: string;
'title'?: string;
'link': string;
'highlights'?: Array<CreateRaindropRequestHighlightsInner>;
'reminder'?: object;
}
interface CreateRaindropRequestCollection {
'$id': number;
}
interface CreateRaindropRequestHighlightsInner {
'text': string;
'note': string;
}
interface CreateRaindropResponse {
'result': boolean;
'item': CreateRaindropResponseItem;
}
interface CreateRaindropResponseItem {
'__v': number;
'_id': number;
'collection': CollectionRef | null;
'collectionId': number;
'cover': string;
'created': string;
'creatorRef': CreatorRef;
'domain': string;
'excerpt': string;
'lastUpdate': string;
'link': string;
'media': Array<CreateRaindropResponseItemMediaInner>;
'note': string;
'removed': boolean;
'sort': number;
'tags': Array<string>;
'title': string;
'type': string;
'user': UserRef;
}
interface CreateRaindropResponseItemMediaInner {
'link': string;
'type': string;
}
interface CreateRaindropsResponse {
'result': boolean;
'items': Array<UpdateRaindropResponseItem>;
}
/**
* @type CreatorRef
*/
type CreatorRef = CreatorRefOneOf | number;
interface CreatorRefOneOf {
'_id': number;
'name': string;
'email': string;
'avatar'?: string;
}
interface GetAllHighlightsResponse {
'result': boolean;
'count'?: number;
'items': Array<GetAllHighlightsResponseItemsInner>;
}
interface GetAllHighlightsResponseItemsInner {
'link': string;
'title': string;
'tags': Array<string>;
'_id': string;
'text': string;
'note': string;
'created': string;
'raindropRef': number;
}
interface GetChildCollectionsResponse {
'result': boolean;
'items': Array<GetChildCollectionsResponseItemsInner>;
}
interface GetChildCollectionsResponseItemsInner {
'_id': number;
'title': string;
'description': string;
'user': UserRef;
'public': boolean;
'view': string;
'count': number;
'cover': Array<string>;
'sort': number;
'expanded': boolean;
'creatorRef': CreatorRef;
'lastAction': string;
'created': string;
'lastUpdate': string;
'slug': string;
'color'?: string;
'access': CollectionAccess;
'author': boolean;
'parent': CollectionRef | null;
}
interface GetCollectionResponse {
'result'?: boolean;
'item'?: Collection;
}
interface GetCurrentUserResponse {
'result': boolean;
'user': User;
}
interface GetFeaturedCoversResponse {
'result': boolean;
'items': Array<GetFeaturedCoversResponseItemsInner>;
}
interface GetFeaturedCoversResponseItemsInner {
'title': string;
'link'?: string;
'sort'?: number;
'icons': Array<SearchCoversResponseItemsInnerIconsInner>;
}
interface GetFiltersResponse {
[key: string]: GetFiltersResponseCreatedInner | any;
'result': boolean;
'collectionId': number;
'created': Array<GetFiltersResponseCreatedInner>;
'tags': Array<GetFiltersResponseCreatedInner>;
'types': Array<GetFiltersResponseCreatedInner>;
}
interface GetFiltersResponseCreatedInner {
'_id': string;
'count': number;
}
interface GetHighlightsInCollectionResponse {
'result': boolean;
'count'?: number;
'items': Array<GetAllHighlightsResponseItemsInner>;
}
/**
* @type GetOrRefreshToken200Response
*/
type GetOrRefreshToken200Response = TokenErrorResponse | TokenResponse;
/**
* @type GetOrRefreshTokenRequest
*/
type GetOrRefreshTokenRequest = ObtainToken | RefreshToken;
interface GetPublicUserByNameResponse {
'result': boolean;
'user': GetPublicUserByNameResponseUser;
}
interface GetPublicUserByNameResponseUser {
'_id': number;
'fullName': string;
'name': string;
'email': string;
'avatar': string;
'pro': boolean;
'lastAction': string;
'registered': string;
'lastUpdate': string;
'config': GetPublicUserByNameResponseUserConfig;
'emailConfirmed'?: boolean;
}
interface GetPublicUserByNameResponseUserConfig {
'raindrops_hide': Array<string>;
'nested_view_legacy': boolean;
}
interface GetRaindropResponse {
'result': boolean;
'author': boolean;
'item': GetRaindropResponseItem;
}
interface GetRaindropResponseItem {
'_id': number;
'collection': CollectionRef | null;
'collectionId': number;
'cover': string;
'created': string;
'creatorRef': CreatorRef;
'domain': string;
'excerpt': string;
'highlights': Array<GetRaindropResponseItemHighlightsInner>;
'lastUpdate': string;
'link': string;
'media': Array<CreateRaindropResponseItemMediaInner>;
'note': string;
'removed': boolean;
'sort': number;
'tags': Array<string>;
'title': string;
'type': string;
'user': UserRef;
}
interface GetRaindropResponseItemHighlightsInner {
'text': string;
'note': string;
'created': string;
'lastUpdate': string;
'creatorRef': CreatorRef;
'_id': string;
}
interface GetRaindropsResponse {
'result': boolean;
'collectionId': number;
'count': number;
'items': Array<GetRaindropResponseItem>;
}
interface GetRootCollectionsResponse {
'result': boolean;
'items': Array<Collection>;
}
interface GetSystemCollectionStatsResponse {
'result': boolean;
'items': Array<GetSystemCollectionStatsResponseItemsInner>;
'meta': GetSystemCollectionStatsResponseMeta;
}
interface GetSystemCollectionStatsResponseItemsInner {
'count': number;
'_id': number;
}
interface GetSystemCollectionStatsResponseMeta {
'_id': number;
'pro': boolean;
'changedBookmarksDate': string;
}
interface GetTagsInCollectionResponse {
'result': boolean;
'items': Array<GetFiltersResponseCreatedInner>;
}
interface Group {
'title': string;
'hidden': boolean;
'sort': number;
'collections': Array<number>;
}
interface ImportHTMLBookmarkFileResponse {
'result': boolean;
'items': Array<ImportHTMLBookmarkFileResponseItemFolder>;
'count': ImportHTMLBookmarkFileResponseCount;
}
interface ImportHTMLBookmarkFileResponseCount {
'bookmarks': number;
'folders': number;
'tags': number;
'highlights': number;
'duplicates': number;
}
interface ImportHTMLBookmarkFileResponseItemBookmark {
'link': string;
'title': string;
'excerpt': string;
'created': string;
'lastUpdate': string;
'tags': Array<string>;
'note': string;
'cover': string;
'media': Array<ParseURLResponseItemMediaInner>;
'important': boolean;
'highlights'?: Array<string>;
}
interface ImportHTMLBookmarkFileResponseItemFolder {
'title': string;
'folders': Array<ImportHTMLBookmarkFileResponseItemFolder>;
'bookmarks': Array<ImportHTMLBookmarkFileResponseItemBookmark>;
'created'?: string;
'lastUpdate'?: string;
}
interface MergeCollectionsRequest {
'to'?: number;
'ids'?: Array<number>;
}
interface MergeCollectionsResponse {
'result': boolean;
'modified': number;
'ids': Array<number>;
}
interface ObtainToken {
'grant_type': ObtainTokenGrantTypeEnum;
'code': string;
'client_id': string;
'client_secret': string;
'redirect_uri': string;
}
declare const ObtainTokenGrantTypeEnum: {
readonly AuthorizationCode: "authorization_code";
};
type ObtainTokenGrantTypeEnum = typeof ObtainTokenGrantTypeEnum[keyof typeof ObtainTokenGrantTypeEnum];
interface ParseURLResponse {
'result': boolean;
'item': ParseURLResponseItem;
}
interface ParseURLResponseItem {
'title': string;
'excerpt': string;
'cover': string;
'media': Array<ParseURLResponseItemMediaInner>;
'type': string;
'meta': ParseURLResponseItemMeta;
}
interface ParseURLResponseItemMediaInner {
'link': string;
}
interface ParseURLResponseItemMeta {
'tags': Array<string>;
}
interface RefreshToken {
'client_id': string;
'client_secret': string;
'grant_type': RefreshTokenGrantTypeEnum;
'refresh_token': string;
}
declare const RefreshTokenGrantTypeEnum: {
readonly RefreshToken: "refresh_token";
};
type RefreshTokenGrantTypeEnum = typeof RefreshTokenGrantTypeEnum[keyof typeof RefreshTokenGrantTypeEnum];
interface RemoveAllEmptyCollectionsResponse {
'result': boolean;
'count': number;
}
interface RemoveCollectionsRequest {
'ids'?: Array<number>;
}
interface RemoveCollectionsResponse {
'result': boolean;
'modified': number;
'ids': Array<number>;
}
interface RemoveRaindropResponse {
'result'?: boolean;
'item'?: RemoveRaindropResponseItem;
}
interface RemoveRaindropResponseItem {
'_id': number;
'collection': CollectionRef | null;
'collectionId': number;
'cover': string;
'created': string;
'creatorRef': CreatorRef;
'domain': string;
'excerpt': string;
'lastUpdate': string;
'link': string;
'media': Array<CreateRaindropResponseItemMediaInner>;
'note': string;
'order': number;
'removed': boolean;
'sort': number;
'tags': Array<string>;
'title': string;
'type': string;
'user': UserRef;
}
interface RemoveRaindropsRequest {
'ids'?: Array<number>;
}
interface RemoveRaindropsResponse {
'result': boolean;
'modified': number;
'matched'?: number;
}
interface RemoveTagsFromCollectionRequest {
'tags'?: Array<string>;
}
interface RenameOrMergeTagsRequest {
'replace'?: string;
'tags'?: Array<string>;
}
interface ReorderAllCollectionsRequest {
'sort'?: string;
'expanded'?: boolean;
}
declare const Role: {
readonly Member: "member";
readonly Viewer: "viewer";
};
type Role = typeof Role[keyof typeof Role];
interface SearchCoversResponse {
'result': boolean;
'items': Array<SearchCoversResponseItemsInner>;
}
interface SearchCoversResponseItemsInner {
'title': string;
'icons': Array<SearchCoversResponseItemsInnerIconsInner>;
}
interface SearchCoversResponseItemsInnerIconsInner {
'png': string;
}
interface ShareCollectionRequest {
'role': Role;
'emails': Array<string>;
}
interface ShareCollectionResponse {
'result': boolean;
'token': string;
'link': string;
}
interface SimpleResponse {
'result': boolean;
}
interface SuggestForExistingBookmarkResponse {
'result'?: boolean;
}
interface SuggestForNewBookmarkRequest {
'link'?: string;
}
interface SuggestForNewBookmarkResponse {
'result'?: boolean;
}
interface TokenErrorResponse {
'result': boolean;
'status': number;
'errorMessage': string;
}
interface TokenResponse {
'access_token': string;
'refresh_token': string;
/**
* @deprecated
*/
'expires'?: number;
'expires_in': number;
'token_type': TokenResponseTokenTypeEnum;
}
declare const TokenResponseTokenTypeEnum: {
readonly Bearer: "Bearer";
};
type TokenResponseTokenTypeEnum = typeof TokenResponseTokenTypeEnum[keyof typeof TokenResponseTokenTypeEnum];
interface UpdateCollectionRequest {
'view'?: string;
'title'?: string;
'sort'?: number;
/**
* Collection and raindrops that it contains will be accessible without authentication?
*/
'public'?: boolean;
'parent'?: CollectionRef | null;
'cover'?: Array<string>;
'expanded'?: boolean;
}
interface UpdateCollectionResponse {
'result': boolean;
'item': Collection;
}
interface UpdateCurrentUserRequest {
'groups'?: Array<UpdateCurrentUserRequestGroupsInner>;
'config'?: UserConfig;
'newpassword'?: string;
'oldpassword'?: string;
'fullName'?: string;
'email'?: string;
}
interface UpdateCurrentUserRequestGroupsInner {
'title'?: string;
'hidden'?: boolean;
'sort'?: number;
'collections'?: Array<number>;
}
interface UpdateCurrentUserResponse {
'result': boolean;
'user': User;
'item': User;
}
interface UpdateRaindropResponse {
'result'?: boolean;
'item'?: UpdateRaindropResponseItem;
}
interface UpdateRaindropResponseItem {
'__v': number;
'_id': number;
'collection': CollectionRef | null;
'collectionId': number;
'cover': string;
'created': string;
'creatorRef': CreatorRef;
'domain': string;
'excerpt': string;
'lastUpdate': string;
'link': string;
'media': Array<CreateRaindropResponseItemMediaInner>;
'note': string;
'removed': boolean;
'sort': number;
'tags': Array<string>;
'title': string;
'type': string;
'user': UserRef;
'highlights': Array<GetRaindropResponseItemHighlightsInner>;
}
interface UpdateRaindropsRequest {
'ids'?: Array<number>;
'important'?: boolean;
'tags'?: Array<string>;
'media'?: Array<string>;
'cover'?: string;
'collection'?: UpdateRaindropsRequestCollection;
}
interface UpdateRaindropsRequestCollection {
'$id'?: number;
}
interface UpdateRaindropsResponse {
'result'?: boolean;
'modified'?: number;
'matched'?: number;
}
interface UploadCollectionCoverResponse {
'result': boolean;
'item': UploadCollectionCoverResponseItem;
}
interface UploadCollectionCoverResponseItem {
'_id': number;
'title': string;
'description': string;
'user': UserRef;
'public': boolean;
'view': string;
'count': number;
'cover': Array<string>;
'sort': number;
'expanded': boolean;
'creatorRef': CreatorRef;
'lastAction': string;
'created': string;
'lastUpdate': string;
'slug': string;
'color'?: string;
'access': CollectionAccess;
'author': boolean;
'parent': object | null;
'__v': number;
}
interface UploadFileResponse {
'result': boolean;
'item': UploadFileResponseItem;
}
interface UploadFileResponseItem {
'__v': number;
'_id': number;
'collection': CollectionRef | null;
'collectionId': number;
'cover': string;
'created': string;
'creatorRef': CreatorRef;
'domain': string;
'excerpt': string;
'file': UploadFileResponseItemFile;
'lastUpdate': string;
'link': string;
'media': Array<CreateRaindropResponseItemMediaInner>;
'note': string;
'removed': boolean;
'sort': number;
'tags': Array<string>;
'title': string;
'type': string;
'user': UserRef;
}
interface UploadFileResponseItemFile {
'name': string;
'size': number;
'type': string;
}
interface UploadRaindropCoverResponse {
'result'?: boolean;
'item'?: UploadRaindropCoverResponseItem;
}
interface UploadRaindropCoverResponseItem {
'__v': number;
'_id': number;
'collection': CollectionRef | null;
'collectionId': number;
'cover': string;
'created': string;
'creatorRef': CreatorRef;
'domain': string;
'excerpt': string;
'lastUpdate': string;
'link': string;
'media': Array<CreateRaindropResponseItemMediaInner>;
'note': string;
'removed': boolean;
'sort': number;
'tags': Array<string>;
'title': string;
'type': string;
'user': UserRef;
}
interface User {
'_id': number;
'config': UserConfig;
'dropbox'?: UserDropbox;
'email': string;
'email_MD5'?: string;
'files': UserFiles;
'fullName': string;
'gdrive'?: UserDropbox;
'groups': Array<Group>;
'password': boolean;
'pro': boolean;
'proExpire'?: string;
'registered': string;
'tfa'?: UserTfa;
'name'?: string;
'avatar'?: string;
'lastAction'?: string;
'lastVisit'?: string;
'lastUpdate'?: string;
'emailConfirmed'?: boolean;
}
interface UserConfig {
'broken_level': string;
'font_color'?: string;
'font_size': number;
'lang'?: string;
'last_collection': number;
'raindrops_buttons'?: Array<string>;
'raindrops_hide'?: Array<string>;
'raindrops_search_by_score'?: boolean;
'raindrops_search_incollection'?: boolean;
'raindrops_sort': string;
'default_collection_view'?: string;
'nested_view_legacy'?: boolean;
'add_default_collection'?: number;
'acknowledge'?: Array<string>;
'ai_suggestions'?: boolean;
'filters_hide'?: boolean;
'ai_assistant'?: boolean;
}
interface UserDropbox {
'enabled': boolean;
}
interface UserFiles {
'used': number;
'size': number;
'lastCheckPoint': string;
}
interface UserRef {
'$id': number;
'$ref': string;
}
interface UserTfa {
'enabled'?: boolean;
}
/**
* AuthenticationApi - axios parameter creator
*/
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 - functional programming interface
*/
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>>;
};
/**
* AuthenticationApi - factory interface
*/
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?: RawAxiosRequestConfig): AxiosPromise<void>;
/**
*
* @param {GetOrRefreshTokenRequest} [getOrRefreshTokenRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getOrRefreshToken(getOrRefreshTokenRequest?: GetOrRefreshTokenRequest, options?: RawAxiosRequestConfig): AxiosPromise<GetOrRefreshToken200Response>;
};
/**
* AuthenticationApi - object-oriented interface
*/
declare class AuthenticationApi$1 extends BaseAPI {
/**
*
* @param {string} redirectUri
* @param {string} clientId
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
authorize(redirectUri: string, clientId: string, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<void, any, {}>>;
/**
*
* @param {GetOrRefreshTokenRequest} [getOrRefreshTokenRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getOrRefreshToken(getOrRefreshTokenRequest?: GetOrRefreshTokenRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GetOrRefreshToken200Response, any, {}>>;
}
/**
* CollectionApi - axios parameter creator
*/
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 - functional programming interface
*/
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>>;
};
/**
* CollectionApi - factory interface
*/
declare const CollectionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
/**
*
* @param {number} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
acceptInvitation(id: number, options?: RawAxiosRequestConfig): 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): AxiosPromise<void>;
/**
*
* @param {CreateCollectionRequest} [createCollectionRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createCollection(createCollectionRequest?: CreateCollectionRequest, options?: RawAxiosRequestConfig): AxiosPromise<CreateCollectionResponse>;
/**
*
* @param {number} userId
* @param {number} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteCollaborator(userId: number, id: number, options?: RawAxiosRequestConfig): AxiosPromise<SimpleResponse>;
/**
*
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
emptyTrash(options?: RawAxiosRequestConfig): AxiosPromise<SimpleResponse>;
/**
*
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getChildCollections(options?: RawAxiosRequestConfig): AxiosPromise<GetChildCollectionsResponse>;
/**
*
* @param {number} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getCollaborators(id: number, options?: RawAxiosRequestConfig): AxiosPromise<void>;
/**
*
* @param {number} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getCollection(id: number, options?: RawAxiosRequestConfig): AxiosPromise<GetCollectionResponse>;
/**
*
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFeaturedCovers(options?: RawAxiosRequestConfig): AxiosPromise<GetFeaturedCoversResponse>;
/**
*
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getRootCollections(options?: RawAxiosRequestConfig): AxiosPromise<GetRootCollectionsResponse>;
/**
*
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSystemCollectionStats(options?: RawAxiosRequestConfig): AxiosPromise<GetSystemCollectionStatsResponse>;
/**
*
* @param {MergeCollectionsRequest} [mergeCollectionsRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
mergeCollections(mergeCollectionsRequest?: MergeCollectionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<MergeCollectionsResponse>;
/**
*
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
removeAllEmptyCollections(options?: RawAxiosRequestConfig): AxiosPromise<RemoveAllEmptyCollectionsResponse>;
/**
*
* @param {number} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
removeCollection(id: number, options?: RawAxiosRequestConfig): AxiosPromise<SimpleResponse>;
/**
*
* @param {RemoveCollectionsRequest} [removeCollectionsRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
removeCollections(removeCollectionsRequest?: RemoveCollectionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<RemoveCollectionsResponse>;
/**
*
* @param {ReorderAllCollectionsRequest} [reorderAllCollectionsRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
reorderAllCollections(reorderAllCollectionsRequest?: ReorderAllCollectionsRequest, options?: RawAxiosRequestConfig): AxiosPromise<SimpleResponse>;
/**
*
* @param {string} text
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
searchCovers(text: string, options?: RawAxiosRequestConfig): AxiosPromise<SearchCoversResponse>;
/**
*
* @param {number} id
* @param {ShareCollectionRequest} [shareCollectionRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
shareCollection(id: number, shareCollectionRequest?: ShareCollectionRequest, options?: RawAxiosRequestConfig): AxiosPromise<ShareCollectionResponse>;
/**
*
* @param {number} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
unshareOrLeaveCollection(id: number, options?: RawAxiosRequestConfig): AxiosPromise<SimpleResponse>;
/**
*
* @param {number} id
* @param {UpdateCollectionRequest} [updateCollectionRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
updateCollection(id: number, updateCollectionRequest?: UpdateCollectionRequest, options?: RawAxiosRequestConfig): AxiosPromise<UpdateCollectionResponse>;
/**
*
* @param {number} id
* @param {File} [cover]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
uploadCollectionCover(id: number, cover?: File, options?: RawAxiosRequestConfig): AxiosPromise<UploadCollectionCoverResponse>;
};
/**
* CollectionApi - object-oriented interface
*/
declare class CollectionApi$1 extends BaseAPI {
/**
*
* @param {number} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
acceptInvitation(id: number, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<AcceptInvitation200Response, any, {}>>;
/**
*
* @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.AxiosResponse<void, any, {}>>;
/**
*
* @param {CreateCollectionRequest} [createCollectionRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
createCollection(createCollectionRequest?: CreateCollectionRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<CreateCollectionResponse, any, {}>>;
/**
*
* @param {number} userId
* @param {number} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
deleteCollaborator(userId: number, id: number, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<SimpleResponse, any, {}>>;
/**
*
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
emptyTrash(options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<SimpleResponse, any, {}>>;
/**
*
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getChildCollections(options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GetChildCollectionsResponse, any, {}>>;
/**
*
* @param {number} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getCollaborators(id: number, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<void, any, {}>>;
/**
*
* @param {number} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getCollection(id: number, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GetCollectionResponse, any, {}>>;
/**
*
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getFeaturedCovers(options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GetFeaturedCoversResponse, any, {}>>;
/**
*
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getRootCollections(options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GetRootCollectionsResponse, any, {}>>;
/**
*
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getSystemCollectionStats(options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<GetSystemCollectionStatsResponse, any, {}>>;
/**
*
* @param {MergeCollectionsRequest} [mergeCollectionsRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
mergeCollections(mergeCollectionsRequest?: MergeCollectionsRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<MergeCollectionsResponse, any, {}>>;
/**
*
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
removeAllEmptyCollections(options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<RemoveAllEmptyCollectionsResponse, any, {}>>;
/**
*
* @param {number} id
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
removeCollection(id: number, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<SimpleResponse, any, {}>>;
/**
*
* @param {RemoveCollectionsRequest} [removeCollectionsRequest]
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
removeCollections(removeCollectionsRequest?: RemoveCollectionsRequest, options?: RawAxiosRequestConfig): Promise<axios.AxiosResponse<RemoveCollectionsResponse, any, {}>>;
/**
*
* @param {ReorderAllCollectionsRequest} [reorderAllCollectionsRequest]
* @param {*}