mpp-sdk/lib/endpoints/users.d.ts

SDK to talk to the Memento Payments Platform

import { BaseEndpoint } from "./base.js";
import { UserSearchInput, PublicUser, UserInput, User } from "../types/user.js";
import { MPPResult } from "../types/index.js";
export default class UsersEndpoint extends BaseEndpoint {
    /**
     * Gets the user by the id. Returns regular User object if
     * the user fetched is the current user. Otherwise returns
     * the public user object.
     * @param id user id
     */
    getById(id: string): Promise<MPPResult<PublicUser | User>>;
    search(data: UserSearchInput): Promise<MPPResult<PublicUser[]>>;
    recents(): Promise<MPPResult<PublicUser[]>>;
    /**
     * Create a user. Newly created users are auto logged in.
     * @param data
     */
    create(data: UserInput): Promise<MPPResult<User>>;
    current(): Promise<MPPResult<User>>;
    updateCurrent(data: UserInput): Promise<MPPResult<User>>;
    /**
     * Checks whether the given username is taken. Returns true if the username
     * is available.
     * @param username
     */
    checkUsername(username: string): Promise<boolean>;
}