# CatalogTypes (*catalogTypes*) ## Overview ### Available Operations * [list](#list) - ListTypes Catalog V2 * [create](#create) - CreateType Catalog V2 * [delete](#delete) - DestroyType Catalog V2 * [show](#show) - ShowType Catalog V2 * [update](#update) - UpdateType Catalog V2 * [updateSchema](#updateschema) - UpdateTypeSchema Catalog V2 ## list List all catalog types for an organisation, including those synced from external resources. ### Example Usage ```typescript import { Incidentio } from "incidentio"; const incidentio = new Incidentio(); async function run() { const result = await incidentio.catalogTypes.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 { catalogTypesList } from "incidentio/funcs/catalogTypesList.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 catalogTypesList(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.ListTypesResponseBody](../../models/components/listtypesresponsebody.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | ## create Create a catalog type. The schema must be updated using the UpdateTypeSchema endpoint. ### Example Usage ```typescript import { Incidentio } from "incidentio"; const incidentio = new Incidentio(); async function run() { const result = await incidentio.catalogTypes.create({ annotations: { "incident.io/catalog-importer/id": "id-of-config", }, categories: [ "issue-tracker", ], color: "yellow", description: "Represents Kubernetes clusters that we run inside of GKE.", icon: "alert", name: "Kubernetes Cluster", ranked: true, sourceRepoUrl: "https://github.com/my-company/incident-io-catalog", typeName: "Custom[\"BackstageGroup\"]", }); // Handle the result console.log(result) } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { IncidentioCore } from "incidentio/core.js"; import { catalogTypesCreate } from "incidentio/funcs/catalogTypesCreate.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 catalogTypesCreate(incidentio, { annotations: { "incident.io/catalog-importer/id": "id-of-config", }, categories: [ "issue-tracker", ], color: "yellow", description: "Represents Kubernetes clusters that we run inside of GKE.", icon: "alert", name: "Kubernetes Cluster", ranked: true, sourceRepoUrl: "https://github.com/my-company/incident-io-catalog", typeName: "Custom[\"BackstageGroup\"]", }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result) } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [components.CreateTypeRequestBody](../../models/components/createtyperequestbody.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.CreateTypeResponseBody](../../models/components/createtyperesponsebody.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | ## delete Archives a catalog type and associated entries. ### Example Usage ```typescript import { Incidentio } from "incidentio"; const incidentio = new Incidentio(); async function run() { await incidentio.catalogTypes.delete({ id: "01FCNDV6P870EA6S7TK1DSYDG0", }); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { IncidentioCore } from "incidentio/core.js"; import { catalogTypesDelete } from "incidentio/funcs/catalogTypesDelete.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 catalogTypesDelete(incidentio, { id: "01FCNDV6P870EA6S7TK1DSYDG0", }); if (!res.ok) { throw res.error; } const { value: result } = res; } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.CatalogV2NumberDestroyTypeRequest](../../models/operations/catalogv2numberdestroytyperequest.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 type. ### Example Usage ```typescript import { Incidentio } from "incidentio"; const incidentio = new Incidentio(); async function run() { const result = await incidentio.catalogTypes.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 { catalogTypesShow } from "incidentio/funcs/catalogTypesShow.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 catalogTypesShow(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.CatalogV2NumberShowTypeRequest](../../models/operations/catalogv2numbershowtyperequest.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.CreateTypeResponseBody](../../models/components/createtyperesponsebody.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | ## update Updates an existing catalog type. The schema must be updated using the UpdateTypeSchema endpoint. ### Example Usage ```typescript import { Incidentio } from "incidentio"; const incidentio = new Incidentio(); async function run() { const result = await incidentio.catalogTypes.update({ id: "01FCNDV6P870EA6S7TK1DSYDG0", updateTypeRequestBody: { annotations: { "incident.io/catalog-importer/id": "id-of-config", }, categories: [ "issue-tracker", ], color: "yellow", description: "Represents Kubernetes clusters that we run inside of GKE.", icon: "alert", name: "Kubernetes Cluster", ranked: true, sourceRepoUrl: "https://github.com/my-company/incident-io-catalog", }, }); // Handle the result console.log(result) } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { IncidentioCore } from "incidentio/core.js"; import { catalogTypesUpdate } from "incidentio/funcs/catalogTypesUpdate.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 catalogTypesUpdate(incidentio, { id: "01FCNDV6P870EA6S7TK1DSYDG0", updateTypeRequestBody: { annotations: { "incident.io/catalog-importer/id": "id-of-config", }, categories: [ "issue-tracker", ], color: "yellow", description: "Represents Kubernetes clusters that we run inside of GKE.", icon: "alert", name: "Kubernetes Cluster", ranked: true, sourceRepoUrl: "https://github.com/my-company/incident-io-catalog", }, }); if (!res.ok) { throw res.error; } const { value: result } = res; // Handle the result console.log(result) } run(); ``` ### Parameters | Parameter | Type | Required | Description | | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `request` | [operations.CatalogV2NumberUpdateTypeRequest](../../models/operations/catalogv2numberupdatetyperequest.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.CreateTypeResponseBody](../../models/components/createtyperesponsebody.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* | ## updateSchema Update an existing catalog types schema, adding or removing attributes. Updating the schema is handled separately from creating and updating types, so that you don't have to worry about dependencies between types. For example, if type A has an attribute that relies on type B, you would have to create type B first. By allowing the creation of types without a schema, they can be created in any order, but it means that you need to make a separate call to this endpoint to update the schema. ### Example Usage ```typescript import { Incidentio } from "incidentio"; const incidentio = new Incidentio(); async function run() { const result = await incidentio.catalogTypes.updateSchema({ id: "01FCNDV6P870EA6S7TK1DSYDG0", updateTypeSchemaRequestBody: { attributes: [ { array: false, backlinkAttribute: "abc123", id: "01GW2G3V0S59R238FAHPDS1R66", mode: "manual", name: "tier", path: [ { attributeId: "abc123", }, ], type: "Custom[\"Service\"]", }, ], version: 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 { catalogTypesUpdateSchema } from "incidentio/funcs/catalogTypesUpdateSchema.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 catalogTypesUpdateSchema(incidentio, { id: "01FCNDV6P870EA6S7TK1DSYDG0", updateTypeSchemaRequestBody: { attributes: [ { array: false, backlinkAttribute: "abc123", id: "01GW2G3V0S59R238FAHPDS1R66", mode: "manual", name: "tier", path: [ { attributeId: "abc123", }, ], type: "Custom[\"Service\"]", }, ], version: 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.CatalogV2NumberUpdateTypeSchemaRequest](../../models/operations/catalogv2numberupdatetypeschemarequest.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.CreateTypeResponseBody](../../models/components/createtyperesponsebody.md)\>** ### Errors | Error Object | Status Code | Content Type | | --------------- | --------------- | --------------- | | errors.SDKError | 4xx-5xx | */* |