/* * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. * @generated-id: e1b3039050d8 */ import { GleanCore } from "../core.js"; import { encodeFormQuery, encodeSimple } from "../lib/encodings.js"; import { matchStatusCode } from "../lib/http.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 { GleanBaseError } from "../models/errors/gleanbaseerror.js"; import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError, } from "../models/errors/httpclienterrors.js"; import * as errors from "../models/errors/index.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"; /** * List an agent's schemas * * @remarks * Return [agent](https://developers.glean.com/agents/agents-api)'s input and output schemas. You can use these schemas to detect changes to an agent's input or output structure. */ export function clientAgentsRetrieveSchemas( client: GleanCore, agentId: string, locale?: string | undefined, timezoneOffset?: number | undefined, options?: RequestOptions, ): APIPromise< Result< components.AgentSchemas, | errors.ErrorResponse | GleanBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError > > { return new APIPromise($do( client, agentId, locale, timezoneOffset, options, )); } async function $do( client: GleanCore, agentId: string, locale?: string | undefined, timezoneOffset?: number | undefined, options?: RequestOptions, ): Promise< [ Result< components.AgentSchemas, | errors.ErrorResponse | GleanBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError >, APICall, ] > { const input: operations.GetAgentSchemasRequest = { agentId: agentId, locale: locale, timezoneOffset: timezoneOffset, }; const parsed = safeParse( input, (value) => operations.GetAgentSchemasRequest$outboundSchema.parse(value), "Input validation failed", ); if (!parsed.ok) { return [parsed, { status: "invalid" }]; } const payload = parsed.value; const body = null; const pathParams = { agent_id: encodeSimple("agent_id", payload.agent_id, { explode: false, charEncoding: "percent", }), }; const path = pathToFunc("/rest/api/v1/agents/{agent_id}/schemas")(pathParams); const query = encodeFormQuery({ "locale": payload.locale, "timezoneOffset": payload.timezoneOffset, }); const headers = new Headers(compactMap({ Accept: "application/json", })); const secConfig = await extractSecurity(client._options.apiToken); const securityInput = secConfig == null ? {} : { apiToken: secConfig }; const requestSecurity = resolveGlobalSecurity(securityInput); const context = { options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "getAgentSchemas", oAuth2Scopes: null, resolvedSecurity: requestSecurity, securitySource: client._options.apiToken, 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, isErrorStatusCode: (statusCode: number) => matchStatusCode({ status: statusCode } as Response, ["4XX", "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.AgentSchemas, | errors.ErrorResponse | GleanBaseError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError >( M.json(200, components.AgentSchemas$inboundSchema), M.jsonErr([404, 422], errors.ErrorResponse$inboundSchema), M.fail([400, 403, "4XX"]), M.fail([500, "5XX"]), )(response, req, { extraFields: responseFields }); if (!result.ok) { return [result, { status: "complete", request: req, response }]; } return [result, { status: "complete", request: req, response }]; }