Source: managers/shared-items.ts

  1. /**
  2.  * @fileoverview Manager for the Shared Items
  3.  */
  5. // ------------------------------------------------------------------------------
  6. // Requirements
  7. // ------------------------------------------------------------------------------
  9. import httpStatusCodes from 'http-status';
  10. import BoxClient from '../box-client';
  11. import errors from '../util/errors';
  13. // ------------------------------------------------------------------------------
  14. // Private
  15. // ------------------------------------------------------------------------------
  17. const BASE_PATH = '/shared_items';
  19. // ------------------------------------------------------------------------------
  20. // Public
  21. // ------------------------------------------------------------------------------
  23. /**
  24.  * Simple manager for interacting with all 'Shared Item' endpoints and actions.
  25.  *
  26.  * @constructor
  27.  * @param {BoxClient} client - The Box API Client that is responsible for making calls to the API
  28.  * @returns {void}
  29.  */
  30. class SharedItems {
  31. 	client: BoxClient;
  33. 	constructor(client: BoxClient) {
  34. 		this.client = client;
  35. 	}
  37. 	/**
  38. 	 * Requests a Box item associated with a shared link.
  39. 	 *
  40. 	 * API Endpoint: '/shared_items'
  41. 	 * Method: GET
  42. 	 *
  43. 	 * @param {string} url - Shared Link URL
  44. 	 * @param {string} [password] - Shared Link Password (null if no password)
  45. 	 * @param {Object} [options] - Additional options for the request. Can be left null in most cases.
  46. 	 * @param {Function} [callback] - passed the shared item if it was successfully acquired
  47. 	 * @returns {Promise<Object>} A promise resolving to the shared item object
  48. 	 */
  49. 	get(
  50. 		url: string,
  51. 		password: string,
  52. 		options?: Record<string, any>,
  53. 		callback?: Function
  54. 	) {
  55. 		var params = {
  56. 			qs: options,
  57. 			headers: {
  58. 				BoxApi: this.client.buildSharedItemAuthHeader(url, password),
  59. 			},
  60. 		};
  62. 		// Handle the Special API Response
  63. 		return this.client
  64. 			.get(BASE_PATH, params)
  65. 			.then((response: any /* FIXME */) => {
  66. 				switch (response.statusCode) {
  67. 					// 200 - Shared Item Recieved
  68. 					case httpStatusCodes.OK:
  69. 						return response.body;
  71. 					// 403 - Incorrect or missing password
  72. 					// Propagate an error explaining that the password is either missing or incorrect
  73. 					case httpStatusCodes.FORBIDDEN:
  74. 						var errMessage = password
  75. 							? 'Incorrect shared link password'
  76. 							: 'Shared link password missing';
  77. 						throw errors.buildResponseError(response, errMessage);
  79. 					// Unexpected Response
  80. 					default:
  81. 						throw errors.buildUnexpectedResponseError(response);
  82. 				}
  83. 			})
  84. 			.asCallback(callback);
  85. 	}
  86. }
  88. /**
  89.  * @module box-node-sdk/lib/managers/shared-items
  90.  * @see {@Link SharedItems}
  91.  */
  92. export = SharedItems;