# Drains ## Overview ### Available Operations * [v1Traces](#v1traces) * [v1Logs](#v1logs) ## v1Traces ### Example Usage ```typescript import { Interfere } from "@interfere/sdk"; const interfere = new Interfere({ publishableKey: process.env["INTERFERE_PUBLISHABLE_KEY"] ?? "", }); async function run() { const result = await interfere.drains.v1Traces(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { InterfereCore } from "@interfere/sdk/core.js"; import { drainsV1Traces } from "@interfere/sdk/funcs/drains-v1-traces.js"; // Use `InterfereCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const interfere = new InterfereCore({ publishableKey: process.env["INTERFERE_PUBLISHABLE_KEY"] ?? "", }); async function run() { const res = await drainsV1Traces(interfere); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("drainsV1Traces failed:", res.error); } } 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\<[operations.V1TracesResponse](../../models/operations/v1-traces-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | ------------------------------------ | ------------------------------------ | ------------------------------------ | | errors.LibraryBareError | 400, 403, 413 | application/json | | errors.LibraryBareError | 400, 403, 413 | application/json | | errors.LibraryBareError | 400, 403, 413 | application/json | | errors.LibraryBareError | 400, 403, 413 | application/json | | errors.LibraryBareError | 400, 403, 413 | application/json | | errors.LibraryBareError | 400, 403, 413 | application/json | | errors.ValidationError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.ReleaseSignTooManyFilesError | 400, 403, 413 | application/json | | errors.ReleaseSignFileTooLargeError | 400, 403, 413 | application/json | | errors.ReleaseSignDuplicatePathError | 400, 403, 413 | application/json | | errors.InterfereError | 4XX, 5XX | \*/\* | ## v1Logs ### Example Usage ```typescript import { Interfere } from "@interfere/sdk"; const interfere = new Interfere({ publishableKey: process.env["INTERFERE_PUBLISHABLE_KEY"] ?? "", }); async function run() { const result = await interfere.drains.v1Logs(); console.log(result); } run(); ``` ### Standalone function The standalone function version of this method: ```typescript import { InterfereCore } from "@interfere/sdk/core.js"; import { drainsV1Logs } from "@interfere/sdk/funcs/drains-v1-logs.js"; // Use `InterfereCore` for best tree-shaking performance. // You can create one instance of it to use across an application. const interfere = new InterfereCore({ publishableKey: process.env["INTERFERE_PUBLISHABLE_KEY"] ?? "", }); async function run() { const res = await drainsV1Logs(interfere); if (res.ok) { const { value: result } = res; console.log(result); } else { console.log("drainsV1Logs failed:", res.error); } } 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\<[operations.V1LogsResponse](../../models/operations/v1-logs-response.md)\>** ### Errors | Error Type | Status Code | Content Type | | ------------------------------------ | ------------------------------------ | ------------------------------------ | | errors.LibraryBareError | 400, 403, 413 | application/json | | errors.LibraryBareError | 400, 403, 413 | application/json | | errors.LibraryBareError | 400, 403, 413 | application/json | | errors.LibraryBareError | 400, 403, 413 | application/json | | errors.LibraryBareError | 400, 403, 413 | application/json | | errors.LibraryBareError | 400, 403, 413 | application/json | | errors.ValidationError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.CollectorBareError | 400, 403, 413 | application/json | | errors.ReleaseSignTooManyFilesError | 400, 403, 413 | application/json | | errors.ReleaseSignFileTooLargeError | 400, 403, 413 | application/json | | errors.ReleaseSignDuplicatePathError | 400, 403, 413 | application/json | | errors.InterfereError | 4XX, 5XX | \*/\* |