@qtsurfer/api-client 0.4.0 → 0.6.0

package/src/generated/sdk.gen.ts

@@ -1,7 +1,7 @@
 // This file is auto-generated by @hey-api/openapi-ts
 
 import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
-import type { AuthData, AuthResponse, AuthError, GetExchangesData, GetExchangesResponse, GetInstrumentsData, GetInstrumentsResponse, GetInstrumentsError, GetSegmentInstrumentsData, GetSegmentInstrumentsResponse, GetSegmentInstrumentsError, GetExchangeTickersHourData, GetExchangeTickersHourResponse, GetExchangeTickersHourError, GetExchangeKlinesHourData, GetExchangeKlinesHourResponse, GetExchangeKlinesHourError, PostStrategyData, PostStrategyResponse, PostStrategyError, GetStrategyStatusData, GetStrategyStatusResponse, GetStrategyStatusError, PrepareBacktestingData, PrepareBacktestingResponse, PrepareBacktestingError, GetPreparationStatusData, GetPreparationStatusResponse, GetPreparationStatusError, ExecuteBacktestingData, ExecuteBacktestingResponse, ExecuteBacktestingError, CancelExecutionData, CancelExecutionResponse, CancelExecutionError, GetExecutionResultData, GetExecutionResultResponse, GetExecutionResultError } from './types.gen';
+import type { AuthenticateData, AuthenticateResponse, AuthenticateError, ListExchangesData, ListExchangesResponse, ListInstrumentsData, ListInstrumentsResponse, ListInstrumentsError, ListSegmentInstrumentsData, ListSegmentInstrumentsResponse, ListSegmentInstrumentsError, DownloadTickersData, DownloadTickersResponse, DownloadTickersError, DownloadKlinesData, DownloadKlinesResponse, DownloadKlinesError, CompileStrategyData, CompileStrategyResponse, CompileStrategyError, GetStrategyData, GetStrategyResponse, GetStrategyError, PrepareBacktestData, PrepareBacktestResponse, PrepareBacktestError, GetPrepareStatusData, GetPrepareStatusResponse, GetPrepareStatusError, ExecuteSweepData, ExecuteSweepResponse, ExecuteSweepError, CancelSweepData, CancelSweepResponse, CancelSweepError, GetSweepResultData, GetSweepResultResponse, GetSweepResultError, ExecuteBacktestData, ExecuteBacktestResponse, ExecuteBacktestError, CancelBacktestData, CancelBacktestResponse, CancelBacktestError, GetBacktestResultData, GetBacktestResultResponse, GetBacktestResultError } from './types.gen';
 import { client as _heyApiClient } from './client.gen';
 
 export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
@@ -30,8 +30,8 @@ export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends
  * before expiry (or on a `401` response) by calling this endpoint again.
  *
  */
-export const auth = <ThrowOnError extends boolean = false>(options?: Options<AuthData, ThrowOnError>) => {
-    return (options?.client ?? _heyApiClient).post<AuthResponse, AuthError, ThrowOnError>({
+export const authenticate = <ThrowOnError extends boolean = false>(options?: Options<AuthenticateData, ThrowOnError>) => {
+    return (options?.client ?? _heyApiClient).post<AuthenticateResponse, AuthenticateError, ThrowOnError>({
         security: [
             {
                 name: 'X-API-Key',
@@ -44,40 +44,40 @@ export const auth = <ThrowOnError extends boolean = false>(options?: Options<Aut
 };
 
 /**
- * Get a list of available exchanges
+ * List the available exchanges
  */
-export const getExchanges = <ThrowOnError extends boolean = false>(options?: Options<GetExchangesData, ThrowOnError>) => {
-    return (options?.client ?? _heyApiClient).get<GetExchangesResponse, unknown, ThrowOnError>({
+export const listExchanges = <ThrowOnError extends boolean = false>(options?: Options<ListExchangesData, ThrowOnError>) => {
+    return (options?.client ?? _heyApiClient).get<ListExchangesResponse, unknown, ThrowOnError>({
         url: '/exchanges',
         ...options
     });
 };
 
 /**
- * Get an exchange's instruments (default spot segment)
+ * List an exchange's instruments (default spot segment)
  * "Give me binance instruments" — returns the exchange's DEFAULT segment (`spot`)
  * in `data`, each instrument with per-data-type coverage and market info. `meta`
  * confirms the served `segment` (`spot`); HAL `_links` carry `self` plus the
  * `spot` / `futures` segment-discovery links.
  *
  */
-export const getInstruments = <ThrowOnError extends boolean = false>(options: Options<GetInstrumentsData, ThrowOnError>) => {
-    return (options.client ?? _heyApiClient).get<GetInstrumentsResponse, GetInstrumentsError, ThrowOnError>({
+export const listInstruments = <ThrowOnError extends boolean = false>(options: Options<ListInstrumentsData, ThrowOnError>) => {
+    return (options.client ?? _heyApiClient).get<ListInstrumentsResponse, ListInstrumentsError, ThrowOnError>({
         url: '/exchange/{exchangeId}/instruments',
         ...options
     });
 };
 
 /**
- * Get the instruments for a specific exchange segment
+ * List an exchange segment's instruments
  * Returns the instruments for one market segment of the exchange, each with
  * per-data-type coverage and market info. HAL `_links` carry `self` plus the
  * `spot` / `futures` segment-discovery links; the default-segment shortcut is
  * `GET /exchange/{exchangeId}/instruments` (spot).
  *
  */
-export const getSegmentInstruments = <ThrowOnError extends boolean = false>(options: Options<GetSegmentInstrumentsData, ThrowOnError>) => {
-    return (options.client ?? _heyApiClient).get<GetSegmentInstrumentsResponse, GetSegmentInstrumentsError, ThrowOnError>({
+export const listSegmentInstruments = <ThrowOnError extends boolean = false>(options: Options<ListSegmentInstrumentsData, ThrowOnError>) => {
+    return (options.client ?? _heyApiClient).get<ListSegmentInstrumentsResponse, ListSegmentInstrumentsError, ThrowOnError>({
         url: '/exchange/{exchangeId}/{segment}/instruments',
         ...options
     });
@@ -115,8 +115,8 @@ export const getSegmentInstruments = <ThrowOnError extends boolean = false>(opti
  * descriptive filename).
  *
  */
-export const getExchangeTickersHour = <ThrowOnError extends boolean = false>(options: Options<GetExchangeTickersHourData, ThrowOnError>) => {
-    return (options.client ?? _heyApiClient).get<GetExchangeTickersHourResponse, GetExchangeTickersHourError, ThrowOnError>({
+export const downloadTickers = <ThrowOnError extends boolean = false>(options: Options<DownloadTickersData, ThrowOnError>) => {
+    return (options.client ?? _heyApiClient).get<DownloadTickersResponse, DownloadTickersError, ThrowOnError>({
         url: '/exchange/{exchangeId}/tickers/{base}/{quote}',
         ...options
     });
@@ -134,8 +134,8 @@ export const getExchangeTickersHour = <ThrowOnError extends boolean = false>(opt
  * per-tick payload would be too large for the window of interest.
  *
  */
-export const getExchangeKlinesHour = <ThrowOnError extends boolean = false>(options: Options<GetExchangeKlinesHourData, ThrowOnError>) => {
-    return (options.client ?? _heyApiClient).get<GetExchangeKlinesHourResponse, GetExchangeKlinesHourError, ThrowOnError>({
+export const downloadKlines = <ThrowOnError extends boolean = false>(options: Options<DownloadKlinesData, ThrowOnError>) => {
+    return (options.client ?? _heyApiClient).get<DownloadKlinesResponse, DownloadKlinesError, ThrowOnError>({
         url: '/exchange/{exchangeId}/klines/{base}/{quote}',
         ...options
     });
@@ -152,8 +152,8 @@ export const getExchangeKlinesHour = <ThrowOnError extends boolean = false>(opti
  * same id.
  *
  */
-export const postStrategy = <ThrowOnError extends boolean = false>(options: Options<PostStrategyData, ThrowOnError>) => {
-    return (options.client ?? _heyApiClient).post<PostStrategyResponse, PostStrategyError, ThrowOnError>({
+export const compileStrategy = <ThrowOnError extends boolean = false>(options: Options<CompileStrategyData, ThrowOnError>) => {
+    return (options.client ?? _heyApiClient).post<CompileStrategyResponse, CompileStrategyError, ThrowOnError>({
         bodySerializer: null,
         security: [
             {
@@ -171,13 +171,13 @@ export const postStrategy = <ThrowOnError extends boolean = false>(options: Opti
 };
 
 /**
- * Get the status of an async compile task
+ * Get a strategy by id, including its compile status
  * Polls the status of a strategy compilation. Useful when the strategy was submitted with
  * `X-Compile-Async: true`. Returns the resolved `strategyId` once compilation completes.
  *
  */
-export const getStrategyStatus = <ThrowOnError extends boolean = false>(options: Options<GetStrategyStatusData, ThrowOnError>) => {
-    return (options.client ?? _heyApiClient).get<GetStrategyStatusResponse, GetStrategyStatusError, ThrowOnError>({
+export const getStrategy = <ThrowOnError extends boolean = false>(options: Options<GetStrategyData, ThrowOnError>) => {
+    return (options.client ?? _heyApiClient).get<GetStrategyResponse, GetStrategyError, ThrowOnError>({
         security: [
             {
                 scheme: 'bearer',
@@ -190,7 +190,7 @@ export const getStrategyStatus = <ThrowOnError extends boolean = false>(options:
 };
 
 /**
- * Prepare backtesting data
+ * Prepare backtest data
  * Enqueues a prepare task over the requested date range. Returns immediately with a `jobId`;
  * poll `GET /backtest/{exchangeId}/{type}/prepare/{jobId}` for completion.
  *
@@ -198,8 +198,8 @@ export const getStrategyStatus = <ThrowOnError extends boolean = false>(options:
  * params do not enqueue duplicate work — they reuse the existing job.
  *
  */
-export const prepareBacktesting = <ThrowOnError extends boolean = false>(options: Options<PrepareBacktestingData, ThrowOnError>) => {
-    return (options.client ?? _heyApiClient).post<PrepareBacktestingResponse, PrepareBacktestingError, ThrowOnError>({
+export const prepareBacktest = <ThrowOnError extends boolean = false>(options: Options<PrepareBacktestData, ThrowOnError>) => {
+    return (options.client ?? _heyApiClient).post<PrepareBacktestResponse, PrepareBacktestError, ThrowOnError>({
         security: [
             {
                 scheme: 'bearer',
@@ -221,8 +221,8 @@ export const prepareBacktesting = <ThrowOnError extends boolean = false>(options
  * Poll until `status` is `Completed`, `Failed`, or `Aborted`.
  *
  */
-export const getPreparationStatus = <ThrowOnError extends boolean = false>(options: Options<GetPreparationStatusData, ThrowOnError>) => {
-    return (options.client ?? _heyApiClient).get<GetPreparationStatusResponse, GetPreparationStatusError, ThrowOnError>({
+export const getPrepareStatus = <ThrowOnError extends boolean = false>(options: Options<GetPrepareStatusData, ThrowOnError>) => {
+    return (options.client ?? _heyApiClient).get<GetPrepareStatusResponse, GetPrepareStatusError, ThrowOnError>({
         security: [
             {
                 scheme: 'bearer',
@@ -234,6 +234,67 @@ export const getPreparationStatus = <ThrowOnError extends boolean = false>(optio
     });
 };
 
+/**
+ * Execute a parameter sweep over prepared data
+ * Runs a parameter matrix over the single immutable dataset identified by `requestId`.
+ * The backend expands and executes the matrix internally; clients poll the returned
+ * `sweepId` for incremental results.
+ *
+ */
+export const executeSweep = <ThrowOnError extends boolean = false>(options: Options<ExecuteSweepData, ThrowOnError>) => {
+    return (options.client ?? _heyApiClient).post<ExecuteSweepResponse, ExecuteSweepError, ThrowOnError>({
+        security: [
+            {
+                scheme: 'bearer',
+                type: 'http'
+            }
+        ],
+        url: '/backtest/{exchangeId}/{type}/executeSweep/{requestId}',
+        ...options,
+        headers: {
+            'Content-Type': 'application/json',
+            ...options?.headers
+        }
+    });
+};
+
+/**
+ * Cancel a running parameter sweep
+ * Requests cancellation between parameter vectors. Completed rows remain readable.
+ */
+export const cancelSweep = <ThrowOnError extends boolean = false>(options: Options<CancelSweepData, ThrowOnError>) => {
+    return (options.client ?? _heyApiClient).delete<CancelSweepResponse, CancelSweepError, ThrowOnError>({
+        security: [
+            {
+                scheme: 'bearer',
+                type: 'http'
+            }
+        ],
+        url: '/backtest/{exchangeId}/{type}/executeSweep/{requestId}/{sweepId}',
+        ...options
+    });
+};
+
+/**
+ * Get sweep progress and results
+ * Returns incremental sweep progress. The default `ranked` view sorts and may truncate the
+ * display leaderboard. `order=natural` returns every available row, untruncated, ordered by
+ * deterministic `runIx`; use that view when materialising durable trial rows.
+ *
+ */
+export const getSweepResult = <ThrowOnError extends boolean = false>(options: Options<GetSweepResultData, ThrowOnError>) => {
+    return (options.client ?? _heyApiClient).get<GetSweepResultResponse, GetSweepResultError, ThrowOnError>({
+        security: [
+            {
+                scheme: 'bearer',
+                type: 'http'
+            }
+        ],
+        url: '/backtest/{exchangeId}/{type}/executeSweep/{requestId}/{sweepId}',
+        ...options
+    });
+};
+
 /**
  * Execute a compiled strategy against a prepared dataset
  * Enqueues an execute task that runs the strategy identified by `strategyId` over the data
@@ -247,8 +308,8 @@ export const getPreparationStatus = <ThrowOnError extends boolean = false>(optio
  * `jobId` (idempotent).
  *
  */
-export const executeBacktesting = <ThrowOnError extends boolean = false>(options: Options<ExecuteBacktestingData, ThrowOnError>) => {
-    return (options.client ?? _heyApiClient).post<ExecuteBacktestingResponse, ExecuteBacktestingError, ThrowOnError>({
+export const executeBacktest = <ThrowOnError extends boolean = false>(options: Options<ExecuteBacktestData, ThrowOnError>) => {
+    return (options.client ?? _heyApiClient).post<ExecuteBacktestResponse, ExecuteBacktestError, ThrowOnError>({
         security: [
             {
                 scheme: 'bearer',
@@ -272,8 +333,8 @@ export const executeBacktesting = <ThrowOnError extends boolean = false>(options
  * to confirm the final status.
  *
  */
-export const cancelExecution = <ThrowOnError extends boolean = false>(options: Options<CancelExecutionData, ThrowOnError>) => {
-    return (options.client ?? _heyApiClient).delete<CancelExecutionResponse, CancelExecutionError, ThrowOnError>({
+export const cancelBacktest = <ThrowOnError extends boolean = false>(options: Options<CancelBacktestData, ThrowOnError>) => {
+    return (options.client ?? _heyApiClient).delete<CancelBacktestResponse, CancelBacktestError, ThrowOnError>({
         security: [
             {
                 scheme: 'bearer',
@@ -290,9 +351,13 @@ export const cancelExecution = <ThrowOnError extends boolean = false>(options: O
  * Retrieves the current state and results of the execute job identified by `jobId`.
  * Poll until `state.status` is `Completed`, `Failed`, or `Aborted`.
  *
+ * A `202` means the result is not readable yet — keep polling. It is never a terminal
+ * outcome, and it carries no `state`, so a poll loop that stops on a terminal status will
+ * not stop on it.
+ *
  */
-export const getExecutionResult = <ThrowOnError extends boolean = false>(options: Options<GetExecutionResultData, ThrowOnError>) => {
-    return (options.client ?? _heyApiClient).get<GetExecutionResultResponse, GetExecutionResultError, ThrowOnError>({
+export const getBacktestResult = <ThrowOnError extends boolean = false>(options: Options<GetBacktestResultData, ThrowOnError>) => {
+    return (options.client ?? _heyApiClient).get<GetBacktestResultResponse, GetBacktestResultError, ThrowOnError>({
         security: [
             {
                 scheme: 'bearer',