# CatalogEntries (*catalogEntries*) ## Overview ### Available Operations * [list](#list) - ListEntries Catalog V2 * [create](#create) - CreateEntry Catalog V2 * [delete](#delete) - DestroyEntry Catalog V2 * [show](#show) - ShowEntry Catalog V2 * [update](#update) - UpdateEntry Catalog V2 ## list List entries for a catalog type. ### Example Usage ```typescript import { Incidentio } from "incidentio"; const incidentio = new Incidentio(); async function run() { const result = await incidentio.catalogEntries.list({ catalogTypeId: "01FCNDV6P870EA6S7TK1DSYDG0", pageSize: 25, after: "01FDAG4SAP5TYPT98WGR2N7W91", }); // Handle the result console.log(result) } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { IncidentioCore } from "incidentio/core.js"; import { catalogEntriesList } from "incidentio/funcs/catalogEntriesList.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 catalogEntriesList(incidentio, { catalogTypeId: "01FCNDV6P870EA6S7TK1DSYDG0", pageSize: 25, after: "01FDAG4SAP5TYPT98WGR2N7W91", }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result) } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.CatalogV2NumberListEntriesRequest](../../models/operations/catalogv2numberlistentriesrequest.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.ListEntriesResponseBody](../../models/components/listentriesresponsebody.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | ## create Create an entry within the catalog. We support a maximum of 50,000 entries per type. If you call this API with a payload where the external_id and catalog_type_id match an existing entry, the existing entry will be updated. ### Example Usage ```typescript import { Incidentio } from "incidentio"; const incidentio = new Incidentio(); async function run() { const result = await incidentio.catalogEntries.create({ aliases: [ "lawrence@incident.io", "lawrence", ], attributeValues: { "abc123": { arrayValue: [ { literal: "SEV123", reference: "incident.severity", }, ], value: { literal: "SEV123", reference: "incident.severity", }, }, }, catalogTypeId: "01FCNDV6P870EA6S7TK1DSYDG0", externalId: "761722cd-d1d7-477b-ac7e-90f9e079dc33", name: "Primary On-call", rank: 3, }); // Handle the result console.log(result) } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { IncidentioCore } from "incidentio/core.js"; import { catalogEntriesCreate } from "incidentio/funcs/catalogEntriesCreate.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 catalogEntriesCreate(incidentio, { aliases: [ "lawrence@incident.io", "lawrence", ], attributeValues: { "abc123": { arrayValue: [ { literal: "SEV123", reference: "incident.severity", }, ], value: { literal: "SEV123", reference: "incident.severity", }, }, }, catalogTypeId: "01FCNDV6P870EA6S7TK1DSYDG0", externalId: "761722cd-d1d7-477b-ac7e-90f9e079dc33", name: "Primary On-call", rank: 3, }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result) } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [components.CreateEntryRequestBody](../../models/components/createentryrequestbody.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.CreateEntryResponseBody](../../models/components/createentryresponsebody.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | ## delete Archives a catalog entry. ### Example Usage ```typescript import { Incidentio } from "incidentio"; const incidentio = new Incidentio(); async function run() { await incidentio.catalogEntries.delete({ id: "01FCNDV6P870EA6S7TK1DSYDG0", }); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { IncidentioCore } from "incidentio/core.js"; import { catalogEntriesDelete } from "incidentio/funcs/catalogEntriesDelete.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 catalogEntriesDelete(incidentio, { id: "01FCNDV6P870EA6S7TK1DSYDG0", }); if (!res.ok) { throw res.error; } const { value: result } = res; } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.CatalogV2NumberDestroyEntryRequest](../../models/operations/catalogv2numberdestroyentryrequest.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 | */* | ## show Show a single catalog entry. ### Example Usage ```typescript import { Incidentio } from "incidentio"; const incidentio = new Incidentio(); async function run() { const result = await incidentio.catalogEntries.show({ 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 { catalogEntriesShow } from "incidentio/funcs/catalogEntriesShow.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 catalogEntriesShow(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.CatalogV2NumberShowEntryRequest](../../models/operations/catalogv2numbershowentryrequest.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.ShowEntryResponseBody](../../models/components/showentryresponsebody.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | ## update Updates an existing catalog entry. ### Example Usage ```typescript import { Incidentio } from "incidentio"; const incidentio = new Incidentio(); async function run() { const result = await incidentio.catalogEntries.update({ id: "01FCNDV6P870EA6S7TK1DSYDG0", updateEntryRequestBody: { aliases: [ "lawrence@incident.io", "lawrence", ], attributeValues: { "abc123": { arrayValue: [ { literal: "SEV123", reference: "incident.severity", }, ], value: { literal: "SEV123", reference: "incident.severity", }, }, }, externalId: "761722cd-d1d7-477b-ac7e-90f9e079dc33", name: "Primary On-call", rank: 3, }, }); // Handle the result console.log(result) } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { IncidentioCore } from "incidentio/core.js"; import { catalogEntriesUpdate } from "incidentio/funcs/catalogEntriesUpdate.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 catalogEntriesUpdate(incidentio, { id: "01FCNDV6P870EA6S7TK1DSYDG0", updateEntryRequestBody: { aliases: [ "lawrence@incident.io", "lawrence", ], attributeValues: { "abc123": { arrayValue: [ { literal: "SEV123", reference: "incident.severity", }, ], value: { literal: "SEV123", reference: "incident.severity", }, }, }, externalId: "761722cd-d1d7-477b-ac7e-90f9e079dc33", name: "Primary On-call", rank: 3, }, }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result) } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.CatalogV2NumberUpdateEntryRequest](../../models/operations/catalogv2numberupdateentryrequest.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.ShowEntryResponseBody](../../models/components/showentryresponsebody.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* |