Source: services/api_key_service.js

  1. import util from 'util';
  3. import Constants from '../constants';
  4. import FilteringError from '../errors/general/filtering_error';
  5. import baseService from './base_service';
  7. export default (easypostClient) =>
  8.   /**
  9.    * The ApiKeyService class provides methods for interacting with EasyPost {@link ApiKey} objects.
  10.    * @param {EasyPostClient} easypostClient - The pre-configured EasyPostClient instance to use for API requests with this service.
  11.    */
  12.   class ApiKeyService extends baseService(easypostClient) {
  13.     /**
  14.      * Retrieve all {@link ApiKey API keys} associated with the current authenticated user.
  15.      * See {@link https://docs.easypost.com/docs/api-keys#retrieve-an-api-key EasyPost API Documentation} for more information.
  16.      * @returns {Object} - An object containing the API keys associated with the current authenticated user and its child users.
  17.      */
  18.     static async all(params = {}) {
  19.       const url = 'api_keys';
  21.       return this._all(url, params);
  22.     }
  24.     /**
  25.      * Retrieve API Keys for a specified {@link User user}.
  26.      * See {@link https://docs.easypost.com/docs/api-keys#retrieve-an-api-key EasyPost API Documentation} for more information.
  27.      * @param {string} id - The ID of the user to retrieve keys for.
  28.      * @returns {Array} - List of associated API Keys.
  29.      * @throws {FilteringError} If user or API Keys are not found.
  30.      */
  31.     static async retrieveApiKeysForUser(id) {
  32.       const url = `api_keys`;
  34.       try {
  35.         const response = await easypostClient._get(url);
  36.         const user = this._convertToEasyPostObject(response.body);
  38.         if (user.id == id) {
  39.           return user.keys;
  40.         }
  42.         user.children.forEach((child) => {
  43.           if (child.id == id) {
  44.             return child.keys;
  45.           }
  46.         });
  47.       } catch (e) {
  48.         return Promise.reject(e);
  49.       }
  51.       throw new FilteringError({ message: util.format(Constants.NO_OBJECT_FOUND, 'child') });
  52.     }
  53.   };