# Severities (*severities*) ## Overview ### Available Operations * [list](#list) - List Severities V1 * [create](#create) - Create Severities V1 * [delete](#delete) - Delete Severities V1 * [get](#get) - Show Severities V1 * [update](#update) - Update Severities V1 ## list List all incident severities for an organisation. ### Example Usage ```typescript import { Incidentio } from "incidentio"; const incidentio = new Incidentio(); async function run() { const result = await incidentio.severities.list(); // Handle the result console.log(result) } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { IncidentioCore } from "incidentio/core.js"; import { severitiesList } from "incidentio/funcs/severitiesList.js"; // Use `IncidentioCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const incidentio = new IncidentioCore(); async function run() { const res = await severitiesList(incidentio); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result) } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[components.ListResponseBody17](../../models/components/listresponsebody17.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | ## create Create a new severity ### Example Usage ```typescript import { Incidentio } from "incidentio"; const incidentio = new Incidentio(); async function run() { const result = await incidentio.severities.create({ description: "Issues with **low impact**.", name: "Minor", rank: 1, }); // Handle the result console.log(result) } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { IncidentioCore } from "incidentio/core.js"; import { severitiesCreate } from "incidentio/funcs/severitiesCreate.js"; // Use `IncidentioCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const incidentio = new IncidentioCore(); async function run() { const res = await severitiesCreate(incidentio, { description: "Issues with **low impact**.", name: "Minor", rank: 1, }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result) } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [components.CreateRequestBody13](../../models/components/createrequestbody13.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[components.ShowResponseBody15](../../models/components/showresponsebody15.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | ## delete Delete a severity ### Example Usage ```typescript import { Incidentio } from "incidentio"; const incidentio = new Incidentio(); async function run() { await incidentio.severities.delete({ id: "01FCNDV6P870EA6S7TK1DSYDG0", }); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { IncidentioCore } from "incidentio/core.js"; import { severitiesDelete } from "incidentio/funcs/severitiesDelete.js"; // Use `IncidentioCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const incidentio = new IncidentioCore(); async function run() { const res = await severitiesDelete(incidentio, { id: "01FCNDV6P870EA6S7TK1DSYDG0", }); if (!res.ok) { throw res.error; } const { value: result } = res; } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.SeveritiesV1NumberDeleteRequest](../../models/operations/severitiesv1numberdeleterequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | ## get Get a single incident severity. ### Example Usage ```typescript import { Incidentio } from "incidentio"; const incidentio = new Incidentio(); async function run() { const result = await incidentio.severities.get({ id: "01FCNDV6P870EA6S7TK1DSYDG0", }); // Handle the result console.log(result) } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { IncidentioCore } from "incidentio/core.js"; import { severitiesGet } from "incidentio/funcs/severitiesGet.js"; // Use `IncidentioCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const incidentio = new IncidentioCore(); async function run() { const res = await severitiesGet(incidentio, { id: "01FCNDV6P870EA6S7TK1DSYDG0", }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result) } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.SeveritiesV1NumberShowRequest](../../models/operations/severitiesv1numbershowrequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[components.ShowResponseBody15](../../models/components/showresponsebody15.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | ## update Update an existing severity ### Example Usage ```typescript import { Incidentio } from "incidentio"; const incidentio = new Incidentio(); async function run() { const result = await incidentio.severities.update({ id: "01FCNDV6P870EA6S7TK1DSYDG0", createRequestBody13: { description: "Issues with **low impact**.", name: "Minor", rank: 1, }, }); // Handle the result console.log(result) } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { IncidentioCore } from "incidentio/core.js"; import { severitiesUpdate } from "incidentio/funcs/severitiesUpdate.js"; // Use `IncidentioCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const incidentio = new IncidentioCore(); async function run() { const res = await severitiesUpdate(incidentio, { id: "01FCNDV6P870EA6S7TK1DSYDG0", createRequestBody13: { description: "Issues with **low impact**.", name: "Minor", rank: 1, }, }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result) } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.SeveritiesV1NumberUpdateRequest](../../models/operations/severitiesv1numberupdaterequest.md) | :heavy_check_mark: | The request object to use for the request. | | `options` | RequestOptions | :heavy_minus_sign: | Used to set various options for making HTTP requests. | | `options.fetchOptions` | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options) | :heavy_minus_sign: | 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](../../lib/utils/retryconfig.md) | :heavy_minus_sign: | Enables retrying HTTP requests under certain failure conditions. | ### Response **Promise\<[components.ShowResponseBody15](../../models/components/showresponsebody15.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* |