diff --git a/src/coinbase/types.ts b/src/coinbase/types.ts index 264b079b..978a5e30 100644 --- a/src/coinbase/types.ts +++ b/src/coinbase/types.ts @@ -2,12 +2,20 @@ import { AxiosPromise } from "axios"; import { User as UserModel } from "./../client/api"; /** - * UserAPI client type definition + * UserAPI client type definition. + * Represents the client for User API interactions. + * @typedef {Object} UserAPIClient + * @property {function} getCurrentUser - Retrieves the current user. + * @property {Object} [options] - Axios request options. + * @returns {AxiosPromise} - A promise resolving to the User model. */ export type UserAPIClient = { getCurrentUser(options?): AxiosPromise }; /** - * API clients type definition for the Coinbase SDK + * API clients type definition for the Coinbase SDK. + * Represents the set of API clients available in the SDK. + * @typedef {Object} ApiClients + * @property {UserAPIClient} [user] - The User API client. */ export type ApiClients = { user?: UserAPIClient;