@compass-labs/api-sdk 2.2.65-rc.0 → 2.2.66-rc.0

package/docs/sdks/globalmarketsperps/README.md

@@ -18,6 +18,7 @@
 * [globalMarketsPerpsApproveBuilderFee](#globalmarketsperpsapprovebuilderfee) - Approve builder fee
 * [globalMarketsPerpsEnableUnifiedAccount](#globalmarketsperpsenableunifiedaccount) - Enable unified account mode
 * [globalMarketsPerpsEnsureLeverage](#globalmarketsperpsensureleverage) - Ensure 1x cross leverage
+* [globalMarketsPerpsSetLeverage](#globalmarketsperpssetleverage) - Set leverage (defaults to market maximum)
 
 ## globalMarketsPerpsOpportunities
 
@@ -1185,6 +1186,88 @@ run();
 
 ### Errors
 
+| Error Type                 | Status Code                | Content Type               |
+| -------------------------- | -------------------------- | -------------------------- |
+| errors.HTTPValidationError | 422                        | application/json           |
+| errors.APIError            | 4XX, 5XX                   | \*/\*                      |
+
+## globalMarketsPerpsSetLeverage
+
+Check leverage and prepare an updateLeverage action to the requested value.
+
+If `leverage` is omitted, targets the asset's maximum leverage for that
+market. If the asset is already at the requested leverage, returns
+leverage_ok=true with null typed_data — no signing needed. Otherwise,
+returns EIP-712 typed data for the user to sign. After signing, submit the
+signature via the /execute endpoint.
+
+### Example Usage
+
+<!-- UsageSnippet language="typescript" operationID="v2_global_markets_perps_set_leverage" method="post" path="/v2/global_markets_perps/set_leverage" -->
+```typescript
+import { CompassApiSDK } from "@compass-labs/api-sdk";
+
+const compassApiSDK = new CompassApiSDK({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const result = await compassApiSDK.globalMarketsPerps.globalMarketsPerpsSetLeverage({
+    owner: "<value>",
+    asset: "<value>",
+  });
+
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { CompassApiSDKCore } from "@compass-labs/api-sdk/core.js";
+import { globalMarketsPerpsGlobalMarketsPerpsSetLeverage } from "@compass-labs/api-sdk/funcs/globalMarketsPerpsGlobalMarketsPerpsSetLeverage.js";
+
+// Use `CompassApiSDKCore` for best tree-shaking performance.
+// You can create one instance of it to use across an application.
+const compassApiSDK = new CompassApiSDKCore({
+  apiKeyAuth: "<YOUR_API_KEY_HERE>",
+});
+
+async function run() {
+  const res = await globalMarketsPerpsGlobalMarketsPerpsSetLeverage(compassApiSDK, {
+    owner: "<value>",
+    asset: "<value>",
+  });
+  if (res.ok) {
+    const { value: result } = res;
+    console.log(result);
+  } else {
+    console.log("globalMarketsPerpsGlobalMarketsPerpsSetLeverage failed:", res.error);
+  }
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [components.GlobalMarketsPerpsSetLeverageRequest](../../models/components/globalmarketsperpssetleveragerequest.md)                                                             | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
+| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
+| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
+
+### Response
+
+**Promise\<[components.GlobalMarketsPerpsSetLeverageResponse](../../models/components/globalmarketsperpssetleverageresponse.md)\>**
+
+### Errors
+
 | Error Type                 | Status Code                | Content Type               |
 | -------------------------- | -------------------------- | -------------------------- |
 | errors.HTTPValidationError | 422                        | application/json           |

package/openapi_prepped_for_speakeasy.json

@@ -7016,6 +7016,49 @@
         "x-speakeasy-name-override": "global_markets_perps_ensure_leverage"
       }
     },
+    "/v2/global_markets_perps/set_leverage": {
+      "post": {
+        "tags": [
+          "Global Markets Perps"
+        ],
+        "summary": "Set leverage (defaults to market maximum)",
+        "description": "Check leverage and prepare an updateLeverage action to the requested value.\n\nIf `leverage` is omitted, targets the asset's maximum leverage for that\nmarket. If the asset is already at the requested leverage, returns\nleverage_ok=true with null typed_data \u2014 no signing needed. Otherwise,\nreturns EIP-712 typed data for the user to sign. After signing, submit the\nsignature via the /execute endpoint.",
+        "operationId": "v2_global_markets_perps_set_leverage",
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "$ref": "#/components/schemas/GlobalMarketsPerpsSetLeverageRequest"
+              }
+            }
+          },
+          "required": true
+        },
+        "responses": {
+          "200": {
+            "description": "Successful Response",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/GlobalMarketsPerpsSetLeverageResponse"
+                }
+              }
+            }
+          },
+          "422": {
+            "description": "Validation Error",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/HTTPValidationError"
+                }
+              }
+            }
+          }
+        },
+        "x-speakeasy-name-override": "global_markets_perps_set_leverage"
+      }
+    },
     "/v2/tokenized_assets/markets": {
       "get": {
         "tags": [
@@ -15373,6 +15416,93 @@
         "title": "GlobalMarketsPerpsPositionsResponse",
         "description": "List of open global markets perps positions with account balance."
       },
+      "GlobalMarketsPerpsSetLeverageRequest": {
+        "properties": {
+          "owner": {
+            "type": "string",
+            "title": "Owner",
+            "description": "User's EOA address"
+          },
+          "asset": {
+            "type": "string",
+            "title": "Asset",
+            "description": "Asset ticker (e.g. 'AAPL', 'CL')"
+          },
+          "leverage": {
+            "anyOf": [
+              {
+                "type": "integer",
+                "minimum": 1.0
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Leverage",
+            "description": "Target leverage as a whole-number multiplier. Omit (or pass null) to use the asset's maximum leverage. Must be between 1 and the asset's max leverage, which is available from the /opportunities endpoint."
+          }
+        },
+        "type": "object",
+        "required": [
+          "owner",
+          "asset"
+        ],
+        "title": "GlobalMarketsPerpsSetLeverageRequest",
+        "description": "Request to set leverage on a global markets perps asset.\n\nOmit ``leverage`` (or pass null) to target the asset's maximum leverage."
+      },
+      "GlobalMarketsPerpsSetLeverageResponse": {
+        "properties": {
+          "leverage_ok": {
+            "type": "boolean",
+            "title": "Leverage Ok",
+            "description": "True if leverage already matches the requested value, false if an update is needed"
+          },
+          "typed_data": {
+            "anyOf": [
+              {
+                "additionalProperties": true,
+                "type": "object"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Typed Data",
+            "description": "EIP-712 typed data for wallet signing, or null if no change is needed"
+          },
+          "action": {
+            "anyOf": [
+              {
+                "additionalProperties": true,
+                "type": "object"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Action",
+            "description": "Raw Hyperliquid action (passed back to the execute endpoint), or null"
+          },
+          "nonce": {
+            "anyOf": [
+              {
+                "type": "integer"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "title": "Nonce",
+            "description": "Timestamp-based nonce, or null if no action needed"
+          }
+        },
+        "type": "object",
+        "required": [
+          "leverage_ok"
+        ],
+        "title": "GlobalMarketsPerpsSetLeverageResponse",
+        "description": "Returned by the set_leverage endpoint.\n\nIf the asset is already at the requested leverage, typed_data/action/nonce\nare null. If not, they contain the EIP-712 payload the user must sign."
+      },
       "GlobalMarketsPerpsSignableActionResponse": {
         "properties": {
           "typed_data": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@compass-labs/api-sdk",
-  "version": "2.2.65-rc.0",
+  "version": "2.2.66-rc.0",
   "author": "royalnine",
   "type": "module",
   "tshy": {

package/src/funcs/globalMarketsPerpsGlobalMarketsPerpsSetLeverage.ts

@@ -0,0 +1,180 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { CompassApiSDKCore } from "../core.js";
+import { encodeJSON } 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 { APICall, APIPromise } from "../types/async.js";
+import { Result } from "../types/fp.js";
+
+/**
+ * Set leverage (defaults to market maximum)
+ *
+ * @remarks
+ * Check leverage and prepare an updateLeverage action to the requested value.
+ *
+ * If `leverage` is omitted, targets the asset's maximum leverage for that
+ * market. If the asset is already at the requested leverage, returns
+ * leverage_ok=true with null typed_data — no signing needed. Otherwise,
+ * returns EIP-712 typed data for the user to sign. After signing, submit the
+ * signature via the /execute endpoint.
+ */
+export function globalMarketsPerpsGlobalMarketsPerpsSetLeverage(
+  client: CompassApiSDKCore,
+  request: components.GlobalMarketsPerpsSetLeverageRequest,
+  options?: RequestOptions,
+): APIPromise<
+  Result<
+    components.GlobalMarketsPerpsSetLeverageResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >
+> {
+  return new APIPromise($do(
+    client,
+    request,
+    options,
+  ));
+}
+
+async function $do(
+  client: CompassApiSDKCore,
+  request: components.GlobalMarketsPerpsSetLeverageRequest,
+  options?: RequestOptions,
+): Promise<
+  [
+    Result<
+      components.GlobalMarketsPerpsSetLeverageResponse,
+      | errors.HTTPValidationError
+      | CompassAPISDKError
+      | ResponseValidationError
+      | ConnectionError
+      | RequestAbortedError
+      | RequestTimeoutError
+      | InvalidRequestError
+      | UnexpectedClientError
+      | SDKValidationError
+    >,
+    APICall,
+  ]
+> {
+  const parsed = safeParse(
+    request,
+    (value) =>
+      components.GlobalMarketsPerpsSetLeverageRequest$outboundSchema.parse(
+        value,
+      ),
+    "Input validation failed",
+  );
+  if (!parsed.ok) {
+    return [parsed, { status: "invalid" }];
+  }
+  const payload = parsed.value;
+  const body = encodeJSON("body", payload, { explode: true });
+
+  const path = pathToFunc("/v2/global_markets_perps/set_leverage")();
+
+  const headers = new Headers(compactMap({
+    "Content-Type": "application/json",
+    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_global_markets_perps_set_leverage",
+    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: "POST",
+    baseURL: options?.serverURL,
+    path: path,
+    headers: headers,
+    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.GlobalMarketsPerpsSetLeverageResponse,
+    | errors.HTTPValidationError
+    | CompassAPISDKError
+    | ResponseValidationError
+    | ConnectionError
+    | RequestAbortedError
+    | RequestTimeoutError
+    | InvalidRequestError
+    | UnexpectedClientError
+    | SDKValidationError
+  >(
+    M.json(200, components.GlobalMarketsPerpsSetLeverageResponse$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/lib/config.ts

@@ -62,7 +62,7 @@ export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "0.0.1",
   sdkVersion: "2.0.0",
-  genVersion: "2.906.0",
+  genVersion: "2.910.1",
   userAgent:
-    "speakeasy-sdk/typescript 2.0.0 2.906.0 0.0.1 @compass-labs/api-sdk",
+    "speakeasy-sdk/typescript 2.0.0 2.910.1 0.0.1 @compass-labs/api-sdk",
 } as const;

package/src/models/components/globalmarketsperpssetleveragerequest.ts

@@ -0,0 +1,55 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+/**
+ * Request to set leverage on a global markets perps asset.
+ *
+ * @remarks
+ *
+ * Omit ``leverage`` (or pass null) to target the asset's maximum leverage.
+ */
+export type GlobalMarketsPerpsSetLeverageRequest = {
+  /**
+   * User's EOA address
+   */
+  owner: string;
+  /**
+   * Asset ticker (e.g. 'AAPL', 'CL')
+   */
+  asset: string;
+  /**
+   * Target leverage as a whole-number multiplier. Omit (or pass null) to use the asset's maximum leverage. Must be between 1 and the asset's max leverage, which is available from the /opportunities endpoint.
+   */
+  leverage?: number | null | undefined;
+};
+
+/** @internal */
+export type GlobalMarketsPerpsSetLeverageRequest$Outbound = {
+  owner: string;
+  asset: string;
+  leverage?: number | null | undefined;
+};
+
+/** @internal */
+export const GlobalMarketsPerpsSetLeverageRequest$outboundSchema: z.ZodType<
+  GlobalMarketsPerpsSetLeverageRequest$Outbound,
+  z.ZodTypeDef,
+  GlobalMarketsPerpsSetLeverageRequest
+> = z.object({
+  owner: z.string(),
+  asset: z.string(),
+  leverage: z.nullable(z.number().int()).optional(),
+});
+
+export function globalMarketsPerpsSetLeverageRequestToJSON(
+  globalMarketsPerpsSetLeverageRequest: GlobalMarketsPerpsSetLeverageRequest,
+): string {
+  return JSON.stringify(
+    GlobalMarketsPerpsSetLeverageRequest$outboundSchema.parse(
+      globalMarketsPerpsSetLeverageRequest,
+    ),
+  );
+}

package/src/models/components/globalmarketsperpssetleverageresponse.ts

@@ -0,0 +1,64 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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";
+
+/**
+ * Returned by the set_leverage endpoint.
+ *
+ * @remarks
+ *
+ * If the asset is already at the requested leverage, typed_data/action/nonce
+ * are null. If not, they contain the EIP-712 payload the user must sign.
+ */
+export type GlobalMarketsPerpsSetLeverageResponse = {
+  /**
+   * True if leverage already matches the requested value, false if an update is needed
+   */
+  leverageOk: boolean;
+  /**
+   * EIP-712 typed data for wallet signing, or null if no change is needed
+   */
+  typedData?: { [k: string]: any } | null | undefined;
+  /**
+   * Raw Hyperliquid action (passed back to the execute endpoint), or null
+   */
+  action?: { [k: string]: any } | null | undefined;
+  /**
+   * Timestamp-based nonce, or null if no action needed
+   */
+  nonce?: number | null | undefined;
+};
+
+/** @internal */
+export const GlobalMarketsPerpsSetLeverageResponse$inboundSchema: z.ZodType<
+  GlobalMarketsPerpsSetLeverageResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  leverage_ok: z.boolean(),
+  typed_data: z.nullable(z.record(z.any())).optional(),
+  action: z.nullable(z.record(z.any())).optional(),
+  nonce: z.nullable(z.number().int()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "leverage_ok": "leverageOk",
+    "typed_data": "typedData",
+  });
+});
+
+export function globalMarketsPerpsSetLeverageResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<GlobalMarketsPerpsSetLeverageResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GlobalMarketsPerpsSetLeverageResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GlobalMarketsPerpsSetLeverageResponse' from JSON`,
+  );
+}

package/src/models/components/index.ts

@@ -171,6 +171,8 @@ export * from "./globalmarketsperpsopportunitiesresponse.js";
 export * from "./globalmarketsperpsopportunity.js";
 export * from "./globalmarketsperpsposition.js";
 export * from "./globalmarketsperpspositionsresponse.js";
+export * from "./globalmarketsperpssetleveragerequest.js";
+export * from "./globalmarketsperpssetleverageresponse.js";
 export * from "./globalmarketsperpssignableactionresponse.js";
 export * from "./globalmarketsperpswithdrawrequest.js";
 export * from "./interestratemode.js";

package/src/sdk/globalmarketsperps.ts

@@ -15,6 +15,7 @@ import { globalMarketsPerpsGlobalMarketsPerpsLimitOrder } from "../funcs/globalM
 import { globalMarketsPerpsGlobalMarketsPerpsMarketOrder } from "../funcs/globalMarketsPerpsGlobalMarketsPerpsMarketOrder.js";
 import { globalMarketsPerpsGlobalMarketsPerpsOpportunities } from "../funcs/globalMarketsPerpsGlobalMarketsPerpsOpportunities.js";
 import { globalMarketsPerpsGlobalMarketsPerpsPositions } from "../funcs/globalMarketsPerpsGlobalMarketsPerpsPositions.js";
+import { globalMarketsPerpsGlobalMarketsPerpsSetLeverage } from "../funcs/globalMarketsPerpsGlobalMarketsPerpsSetLeverage.js";
 import { globalMarketsPerpsGlobalMarketsPerpsWithdraw } from "../funcs/globalMarketsPerpsGlobalMarketsPerpsWithdraw.js";
 import { ClientSDK, RequestOptions } from "../lib/sdks.js";
 import * as components from "../models/components/index.js";
@@ -332,4 +333,27 @@ export class GlobalMarketsPerps extends ClientSDK {
       options,
     ));
   }
+
+  /**
+   * Set leverage (defaults to market maximum)
+   *
+   * @remarks
+   * Check leverage and prepare an updateLeverage action to the requested value.
+   *
+   * If `leverage` is omitted, targets the asset's maximum leverage for that
+   * market. If the asset is already at the requested leverage, returns
+   * leverage_ok=true with null typed_data — no signing needed. Otherwise,
+   * returns EIP-712 typed data for the user to sign. After signing, submit the
+   * signature via the /execute endpoint.
+   */
+  async globalMarketsPerpsSetLeverage(
+    request: components.GlobalMarketsPerpsSetLeverageRequest,
+    options?: RequestOptions,
+  ): Promise<components.GlobalMarketsPerpsSetLeverageResponse> {
+    return unwrapAsync(globalMarketsPerpsGlobalMarketsPerpsSetLeverage(
+      this,
+      request,
+      options,
+    ));
+  }
 }