@compass-labs/api-sdk 2.2.106 → 2.2.107

package/src/funcs/riskYieldRiskYieldPools.ts

@@ -1,204 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import { CompassApiSDKCore } from "../core.js";
-import { encodeFormQuery } 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 { CompassAPISDKError } from "../models/errors/compassapisdkerror.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 pools
- *
- * @remarks
- * Pools you could provide liquidity to, ranked by what you would keep.
- *
- * **Read `lp_earns_fees` first.** The launchpad that dominates this chain
- * graduates tokens into pools whose hook takes the swap fee, so they trade
- * enormously and pay an external liquidity provider nothing. Those pools are
- * listed — they carry the memecoin's price and volume — with a fee APR of
- * exactly zero and a note saying why. Pass `lp_earns_fees=true` to hide them.
- *
- * The default ordering is `il_adjusted_apr_7d`: the fee APR less the expected
- * impermanent-loss drag from the pair's own volatility. A pool paying 200% on
- * an asset that moves 400% is not a better position than one paying 20% on an
- * asset that moves 30%, and sorting on the raw APR would say it was.
- *
- * Pools too thin for a rate to mean anything — under 20 swaps a day, or under
- * $1,000 of liquidity — are served with `ranked: false` and always sort last.
- */
-export function riskYieldRiskYieldPools(
-  client: CompassApiSDKCore,
-  request: operations.V2RiskYieldPoolsRequest,
-  options?: RequestOptions,
-): APIPromise<
-  Result<
-    components.DexPoolsResponse,
-    | errors.HTTPValidationError
-    | CompassAPISDKError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
-  >
-> {
-  return new APIPromise($do(
-    client,
-    request,
-    options,
-  ));
-}
-
-async function $do(
-  client: CompassApiSDKCore,
-  request: operations.V2RiskYieldPoolsRequest,
-  options?: RequestOptions,
-): Promise<
-  [
-    Result<
-      components.DexPoolsResponse,
-      | errors.HTTPValidationError
-      | CompassAPISDKError
-      | ResponseValidationError
-      | ConnectionError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | InvalidRequestError
-      | UnexpectedClientError
-      | SDKValidationError
-    >,
-    APICall,
-  ]
-> {
-  const parsed = safeParse(
-    request,
-    (value) => operations.V2RiskYieldPoolsRequest$outboundSchema.parse(value),
-    "Input validation failed",
-  );
-  if (!parsed.ok) {
-    return [parsed, { status: "invalid" }];
-  }
-  const payload = parsed.value;
-  const body = null;
-
-  const path = pathToFunc("/v2/risk_yield/pools")();
-
-  const query = encodeFormQuery({
-    "chain": payload.chain,
-    "dex_version": payload.dex_version,
-    "direction": payload.direction,
-    "launchpad": payload.launchpad,
-    "limit": payload.limit,
-    "lp_earns_fees": payload.lp_earns_fees,
-    "lp_open": payload.lp_open,
-    "min_tvl_usd": payload.min_tvl_usd,
-    "min_volume_24h_usd": payload.min_volume_24h_usd,
-    "offset": payload.offset,
-    "order_by": payload.order_by,
-    "pair_class": payload.pair_class,
-    "stock_ticker": payload.stock_ticker,
-    "token": payload.token,
-    "watched": payload.watched,
-  });
-
-  const headers = new Headers(compactMap({
-    Accept: "application/json",
-  }));
-
-  const secConfig = await extractSecurity(client._options.apiKeyAuth);
-  const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
-  const requestSecurity = resolveGlobalSecurity(securityInput);
-
-  const context = {
-    options: client._options,
-    baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "v2_risk_yield_pools",
-    oAuth2Scopes: null,
-
-    resolvedSecurity: requestSecurity,
-
-    securitySource: client._options.apiKeyAuth,
-    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.DexPoolsResponse,
-    | errors.HTTPValidationError
-    | CompassAPISDKError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
-  >(
-    M.json(200, components.DexPoolsResponse$inboundSchema),
-    M.jsonErr(422, errors.HTTPValidationError$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 }];
-}

package/src/funcs/riskYieldRiskYieldPoolsPoolId.ts

@@ -1,190 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import { CompassApiSDKCore } 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 { CompassAPISDKError } from "../models/errors/compassapisdkerror.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";
-
-/**
- * Get pool detail
- *
- * @remarks
- * One pool, with its price history and the caveats that apply to it.
- *
- * For a pool holding a tokenized stock, `stock_reference` compares the pool's
- * price against the stock's own. They drift: the pool trades around the clock
- * while the stock trades in a session, and that gap is what a liquidity
- * provider is quoting against overnight.
- */
-export function riskYieldRiskYieldPoolsPoolId(
-  client: CompassApiSDKCore,
-  request: operations.V2RiskYieldPoolsPoolIdRequest,
-  options?: RequestOptions,
-): APIPromise<
-  Result<
-    components.DexPoolDetailResponse,
-    | errors.HTTPValidationError
-    | CompassAPISDKError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
-  >
-> {
-  return new APIPromise($do(
-    client,
-    request,
-    options,
-  ));
-}
-
-async function $do(
-  client: CompassApiSDKCore,
-  request: operations.V2RiskYieldPoolsPoolIdRequest,
-  options?: RequestOptions,
-): Promise<
-  [
-    Result<
-      components.DexPoolDetailResponse,
-      | errors.HTTPValidationError
-      | CompassAPISDKError
-      | ResponseValidationError
-      | ConnectionError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | InvalidRequestError
-      | UnexpectedClientError
-      | SDKValidationError
-    >,
-    APICall,
-  ]
-> {
-  const parsed = safeParse(
-    request,
-    (value) =>
-      operations.V2RiskYieldPoolsPoolIdRequest$outboundSchema.parse(value),
-    "Input validation failed",
-  );
-  if (!parsed.ok) {
-    return [parsed, { status: "invalid" }];
-  }
-  const payload = parsed.value;
-  const body = null;
-
-  const pathParams = {
-    pool_id: encodeSimple("pool_id", payload.pool_id, {
-      explode: false,
-      charEncoding: "percent",
-    }),
-  };
-  const path = pathToFunc("/v2/risk_yield/pools/{pool_id}")(pathParams);
-
-  const query = encodeFormQuery({
-    "chain": payload.chain,
-    "depth_words": payload.depth_words,
-    "history": payload.history,
-  });
-
-  const headers = new Headers(compactMap({
-    Accept: "application/json",
-  }));
-
-  const secConfig = await extractSecurity(client._options.apiKeyAuth);
-  const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
-  const requestSecurity = resolveGlobalSecurity(securityInput);
-
-  const context = {
-    options: client._options,
-    baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "v2_risk_yield_pools_{pool_id}",
-    oAuth2Scopes: null,
-
-    resolvedSecurity: requestSecurity,
-
-    securitySource: client._options.apiKeyAuth,
-    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.DexPoolDetailResponse,
-    | errors.HTTPValidationError
-    | CompassAPISDKError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
-  >(
-    M.json(200, components.DexPoolDetailResponse$inboundSchema),
-    M.jsonErr(422, errors.HTTPValidationError$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 }];
-}

package/src/funcs/riskYieldRiskYieldPositions.ts

@@ -1,195 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import { CompassApiSDKCore } from "../core.js";
-import { encodeFormQuery } 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 { CompassAPISDKError } from "../models/errors/compassapisdkerror.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 LP positions
- *
- * @remarks
- * Your liquidity positions: what they hold, what they cost, what they paid.
- *
- * Only the first of those is on chain. A position reports its liquidity and
- * its range; it does not report the amounts that opened it or what has already
- * been collected. Those come from recorded events, and where there are none
- * `cost_basis.source` is `unavailable` and the PnL fields are null rather than
- * guessed — an invented cost basis would make every number derived from it
- * wrong in the same direction.
- *
- * `hold_value_usd` is what the deposited amounts would be worth if they had
- * simply been held. The gap between that and `value_usd` is impermanent loss,
- * and it is the number that decides whether the fees were worth it.
- *
- * `needs_rebalance` and `rebalance_reasons` say what the API would look at, not
- * what it will do: rebalancing realizes the loss, pays gas twice and a swap,
- * and puts the position back at risk from a new price.
- */
-export function riskYieldRiskYieldPositions(
-  client: CompassApiSDKCore,
-  request: operations.V2RiskYieldPositionsRequest,
-  options?: RequestOptions,
-): APIPromise<
-  Result<
-    components.RiskYieldPositionsResponse,
-    | errors.HTTPValidationError
-    | CompassAPISDKError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
-  >
-> {
-  return new APIPromise($do(
-    client,
-    request,
-    options,
-  ));
-}
-
-async function $do(
-  client: CompassApiSDKCore,
-  request: operations.V2RiskYieldPositionsRequest,
-  options?: RequestOptions,
-): Promise<
-  [
-    Result<
-      components.RiskYieldPositionsResponse,
-      | errors.HTTPValidationError
-      | CompassAPISDKError
-      | ResponseValidationError
-      | ConnectionError
-      | RequestAbortedError
-      | RequestTimeoutError
-      | InvalidRequestError
-      | UnexpectedClientError
-      | SDKValidationError
-    >,
-    APICall,
-  ]
-> {
-  const parsed = safeParse(
-    request,
-    (value) =>
-      operations.V2RiskYieldPositionsRequest$outboundSchema.parse(value),
-    "Input validation failed",
-  );
-  if (!parsed.ok) {
-    return [parsed, { status: "invalid" }];
-  }
-  const payload = parsed.value;
-  const body = null;
-
-  const path = pathToFunc("/v2/risk_yield/positions")();
-
-  const query = encodeFormQuery({
-    "chain": payload.chain,
-    "dex_version": payload.dex_version,
-    "include_closed": payload.include_closed,
-    "owner": payload.owner,
-  });
-
-  const headers = new Headers(compactMap({
-    Accept: "application/json",
-  }));
-
-  const secConfig = await extractSecurity(client._options.apiKeyAuth);
-  const securityInput = secConfig == null ? {} : { apiKeyAuth: secConfig };
-  const requestSecurity = resolveGlobalSecurity(securityInput);
-
-  const context = {
-    options: client._options,
-    baseURL: options?.serverURL ?? client._baseURL ?? "",
-    operationID: "v2_risk_yield_positions",
-    oAuth2Scopes: null,
-
-    resolvedSecurity: requestSecurity,
-
-    securitySource: client._options.apiKeyAuth,
-    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.RiskYieldPositionsResponse,
-    | errors.HTTPValidationError
-    | CompassAPISDKError
-    | ResponseValidationError
-    | ConnectionError
-    | RequestAbortedError
-    | RequestTimeoutError
-    | InvalidRequestError
-    | UnexpectedClientError
-    | SDKValidationError
-  >(
-    M.json(200, components.RiskYieldPositionsResponse$inboundSchema),
-    M.jsonErr(422, errors.HTTPValidationError$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 }];
-}