api/Notifications.js

  1. const fetch = require('node-fetch');
  2. const Trello = require('../trello');
  3. const BASE_URL = 'https://api.trello.com/1/notifications';
  5. /**
  6.  * Get notification by id.
  7.  * @async
  8.  * @function
  9.  * @memberOf Trello
  10.  * @param {string} idNotification
  11.  * @param {Object} options - {board, board_fields, card, card_fields, display, entities, fields, list, member, member_fields, memberCreator, memberCreator_fields, organization, organization_fields}
  12.  * @returns {Promise<*>}
  13.  */
  14. Trello.prototype.getNotification = async function (idNotification, options) {
  15.     const Defaults = {
  16.         board: '',
  17.         board_fields: '',
  18.         card: '',
  19.         card_fields: '',
  20.         display: '',
  21.         entities: '',
  22.         fields: '',
  23.         list: '',
  24.         member: '',
  25.         member_fields: '',
  26.         memberCreator: '',
  27.         memberCreator_fields: '',
  28.         organization: '',
  29.         organization_fields: '',
  30.     }
  31.     let url = `${BASE_URL}/${idNotification}?key=${this.key}&token=${this.token}`;
  32.     options = Object.assign({}, Defaults, options);
  33.     for (let key in options) {
  34.         if (options[key] !== '') {
  35.             url += `&${key}=${options[key]}`;
  36.         }
  37.     }
  38.     const response = await fetch(url, {method: 'GET', headers: this.headers})
  39.     const json = await response.json();
  40.     return json;
  41. }
  43. /**
  44.  * Update notification Read status by id.
  45.  * @async
  46.  * @function
  47.  * @memberOf Trello
  48.  * @param {string} idNotification
  49.  * @param {Object} options - {unread}
  50.  * @returns {Promise<*>}
  51.  */
  52. Trello.prototype.updateNotificationReadStatus = async function (idNotification, options) {
  53.     const Defaults = {
  54.         unread: '',
  55.     }
  56.     let url = `${BASE_URL}/${idNotification}?key=${this.key}&token=${this.token}`;
  57.     options = Object.assign({}, Defaults, options);
  58.     for (let key in options) {
  59.         if (options[key] !== '') {
  60.             url += `&${key}=${options[key]}`;
  61.         }
  62.     }
  63.     const response = await fetch(url, {method: 'PUT', headers: this.headers})
  64.     const json = await response.json();
  65.     return json;
  66. }
  68. /**
  69.  * Get notification field by id.
  70.  * @async
  71.  * @function
  72.  * @memberOf Trello
  73.  * @param {string} idNotification
  74.  * @param {string} field
  75.  * @returns {Promise<*>}
  76.  */
  77. Trello.prototype.getNotificationField = async function (idNotification, field) {
  78.     const url = `${BASE_URL}/${idNotification}/${field}?key=${this.key}&token=${this.token}`;
  79.     const response = await fetch(url, {method: 'GET', headers: this.headers})
  80.     const json = await response.json();
  81.     return json;
  82. }
  84. /**
  85.  * Mark all notifications as read.
  86.  * @async
  87.  * @function
  88.  * @memberOf Trello
  89.  * @param {string} options - {read, ids}
  90.  * @returns {Promise<*>}
  91.  */
  92. Trello.prototype.markAllNotificationsAsRead = async function (options) {
  93.     const Defaults = {
  94.         read: '',
  95.         ids: '',
  96.     }
  97.     let url = `${BASE_URL}/all/read?key=${this.key}&token=${this.token}`;
  98.     options = Object.assign({}, Defaults, options);
  99.     for (let key in options) {
  100.         if (options[key] !== '') {
  101.             url += `&${key}=${options[key]}`;
  102.         }
  103.     }
  104.     const response = await fetch(url, {method: 'POST', headers: this.headers})
  105.     const json = await response.json();
  106.     return json;
  107. }
  109. /**
  110.  * Update notifications read status.
  111.  * @async
  112.  * @function
  113.  * @memberOf Trello
  114.  * @param id
  115.  * @param options - {value}
  116.  * @returns {Promise<*>}
  117.  */
  118. Trello.prototype.updateNotificationsReadStatus = async function (id, options){
  119.     const Defaults = {
  120.         value: '',
  121.     }
  122.     let url = `${BASE_URL}/${id}/unread?key=${this.key}&token=${this.token}`;
  123.     options = Object.assign({}, Defaults, options);
  124.     for (let key in options) {
  125.         if (options[key] !== '') {
  126.             url += `&${key}=${options[key]}`;
  127.         }
  128.     }
  129.     const response = await fetch(url, {method: 'PUT', headers: this.headers})
  130.     const json = await response.json();
  131.     return json;
  132. }
  134. /**
  135.  * Get notification board by id.
  136.  * @async
  137.  * @function
  138.  * @memberOf Trello
  139.  * @param {string} idNotification
  140.  * @param {Object} options - {fields}
  141.  * @returns {Promise<*>}
  142.  */
  143. Trello.prototype.getNotificationBoard = async function (idNotification, options) {
  144.     const Defaults = {
  145.         fields: '',
  146.     }
  147.     let url = `${BASE_URL}/${idNotification}/board?key=${this.key}&token=${this.token}`;
  148.     options = Object.assign({}, Defaults, options);
  149.     for (let key in options) {
  150.         if (options[key] !== '') {
  151.             url += `&${key}=${options[key]}`;
  152.         }
  153.     }
  154.     const response = await fetch(url, {method: 'GET', headers: this.headers})
  155.     const json = await response.json();
  156.     return json;
  157. }
  159. /**
  160.  * Get notification card by id.
  161.  * @async
  162.  * @function
  163.  * @memberOf Trello
  164.  * @param {string} idNotification
  165.  * @param {string} options - {fields}
  166.  * @returns {Promise<*>}
  167.  */
  168. Trello.prototype.getNotificationCard = async function (idNotification, options) {
  169.     const Defaults = {
  170.         fields: '',
  171.     }
  172.     let url = `${BASE_URL}/${idNotification}/card?key=${this.key}&token=${this.token}`;
  173.     options = Object.assign({}, Defaults, options);
  174.     for (let key in options) {
  175.         if (options[key] !== '') {
  176.             url += `&${key}=${options[key]}`;
  177.         }
  178.     }
  179.     const response = await fetch(url, {method: 'GET', headers: this.headers})
  180.     const json = await response.json();
  181.     return json;
  182. }
  184. /**
  185.  * Get notification list by id.
  186.  * @async
  187.  * @function
  188.  * @memberOf Trello
  189.  * @param {string} idNotification
  190.  * @param {Object} options - {fields}
  191.  * @returns {Promise<*>}
  192.  */
  193. Trello.prototype.getNotificationList = async function (idNotification, options) {
  194.     const Defaults = {
  195.         fields: '',
  196.     }
  197.     let url = `${BASE_URL}/${idNotification}/list?key=${this.key}&token=${this.token}`;
  198.     options = Object.assign({}, Defaults, options);
  199.     for (let key in options) {
  200.         if (options[key] !== '') {
  201.             url += `&${key}=${options[key]}`;
  202.         }
  203.     }
  204.     const response = await fetch(url, {method: 'GET', headers: this.headers})
  205.     const json = await response.json();
  206.     return json;
  207. }
  209. /**
  210.  * Get notification member by id.
  211.  * @async
  212.  * @function
  213.  * @memberOf Trello
  214.  * @param {string} idNotification
  215.  * @param {Object} options - {fields}
  216.  * @returns {Promise<*>}
  217.  */
  218. Trello.prototype.getNotificationMember = async function (idNotification, options) {
  219. const Defaults = {
  220.         fields: '',
  221.     }
  222.     let url = `${BASE_URL}/${idNotification}/member?key=${this.key}&token=${this.token}`;
  223.     options = Object.assign({}, Defaults, options);
  224.     for (let key in options) {
  225.         if (options[key] !== '') {
  226.             url += `&${key}=${options[key]}`;
  227.         }
  228.     }
  229.     const response = await fetch(url, {method: 'GET', headers: this.headers})
  230.     const json = await response.json();
  231.     return json;
  232. }
  234. /**
  235.  * Get notification member creator by id.
  236.  * @async
  237.  * @function
  238.  * @memberOf Trello
  239.  * @param {string} idNotification
  240.  * @param {Object} options - {fields}
  241.  * @returns {Promise<*>}
  242.  */
  243. Trello.prototype.getNotificationMemberCreator = async function (idNotification, options) {
  244.     const Defaults = {
  245.         fields: '',
  246.     }
  247.     let url = `${BASE_URL}/${idNotification}/memberCreator?key=${this.key}&token=${this.token}`;
  248.     options = Object.assign({}, Defaults, options);
  249.     for (let key in options) {
  250.         if (options[key] !== '') {
  251.             url += `&${key}=${options[key]}`;
  252.         }
  253.     }
  254.     const response = await fetch(url, {method: 'GET', headers: this.headers})
  255.     const json = await response.json();
  256.     return json;
  257. }
  259. /**
  260.  * Get notification organization by id.
  261.  * @async
  262.  * @function
  263.  * @memberOf Trello
  264.  * @param {string} idNotification
  265.  * @param {Object} options - {fields}
  266.  * @returns {Promise<*>}
  267.  */
  268. Trello.prototype.getNotificationOrganization = async function (idNotification, options) {
  269.     const Defaults = {
  270.         fields: '',
  271.     }
  272.     let url = `${BASE_URL}/${idNotification}/organization?key=${this.key}&token=${this.token}`;
  273.     options = Object.assign({}, Defaults, options);
  274.     for (let key in options) {
  275.         if (options[key] !== '') {
  276.             url += `&${key}=${options[key]}`;
  277.         }
  278.     }
  279.     const response = await fetch(url, {method: 'GET', headers: this.headers})
  280.     const json = await response.json();
  281.     return json;
  282. }