xcoobee-sdk/src/xcoobee/api/InboxApi.js

The XcooBee SDK is a facility to abstract lower level calls and implement standard behaviors. The XcooBee team is providing this to improve the speed of implementation and show the best practices while interacting with XcooBee.

const ApiUtils = require('./ApiUtils');

/**
 * Deletes an item from the inbox with the specified message ID.
 *
 * @async
 * @param {string} apiUrlRoot - The root of the API URL.
 * @param {ApiAccessToken} apiAccessToken - A valid API access token.
 * @param {string} userCursor - The user's cursor.
 * @param {string} messageId - The ID of the inbox item.
 *
 * @returns {Promise<true>} - The result.
 *
 * @throws {XcooBeeError}
 */
const deleteInboxItem = (apiUrlRoot, apiAccessToken, userCursor, messageId) => {
  const query = `
    mutation deleteInboxItem($userCursor: String!, $messageId: String!) {
      remove_inbox_item(user_cursor: $userCursor, filename: $messageId) {
        trans_id
      }
    }
  `;
  return ApiUtils.createClient(apiUrlRoot, apiAccessToken).request(query, {
    userCursor,
    messageId,
  })
    .then(() => true)
    .catch((err) => {
      throw ApiUtils.transformError(err);
    });
};

/**
 * Fetches an item from the inbox with the specified message ID.
 *
 * @async
 * @param {string} apiUrlRoot - The root of the API URL.
 * @param {ApiAccessToken} apiAccessToken - A valid API access token.
 * @param {string} userCursor - The user's cursor.
 * @param {string} messageId - The ID of the inbox item.
 *
 * @returns {Promise<Object>} - The result.
 * @property {InboxItemDetails} inbox_item - The inbox item details.
 * @property {string} inbox_item.download_link - The inbox item download link.
 * @property {InboxItem} inbox_item.info - The inbox item info.
 *
 * @throws {XcooBeeError}
 */
const getInboxItem = (apiUrlRoot, apiAccessToken, userCursor, messageId) => {
  const query = `
    query getInboxItem($userCursor: String!, $messageId: String!) {
      inbox_item(user_cursor: $userCursor, filename: $messageId) {
        download_link
        info {
          date
          downloaded
          filename
          file_size
          file_tags
          file_type
          from
          from_xcoobee_id
          original_name
          sender {
            from
            from_xcoobee_id
            name
            photo_url
            validation_score
          }
          trans_id
          trans_name
          user_ref
        }
      }
    }
  `;
  return ApiUtils.createClient(apiUrlRoot, apiAccessToken).request(query, {
    messageId,
    userCursor,
  })
    .then((response) => {
      const { inbox_item } = response;

      return { inbox_item };
    })
    .catch((err) => {
      throw ApiUtils.transformError(err);
    });
};

/**
 * Fetch a page of items from the inbox.
 *
 * @async
 * @param {string} apiUrlRoot - The root of the API URL.
 * @param {ApiAccessToken} apiAccessToken - A valid API access token.
 * @param {string} [after] - Fetch data after this cursor.
 * @param {number} [first] - The maximum count to fetch.
 *
 * @returns {Promise<Object>} - A page of the inbox.
 * @property {InboxItem[]} data - Inbox items for this page.
 * @property {Object} page_info - The page information.
 * @property {boolean} page_info.has_next_page - Flag indicating whether there is
 *   another page of data to may be fetched.
 * @property {string} page_info.end_cursor - The end cursor.
 *
 * @throws {XcooBeeError}
 */
const listInbox = (apiUrlRoot, apiAccessToken, after = null, first = null) => {
  const query = `
    query listInbox($after: String, $first: Int) {
      inbox(after: $after, first: $first) {
        data {
          date
          downloaded
          file_size
          filename
          original_name
          sender {
            from
            from_xcoobee_id
            name
            validation_score
          }
        }
        page_info {
          end_cursor
          has_next_page
        }
      }
    }
  `;
  return ApiUtils.createClient(apiUrlRoot, apiAccessToken).request(query, {
    after,
    first,
  })
    .then((response) => {
      const { inbox } = response;
      const { page_info } = inbox;

      const data = inbox.data.map(item => ({
        messageId: item.filename,
        fileName: item.original_name,
        fileSize: item.file_size,
        sender: {
          ...item.sender,
        },
        receiptDate: item.date,
        downloadDate: item.downloaded,
        expirationDate: item.date,
      }));
      const result = {
        data,
        page_info,
      };
      return result;
    })
    .catch((err) => {
      throw ApiUtils.transformError(err);
    });
};

module.exports = {
  deleteInboxItem,
  getInboxItem,
  listInbox,
};