@compass-labs/api-sdk 1.0.3 → 1.0.5

package/src/models/components/ethenadepositparams.ts

@@ -0,0 +1,142 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * The amount of USDe to deposit into Ethena's vault.
+ */
+export type EthenaDepositParamsAmount = number | string;
+
+export type EthenaDepositParams = {
+  actionType?: "ETHENA_DEPOSIT" | undefined;
+  /**
+   * The amount of USDe to deposit into Ethena's vault.
+   */
+  amount: number | string;
+  /**
+   * The address which will receive the shares (sUSDe) from Ethena's vault representing their proportional ownership of the vault's assets. Defaults to the sender.
+   */
+  receiver?: string | null | undefined;
+};
+
+/** @internal */
+export const EthenaDepositParamsAmount$inboundSchema: z.ZodType<
+  EthenaDepositParamsAmount,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.number(), z.string()]);
+
+/** @internal */
+export type EthenaDepositParamsAmount$Outbound = number | string;
+
+/** @internal */
+export const EthenaDepositParamsAmount$outboundSchema: z.ZodType<
+  EthenaDepositParamsAmount$Outbound,
+  z.ZodTypeDef,
+  EthenaDepositParamsAmount
+> = z.union([z.number(), z.string()]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EthenaDepositParamsAmount$ {
+  /** @deprecated use `EthenaDepositParamsAmount$inboundSchema` instead. */
+  export const inboundSchema = EthenaDepositParamsAmount$inboundSchema;
+  /** @deprecated use `EthenaDepositParamsAmount$outboundSchema` instead. */
+  export const outboundSchema = EthenaDepositParamsAmount$outboundSchema;
+  /** @deprecated use `EthenaDepositParamsAmount$Outbound` instead. */
+  export type Outbound = EthenaDepositParamsAmount$Outbound;
+}
+
+export function ethenaDepositParamsAmountToJSON(
+  ethenaDepositParamsAmount: EthenaDepositParamsAmount,
+): string {
+  return JSON.stringify(
+    EthenaDepositParamsAmount$outboundSchema.parse(ethenaDepositParamsAmount),
+  );
+}
+
+export function ethenaDepositParamsAmountFromJSON(
+  jsonString: string,
+): SafeParseResult<EthenaDepositParamsAmount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EthenaDepositParamsAmount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EthenaDepositParamsAmount' from JSON`,
+  );
+}
+
+/** @internal */
+export const EthenaDepositParams$inboundSchema: z.ZodType<
+  EthenaDepositParams,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  action_type: z.literal("ETHENA_DEPOSIT").default("ETHENA_DEPOSIT"),
+  amount: z.union([z.number(), z.string()]),
+  receiver: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "action_type": "actionType",
+  });
+});
+
+/** @internal */
+export type EthenaDepositParams$Outbound = {
+  action_type: "ETHENA_DEPOSIT";
+  amount: number | string;
+  receiver?: string | null | undefined;
+};
+
+/** @internal */
+export const EthenaDepositParams$outboundSchema: z.ZodType<
+  EthenaDepositParams$Outbound,
+  z.ZodTypeDef,
+  EthenaDepositParams
+> = z.object({
+  actionType: z.literal("ETHENA_DEPOSIT").default("ETHENA_DEPOSIT" as const),
+  amount: z.union([z.number(), z.string()]),
+  receiver: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    actionType: "action_type",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EthenaDepositParams$ {
+  /** @deprecated use `EthenaDepositParams$inboundSchema` instead. */
+  export const inboundSchema = EthenaDepositParams$inboundSchema;
+  /** @deprecated use `EthenaDepositParams$outboundSchema` instead. */
+  export const outboundSchema = EthenaDepositParams$outboundSchema;
+  /** @deprecated use `EthenaDepositParams$Outbound` instead. */
+  export type Outbound = EthenaDepositParams$Outbound;
+}
+
+export function ethenaDepositParamsToJSON(
+  ethenaDepositParams: EthenaDepositParams,
+): string {
+  return JSON.stringify(
+    EthenaDepositParams$outboundSchema.parse(ethenaDepositParams),
+  );
+}
+
+export function ethenaDepositParamsFromJSON(
+  jsonString: string,
+): SafeParseResult<EthenaDepositParams, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EthenaDepositParams$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EthenaDepositParams' from JSON`,
+  );
+}

package/src/models/components/ethenadepositrequest.ts

@@ -0,0 +1,182 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * The amount of USDe to deposit into Ethena's vault.
+ */
+export type EthenaDepositRequestAmount = number | string;
+
+export const EthenaDepositRequestChain = {
+  Ethereum: "ethereum",
+} as const;
+export type EthenaDepositRequestChain = ClosedEnum<
+  typeof EthenaDepositRequestChain
+>;
+
+export type EthenaDepositRequest = {
+  actionType?: "ETHENA_DEPOSIT" | undefined;
+  /**
+   * The amount of USDe to deposit into Ethena's vault.
+   */
+  amount: number | string;
+  /**
+   * The address which will receive the shares (sUSDe) from Ethena's vault representing their proportional ownership of the vault's assets. Defaults to the sender.
+   */
+  receiver?: string | null | undefined;
+  chain: EthenaDepositRequestChain;
+  /**
+   * The address of the transaction sender.
+   */
+  sender: string;
+};
+
+/** @internal */
+export const EthenaDepositRequestAmount$inboundSchema: z.ZodType<
+  EthenaDepositRequestAmount,
+  z.ZodTypeDef,
+  unknown
+> = z.union([z.number(), z.string()]);
+
+/** @internal */
+export type EthenaDepositRequestAmount$Outbound = number | string;
+
+/** @internal */
+export const EthenaDepositRequestAmount$outboundSchema: z.ZodType<
+  EthenaDepositRequestAmount$Outbound,
+  z.ZodTypeDef,
+  EthenaDepositRequestAmount
+> = z.union([z.number(), z.string()]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EthenaDepositRequestAmount$ {
+  /** @deprecated use `EthenaDepositRequestAmount$inboundSchema` instead. */
+  export const inboundSchema = EthenaDepositRequestAmount$inboundSchema;
+  /** @deprecated use `EthenaDepositRequestAmount$outboundSchema` instead. */
+  export const outboundSchema = EthenaDepositRequestAmount$outboundSchema;
+  /** @deprecated use `EthenaDepositRequestAmount$Outbound` instead. */
+  export type Outbound = EthenaDepositRequestAmount$Outbound;
+}
+
+export function ethenaDepositRequestAmountToJSON(
+  ethenaDepositRequestAmount: EthenaDepositRequestAmount,
+): string {
+  return JSON.stringify(
+    EthenaDepositRequestAmount$outboundSchema.parse(ethenaDepositRequestAmount),
+  );
+}
+
+export function ethenaDepositRequestAmountFromJSON(
+  jsonString: string,
+): SafeParseResult<EthenaDepositRequestAmount, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EthenaDepositRequestAmount$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EthenaDepositRequestAmount' from JSON`,
+  );
+}
+
+/** @internal */
+export const EthenaDepositRequestChain$inboundSchema: z.ZodNativeEnum<
+  typeof EthenaDepositRequestChain
+> = z.nativeEnum(EthenaDepositRequestChain);
+
+/** @internal */
+export const EthenaDepositRequestChain$outboundSchema: z.ZodNativeEnum<
+  typeof EthenaDepositRequestChain
+> = EthenaDepositRequestChain$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EthenaDepositRequestChain$ {
+  /** @deprecated use `EthenaDepositRequestChain$inboundSchema` instead. */
+  export const inboundSchema = EthenaDepositRequestChain$inboundSchema;
+  /** @deprecated use `EthenaDepositRequestChain$outboundSchema` instead. */
+  export const outboundSchema = EthenaDepositRequestChain$outboundSchema;
+}
+
+/** @internal */
+export const EthenaDepositRequest$inboundSchema: z.ZodType<
+  EthenaDepositRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  action_type: z.literal("ETHENA_DEPOSIT").default("ETHENA_DEPOSIT"),
+  amount: z.union([z.number(), z.string()]),
+  receiver: z.nullable(z.string()).optional(),
+  chain: EthenaDepositRequestChain$inboundSchema,
+  sender: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "action_type": "actionType",
+  });
+});
+
+/** @internal */
+export type EthenaDepositRequest$Outbound = {
+  action_type: "ETHENA_DEPOSIT";
+  amount: number | string;
+  receiver?: string | null | undefined;
+  chain: string;
+  sender: string;
+};
+
+/** @internal */
+export const EthenaDepositRequest$outboundSchema: z.ZodType<
+  EthenaDepositRequest$Outbound,
+  z.ZodTypeDef,
+  EthenaDepositRequest
+> = z.object({
+  actionType: z.literal("ETHENA_DEPOSIT").default("ETHENA_DEPOSIT" as const),
+  amount: z.union([z.number(), z.string()]),
+  receiver: z.nullable(z.string()).optional(),
+  chain: EthenaDepositRequestChain$outboundSchema,
+  sender: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    actionType: "action_type",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EthenaDepositRequest$ {
+  /** @deprecated use `EthenaDepositRequest$inboundSchema` instead. */
+  export const inboundSchema = EthenaDepositRequest$inboundSchema;
+  /** @deprecated use `EthenaDepositRequest$outboundSchema` instead. */
+  export const outboundSchema = EthenaDepositRequest$outboundSchema;
+  /** @deprecated use `EthenaDepositRequest$Outbound` instead. */
+  export type Outbound = EthenaDepositRequest$Outbound;
+}
+
+export function ethenaDepositRequestToJSON(
+  ethenaDepositRequest: EthenaDepositRequest,
+): string {
+  return JSON.stringify(
+    EthenaDepositRequest$outboundSchema.parse(ethenaDepositRequest),
+  );
+}
+
+export function ethenaDepositRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<EthenaDepositRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EthenaDepositRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EthenaDepositRequest' from JSON`,
+  );
+}

package/src/models/components/ethenagetvaultresponse.ts

@@ -0,0 +1,188 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  Apy,
+  Apy$inboundSchema,
+  Apy$Outbound,
+  Apy$outboundSchema,
+} from "./apy.js";
+import {
+  CompassApiBackendModelsVaultsReadResponseVaultUserPosition,
+  CompassApiBackendModelsVaultsReadResponseVaultUserPosition$inboundSchema,
+  CompassApiBackendModelsVaultsReadResponseVaultUserPosition$Outbound,
+  CompassApiBackendModelsVaultsReadResponseVaultUserPosition$outboundSchema,
+} from "./compassapibackendmodelsvaultsreadresponsevaultuserposition.js";
+import {
+  CooldownPosition,
+  CooldownPosition$inboundSchema,
+  CooldownPosition$Outbound,
+  CooldownPosition$outboundSchema,
+} from "./cooldownposition.js";
+import {
+  UnderlyingToken,
+  UnderlyingToken$inboundSchema,
+  UnderlyingToken$Outbound,
+  UnderlyingToken$outboundSchema,
+} from "./underlyingtoken.js";
+
+export type EthenaGetVaultResponse = {
+  /**
+   * Name of the vault.
+   */
+  name: string;
+  /**
+   * Symbol of the vault.
+   */
+  symbol: string;
+  /**
+   * Number of decimals used for the vault's share precision.
+   */
+  decimals: number;
+  /**
+   * Total amount of assets deposited in the vault.
+   */
+  totalAssets: string;
+  /**
+   * Total amount of shares issued from the vault.
+   */
+  totalSupply: string;
+  /**
+   * The price of one vault share in terms of the underlying asset.
+   */
+  sharePrice: string;
+  underlyingToken: UnderlyingToken;
+  apy: Apy;
+  /**
+   * The user's position in the vault.
+   */
+  userPosition?:
+    | CompassApiBackendModelsVaultsReadResponseVaultUserPosition
+    | null
+    | undefined;
+  /**
+   * The duration of days that must pass before a position can be withdrawn from the Ethena vault after a request to withdraw has been made.
+   */
+  cooldownDurationDays: number;
+  /**
+   * The user's cooldown position.
+   */
+  cooldownPosition?: CooldownPosition | null | undefined;
+};
+
+/** @internal */
+export const EthenaGetVaultResponse$inboundSchema: z.ZodType<
+  EthenaGetVaultResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  symbol: z.string(),
+  decimals: z.number().int(),
+  total_assets: z.string(),
+  total_supply: z.string(),
+  share_price: z.string(),
+  underlying_token: UnderlyingToken$inboundSchema,
+  apy: Apy$inboundSchema,
+  user_position: z.nullable(
+    CompassApiBackendModelsVaultsReadResponseVaultUserPosition$inboundSchema,
+  ).optional(),
+  cooldown_duration_days: z.number().int(),
+  cooldown_position: z.nullable(CooldownPosition$inboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "total_assets": "totalAssets",
+    "total_supply": "totalSupply",
+    "share_price": "sharePrice",
+    "underlying_token": "underlyingToken",
+    "user_position": "userPosition",
+    "cooldown_duration_days": "cooldownDurationDays",
+    "cooldown_position": "cooldownPosition",
+  });
+});
+
+/** @internal */
+export type EthenaGetVaultResponse$Outbound = {
+  name: string;
+  symbol: string;
+  decimals: number;
+  total_assets: string;
+  total_supply: string;
+  share_price: string;
+  underlying_token: UnderlyingToken$Outbound;
+  apy: Apy$Outbound;
+  user_position?:
+    | CompassApiBackendModelsVaultsReadResponseVaultUserPosition$Outbound
+    | null
+    | undefined;
+  cooldown_duration_days: number;
+  cooldown_position?: CooldownPosition$Outbound | null | undefined;
+};
+
+/** @internal */
+export const EthenaGetVaultResponse$outboundSchema: z.ZodType<
+  EthenaGetVaultResponse$Outbound,
+  z.ZodTypeDef,
+  EthenaGetVaultResponse
+> = z.object({
+  name: z.string(),
+  symbol: z.string(),
+  decimals: z.number().int(),
+  totalAssets: z.string(),
+  totalSupply: z.string(),
+  sharePrice: z.string(),
+  underlyingToken: UnderlyingToken$outboundSchema,
+  apy: Apy$outboundSchema,
+  userPosition: z.nullable(
+    CompassApiBackendModelsVaultsReadResponseVaultUserPosition$outboundSchema,
+  ).optional(),
+  cooldownDurationDays: z.number().int(),
+  cooldownPosition: z.nullable(CooldownPosition$outboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    totalAssets: "total_assets",
+    totalSupply: "total_supply",
+    sharePrice: "share_price",
+    underlyingToken: "underlying_token",
+    userPosition: "user_position",
+    cooldownDurationDays: "cooldown_duration_days",
+    cooldownPosition: "cooldown_position",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EthenaGetVaultResponse$ {
+  /** @deprecated use `EthenaGetVaultResponse$inboundSchema` instead. */
+  export const inboundSchema = EthenaGetVaultResponse$inboundSchema;
+  /** @deprecated use `EthenaGetVaultResponse$outboundSchema` instead. */
+  export const outboundSchema = EthenaGetVaultResponse$outboundSchema;
+  /** @deprecated use `EthenaGetVaultResponse$Outbound` instead. */
+  export type Outbound = EthenaGetVaultResponse$Outbound;
+}
+
+export function ethenaGetVaultResponseToJSON(
+  ethenaGetVaultResponse: EthenaGetVaultResponse,
+): string {
+  return JSON.stringify(
+    EthenaGetVaultResponse$outboundSchema.parse(ethenaGetVaultResponse),
+  );
+}
+
+export function ethenaGetVaultResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<EthenaGetVaultResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EthenaGetVaultResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EthenaGetVaultResponse' from JSON`,
+  );
+}

package/src/models/components/ethenarequesttowithdrawparams.ts

@@ -0,0 +1,88 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type EthenaRequestToWithdrawParams = {
+  actionType?: "ETHENA_REQUEST_WITHDRAW" | undefined;
+  /**
+   * The amount of USDe to request to withdraw from Ethena's vault. If set to 'ALL', your total deposited USDe amount will be requested to be withdrawn.
+   */
+  amount?: any | undefined;
+};
+
+/** @internal */
+export const EthenaRequestToWithdrawParams$inboundSchema: z.ZodType<
+  EthenaRequestToWithdrawParams,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  action_type: z.literal("ETHENA_REQUEST_WITHDRAW").default(
+    "ETHENA_REQUEST_WITHDRAW",
+  ),
+  amount: z.any().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "action_type": "actionType",
+  });
+});
+
+/** @internal */
+export type EthenaRequestToWithdrawParams$Outbound = {
+  action_type: "ETHENA_REQUEST_WITHDRAW";
+  amount?: any | undefined;
+};
+
+/** @internal */
+export const EthenaRequestToWithdrawParams$outboundSchema: z.ZodType<
+  EthenaRequestToWithdrawParams$Outbound,
+  z.ZodTypeDef,
+  EthenaRequestToWithdrawParams
+> = z.object({
+  actionType: z.literal("ETHENA_REQUEST_WITHDRAW").default(
+    "ETHENA_REQUEST_WITHDRAW" as const,
+  ),
+  amount: z.any().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    actionType: "action_type",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EthenaRequestToWithdrawParams$ {
+  /** @deprecated use `EthenaRequestToWithdrawParams$inboundSchema` instead. */
+  export const inboundSchema = EthenaRequestToWithdrawParams$inboundSchema;
+  /** @deprecated use `EthenaRequestToWithdrawParams$outboundSchema` instead. */
+  export const outboundSchema = EthenaRequestToWithdrawParams$outboundSchema;
+  /** @deprecated use `EthenaRequestToWithdrawParams$Outbound` instead. */
+  export type Outbound = EthenaRequestToWithdrawParams$Outbound;
+}
+
+export function ethenaRequestToWithdrawParamsToJSON(
+  ethenaRequestToWithdrawParams: EthenaRequestToWithdrawParams,
+): string {
+  return JSON.stringify(
+    EthenaRequestToWithdrawParams$outboundSchema.parse(
+      ethenaRequestToWithdrawParams,
+    ),
+  );
+}
+
+export function ethenaRequestToWithdrawParamsFromJSON(
+  jsonString: string,
+): SafeParseResult<EthenaRequestToWithdrawParams, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EthenaRequestToWithdrawParams$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EthenaRequestToWithdrawParams' from JSON`,
+  );
+}