box-node-sdk/lib-esm/managers/shared-items.js

Official SDK for Box Plaform APIs

"use strict";
/**
 * @fileoverview Manager for the Shared Items
 */
var __importDefault = (this && this.__importDefault) || function (mod) {
    return (mod && mod.__esModule) ? mod : { "default": mod };
};
// ------------------------------------------------------------------------------
// Requirements
// ------------------------------------------------------------------------------
const http_status_1 = __importDefault(require("http-status"));
const errors_1 = __importDefault(require("../util/errors"));
// ------------------------------------------------------------------------------
// Private
// ------------------------------------------------------------------------------
const BASE_PATH = '/shared_items';
// ------------------------------------------------------------------------------
// Public
// ------------------------------------------------------------------------------
/**
 * Simple manager for interacting with all 'Shared Item' endpoints and actions.
 *
 * @constructor
 * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
 * @returns {void}
 */
class SharedItems {
    constructor(client) {
        this.client = client;
    }
    /**
     * Requests a Box item associated with a shared link.
     *
     * API Endpoint: '/shared_items'
     * Method: GET
     *
     * @param {string} url - Shared Link URL
     * @param {string} [password] - Shared Link Password (null if no password)
     * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
     * @param {Function} [callback] - passed the shared item if it was successfully acquired
     * @returns {Promise<Object>} A promise resolving to the shared item object
     */
    get(url, password, options, callback) {
        var params = {
            qs: options,
            headers: {
                BoxApi: this.client.buildSharedItemAuthHeader(url, password),
            },
        };
        // Handle the Special API Response
        return this.client
            .get(BASE_PATH, params)
            .then((response /* FIXME */) => {
            switch (response.statusCode) {
                // 200 - Shared Item Recieved
                case http_status_1.default.OK:
                    return response.body;
                // 403 - Incorrect or missing password
                // Propagate an error explaining that the password is either missing or incorrect
                case http_status_1.default.FORBIDDEN:
                    var errMessage = password
                        ? 'Incorrect shared link password'
                        : 'Shared link password missing';
                    throw errors_1.default.buildResponseError(response, errMessage);
                // Unexpected Response
                default:
                    throw errors_1.default.buildUnexpectedResponseError(response);
            }
        })
            .asCallback(callback);
    }
}
module.exports = SharedItems;
//# sourceMappingURL=shared-items.js.map