/* * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. */ import { FathomCore } from "../core.js"; import { dlv } from "../lib/dlv.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 { FathomError } from "../sdk/models/errors/fathomerror.js"; import { ConnectionError, InvalidRequestError, RequestAbortedError, RequestTimeoutError, UnexpectedClientError, } from "../sdk/models/errors/httpclienterrors.js"; import { ResponseValidationError } from "../sdk/models/errors/responsevalidationerror.js"; import { SDKValidationError } from "../sdk/models/errors/sdkvalidationerror.js"; import * as operations from "../sdk/models/operations/index.js"; import { APICall, APIPromise } from "../sdk/types/async.js"; import { Result } from "../sdk/types/fp.js"; import { createPageIterator, haltIterator, PageIterator, Paginator, } from "../sdk/types/operations.js"; /** * List users and their permissions * * @remarks * List every user in the account along with their permissions. Restricted to account admins: if the API key does not belong to a user whose `settings_access` level is `account_admin`, this endpoint returns `403 Forbidden`. * * By default the list contains active and deactivated members followed by pending invitees — keep following `next_cursor` to page through all of them. Use `status` to narrow to one group. Invited users have no permissions yet, so their items omit the `permissions` object and `created_at` is the date they were invited. */ export function listUsers( client: FathomCore, request?: operations.ListUsersRequest | undefined, options?: RequestOptions, ): APIPromise< PageIterator< Result< operations.ListUsersResponse, | FathomError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError >, { cursor: string } > > { return new APIPromise($do( client, request, options, )); } async function $do( client: FathomCore, request?: operations.ListUsersRequest | undefined, options?: RequestOptions, ): Promise< [ PageIterator< Result< operations.ListUsersResponse, | FathomError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError >, { cursor: string } >, APICall, ] > { const parsed = safeParse( request, (value) => operations.ListUsersRequest$outboundSchema.optional().parse(value), "Input validation failed", ); if (!parsed.ok) { return [haltIterator(parsed), { status: "invalid" }]; } const payload = parsed.value; const body = null; const path = pathToFunc("/users")(); const query = encodeFormQuery({ "cursor": payload?.cursor, "settings_access": payload?.settings_access, "status": payload?.status, "team": payload?.team, }); const headers = new Headers(compactMap({ Accept: "application/json", })); const securityInput = await extractSecurity(client._options.security); const requestSecurity = resolveGlobalSecurity(securityInput); const context = { options: client._options, baseURL: options?.serverURL ?? client._baseURL ?? "", operationID: "listUsers", oAuth2Scopes: null, resolvedSecurity: requestSecurity, securitySource: client._options.security, retryConfig: options?.retries || client._options.retryConfig || { strategy: "backoff", backoff: { initialInterval: 500, maxInterval: 60000, exponent: 1.5, maxElapsedTime: 300000, }, retryConnectionErrors: true, } || { strategy: "none" }, retryCodes: options?.retryCodes || ["429"], }; 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 [haltIterator(requestRes), { status: "invalid" }]; } const req = requestRes.value; const doResult = await client._do(req, { context, errorCodes: ["400", "401", "403", "429", "4XX", "5XX"], retryConfig: context.retryConfig, retryCodes: context.retryCodes, }); if (!doResult.ok) { return [haltIterator(doResult), { status: "request-error", request: req }]; } const response = doResult.value; const responseFields = { HttpMeta: { Response: response, Request: req }, }; const [result, raw] = await M.match< operations.ListUsersResponse, | FathomError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError >( M.json(200, operations.ListUsersResponse$inboundSchema, { key: "Result" }), M.fail([400, 401, 403, 429, "4XX"]), M.fail("5XX"), )(response, req, { extraFields: responseFields }); if (!result.ok) { return [haltIterator(result), { status: "complete", request: req, response, }]; } const nextFunc = ( responseData: unknown, ): { next: Paginator< Result< operations.ListUsersResponse, | FathomError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError > >; "~next"?: { cursor: string }; } => { const nextCursor = dlv(responseData, "next_cursor"); if (typeof nextCursor !== "string") { return { next: () => null }; } if (nextCursor.trim() === "") { return { next: () => null }; } const nextVal = () => listUsers( client, { ...request, cursor: nextCursor, }, options, ); return { next: nextVal, "~next": { cursor: nextCursor } }; }; const page = { ...result, ...nextFunc(raw) }; return [{ ...page, ...createPageIterator(page, (v) => !v.ok) }, { status: "complete", request: req, response, }]; }