Source: api/workflow.js

  1. "use strict";
  3. module.exports = WorkflowClient;
  5. /**
  6.  * Used to access Jira REST endpoints in '/rest/api/2/workflow'
  7.  *
  8.  * @param {JiraClient} jiraClient
  9.  * @constructor WorkflowClient
  10.  */
  11. function WorkflowClient(jiraClient) {
  12.     this.jiraClient = jiraClient;
  14.     /**
  15.      * Returns all workflows.
  16.      *
  17.      * @method getWorkflows
  18.      * @memberOf WorkflowClient#
  19.      * @param {Object} opts The request options sent to the Jira API
  20.      * @param {string} [opts.workflowName] The name of the workflow to retrieve.
  21.      * @param [callback] Called when the workflow(s) have been retrieved.
  22.      * @return {Promise} Resolved when the workflow(s) have been retrieved.
  23.      */
  24.     this.getWorkflows = function (opts, callback) {
  25.         var qs = {};
  26.         if (opts && typeof opts === 'object' && opts.hasOwnProperty('workflowName')) {
  27.             qs.workflowName = opts.workflowName;
  28.         }
  29.         var options = {
  30.             uri: this.jiraClient.buildURL('/workflow'),
  31.             method: 'GET',
  32.             json: true,
  33.             followAllRedirects: true,
  34.             qs: qs
  35.         };
  37.         return this.jiraClient.makeRequest(options, callback);
  38.     };
  39. }