StatusPages

(statusPages)

Overview

Available Operations

deleteIncident - Remove a status page from an incident
createSubscription - Create a status page subscription
deleteSubscription - Unsubscribe from status page notifications
list - List status pages
create - Create a status page
get - Get a status page
update - Update a status page
delete - Delete a status page
createComponentGroup - Create a component group for a status page
deleteComponentGroup - Delete a status page component group
updateComponentGroup - Update a status page component group
updateImage - Upload an image for a status page
deleteImage - Delete an image from a status page
createLink - Create a link for a status page
deleteLink - Delete a status page link
updateLink - Update a status page link
listSubscribers - List status page subscribers
createSubscribers - Add subscribers to a status page
deleteSubscribers - Remove subscribers from a status page

deleteIncident

Remove a status page incident attached to an incident

Example Usage

import { FirehydrantTypescriptSDK } from "firehydrant-typescript-sdk";

const firehydrantTypescriptSDK = new FirehydrantTypescriptSDK({
  apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});

async function run() {
  await firehydrantTypescriptSDK.statusPages.deleteIncident({
    statusPageId: "<id>",
    incidentId: "<id>",
  });


}

run();

Standalone function

The standalone function version of this method:

import { FirehydrantTypescriptSDKCore } from "firehydrant-typescript-sdk/core.js";
import { statusPagesDeleteIncident } from "firehydrant-typescript-sdk/funcs/statusPagesDeleteIncident.js";

// Use `FirehydrantTypescriptSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const firehydrantTypescriptSDK = new FirehydrantTypescriptSDKCore({
  apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});

async function run() {
  const res = await statusPagesDeleteIncident(firehydrantTypescriptSDK, {
    statusPageId: "<id>",
    incidentId: "<id>",
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.DeleteIncidentStatusPageRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<void>

Errors

Error Type	Status Code	Content Type
errors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
errors.Unauthorized	401, 403, 407, 511	application/json
errors.NotFound	404, 501, 505	application/json
errors.Timeout	408, 504	application/json
errors.RateLimited	429	application/json
errors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
errors.APIError	4XX, 5XX	/

createSubscription

Subscribe to status page updates

Example Usage

import { FirehydrantTypescriptSDK } from "firehydrant-typescript-sdk";

const firehydrantTypescriptSDK = new FirehydrantTypescriptSDK({
  apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});

async function run() {
  const result = await firehydrantTypescriptSDK.statusPages.createSubscription({
    email: "Christ52@gmail.com",
  });

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { FirehydrantTypescriptSDKCore } from "firehydrant-typescript-sdk/core.js";
import { statusPagesCreateSubscription } from "firehydrant-typescript-sdk/funcs/statusPagesCreateSubscription.js";

// Use `FirehydrantTypescriptSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const firehydrantTypescriptSDK = new FirehydrantTypescriptSDKCore({
  apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});

async function run() {
  const res = await statusPagesCreateSubscription(firehydrantTypescriptSDK, {
    email: "Christ52@gmail.com",
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter	Type	Required	Description
`request`	components.PostV1NuncSubscriptions	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.NuncNuncSubscription>

Errors

Error Type	Status Code	Content Type
errors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
errors.Unauthorized	401, 403, 407, 511	application/json
errors.NotFound	404, 501, 505	application/json
errors.Timeout	408, 504	application/json
errors.RateLimited	429	application/json
errors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
errors.APIError	4XX, 5XX	/

deleteSubscription

Unsubscribe from status page updates

Example Usage

import { FirehydrantTypescriptSDK } from "firehydrant-typescript-sdk";

const firehydrantTypescriptSDK = new FirehydrantTypescriptSDK({
  apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});

async function run() {
  const result = await firehydrantTypescriptSDK.statusPages.deleteSubscription({
    unsubscribeToken: "<value>",
  });

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { FirehydrantTypescriptSDKCore } from "firehydrant-typescript-sdk/core.js";
import { statusPagesDeleteSubscription } from "firehydrant-typescript-sdk/funcs/statusPagesDeleteSubscription.js";

// Use `FirehydrantTypescriptSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const firehydrantTypescriptSDK = new FirehydrantTypescriptSDKCore({
  apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});

async function run() {
  const res = await statusPagesDeleteSubscription(firehydrantTypescriptSDK, {
    unsubscribeToken: "<value>",
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.DeleteNuncSubscriptionRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.NuncNuncSubscription>

Errors

Error Type	Status Code	Content Type
errors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
errors.Unauthorized	401, 403, 407, 511	application/json
errors.NotFound	404, 501, 505	application/json
errors.Timeout	408, 504	application/json
errors.RateLimited	429	application/json
errors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
errors.APIError	4XX, 5XX	/

list

Lists the information displayed as part of your FireHydrant hosted status pages.

Example Usage

import { FirehydrantTypescriptSDK } from "firehydrant-typescript-sdk";

const firehydrantTypescriptSDK = new FirehydrantTypescriptSDK({
  apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});

async function run() {
  const result = await firehydrantTypescriptSDK.statusPages.list();

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { FirehydrantTypescriptSDKCore } from "firehydrant-typescript-sdk/core.js";
import { statusPagesList } from "firehydrant-typescript-sdk/funcs/statusPagesList.js";

// Use `FirehydrantTypescriptSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const firehydrantTypescriptSDK = new FirehydrantTypescriptSDKCore({
  apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});

async function run() {
  const res = await statusPagesList(firehydrantTypescriptSDK);

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter	Type	Required	Description
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.NuncConnectionEntityPaginated>

Errors

Error Type	Status Code	Content Type
errors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
errors.Unauthorized	401, 403, 407, 511	application/json
errors.NotFound	404, 501, 505	application/json
errors.Timeout	408, 504	application/json
errors.RateLimited	429	application/json
errors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
errors.APIError	4XX, 5XX	/

create

Create a new FireHydrant hosted status page for customer facing statuses.

Example Usage

import { FirehydrantTypescriptSDK } from "firehydrant-typescript-sdk";

const firehydrantTypescriptSDK = new FirehydrantTypescriptSDK({
  apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});

async function run() {
  const result = await firehydrantTypescriptSDK.statusPages.create({
    domain: "low-packaging.info",
    conditionsNuncCondition: [
      "<value>",
    ],
    conditionsConditionId: [
      "<value>",
    ],
    componentsInfrastructureType: [
      "<value>",
      "<value>",
      "<value>",
    ],
    componentsInfrastructureId: [
      "<value>",
      "<value>",
      "<value>",
    ],
  });

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { FirehydrantTypescriptSDKCore } from "firehydrant-typescript-sdk/core.js";
import { statusPagesCreate } from "firehydrant-typescript-sdk/funcs/statusPagesCreate.js";

// Use `FirehydrantTypescriptSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const firehydrantTypescriptSDK = new FirehydrantTypescriptSDKCore({
  apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});

async function run() {
  const res = await statusPagesCreate(firehydrantTypescriptSDK, {
    domain: "low-packaging.info",
    conditionsNuncCondition: [
      "<value>",
    ],
    conditionsConditionId: [
      "<value>",
    ],
    componentsInfrastructureType: [
      "<value>",
      "<value>",
      "<value>",
    ],
    componentsInfrastructureId: [
      "<value>",
      "<value>",
      "<value>",
    ],
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.CreateStatusPageRequestBody	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.NuncConnectionEntity>

Errors

Error Type	Status Code	Content Type
errors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
errors.Unauthorized	401, 403, 407, 511	application/json
errors.NotFound	404, 501, 505	application/json
errors.Timeout	408, 504	application/json
errors.RateLimited	429	application/json
errors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
errors.APIError	4XX, 5XX	/

get

Retrieve the information displayed as part of your FireHydrant hosted status page.

Example Usage

import { FirehydrantTypescriptSDK } from "firehydrant-typescript-sdk";

const firehydrantTypescriptSDK = new FirehydrantTypescriptSDK({
  apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});

async function run() {
  const result = await firehydrantTypescriptSDK.statusPages.get({
    nuncConnectionId: "<id>",
  });

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { FirehydrantTypescriptSDKCore } from "firehydrant-typescript-sdk/core.js";
import { statusPagesGet } from "firehydrant-typescript-sdk/funcs/statusPagesGet.js";

// Use `FirehydrantTypescriptSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const firehydrantTypescriptSDK = new FirehydrantTypescriptSDKCore({
  apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});

async function run() {
  const res = await statusPagesGet(firehydrantTypescriptSDK, {
    nuncConnectionId: "<id>",
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.GetStatusPageRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.NuncConnectionEntity>

Errors

Error Type	Status Code	Content Type
errors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
errors.Unauthorized	401, 403, 407, 511	application/json
errors.NotFound	404, 501, 505	application/json
errors.Timeout	408, 504	application/json
errors.RateLimited	429	application/json
errors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
errors.APIError	4XX, 5XX	/

update

Update your company's information and other components in the specified FireHydrant hosted status page.

Example Usage

import { FirehydrantTypescriptSDK } from "firehydrant-typescript-sdk";

const firehydrantTypescriptSDK = new FirehydrantTypescriptSDK({
  apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});

async function run() {
  const result = await firehydrantTypescriptSDK.statusPages.update({
    nuncConnectionId: "<id>",
    requestBody: {
      conditionsNuncCondition: [
        "<value>",
        "<value>",
        "<value>",
      ],
      conditionsConditionId: [
        "<value>",
        "<value>",
      ],
      componentsInfrastructureType: [
        "<value>",
      ],
      componentsInfrastructureId: [
        "<value>",
        "<value>",
        "<value>",
      ],
    },
  });

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { FirehydrantTypescriptSDKCore } from "firehydrant-typescript-sdk/core.js";
import { statusPagesUpdate } from "firehydrant-typescript-sdk/funcs/statusPagesUpdate.js";

// Use `FirehydrantTypescriptSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const firehydrantTypescriptSDK = new FirehydrantTypescriptSDKCore({
  apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});

async function run() {
  const res = await statusPagesUpdate(firehydrantTypescriptSDK, {
    nuncConnectionId: "<id>",
    requestBody: {
      conditionsNuncCondition: [
        "<value>",
        "<value>",
        "<value>",
      ],
      conditionsConditionId: [
        "<value>",
        "<value>",
      ],
      componentsInfrastructureType: [
        "<value>",
      ],
      componentsInfrastructureId: [
        "<value>",
        "<value>",
        "<value>",
      ],
    },
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.UpdateStatusPageRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.NuncConnectionEntity>

Errors

Error Type	Status Code	Content Type
errors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
errors.Unauthorized	401, 403, 407, 511	application/json
errors.NotFound	404, 501, 505	application/json
errors.Timeout	408, 504	application/json
errors.RateLimited	429	application/json
errors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
errors.APIError	4XX, 5XX	/

delete

Delete a FireHydrant hosted status page, stopping updates of your incidents to it.

Example Usage

import { FirehydrantTypescriptSDK } from "firehydrant-typescript-sdk";

const firehydrantTypescriptSDK = new FirehydrantTypescriptSDK({
  apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});

async function run() {
  const result = await firehydrantTypescriptSDK.statusPages.delete({
    nuncConnectionId: "<id>",
  });

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { FirehydrantTypescriptSDKCore } from "firehydrant-typescript-sdk/core.js";
import { statusPagesDelete } from "firehydrant-typescript-sdk/funcs/statusPagesDelete.js";

// Use `FirehydrantTypescriptSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const firehydrantTypescriptSDK = new FirehydrantTypescriptSDKCore({
  apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});

async function run() {
  const res = await statusPagesDelete(firehydrantTypescriptSDK, {
    nuncConnectionId: "<id>",
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.DeleteStatusPageRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.NuncConnectionEntity>

Errors

Error Type	Status Code	Content Type
errors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
errors.Unauthorized	401, 403, 407, 511	application/json
errors.NotFound	404, 501, 505	application/json
errors.Timeout	408, 504	application/json
errors.RateLimited	429	application/json
errors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
errors.APIError	4XX, 5XX	/

createComponentGroup

Add a component group to be displayed on a FireHydrant status page

Example Usage

import { FirehydrantTypescriptSDK } from "firehydrant-typescript-sdk";

const firehydrantTypescriptSDK = new FirehydrantTypescriptSDK({
  apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});

async function run() {
  const result = await firehydrantTypescriptSDK.statusPages.createComponentGroup({
    nuncConnectionId: "<id>",
    requestBody: {
      name: "<value>",
    },
  });

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { FirehydrantTypescriptSDKCore } from "firehydrant-typescript-sdk/core.js";
import { statusPagesCreateComponentGroup } from "firehydrant-typescript-sdk/funcs/statusPagesCreateComponentGroup.js";

// Use `FirehydrantTypescriptSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const firehydrantTypescriptSDK = new FirehydrantTypescriptSDKCore({
  apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});

async function run() {
  const res = await statusPagesCreateComponentGroup(firehydrantTypescriptSDK, {
    nuncConnectionId: "<id>",
    requestBody: {
      name: "<value>",
    },
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.CreateStatusPageComponentGroupRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.NuncConnectionEntity>

Errors

Error Type	Status Code	Content Type
errors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
errors.Unauthorized	401, 403, 407, 511	application/json
errors.NotFound	404, 501, 505	application/json
errors.Timeout	408, 504	application/json
errors.RateLimited	429	application/json
errors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
errors.APIError	4XX, 5XX	/

deleteComponentGroup

Delete a component group displayed on a FireHydrant status page

Example Usage

import { FirehydrantTypescriptSDK } from "firehydrant-typescript-sdk";

const firehydrantTypescriptSDK = new FirehydrantTypescriptSDK({
  apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});

async function run() {
  await firehydrantTypescriptSDK.statusPages.deleteComponentGroup({
    nuncConnectionId: "<id>",
    groupId: "<id>",
  });


}

run();

Standalone function

The standalone function version of this method:

import { FirehydrantTypescriptSDKCore } from "firehydrant-typescript-sdk/core.js";
import { statusPagesDeleteComponentGroup } from "firehydrant-typescript-sdk/funcs/statusPagesDeleteComponentGroup.js";

// Use `FirehydrantTypescriptSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const firehydrantTypescriptSDK = new FirehydrantTypescriptSDKCore({
  apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});

async function run() {
  const res = await statusPagesDeleteComponentGroup(firehydrantTypescriptSDK, {
    nuncConnectionId: "<id>",
    groupId: "<id>",
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.DeleteStatusPageComponentGroupRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<void>

Errors

Error Type	Status Code	Content Type
errors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
errors.Unauthorized	401, 403, 407, 511	application/json
errors.NotFound	404, 501, 505	application/json
errors.Timeout	408, 504	application/json
errors.RateLimited	429	application/json
errors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
errors.APIError	4XX, 5XX	/

updateComponentGroup

Update a component group to be displayed on a FireHydrant status page

Example Usage

import { FirehydrantTypescriptSDK } from "firehydrant-typescript-sdk";

const firehydrantTypescriptSDK = new FirehydrantTypescriptSDK({
  apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});

async function run() {
  await firehydrantTypescriptSDK.statusPages.updateComponentGroup({
    nuncConnectionId: "<id>",
    groupId: "<id>",
  });


}

run();

Standalone function

The standalone function version of this method:

import { FirehydrantTypescriptSDKCore } from "firehydrant-typescript-sdk/core.js";
import { statusPagesUpdateComponentGroup } from "firehydrant-typescript-sdk/funcs/statusPagesUpdateComponentGroup.js";

// Use `FirehydrantTypescriptSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const firehydrantTypescriptSDK = new FirehydrantTypescriptSDKCore({
  apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});

async function run() {
  const res = await statusPagesUpdateComponentGroup(firehydrantTypescriptSDK, {
    nuncConnectionId: "<id>",
    groupId: "<id>",
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.UpdateStatusPageComponentGroupRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<void>

Errors

Error Type	Status Code	Content Type
errors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
errors.Unauthorized	401, 403, 407, 511	application/json
errors.NotFound	404, 501, 505	application/json
errors.Timeout	408, 504	application/json
errors.RateLimited	429	application/json
errors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
errors.APIError	4XX, 5XX	/

updateImage

Add or replace an image attached to a FireHydrant status page

Example Usage

import { FirehydrantTypescriptSDK } from "firehydrant-typescript-sdk";

const firehydrantTypescriptSDK = new FirehydrantTypescriptSDK({
  apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});

async function run() {
  const result = await firehydrantTypescriptSDK.statusPages.updateImage({
    nuncConnectionId: "<id>",
    type: "<value>",
  });

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { FirehydrantTypescriptSDKCore } from "firehydrant-typescript-sdk/core.js";
import { statusPagesUpdateImage } from "firehydrant-typescript-sdk/funcs/statusPagesUpdateImage.js";

// Use `FirehydrantTypescriptSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const firehydrantTypescriptSDK = new FirehydrantTypescriptSDKCore({
  apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});

async function run() {
  const res = await statusPagesUpdateImage(firehydrantTypescriptSDK, {
    nuncConnectionId: "<id>",
    type: "<value>",
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.UpdateStatusPageImageRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.NuncConnectionEntity>

Errors

Error Type	Status Code	Content Type
errors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
errors.Unauthorized	401, 403, 407, 511	application/json
errors.NotFound	404, 501, 505	application/json
errors.Timeout	408, 504	application/json
errors.RateLimited	429	application/json
errors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
errors.APIError	4XX, 5XX	/

deleteImage

Delete an image attached to a FireHydrant status page

Example Usage

import { FirehydrantTypescriptSDK } from "firehydrant-typescript-sdk";

const firehydrantTypescriptSDK = new FirehydrantTypescriptSDK({
  apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});

async function run() {
  const result = await firehydrantTypescriptSDK.statusPages.deleteImage({
    nuncConnectionId: "<id>",
    type: "<value>",
  });

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { FirehydrantTypescriptSDKCore } from "firehydrant-typescript-sdk/core.js";
import { statusPagesDeleteImage } from "firehydrant-typescript-sdk/funcs/statusPagesDeleteImage.js";

// Use `FirehydrantTypescriptSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const firehydrantTypescriptSDK = new FirehydrantTypescriptSDKCore({
  apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});

async function run() {
  const res = await statusPagesDeleteImage(firehydrantTypescriptSDK, {
    nuncConnectionId: "<id>",
    type: "<value>",
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.DeleteStatusPageImageRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.NuncConnectionEntity>

Errors

Error Type	Status Code	Content Type
errors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
errors.Unauthorized	401, 403, 407, 511	application/json
errors.NotFound	404, 501, 505	application/json
errors.Timeout	408, 504	application/json
errors.RateLimited	429	application/json
errors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
errors.APIError	4XX, 5XX	/

createLink

Add a link to be displayed on a FireHydrant status page

Example Usage

import { FirehydrantTypescriptSDK } from "firehydrant-typescript-sdk";

const firehydrantTypescriptSDK = new FirehydrantTypescriptSDK({
  apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});

async function run() {
  const result = await firehydrantTypescriptSDK.statusPages.createLink({
    nuncConnectionId: "<id>",
  });

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { FirehydrantTypescriptSDKCore } from "firehydrant-typescript-sdk/core.js";
import { statusPagesCreateLink } from "firehydrant-typescript-sdk/funcs/statusPagesCreateLink.js";

// Use `FirehydrantTypescriptSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const firehydrantTypescriptSDK = new FirehydrantTypescriptSDKCore({
  apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});

async function run() {
  const res = await statusPagesCreateLink(firehydrantTypescriptSDK, {
    nuncConnectionId: "<id>",
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.CreateStatusPageLinkRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.NuncConnectionEntity>

Errors

Error Type	Status Code	Content Type
errors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
errors.Unauthorized	401, 403, 407, 511	application/json
errors.NotFound	404, 501, 505	application/json
errors.Timeout	408, 504	application/json
errors.RateLimited	429	application/json
errors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
errors.APIError	4XX, 5XX	/

deleteLink

Delete a link displayed on a FireHydrant status page

Example Usage

import { FirehydrantTypescriptSDK } from "firehydrant-typescript-sdk";

const firehydrantTypescriptSDK = new FirehydrantTypescriptSDK({
  apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});

async function run() {
  await firehydrantTypescriptSDK.statusPages.deleteLink({
    nuncConnectionId: "<id>",
    linkId: "<id>",
  });


}

run();

Standalone function

The standalone function version of this method:

import { FirehydrantTypescriptSDKCore } from "firehydrant-typescript-sdk/core.js";
import { statusPagesDeleteLink } from "firehydrant-typescript-sdk/funcs/statusPagesDeleteLink.js";

// Use `FirehydrantTypescriptSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const firehydrantTypescriptSDK = new FirehydrantTypescriptSDKCore({
  apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});

async function run() {
  const res = await statusPagesDeleteLink(firehydrantTypescriptSDK, {
    nuncConnectionId: "<id>",
    linkId: "<id>",
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.DeleteStatusPageLinkRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<void>

Errors

Error Type	Status Code	Content Type
errors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
errors.Unauthorized	401, 403, 407, 511	application/json
errors.NotFound	404, 501, 505	application/json
errors.Timeout	408, 504	application/json
errors.RateLimited	429	application/json
errors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
errors.APIError	4XX, 5XX	/

updateLink

Update a link to be displayed on a FireHydrant status page

Example Usage

import { FirehydrantTypescriptSDK } from "firehydrant-typescript-sdk";

const firehydrantTypescriptSDK = new FirehydrantTypescriptSDK({
  apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});

async function run() {
  await firehydrantTypescriptSDK.statusPages.updateLink({
    nuncConnectionId: "<id>",
    linkId: "<id>",
    patchV1NuncConnectionsNuncConnectionIdLinksLinkId: {},
  });


}

run();

Standalone function

The standalone function version of this method:

import { FirehydrantTypescriptSDKCore } from "firehydrant-typescript-sdk/core.js";
import { statusPagesUpdateLink } from "firehydrant-typescript-sdk/funcs/statusPagesUpdateLink.js";

// Use `FirehydrantTypescriptSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const firehydrantTypescriptSDK = new FirehydrantTypescriptSDKCore({
  apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});

async function run() {
  const res = await statusPagesUpdateLink(firehydrantTypescriptSDK, {
    nuncConnectionId: "<id>",
    linkId: "<id>",
    patchV1NuncConnectionsNuncConnectionIdLinksLinkId: {},
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.UpdateStatusPageLinkRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<void>

Errors

Error Type	Status Code	Content Type
errors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
errors.Unauthorized	401, 403, 407, 511	application/json
errors.NotFound	404, 501, 505	application/json
errors.Timeout	408, 504	application/json
errors.RateLimited	429	application/json
errors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
errors.APIError	4XX, 5XX	/

listSubscribers

Retrieves the list of subscribers for a status page.

Example Usage

import { FirehydrantTypescriptSDK } from "firehydrant-typescript-sdk";

const firehydrantTypescriptSDK = new FirehydrantTypescriptSDK({
  apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});

async function run() {
  const result = await firehydrantTypescriptSDK.statusPages.listSubscribers({
    nuncConnectionId: "<id>",
  });

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { FirehydrantTypescriptSDKCore } from "firehydrant-typescript-sdk/core.js";
import { statusPagesListSubscribers } from "firehydrant-typescript-sdk/funcs/statusPagesListSubscribers.js";

// Use `FirehydrantTypescriptSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const firehydrantTypescriptSDK = new FirehydrantTypescriptSDKCore({
  apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});

async function run() {
  const res = await statusPagesListSubscribers(firehydrantTypescriptSDK, {
    nuncConnectionId: "<id>",
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.ListStatusPageSubscribersRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.NuncEmailSubscribersEntity>

Errors

Error Type	Status Code	Content Type
errors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
errors.Unauthorized	401, 403, 407, 511	application/json
errors.NotFound	404, 501, 505	application/json
errors.Timeout	408, 504	application/json
errors.RateLimited	429	application/json
errors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
errors.APIError	4XX, 5XX	/

createSubscribers

Subscribes a comma-separated string of emails to status page updates

Example Usage

import { FirehydrantTypescriptSDK } from "firehydrant-typescript-sdk";

const firehydrantTypescriptSDK = new FirehydrantTypescriptSDK({
  apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});

async function run() {
  const result = await firehydrantTypescriptSDK.statusPages.createSubscribers({
    nuncConnectionId: "<id>",
    requestBody: {
      emails: "<value>",
    },
  });

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { FirehydrantTypescriptSDKCore } from "firehydrant-typescript-sdk/core.js";
import { statusPagesCreateSubscribers } from "firehydrant-typescript-sdk/funcs/statusPagesCreateSubscribers.js";

// Use `FirehydrantTypescriptSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const firehydrantTypescriptSDK = new FirehydrantTypescriptSDKCore({
  apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});

async function run() {
  const res = await statusPagesCreateSubscribers(firehydrantTypescriptSDK, {
    nuncConnectionId: "<id>",
    requestBody: {
      emails: "<value>",
    },
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.CreateStatusPageSubscribersRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.NuncEmailSubscribersEntity>

Errors

Error Type	Status Code	Content Type
errors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
errors.Unauthorized	401, 403, 407, 511	application/json
errors.NotFound	404, 501, 505	application/json
errors.Timeout	408, 504	application/json
errors.RateLimited	429	application/json
errors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
errors.APIError	4XX, 5XX	/

deleteSubscribers

Unsubscribes one or more status page subscribers.

Example Usage

import { FirehydrantTypescriptSDK } from "firehydrant-typescript-sdk";

const firehydrantTypescriptSDK = new FirehydrantTypescriptSDK({
  apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});

async function run() {
  const result = await firehydrantTypescriptSDK.statusPages.deleteSubscribers({
    nuncConnectionId: "<id>",
    subscriberIds: "<value>",
  });

  // Handle the result
  console.log(result);
}

run();

Standalone function

The standalone function version of this method:

import { FirehydrantTypescriptSDKCore } from "firehydrant-typescript-sdk/core.js";
import { statusPagesDeleteSubscribers } from "firehydrant-typescript-sdk/funcs/statusPagesDeleteSubscribers.js";

// Use `FirehydrantTypescriptSDKCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const firehydrantTypescriptSDK = new FirehydrantTypescriptSDKCore({
  apiKey: process.env["FIREHYDRANTTYPESCRIPTSDK_API_KEY"] ?? "",
});

async function run() {
  const res = await statusPagesDeleteSubscribers(firehydrantTypescriptSDK, {
    nuncConnectionId: "<id>",
    subscriberIds: "<value>",
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result);
}

run();

Parameters

Parameter	Type	Required	Description
`request`	operations.DeleteStatusPageSubscribersRequest	✔️	The request object to use for the request.
`options`	RequestOptions	➖	Used to set various options for making HTTP requests.
`options.fetchOptions`	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed.
`options.retries`	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.NuncEmailSubscribersEntity>

Errors

Error Type	Status Code	Content Type
errors.BadRequest	400, 413, 414, 415, 422, 431, 510	application/json
errors.Unauthorized	401, 403, 407, 511	application/json
errors.NotFound	404, 501, 505	application/json
errors.Timeout	408, 504	application/json
errors.RateLimited	429	application/json
errors.InternalServerError	500, 502, 503, 506, 507, 508	application/json
errors.APIError	4XX, 5XX	/

Files

README.md

Latest commit

History

README.md

File metadata and controls

StatusPages

Overview

Available Operations

deleteIncident

Example Usage

Standalone function

Parameters

Response

Errors

createSubscription

Example Usage

Standalone function

Parameters

Response

Errors

deleteSubscription

Example Usage

Standalone function

Parameters

Response

Errors

list

Example Usage

Standalone function

Parameters

Response

Errors

create

Example Usage

Standalone function

Parameters

Response

Errors

get

Example Usage

Standalone function

Parameters

Response

Errors

update

Example Usage

Standalone function

Parameters

Response

Errors

delete

Example Usage

Standalone function

Parameters

Response

Errors

createComponentGroup

Example Usage

Standalone function

Parameters

Response

Errors

deleteComponentGroup

Example Usage

Standalone function

Parameters

Response

Errors

updateComponentGroup

Example Usage

Standalone function

Parameters

Response

Errors

updateImage

Example Usage

Standalone function

Parameters

Response