tag.js

  1. /**
  2.  * @class
  3.  * @classdesc API for the Tag entities, which give extra visual information about a given entity.
  4.  */
  5. export const TagAPI = superclass =>
  6.     class extends superclass {
  7.         /**
  8.          * Returns all tags in the registry.
  9.          *
  10.          * @memberof TagAPI
  11.          * @param {Object} options An object of options to configure the query and
  12.          * its results.
  13.          * @returns {Promise} The tag result list.
  14.          */
  15.         async listTags(options = {}) {
  16.             const url = this.baseUrl + "tags";
  17.             const contents = await this.get(url, options);
  18.             return contents;
  19.         }
  21.         /**
  22.          * Creates a new tag with the provided information.
  23.          *
  24.          * @memberof TagAPI
  25.          * @param {Tag} payload An object that contains information about a tag.
  26.          * @returns {Promise} The created person.
  27.          */
  28.         async createTag(payload) {
  29.             const url = this.baseUrl + "tags";
  30.             const tag = await this.post(url, { dataJ: payload });
  31.             return tag;
  32.         }
  34.         /**
  35.          * Returns the tag with the provided name.
  36.          *
  37.          * @memberof TagAPI
  38.          * @param {String} name The name of the tag.
  39.          * @returns {Promise} The tag requested.
  40.          */
  41.         async getTag(name) {
  42.             const url = this.baseUrl + `tags/${name}`;
  43.             const tag = await this.get(url);
  44.             return tag;
  45.         }
  47.         /**
  48.          * Updates the tag with the provided information.
  49.          *
  50.          * @memberof TagAPI
  51.          * @param {String} name The name of the tag.
  52.          * @param {Object} payload An object that contains information about a tag.
  53.          * @returns {Promise} The updated tag.
  54.          */
  55.         async updateTag(name, payload) {
  56.             const url = this.baseUrl + `tags/${name}`;
  57.             const tag = await this.put(url, { dataJ: payload });
  58.             return tag;
  59.         }
  61.         /**
  62.          * Deletes the tag with the provided name.
  63.          *
  64.          * @memberof TagAPI
  65.          * @param {String} name The name of the tag.
  66.          * @returns {Promise} Empty response.
  67.          */
  68.         async deleteTag(name) {
  69.             const url = this.baseUrl + `tags/${name}`;
  70.             const tag = await this.delete(url);
  71.             return tag;
  72.         }
  73.     };
  75. export default TagAPI;