/* * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. */ import { OutpostCore } from "../core.js"; import { encodeFormQuery } from "../lib/encodings.js"; import * as M from "../lib/matchers.js"; import { compactMap } from "../lib/primitives.js"; import { safeParse } from "../lib/schemas.js"; import { RequestOptions } from "../lib/sdks.js"; import { extractSecurity, resolveGlobalSecurity } from "../lib/security.js"; import { pathToFunc } from "../lib/url.js"; import * as components from "../models/components/index.js"; import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError, } from "../models/errors/httpclienterrors.js"; import * as errors from "../models/errors/index.js"; import { OutpostError } from "../models/errors/outposterror.js"; import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; import * as operations from "../models/operations/index.js"; import { APICall, APIPromise } from "../types/async.js"; import { Result } from "../types/fp.js"; /** * Get Attempt Metrics * * @remarks * Returns aggregated delivery attempt metrics. Supports time bucketing via granularity, * dimensional grouping, and filtering. * * **Measures:** `count`, `successful_count`, `failed_count`, `error_rate`, * `first_attempt_count`, `retry_count`, `manual_retry_count`, `avg_attempt_number`, * `rate`, `successful_rate`, `failed_rate` * * **Dimensions:** `tenant_id` (admin-only), `destination_id`, `topic`, `status`, `code`, `manual`, `attempt_number` * * **Filters:** `tenant_id` (admin-only), `destination_id`, `topic`, `status`, `code`, `manual`, `attempt_number` */ export function metricsGetAttemptMetrics( client: OutpostCore, request: operations.GetAttemptMetricsRequest, options?: RequestOptions, ): APIPromise< Result< components.MetricsResponse, | errors.BadRequestError | errors.UnauthorizedError | errors.APIErrorResponse | errors.InternalServerError | OutpostError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError > > { return new APIPromise($do( client, request, options, )); } async function $do( client: OutpostCore, request: operations.GetAttemptMetricsRequest, options?: RequestOptions, ): Promise< [ Result< components.MetricsResponse, | errors.BadRequestError | errors.UnauthorizedError | errors.APIErrorResponse | errors.InternalServerError | OutpostError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError >, APICall, ] > { const parsed = safeParse( request, (value) => operations.GetAttemptMetricsRequest$outboundSchema.parse(value), "Input validation failed", ); if (!parsed.ok) { return [parsed, { status: "invalid" }]; } const payload = parsed.value; const body = null; const path = pathToFunc("/metrics/attempts")(); const query = encodeFormQuery({ "dimensions": payload.dimensions, "filters[attempt_number]": payload["filters[attempt_number]"], "filters[code]": payload["filters[code]"], "filters[destination_id]": payload["filters[destination_id]"], "filters[manual]": payload["filters[manual]"], "filters[status]": payload["filters[status]"], "filters[tenant_id]": payload["filters[tenant_id]"], "filters[topic]": payload["filters[topic]"], "granularity": payload.granularity, "measures": payload.measures, "time[end]": payload["time[end]"], "time[start]": payload["time[start]"], }); const headers = new Headers(compactMap({ Accept: "application/json", })); const secConfig = await extractSecurity(client._options.apiKey); const securityInput = secConfig == null ? {} : { apiKey: secConfig }; const requestSecurity = resolveGlobalSecurity(securityInput); const context = { options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "getAttemptMetrics", oAuth2Scopes: null, resolvedSecurity: requestSecurity, securitySource: client._options.apiKey, retryConfig: options?.retries || client._options.retryConfig || { strategy: "none" }, retryCodes: options?.retryCodes || ["429", "500", "502", "503", "504"], }; const requestRes = client._createRequest(context, { security: requestSecurity, method: "GET", baseURL: options?.serverURL, path: path, headers: headers, query: query, body: body, userAgent: client._options.userAgent, timeoutMs: options?.timeoutMs || client._options.timeoutMs || -1, }, options); if (!requestRes.ok) { return [requestRes, { status: "invalid" }]; } const req = requestRes.value; const doResult = await client._do(req, { context, errorCodes: ["400", "401", "403", "4XX", "500", "5XX"], retryConfig: context.retryConfig, retryCodes: context.retryCodes, }); if (!doResult.ok) { return [doResult, { status: "request-error", request: req }]; } const response = doResult.value; const responseFields = { HttpMeta: { Response: response, Request: req }, }; const [result] = await M.match< components.MetricsResponse, | errors.BadRequestError | errors.UnauthorizedError | errors.APIErrorResponse | errors.InternalServerError | OutpostError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError >( M.json(200, components.MetricsResponse$inboundSchema), M.jsonErr(400, errors.BadRequestError$inboundSchema), M.jsonErr(401, errors.UnauthorizedError$inboundSchema), M.jsonErr(403, errors.APIErrorResponse$inboundSchema), M.jsonErr(500, errors.InternalServerError$inboundSchema), M.fail("4XX"), M.fail("5XX"), )(response, req, { extraFields: responseFields }); if (!result.ok) { return [result, { status: "complete", request: req, response }]; } return [result, { status: "complete", request: req, response }]; }