@stackfactor/client-api 1.0.0

package/lib/templateDocument.js

@@ -0,0 +1,131 @@
+import axios from "./axios";
+
+export default {
+  /**
+   * Create a new document to an existing template
+   *
+   * @param {String} templateId - the template id
+   * @param {String} parentPhaseId - the parent of the new phase. If null, it will add the phase to the
+   * root of the template
+   * @param {Object} data - new phase data information
+   * @param {String} token - authorization token
+   *
+   */
+  create(templateId, parentPhaseId, data, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        templateId: templateId,
+        parentPhaseId: parentPhaseId,
+        data: data,
+      };
+      let confirmationRequest = axios.put(
+        "api/v1/templates/template/phases/phase/document",
+        requestData,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Delete an existing document from a template
+   *
+   * @param {String} templateId - the template id
+   * @param {String} documentId - the document id
+   * @param {String} token - authorization token
+   *
+   */
+  delete(templateId, documentId, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        templateId: templateId,
+        documentId: documentId,
+      };
+      let confirmationRequest = axios.delete(
+        `api/v1/templates/template/phases/phase/document`,
+        { headers: { authorization: token }, data: requestData }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Move an existing document
+   *
+   * @param {String} templateId - the template id
+   * @param {String} documentId - the id of the document to be moved
+   * @param {String} newParentPhaseId - the new parent phase id
+   * @param {String} token - authorization token
+   *
+   */
+  move(templateId, documentId, newParentPhaseId, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        templateId: templateId,
+        documentId: documentId,
+        newParentPhaseId: newParentPhaseId,
+      };
+      let confirmationRequest = axios.patch(
+        "api/v1/templates/template/phases/phase/document/move",
+        requestData,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Update an existing document phase
+   *
+   * @param {String} templateId - template id
+   * @param {String} documentId - document id
+   * @param {Object} data - data containing the updated document information
+   * @param {String} token - authorization token
+   *
+   */
+  update(templateId, documentId, data, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        templateId: templateId,
+        documentId: documentId,
+        data: data,
+      };
+      let confirmationRequest = axios.patch(
+        "api/v1/templates/template/phases/phase/document",
+        requestData,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+};

package/lib/templatePhase.js

@@ -0,0 +1,134 @@
+import axios from "./axios";
+
+export default {
+  /**
+   * Add a new phase to an existing template
+   *
+   * @param {String} templateId - the template id
+   * @param {String} parentPhaseId - the parent of the new phase. If null, it will add the phase to the root
+   * of the template
+   * @param {Object} data - new phase data information
+   * @param {String} token - authorization token
+   *
+   */
+  create(templateId, parentPhaseId, data, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        templateId: templateId,
+        data: data,
+      };
+      if (parentPhaseId) requestData.parentPhaseId = parentPhaseId;
+      let confirmationRequest = axios.put(
+        "api/v1/templates/template/phases/phase",
+        requestData,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Delete an existing phase
+   *
+   * @param {String} templateId - the template id
+   * @param {String} phaseId - the phase id
+   * @param {String} token - authorization token
+   *
+   */
+  delete(templateId, phaseId, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        templateId: templateId,
+        phaseId: phaseId,
+      };
+      let confirmationRequest = axios.delete(
+        `api/v1/templates/template/phases/phase`,
+        {
+          headers: { authorization: token },
+          data: requestData,
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Move an existing phase
+   *
+   * @param {String} templateId - the template id
+   * @param {String} phaseId - the id of the phase to be moved
+   * @param {String} newParentPhaseId - the new parent phase id
+   * @param {String} token - authorization token
+   *
+   */
+  move(templateId, phaseId, newParentPhaseId, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        templateId: templateId,
+        phaseId: phaseId,
+        newParentPhaseId: newParentPhaseId,
+      };
+      let confirmationRequest = axios.patch(
+        "api/v1/templates/template/phases/phase/move",
+        requestData,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Update an existing template phase
+   *
+   * @param {String} templateId - template id
+   * @param {String} phaseId - phase id
+   * @param {Object} data - data containing the new phase information
+   * @param {String} token - authorization token
+   *
+   */
+  update(templateId, phaseId, data, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        templateId: templateId,
+        phaseId: phaseId,
+        data: data,
+      };
+      let confirmationRequest = axios.patch(
+        "api/v1/templates/template/phases/phase",
+        requestData,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+};

package/lib/templateRelease.js

@@ -0,0 +1,98 @@
+import axios from "./axios";
+
+export default {
+  /**
+   * Create a new release to an existing template
+   *
+   * @param {string} templateId - the template id
+   * @param {Object} data - new phase data information
+   * @param {string} token - authorization token
+   *
+   */
+  create(templateId, data, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        templateId: templateId,
+        data: data,
+      };
+      let confirmationRequest = axios.put(
+        "api/v1/templates/template/releases/release",
+        requestData,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Delete an existing release from a template
+   *
+   * @param {string} templateId - the template id
+   * @param {string} releaseId - the document id
+   * @param {string} token - authorization token
+   *
+   */
+  delete(templateId, releaseId, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        templateId: templateId,
+        releaseId: releaseId,
+      };
+      let confirmationRequest = axios.delete(
+        `api/v1/templates/template/releases/release`,
+        {
+          data: requestData,
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Update an existing release
+   *
+   * @param {string} templateId - template id
+   * @param {string} releaseId - release id
+   * @param {Object} data - data containing the updated document information
+   * @param {string} token - authorization token
+   *
+   */
+  update(templateId, releaseId, data, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        templateId: templateId,
+        releaseId: releaseId,
+        data: data,
+      };
+      let confirmationRequest = axios.patch(
+        "api/v1/templates/template/releases/release",
+        requestData,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+};

package/lib/templates.js

@@ -0,0 +1,159 @@
+import axios from "./axios";
+
+export default {
+  axios: axios,
+
+  /**
+   *
+   * Create template and set information
+   *
+   * @param {Object} data New template data information
+   * @param {String} token Authorization token
+   *
+   */
+  createTemplate(data, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        data: data,
+      };
+      let confirmationRequest = axios.put("api/v1/templates", requestData, {
+        headers: { authorization: token },
+      });
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Delete template
+   *
+   * @param {number} id The id of the template to be deleted
+   * @param {String} token Authorization token
+   *
+   */
+  deleteTemplate(id, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        id: id,
+      };
+      let confirmationRequest = axios.delete(`api/v1/templates/`, {
+        headers: { authorization: token },
+        data: requestData,
+      });
+      confirmationRequest
+        .then((response) => {
+          resolve(response);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Get template information
+   *
+   * @param {number} id The id of the template
+   * @param {String} token Authorization token
+   *
+   */
+  getTemplateInformationById(id, version, token) {
+    return new Promise(function (resolve, reject) {
+      let confirmationRequest = axios.get(`api/v1/templates/${id}/${version}`, {
+        headers: { authorization: token },
+      });
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Get template information
+   *
+   * @param {Object} filter The filter used to select the template
+   * @param {String} token Authorization token
+   */
+  getTemplateList(filter, version, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        filter: filter ? filter : "",
+        version: version,
+      };
+      let confirmationRequest = axios.post(`api/v1/templates`, requestData, {
+        headers: { authorization: token },
+      });
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Publish template
+   *
+   * @param {number} id The id of the template to be published
+   * @param {String} token Authorization token
+   */
+  publishTemplate(id, token) {
+    return new Promise(function (resolve, reject) {
+      let confirmationRequest = axios.post(
+        `api/v1/templates/publish/${id}`,
+        {},
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Set template profile information
+   *
+   * @param {String} id The id of the template to be updated
+   * @param {Object} data Data used to update the template
+   * @param {String} token Authorization token
+   *
+   */
+  setTemplateInformation(id, data, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        data: data,
+      };
+      let confirmationRequest = axios.post(
+        `api/v1/templates/${id}`,
+        requestData,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+};

package/lib/tenants.js

@@ -0,0 +1,60 @@
+import axios from "./axios";
+
+export default {
+  axios: axios,
+
+  /**
+   * Get tenant information
+   *
+   * @param {String} category Tenant information category
+   * @param {String} token Authorization token
+   */
+  getTenantInformation(categories, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        categories: categories,
+      };
+      let request = axios.post("api/v1/tenants/tenant/get", requestData, {
+        headers: { authorization: token },
+      });
+      request
+        .then((response) => {
+          resolve(response.data ? response.data : null);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+
+  /**
+   * Set tenant profile information
+   *
+   * @param {String} category Tenant information category
+   * @param {String} data New or updated tenant data information
+   * @param {Object} token Authorization token
+   *
+   */
+  setTenantInformation(category, data, token) {
+    return new Promise(function (resolve, reject) {
+      const requestData = {
+        category: category,
+        data: data,
+      };
+      let confirmationRequest = axios.post(
+        "api/v1/tenants/tenant/set",
+        requestData,
+        {
+          headers: { authorization: token },
+        }
+      );
+      confirmationRequest
+        .then((response) => {
+          resolve(response.data);
+        })
+        .catch((error) => {
+          reject(error);
+        });
+    });
+  },
+};