betterstackmanager 0.0.1

package/README.md

@@ -0,0 +1,40 @@
+# BSM
+
+BSM is a Node.js module made to make managing Better Stack data easier and quicker.
+
+## Installation
+
+There is a required node version, and it is `>= 6.0.0`.
+
+You must clone this repository (or, at least, the `src` directory) and require the Client object.
+
+```js
+const BSM = require('./src/client/index');
+const client = new BSM();
+const config = require('./config.json');
+
+client.login(config.token);
+```
+
+Once you've done this, you can use the `client` object.
+
+The node version requirement actually depends on the `form-data` sub-dependency included by `axios`.
+
+## Example usage
+
+You should browse the `example` directory to get started with actual examples.
+
+## Documentation
+
+The documentation for this project is contained within the `docs` directory.
+
+## Links
+
+- [Documentation](https://codeberg.org/Cyanic76/BSM.js/src/branch/main/docs)
+- [Discord server](https://cyanic.me/next)
+
+## Contributing & Help
+
+As always, if you're in need of help, don't hesitate to create a new issue or to [join my Discord server](https://cyanic.me/discord).
+
+This project abides by the CCoC.

package/docs/classes/Client.md

@@ -0,0 +1,17 @@
+# Client
+
+The `Client` interface is the main entry point to interact with BetterStack.
+
+> Before creating a new BetterStack client, you must first [get a **global API key**](https://betterstack.com/settings/global-api-tokens).
+
+## `client`
+
+`new Client(token)`
+
+| Value | Type | Required | About |
+|-|-|-|-|
+| `token` | String | true | The global API key. |
+
+## Classes
+
+The Client constructor includes the `incidents` class.

package/docs/classes/Error.md

@@ -0,0 +1,29 @@
+# Errors
+
+The errors generated via this module fall in 3 categories:
+
+- the API errors,
+- the network errors,
+- the request errors.
+
+## APIError
+
+| Value | Type |
+|-|-|
+| name | `APIError` |
+| status | HTTP Response code (usually 4XX or 5XX) |
+| data | The error data. |
+
+# NetworkError
+
+| Value | Type |
+|-|-|
+| name | `NetworkError` |
+| message | The error message. |
+
+# RequestError
+
+| Value | Type |
+|-|-|
+| name | `RequestError` |
+| message | The error message. |

package/docs/classes/IncidentComment.md

@@ -0,0 +1,49 @@
+# IncidentComments
+
+Class: `client.incidentComments`
+
+This is the point from which all incident comments can be managed.
+
+> **Markdown is supported within comments.**
+
+## create(incidentId, incidentCommentText)
+
+Add a comment to an existing incident.
+
+| Value | Type | Required | About |
+|-|-|-|-|
+| `incidentId` | Number | true | Specify the ID of the incident. |
+| `incidentCommentText` | String | true | The text of the comment. |
+
+This can return:
+
+- HTTP 201 if it was successful.
+
+## get(incidentId, incidentCommentId)
+
+Fetch one existing comment from an incident.
+
+| Value | Type | Required | About |
+|-|-|-|-|
+| `incidentId` | Number | true | Specify the ID of the incident. |
+| `incidentCommentId` | Number | true | Specify the ID of the incident comment. |
+
+This can return:
+
+- HTTP 200 with the comment object if it was successful.
+- HTTP 404 if the given comment or incident doesn't exist.
+
+## update(incidentId, incidentCommentId, incidentCommentText)
+
+Edit an existing comment on an incident.
+
+| Value | Type | Required | About |
+|-|-|-|-|
+| `incidentId` | Number | true | Specify the ID of the incident. |
+| `incidentCommentId` | Number | true | Specify the ID of the incident comment. |
+| `incidentCommentText` | String | true | New text of the incident comment. |
+
+This can return:
+
+- HTTP 200 if it was successful.
+- HTTP 404 if the given comment or incident doesn't exist.

package/docs/classes/Incidents.md

@@ -0,0 +1,118 @@
+# Incidents
+
+Class: `client.incidents`
+
+This is the point from which all incidents can be managed.
+
+Status updates can't be managed from here.
+
+## `acknowledge`
+
+`acknowledge(incidentId)`
+
+Acknowledge an existing incident.
+
+| Value | Type | Required | About |
+|-|-|-|-|
+| `incidentId` | Number | true | Specify the ID of the incident. |
+
+This can return:
+
+- HTTP 200 if it was successful,
+- HTTP 409 if that incident was already acknowledged.
+
+## `create`
+
+`create(incidentData)`
+
+Create a new incident. `incidentData` is an object with the following properties.
+
+| Value | Type | Required | About |
+|-|-|-|-|
+| `teamName` | String | true | Specify the team which should own the resource. |
+| `name` | String | true | The title of the incident. |
+| `summary` | String | true | A short summary. |
+| `description` | String | true | A description of the incident. |
+| `call` | Boolean | false | Whether the on-call person should be called. |
+| `sms` | Boolean | false | Whether the on-call person should receive a text message. |
+| `email` | Boolean | false | Whether the on-call person should be notified via email. |
+| `critical_alert` | Boolean | false | Whether a notification ignoring the Do Not Disturb mode and the mute switch should be sent. |
+| `team_wait` | Number | false | Wait time before escalating the incident to the team specified in `teamName`, in seconds. |
+| `policy_id` | String | false | Policy escalation ID with which the incident should be escalated. |
+
+This can return:
+
+- HTTP 201 if the incident was successfully created,
+- HTTP 404 if the token was not provided.
+
+Most optional options can also be found in the [upstream](https://betterstack.com/docs/uptime/api/create-a-new-incident/) documentation.
+
+## `escalate`
+
+`escalate(incidentId, escalationData)`
+
+Escalate an incident to someone else.
+
+| Value | Type | Required | About |
+|-|-|-|-|
+| `incidentId` | Number | true | Specify the ID of the incident. |
+
+Some properties in the `escalationData` value are only required depending on what is the escalation type defined in the `type` value.
+
+| `escalationData` property | Type | Required | About |
+|-|-|-|-|
+| `type` | String | true | Either `User`, `Team`, `Schedule`, `Policy` or `Organization`. |
+| `user_email` | String | | User to escalate this incident to. Either `user_email` or `user_id` is required if `type` is set to `User`. |
+| `user_id` | String | | User to escalate this incident to. Either `user_email` or `user_id` is required if `type` is set to `User`. |
+| `team_name` | String | | Team to escalate this incident to. Either `team_name` or `team_id` is required if `type` is set to `Team`. |
+| `team_id` | String | | Team to escalate this incident to. Either `team_name` or `team_id` is required if `type` is set to `Team`. |
+| `schedule_id` | String | | Schedule to escalate this incident to. Required if `type` is set to `Schedule`. |
+| `policy_id` | String | | Policy to escalate this incident to. Required if `type` is set to `Policy`. |
+
+Other properties of this value can be found in the [upstream](https://betterstack.com/docs/uptime/api/escalate-an-ongoing-incident/) documentation, though they're not required.
+
+This can return:
+
+- HTTP 200 if the incident was successfully escalated,
+- HTTP 409 if the incident was already resolved.
+
+## `get`
+
+Fetch an existing incident.
+
+| Value | Type | Required | About |
+|-|-|-|-|
+| `incidentId` | Number | true | Specify the ID of the incident. |
+
+This can return:
+
+- HTTP 200 with the incident data as an Object if it was successful.
+
+## `remove`
+
+`remove(incidentId)`
+
+Delete an existing incident.
+
+| Value | Type | Required | About |
+|-|-|-|-|
+| `incidentId` | Number | true | Specify the ID of the incident. |
+
+This can return:
+
+- HTTP 204 if it was successful.
+
+## `resolve`
+
+`resolve(incidentId)`
+
+Resolve and close an existing incident.
+
+| Value | Type | Required | About |
+|-|-|-|-|
+| `incidentId` | Number | true | Specify the ID of the incident. |
+
+This can return:
+
+- HTTP 200 if it was successful,
+- HTTP 409 if that incident was already resolved.

package/docs/objects/Incident.md

@@ -0,0 +1,56 @@
+# Incident object
+
+An Incident object has the following properties:
+
+> The namespace is `data`.
+
+## data
+
+The `data` property has many sub-properties, including the following:
+
+| Property | Type | Description |
+|-|-|-|
+| `id` | String | The ID of the incident. |
+| `type` | String | The type that should be "incident". |
+
+## data.attributes
+
+| Property | Type | Description |
+|-|-|-|
+| `name` | String | The name of the incident. |
+| `http_method` | String | Which HTTP method was used. |
+| `cause` | String | The reason why this incident was created. |
+| `url` | String | The URL to the incident. |
+| `started_at` | String | The ISO-formatted timestamp at which the incident started. |
+| `acknowledged_at` | String/null | The ISO-formatted timestamp at which the incident was first acknowledged. This will be `null` if it was automatic or not yet acknowledged. |
+| `acknowledged_by` | String/null | The user who acknowledged that incident. This will be `null` if it was automatic or not yet acknowledged. |
+| `resolved_at` | String/null | The ISO-formatted timestamp at which the incident was resolved. This will be `null` if it was automatic or not yet acknowledged. |
+| `resolved_by` | String/null | The user who acknowledged that incident. This will be `null` if it was automatic or not yet resolved. |
+| `status` | String | The current status of this incident. |
+| `team_name` | String | The team this incident is in. |
+| `response_content` | String | Body of the response that triggered the incident. **undefined/null if it exceeds 500 bytes.** |
+| `response_options` | JSON String | The HTTP response headers. |
+| `response_url` | String | Link to the logs of this incident. **Only if `response_content` is longer than 500 bytes.** |
+| `screenshot_url` | String | A screenshot that was captured when the incident started. |
+| `escalation_policy_id` | String/null | The policy with which that incident was escalated. This will be `null` if it was never or not yet escalated. |
+| `call` | Boolean | If the on-call person was called. |
+| `sms` | Boolean | If the on-call person was sent a text message. |
+| `email` | Boolean | If the on-call person was sent a mail. |
+| `push` | Boolean | If the on-call person was sent a push notification on the app. |
+| `critical_alert` | Boolean | If the incident triggered a critical alert. |
+| `regions` | Array of Strings | The regions in which the monitor that triggered this incident run. |
+| `ssl_certificate_expires_at` | String | The ISO-formatted timestamp at which the SSL certificate will expire if the incident is about a SSL cert problem. |
+| `domain_expires_at` | String | The ISO-formatted timestamp at which the domain will expire if the incident is about a domain expiration problem. |
+
+## included
+
+This is an Array of Objects containing the monitors that triggered that incident.
+
+Each Object may have the following properties:
+
+| Name | Type | Description |
+|-|-|-|
+| `id` | String | The ID of the resource. |
+| `type` | String | The type of resource. |
+
+The type may be "heartbeat" or "monitor". In any case, go to the corresponding page to learn more.

package/docs/objects/IncidentComment.md

@@ -0,0 +1,44 @@
+# Incident Comment object
+
+An Incident Comment object has the following properties:
+
+> The namespace is `data`.
+
+## data
+
+The `data` property has many sub-properties, including the following:
+
+| Property | Type | Description |
+|-|-|-|
+| `id` | String | The ID of the incident comment. |
+| `type` | String | The type that should be "incident_comment". |
+
+## attributes
+
+| Property | Type | Description |
+|-|-|-|
+| `id` | String | The ID of the incident comment. |
+| `comment` | String | The comment. |
+| `user_id` | Number | The ID of the author. |
+| `user_email` | String | The email address of the author. |
+| `created_at` | String | The ISO-formatted timestamp at which the incident comment was created. |
+| `updated_at` | String | The ISO-formatted timestamp at which the incident comment was last edited. |
+
+## Example
+
+```json
+{
+  "data": {
+    "id": "1",
+    "type": "incident_comment",
+    "attributes": {
+      "id": 1,
+      "content": "content",
+      "user_id": 123,
+      "user_email": "test@example.com",
+      "created_at": "2025-06-03T12:10:28.357Z",
+      "updated_at": "2025-06-03T12:10:28.357Z"
+    }
+  }
+}
+```

package/docs/objects/Monitor.md

@@ -0,0 +1,7 @@
+# Monitor object
+
+A Monitor object has the following properties.
+
+> The namespace is `data`.
+
+Get the attributes on the [upstream documentation](https://betterstack.com/docs/uptime/api/monitors-api-response-params/).

package/docs/readme.md

@@ -0,0 +1,10 @@
+# BSM - Better Stack Manager
+
+Manage your Better Stack incidents & more using the API with this library.
+
+You're in the **user-facing documentation**.
+
+## Links
+
+- [Source code](https://codeberg.org/Cyanic76/BSM.js)
+- [Discord server](https://cyanic.me/next)

package/examples/acknowledgeIncident.js

@@ -0,0 +1,15 @@
+const BSM = require('../src/index');
+const config = require('./config.json');
+
+const client = new BSM.Client(config.token);
+
+async function main(incidentId) {
+  try {
+    await client.incidents.acknowledge(incidentId);
+    console.log('Acknowledged incident ', incidentId);
+  } catch(e) {
+    console.error('Failed to acknowledge an incident: ', e.message);
+  }
+};
+
+main('YOUR_INCIDENT_ID');

package/examples/config.template.json

@@ -0,0 +1,4 @@
+{
+  "email": "admin@example.com",
+  "token": "REPLACE_WITH_YOUR_TOKEN"
+}

package/examples/createIncident.js

@@ -0,0 +1,24 @@
+const BSM = require('../src/index');
+const config = require('./config.json');
+
+const client = new BSM.Client(config.token);
+
+async function main(incidentData) {
+  try {
+    const incident = await client.incidents.create(incidentData);
+    console.log('My new incident: ', incident);
+  } catch(e) {
+    console.error('Failed to create an incident:', e.message);
+  }
+};
+
+const incidentData = {
+  requester_email: config.email,
+  name: 'My testing incident',
+  summary: 'Something went wrong.',
+  description: 'Something went horribly wrong!',
+  email: true,
+  teamName: 'Main'
+}
+
+main(incidentData);

package/examples/createIncidentComment.js

@@ -0,0 +1,18 @@
+const BSM = require('../src/index');
+const config = require('./config.json');
+
+const client = new BSM.Client(config.token);
+
+async function main(incidentId, incidentCommentText) {
+  try {
+    await client.incidentComments.create(incidentId, incidentCommentText);
+    console.log('Added this comment to the incident ', incidentId);
+  } catch(e) {
+    console.error('Failed to add a comment to this incident: ', e.message);
+  }
+};
+
+main(
+  'YOUR_INCIDENT_ID',
+  'YOUR_COMMENT_TEXT'
+);

package/examples/getSingleIncident.js

@@ -0,0 +1,16 @@
+const BSM = require('../src/index');
+const config = require('./config.json');
+
+const client = new BSM.Client(config.token);
+
+async function main(incidentId) {
+  try {
+    const incident = await client.incidents.get(incidentId);
+    console.log(incident.included);
+  } catch(e) {
+    console.error('Failed to fetch that incident!');
+    console.log(e);
+  }
+};
+
+main(875155703);

package/examples/readme.md

@@ -0,0 +1,36 @@
+# BSM - Better Stack Manager
+
+Manage your Better Stack incidents & more using the API with this library.
+
+You're in the **code examples**.
+
+## Specifying correct configuration data
+
+You'll need to have, at least,
+- your **global API** key,
+- a mail address.
+
+## Following examples
+
+All examples show how to get your BSM client up and running.
+
+## acknowledgeIncident.js
+
+This short example acknowledges an incident with the given ID.
+
+## createIncident.js
+
+This short example creates an incident with the given name, summary and explanation.
+
+## createIncidentComment.js
+
+This example appends a new comment to an existing incident.
+
+## resolveIncident.js
+
+This example resolves an existing incident with the given ID.
+
+## Links
+
+- [Source code](https://codeberg.org/Cyanic76/BSM.js)
+- [Discord server](https://cyanic.me/next)

package/examples/resolveIncident.js

@@ -0,0 +1,15 @@
+const BSM = require('../src/index');
+const config = require('./config.json');
+
+const client = new BSM.Client(config.token);
+
+async function main(incidentId) {
+  try {
+    await client.incidents.acknowledge(incidentId);
+    console.log('Resolved incident ', incidentId);
+  } catch(e) {
+    console.error('Failed to resolve an incident: ', e.message);
+  }
+};
+
+main('YOUR_INCIDENT_ID');

package/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "betterstackmanager",
+  "version": "0.0.1",
+  "description": "Interact with Better Stack in Node.JS",
+  "license": "GPL-3.0-only",
+  "author": "Cyanic76",
+  "type": "commonjs",
+  "main": "src/index.js",
+  "directories": {
+    "doc": "docs",
+    "example": "examples",
+    "lib": "src"
+  },
+  "dependencies": {
+    "axios": "^1.13.2"
+  }
+}

package/src/client/index.js

@@ -0,0 +1,64 @@
+const axios = require('axios');
+
+const Incidents = require('../etc/Incident');
+const IncidentComments = require('../etc/IncidentComment');
+
+const { handleError } = require('../errors/Error');
+
+class Client {
+  constructor(token, baseURL = 'https://uptime.betterstack.com/api/'){
+
+    if(!token || token == '') throw new Error('No token was provided.');
+
+    this.client = axios.create({
+      baseURL,
+      headers: {
+        'Authorization': `Bearer ${token}`,
+        'Content-Type': 'application/json'
+      }
+    });
+
+    // Get the right classes as found in the folder.
+    this.incidents = new Incidents(this);
+    this.incidentComments = new IncidentComments(this);
+  }
+
+  async delete (endpoint) {
+    try {
+      const response = await this.client.delete(endpoint);
+      return response.data;
+    } catch(error) {
+      handleError(error);
+    }
+  }
+
+  async get (endpoint, params = {}) {
+    try {
+      const response = await this.client.get(endpoint, { params });
+      return response.data;
+    } catch(error) {
+      handleError(error);
+    }
+  }
+
+  async patch (endpoint, data = {}) {
+    try {
+      const response = await this.client.patch(endpoint, data);
+      return response.data;
+    } catch(error) {
+      handleError(error);
+    }
+  }
+
+  async post (endpoint, data = {}) {
+    try {
+      const response = await this.client.post(endpoint, data);
+      return response.data;
+    } catch(error) {
+      handleError(error);
+    }
+  }
+
+}
+
+module.exports = { Client };

package/src/errors/Error.js

@@ -0,0 +1,55 @@
+class APIError extends Error {
+  constructor(message, status, data){
+    super(message);
+    this.name = 'APIError';
+    this.status = status;
+    this.data = data;
+  }
+};
+
+class NetworkError extends Error {
+  constructor(message) {
+    super(message);
+    this.name = 'NetworkError';
+  }
+};
+
+class RequestError extends Error {
+  constructor(message) {
+    super(message);
+    this.name = 'RequestError';
+  }
+};
+
+/**
+ * Manages API errors.
+ * @param {Error} error - The Axios error.
+ * @throws {APIError|NetworkError|RequestError}
+*/
+function handleError(error) {
+  if(error.response) {
+    // API replied with an error status.
+    throw new APIError(
+      `API Error: ${error.response.status}`,
+      error.response.status,
+      error.response.data
+    );
+  }
+  
+  // If request didn't reach API.
+  else if (error.request) {
+    throw new NetworkError('NetworkError: Did not get a response from API.');
+  }
+
+  // If a bad request was sent.
+  else {
+    throw new RequestError(`RequestError: ${error.message}`);
+  }
+};
+
+module.exports = {
+  handleError,
+  APIError,
+  NetworkError,
+  RequestError
+};

package/src/etc/Incident.js

@@ -0,0 +1,145 @@
+class Incidents {
+  /**
+   * @param {string} token
+   * @param {string} baseURL
+   */
+  constructor(client) {
+    this.client = client;
+  };
+
+  /**
+   * Create a new incident.
+   * @param {object} incidentData 
+   * @returns {Promise<Object>} - The new incident
+   */
+  async create(incidentData) {
+
+    // Before trying anything, check some things right away.
+    if(!incidentData.teamName) throw new Error("Incident creation: teamName is a required incident option.");
+    if(!incidentData.name) throw new Error("Incident creation: name is a required incident option.");
+    if(!incidentData.summary) throw new Error("Incident creation: summary is a required incident option.");
+    if(!incidentData.description) throw new Error("Incident creation: description is a required incident option.");
+    if(!incidentData.email || typeof(incidentData.email) != 'boolean') throw new Error("Incident creation: email is a required boolean incident option.");
+
+    // Modify a copy of the provided object.
+    const data = { ...incidentData };
+
+    // Rename variables.
+    if('teamName' in data){ data.team_name = data.teamName; delete data.teamName };
+    
+    try {
+      return await this.client.post('/v3/incidents', data);
+    } catch(error) {
+      throw error;
+    }
+  };
+
+  /**
+   * Acknowledge an existing incident.
+   * @param {Number} incidentId - The ID of the incident.
+   * @returns 
+   */
+
+  async acknowledge(incidentId) {
+    if(!incidentId) throw new Error("Incident acknowledgement: incidentId is a required incident option.");
+    if(isNaN(incidentId)) throw new Error("Incident acknowledgement: incidentId is not a Number.");
+
+    try {
+      return await this.client.post(`/v3/incidents/${incidentId}/acknowledge`);
+    } catch(error) {
+      throw error;
+    }
+  };
+
+  /**
+   * Fetch an existing incident.
+   * @param {Number} incidentId 
+   * @returns 
+   */
+
+  async get(incidentId) {
+    if(!incidentId) throw new Error("Incident fetching: incidentId is a required incident option.");
+    if(isNaN(incidentId)) throw new Error("Incident acknowledgement: incidentId is not a Number.");
+
+    try {
+      return await this.client.get(`/v3/incidents/${incidentId}`);
+    } catch(error) {
+      throw error;
+    }
+  };
+
+  /**
+   * Resolve an existing incident.
+   * @param {Number} incidentId 
+   * @returns 
+   */
+
+  async resolve(incidentId) {
+    if(!incidentId) throw new Error("Incident resolution: incidentId is a required incident option.");
+    if(isNaN(incidentId)) throw new Error("Incident acknowledgement: incidentId is not a Number.");
+
+    try {
+      return await this.client.post(`/v3/incidents/${incidentId}/resolve`);
+    } catch(error) {
+      throw error;
+    }
+  };
+
+  /**
+   * Escalate an ongoing incident
+   * @param {Number} incidentId 
+   * @param {Object} escalationData 
+   * @returns 
+   */
+
+  async escalate(incidentId, escalationData){
+
+    // Before trying anything, check some things right away.
+    if(!incidentId || !escalationData) throw new Error("Incident resolution: incidentId and escalationData are required incident options.");
+    if(isNaN(incidentId)) throw new Error("Incident acknowledgement: incidentId is not a Number.");
+    const allowedTypes = ["User", "Team", "Schedule", "Policy", "Organization"];
+    if(!allowedTypes.includes(escalationData.type)) throw new Error("Incident resolution: Escalation Type is invalid.");
+
+    switch(escalationData.type){
+      case 'User':
+        if(!escalationData.user_email && !escalationData.user_id) throw new Error("Incident resolution: when escalating to User, either user_id or user_email must be passed.");
+        break;
+      case 'Team':
+        if(!escalationData.team_name && !escalationData.team_id) throw new Error("Incident resolution: when escalating to Team, either team_id or team_name must be passed.");
+        break;
+      case 'Schedule':
+        if(!escalationData.schedule_id) throw new Error("Incident resolution: when escalating to Schedule, schedule_id must be passed.");
+        break;
+      case 'Policy':
+        if(!escalationData.policy_id) throw new Error("Incident resolution: when escalating to Policy, policy_id must be passed.");
+        break;
+      default:break;
+    }
+
+    try {
+      return await this.client.post(`/v3/incidents/${incidentId}/escalate`, { escalation_type: escalationType });
+    } catch(error) {
+      throw error;
+    }
+  }
+
+  /**
+   * Delete an existing incident.
+   * @param {Number} incidentId 
+   * @returns 
+   */
+  async remove(incidentId){
+
+    if(!incidentId) throw new Error("Incident deletion: incidentId is a required incident option.");
+    if(isNaN(incidentId)) throw new Error("Incident acknowledgement: incidentId is not a Number.");
+
+    try {
+      return await this.client.remove(`/v3/incidents/${incidentId}`);
+    } catch(error) {
+      throw error;
+    }
+
+  }
+}
+
+module.exports = Incidents;

package/src/etc/IncidentComment.js

@@ -0,0 +1,72 @@
+class IncidentComments {
+  /**
+   * @param {string} token
+   * @param {string} baseURL
+   */
+  constructor(client) {
+    this.client = client;
+  };
+
+  /**
+   * Add a comment to an existing incident.
+   * @param {Number} incidentId 
+   * @param {String} incidentCommentText 
+   * @returns 
+   */
+  async create(incidentId, incidentCommentText) {
+
+    if(!incidentId || !incidentCommentText) throw new Error("Incident comment creation: incidentId and incidentCommentText are required options.");
+    if(isNaN(incidentId)) throw new Error("Incident comment creation: incidentId must be a Number.");
+    
+    try {
+      return await this.client.post(`/v2/incidents/${incidentId}/comments`, {
+        content: incidentCommentText
+      });
+    } catch(error) {
+      throw error;
+    }
+  };
+
+  /**
+   * Get an existing comment on an incident.
+   * @param {Number} incidentId 
+   * @param {Number} incidentCommentId 
+   * @returns
+   */
+  async get(incidentId, incidentCommentId) {
+
+    if(!incidentId || !incidentCommentId) throw new Error("Incident comment fetch: incidentId, incidentCommentId are required options.");
+    if(isNaN(incidentId) || isNaN(incidentCommentId)) throw new Error("Incident comment fetch: incidentId and incidentCommentId must both be Numbers.");
+
+    try {
+      return await this.client.get(`/v2/incidents/${incidentId}/comments/${incidentCommentId}`);
+    } catch(error) {
+      throw error;
+    }
+
+  }
+
+  /**
+   * Edit an existing incident comment.
+   * @param {Number} incidentId 
+   * @param {Number} incidentCommentId 
+   * @param {String} incidentCommentText 
+   * @returns 
+   */
+  async update(incidentId, incidentCommentId, incidentCommentText) {
+    
+    if(!incidentId || !incidentCommentId || !incidentCommentText ) throw new Error("Incident comment update: incidentId, incidentCommentId, incidentCommentText are required options.");
+    if(isNaN(incidentId) || isNaN(incidentCommentId)) throw new Error("Incident comment update: incidentId and incidentCommentId must both be Numbers.");
+
+    try {
+      return await this.client.patch(`/v2/incidents/${incidentId}/comments/${incidentCommentId}`, {
+        content: incidentCommentText
+      });
+    } catch(error) {
+      throw error;
+    }
+  }
+
+}
+
+module.exports = { IncidentComments };

package/src/index.js

@@ -0,0 +1,8 @@
+const { Client } = require('./client');
+const { Incidents } = require('./etc/Incident');
+
+module.exports = {
+  Client,
+
+  Incidents,
+};