@lasuillard/raindrop-client 0.7.6 → 0.8.0

package/dist/src/client/auth.d.ts

@@ -0,0 +1,18 @@
+import { AxiosRequestConfig, AxiosResponse } from 'axios';
+import { AuthenticationApi as _AuthenticationApi, ObtainToken, RefreshToken, TokenResponse } from '../generated';
+export declare class AuthenticationApi extends _AuthenticationApi {
+    /**
+     * 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>>;
+}

package/dist/src/client/client.d.ts

@@ -0,0 +1,25 @@
+import { AxiosInstance } from 'axios';
+import { Configuration, FilterApi, HighlightApi, ImportApi, TagApi, UserApi } from '../generated';
+import { AuthenticationApi } from './auth';
+import { CollectionApi } from './collection';
+import { RaindropApi } from './raindrop';
+/**
+ * Raindrop API set.
+ *
+ * You can provide auth credentials via `new Configuration({accessToken: ...})` or headers in Axios instances.
+ */
+export declare class Raindrop {
+    /** Axios client instance. If not set, will use default Axios instance. */
+    readonly client: AxiosInstance;
+    /** API global configurations. */
+    readonly configuration: Configuration;
+    readonly auth: AuthenticationApi;
+    readonly user: UserApi;
+    readonly collection: CollectionApi;
+    readonly filter: FilterApi;
+    readonly highlight: HighlightApi;
+    readonly import: ImportApi;
+    readonly raindrop: RaindropApi;
+    readonly tag: TagApi;
+    constructor(configuration?: Configuration, client?: AxiosInstance);
+}

package/dist/src/client/collection.d.ts

@@ -0,0 +1,14 @@
+import { CollectionApi as _CollectionApi, GetChildCollectionsResponse, GetRootCollectionsResponse } from '../generated';
+import { TreeNode } from '../utils/tree';
+type GetRootCollectionsResponseItem = GetRootCollectionsResponse["items"][0];
+type GetChildCollectionsResponseItem = GetChildCollectionsResponse["items"][0];
+export type CollectionItem = GetRootCollectionsResponseItem | GetChildCollectionsResponseItem;
+export declare class CollectionApi extends _CollectionApi {
+    /**
+     * Create structured tree of collections.
+     * @returns Root of tree.
+     * @deprecated This function is deprecated and will be removed in a future release.
+     */
+    getCollectionTree(): Promise<TreeNode<CollectionItem | null>>;
+}
+export {};

package/dist/src/client/index.d.ts

@@ -0,0 +1 @@
+export { Raindrop } from './client';

package/dist/src/client/raindrop.d.ts

@@ -0,0 +1,23 @@
+import { AxiosRequestConfig } from 'axios';
+import { RaindropApi as _RaindropApi, GetRaindropsResponse } from '../generated';
+type RaindropItem = GetRaindropsResponse["items"][0];
+export interface GetAllRaindropsParams {
+    /** Sort option. See https://developer.raindrop.io/v1/raindrops/multiple#common-parameters */
+    sort?: string;
+    /** Size of per page to fetch. Maximum 50 limited by Raindrop.io */
+    pageSize?: number;
+    /** Search query. See details at https://help.raindrop.io/using-search/ */
+    search?: string;
+}
+export declare class RaindropApi extends _RaindropApi {
+    /**
+     * Fetch all raindrops of a collection.
+     * @param collectionId ID of collection.
+     * @param params Request parameters.
+     * @param options Axios request config.
+     * @returns Array of raindrops.
+     * @deprecated This function is deprecated and will be removed in a future release.
+     */
+    getAllRaindrops(collectionId?: number, params?: GetAllRaindropsParams, options?: AxiosRequestConfig<any>): Promise<RaindropItem[]>;
+}
+export {};