box-node-sdk/lib-esm/managers/users.d.ts

Official SDK for Box Plaform APIs

/**
 * @fileoverview Manager for the Box User Resource
 */
import BoxClient from '../box-client';
import { Readable } from 'stream';
/**
 * Simple manager for interacting with all 'User' endpoints and actions.
 *
 * @constructor
 * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
 * @returns {void}
 */
declare class Users {
    client: BoxClient;
    CURRENT_USER_ID: string;
    constructor(client: BoxClient);
    /**
     * Requests information for the Box user info associated with a given ID
     *
     * API Endpoint: '/users/:id'
     * Method: GET
     *
     * @param {string} userID - The ID of the user to retrieve
     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
     * @param {Function} [callback] - passed the user info if it was acquired successfully
     * @returns {Promise<Object>} A promise resolving to the user object
     */
    get(userID: string, options?: Record<string, any>, callback?: Function): any;
    /**
     * Update some information about a user.
     *
     * API Endpoint: '/users/:id'
     * Method: PUT
     *
     * @param {string} userID - The ID of the user to update
     * @param {Object} updates - User fields to update
     * @param {Function} [callback] - Passed the updated user information if it was acquired successfully
     * @returns {Promise<Object>} A promise resolving to the updated user object
     */
    update(userID: string, updates: Record<string, any>, callback?: Function): any;
    /**
     * Deletes a user in an enterprise account.
     *
     * API Endpoint: '/users/:userID'
     * Method: DELETE
     *
     * @param {string} userID - The ID of the user to delete
     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
     * @param {boolean} [options.notify] - Determines if the destination user should receive email notification of the transfer.
     * @param {boolean} [options.force] - Whether or not the user should be deleted even if this user still own files.
     * @param {Function} [callback] - Empty response body passed if successful, error otherwise
     * @returns {Promise<void>} A promise resolving to nothing
     */
    delete(userID: string, options?: {
        notify?: boolean;
        force?: boolean;
    }, callback?: Function): any;
    /**
     * Get all linked email addresses for a user.
     *
     * API Endpoint: '/users/:id/email_aliases'
     * Method: GET
     *
     * @param {string} userID - The ID of the user to retrieve email alises for
     * @param {Function} [callback] - Passed the email aliases if successful
     * @returns {Promise<Object>} A promise resolving to the collection of email aliases
     */
    getEmailAliases(userID: string, callback?: Function): any;
    /**
     * Add a linked email address to a user's account.
     *
     * API Endpoint: '/users/:id/email_aliases'
     * Method: POST
     *
     * @param {string} userID - The ID of the user to add an email alias to
     * @param {string} email - The email address to add
     * @param {Object} [options] - Optional parameters
     * @param {boolean} [options.is_confirmed=false] Whether or not to attempt to auto-confirm the alias (for admins)
     * @param {Function} [callback] - Passed the new alias if successful
     * @returns {Promise<Object>} A promise resolving to the new email alias
     */
    addEmailAlias(userID: string, email: string, options?: {
        is_confirmed?: boolean;
    } | Function, callback?: Function): any;
    /**
     * Remove a linked email address from the current user by alias ID.
     *
     * API Endpoint: '/users/:id/email_aliases/:aliasID'
     * Method: DELETE
     *
     * @param {string} userID - The ID of the user to remove the email alias from
     * @param {string} aliasID - The ID of the linked email alias to remove
     * @param {Function} [callback] - Passed nothing on success
     * @returns {Promise<void>} A promise resolving to nothing
     */
    removeEmailAlias(userID: string, aliasID: string, callback?: Function): any;
    /**
     * Retrieve a list of group memberships for the user, which show which groups
     * the user belongs to.  This ability is restricted to group admins.
     *
     * API Endpoint: '/users/:userID/memberships'
     * Method: GET
     *
     * @param {string} userID - The ID of the user to get group memberships for
     * @param {Object} [options] - Optional parameters, can be left null in most cases
     * @param {int} [options.limit] - The number of memberships to retrieve
     * @param {int} [options.offset] - Paging marker, retrieve records starting at this position in the list
     * @param {Function} [callback] - Passed a list of memberships if successful, error otherwise
     * @returns {Promise<Object>} A promise resolving to the collection of group memberships
     */
    getGroupMemberships(userID: string, options?: {
        limit?: number;
        offset?: number;
    }, callback?: Function): any;
    /**
     * Retrieve the user's avatar image.
     *
     * API Endpoint: '/users/:userID/avatar'
     * Method: GET
     *
     * @param {string} userID The ID of the user whose avatar should be retrieved
     * @param {Function} [callback] Passed a stream over the bytes of the avatar image if successful
     * @returns {Promise<Readable>} A promise resolving to the image stream
     */
    getAvatar(userID: string, callback?: Function): any;
    /**
     * Set the user's avatar image.
     *
     * API Endpoint: '/users/:userID/avatar'
     * Method: POST
     *
     * @param {string} userID The ID of the user whose avatar should be set
     * @param {string|Buffer|ReadStream} avatar - the content of the file. It can be a string, a Buffer, or a read stream
     * (like that returned by fs.createReadStream()).
     * @param {Function} [callback] Passed dictionary of picture urls if successful
     * @returns {Promise<Object>} A promise resolving to the picture urls
     */
    setAvatar(userID: string, avatar: string | Buffer | Readable, callback?: Function): any;
    /**
     * Delete the user's avatar image.
     *
     * API Endpoint: '/users/:userID/avatar'
     * Method: DELETE
     *
     * @param {string} userID The ID of the user whose avatar should be deleted
     * @param {Function} [callback] Passed nothing if successful
     * @returns {Promise<void>} A promise resolving to nothing
     */
    deleteAvatar(userID: string, callback?: Function): any;
    /**
     * Validates the roles and permissions of the user,
     * and creates asynchronous jobs to terminate the user's sessions.
     *
     * API Endpoint: '/users/terminate_sessions'
     * Method: POST
     *
     * @param {Object} options - The user IDs or logins to terminate sessions
     * @param {string[]} [options.userIDs] - The user IDs to terminate sessions
     * @param {string[]} [options.userLogins] - The user logins to terminate sessions
     * @returns {Promise<Object>} A promise resolving a message about the request status.
     */
    terminateSession(options: {
        userIDs?: string[];
        userLogins?: string[];
    }, callback?: Function): any;
}
/**
 * @module box-node-sdk/lib/managers/users
 * @see {@Link Users}
 */
export = Users;