attio-js/src/funcs/recordsListAttributeValues.ts

Developer-friendly & type-safe JS/TS SDK based on the official OpenAPI spec of Attio.

/*
 * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
 */

import { AttioCore } from "../core.js";
import { encodeFormQuery, encodeSimple } 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 { APIError } from "../models/errors/apierror.js";
import {
  GetV2ObjectsObjectRecordsRecordIdAttributesAttributeValuesValidationTypeError,
  GetV2ObjectsObjectRecordsRecordIdAttributesAttributeValuesValidationTypeError$inboundSchema,
  GetV2TargetIdentifierAttributesAttributeNotFoundError,
  GetV2TargetIdentifierAttributesAttributeNotFoundError$inboundSchema,
} from "../models/errors/getv2objectsobject.js";
import {
  ConnectionError,
  InvalidRequestError,
  RequestAbortedError,
  RequestTimeoutError,
  UnexpectedClientError,
} from "../models/errors/httpclienterrors.js";
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
import {
  GetV2ObjectsObjectRecordsRecordIdAttributesAttributeValuesRequest,
  GetV2ObjectsObjectRecordsRecordIdAttributesAttributeValuesRequest$outboundSchema,
  GetV2ObjectsObjectRecordsRecordIdAttributesAttributeValuesResponse,
  GetV2ObjectsObjectRecordsRecordIdAttributesAttributeValuesResponse$inboundSchema,
} from "../models/operations/getv2objectsobjectrecordsrecordidattributesattributevalues.js";
import { APICall, APIPromise } from "../types/async.js";
import { Result } from "../types/fp.js";

/**
 * List record attribute values
 *
 * @remarks
 * Gets all values for a given attribute on a record. If the attribute is historic, this endpoint has the ability to return all historic values using the `show_historic` query param.
 *
 * Required scopes: `record_permission:read`, `object_configuration:read`.
 */
export function recordsListAttributeValues(
  client: AttioCore,
  request: GetV2ObjectsObjectRecordsRecordIdAttributesAttributeValuesRequest,
  options?: RequestOptions,
): APIPromise<
  Result<
    GetV2ObjectsObjectRecordsRecordIdAttributesAttributeValuesResponse,
    | GetV2ObjectsObjectRecordsRecordIdAttributesAttributeValuesValidationTypeError
    | GetV2TargetIdentifierAttributesAttributeNotFoundError
    | APIError
    | SDKValidationError
    | UnexpectedClientError
    | InvalidRequestError
    | RequestAbortedError
    | RequestTimeoutError
    | ConnectionError
  >
> {
  return new APIPromise($do(
    client,
    request,
    options,
  ));
}

async function $do(
  client: AttioCore,
  request: GetV2ObjectsObjectRecordsRecordIdAttributesAttributeValuesRequest,
  options?: RequestOptions,
): Promise<
  [
    Result<
      GetV2ObjectsObjectRecordsRecordIdAttributesAttributeValuesResponse,
      | GetV2ObjectsObjectRecordsRecordIdAttributesAttributeValuesValidationTypeError
      | GetV2TargetIdentifierAttributesAttributeNotFoundError
      | APIError
      | SDKValidationError
      | UnexpectedClientError
      | InvalidRequestError
      | RequestAbortedError
      | RequestTimeoutError
      | ConnectionError
    >,
    APICall,
  ]
> {
  const parsed = safeParse(
    request,
    (value) =>
      GetV2ObjectsObjectRecordsRecordIdAttributesAttributeValuesRequest$outboundSchema
        .parse(value),
    "Input validation failed",
  );
  if (!parsed.ok) {
    return [parsed, { status: "invalid" }];
  }
  const payload = parsed.value;
  const body = null;

  const pathParams = {
    attribute: encodeSimple("attribute", payload.attribute, {
      explode: false,
      charEncoding: "percent",
    }),
    object: encodeSimple("object", payload.object, {
      explode: false,
      charEncoding: "percent",
    }),
    record_id: encodeSimple("record_id", payload.record_id, {
      explode: false,
      charEncoding: "percent",
    }),
  };

  const path = pathToFunc(
    "/v2/objects/{object}/records/{record_id}/attributes/{attribute}/values",
  )(pathParams);

  const query = encodeFormQuery({
    "limit": payload.limit,
    "offset": payload.offset,
    "show_historic": payload.show_historic,
  });

  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 = {
    baseURL: options?.serverURL ?? client._baseURL ?? "",
    operationID:
      "get_/v2/objects/{object}/records/{record_id}/attributes/{attribute}/values",
    oAuth2Scopes: [],

    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,
    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", "404", "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<
    GetV2ObjectsObjectRecordsRecordIdAttributesAttributeValuesResponse,
    | GetV2ObjectsObjectRecordsRecordIdAttributesAttributeValuesValidationTypeError
    | GetV2TargetIdentifierAttributesAttributeNotFoundError
    | APIError
    | SDKValidationError
    | UnexpectedClientError
    | InvalidRequestError
    | RequestAbortedError
    | RequestTimeoutError
    | ConnectionError
  >(
    M.json(
      200,
      GetV2ObjectsObjectRecordsRecordIdAttributesAttributeValuesResponse$inboundSchema,
    ),
    M.jsonErr(
      400,
      GetV2ObjectsObjectRecordsRecordIdAttributesAttributeValuesValidationTypeError$inboundSchema,
    ),
    M.jsonErr(
      404,
      GetV2TargetIdentifierAttributesAttributeNotFoundError$inboundSchema,
    ),
    M.fail("4XX"),
    M.fail("5XX"),
  )(response, { extraFields: responseFields });
  if (!result.ok) {
    return [result, { status: "complete", request: req, response }];
  }

  return [result, { status: "complete", request: req, response }];
}