@qtsurfer/api-client 0.9.0 → 0.11.0

package/src/generated/sdk.gen.ts

@@ -23,15 +23,23 @@ import type {
   DownloadKlinesData,
   DownloadKlinesResponse,
   DownloadKlinesError,
+  ListStrategiesData,
+  ListStrategiesResponse,
   CompileStrategyData,
   CompileStrategyResponse,
   CompileStrategyError,
   ValidateStrategyData,
   ValidateStrategyResponse,
   ValidateStrategyError,
+  DeleteStrategyData,
+  DeleteStrategyResponse,
+  DeleteStrategyError,
   GetStrategyData,
   GetStrategyResponse,
   GetStrategyError,
+  GetStrategyCodeData,
+  GetStrategyCodeResponse,
+  GetStrategyCodeError,
   PrepareBacktestData,
   PrepareBacktestResponse,
   PrepareBacktestError,
@@ -59,6 +67,23 @@ import type {
   GetBacktestResultData,
   GetBacktestResultResponse,
   GetBacktestResultError,
+  ListDatasetsData,
+  ListDatasetsResponse,
+  CreateDatasetData,
+  CreateDatasetResponse,
+  CreateDatasetError,
+  DeleteDatasetData,
+  DeleteDatasetResponse,
+  DeleteDatasetError,
+  GetDatasetData,
+  GetDatasetResponse,
+  GetDatasetError,
+  FinalizeDatasetUploadData,
+  FinalizeDatasetUploadResponse,
+  FinalizeDatasetUploadError,
+  GetDatasetUploadData,
+  GetDatasetUploadResponse,
+  GetDatasetUploadError,
 } from "./types.gen";
 import { client as _heyApiClient } from "./client.gen";
 
@@ -238,6 +263,35 @@ export const downloadKlines = <ThrowOnError extends boolean = false>(
   });
 };
 
+/**
+ * List your registered strategies
+ * Every strategy you have registered and not deleted, most recently compiled first.
+ *
+ * Each entry carries the same provenance `GET /strategy/{strategyId}` does — `compiledAt`,
+ * `requiredSources` — but not its validation state, so listing stays cheap regardless of how
+ * many strategies you have. Check a specific strategy's validation with `GET
+ * /strategy/{strategyId}`.
+ *
+ */
+export const listStrategies = <ThrowOnError extends boolean = false>(
+  options?: Options<ListStrategiesData, ThrowOnError>
+) => {
+  return (options?.client ?? _heyApiClient).get<
+    ListStrategiesResponse,
+    unknown,
+    ThrowOnError
+  >({
+    security: [
+      {
+        scheme: "bearer",
+        type: "http",
+      },
+    ],
+    url: "/strategies",
+    ...options,
+  });
+};
+
 /**
  * Compile and register a strategy
  * Compiles raw strategy source and registers it, returning its `strategyId`.
@@ -320,6 +374,39 @@ export const validateStrategy = <ThrowOnError extends boolean = false>(
   });
 };
 
+/**
+ * Release a registered strategy
+ * Removes a strategy from `GET /strategy/{strategyId}` and `GET /strategies`. This is not
+ * undone by re-submitting the same source to `POST /strategy` — that registers a new
+ * strategy, with a new id.
+ *
+ * **Backtests you already ran against this strategy are unaffected.** Deleting it stops it
+ * from counting against your account and stops you from validating or re-running it under
+ * this id — it does not erase what already happened.
+ *
+ * Only removes a strategy you registered yourself. If you copied someone else's strategy
+ * (a shared/marketplace listing), deleting your copy never affects theirs, or anyone else's.
+ *
+ */
+export const deleteStrategy = <ThrowOnError extends boolean = false>(
+  options: Options<DeleteStrategyData, ThrowOnError>
+) => {
+  return (options.client ?? _heyApiClient).delete<
+    DeleteStrategyResponse,
+    DeleteStrategyError,
+    ThrowOnError
+  >({
+    security: [
+      {
+        scheme: "bearer",
+        type: "http",
+      },
+    ],
+    url: "/strategy/{strategyId}",
+    ...options,
+  });
+};
+
 /**
  * Get a strategy by id, including its validation state
  * Reports that the strategy is registered — implied by a `200` at all — and what validating it
@@ -348,6 +435,36 @@ export const getStrategy = <ThrowOnError extends boolean = false>(
   });
 };
 
+/**
+ * Get a registered strategy's source, if you still have one to read
+ * The exact source you last submitted for this id — the same text `POST /strategy` derives
+ * `strategyId` from, whitespace and comments included.
+ *
+ * **"If available", not "always".** A strategy you resolve only through a shared/marketplace
+ * listing you copied by reference carries no source of its own, and reads as a `404` here the
+ * same as a `strategyId` you never registered — that is the honest answer either way, since
+ * from this endpoint's point of view nothing is there to return.
+ *
+ */
+export const getStrategyCode = <ThrowOnError extends boolean = false>(
+  options: Options<GetStrategyCodeData, ThrowOnError>
+) => {
+  return (options.client ?? _heyApiClient).get<
+    GetStrategyCodeResponse,
+    GetStrategyCodeError,
+    ThrowOnError
+  >({
+    security: [
+      {
+        scheme: "bearer",
+        type: "http",
+      },
+    ],
+    url: "/strategy/{strategyId}/code",
+    ...options,
+  });
+};
+
 /**
  * Prepare backtest data
  * Enqueues a prepare task over the requested date range. Returns immediately with a `jobId`;
@@ -356,6 +473,11 @@ export const getStrategy = <ThrowOnError extends boolean = false>(
  * The same params always return the same `jobId` (idempotent). Repeated calls with identical
  * params do not enqueue duplicate work — they reuse the existing job.
  *
+ * **`exchangeId: user` is reserved for your own uploaded data.** Instead of a managed
+ * exchange, it prepares from a dataset you created via `POST /datasets` (see the **Dataset**
+ * endpoints) — send `datasetId` in place of `instrument`. See `PrepareRequest` below for the
+ * two request shapes.
+ *
  */
 export const prepareBacktest = <ThrowOnError extends boolean = false>(
   options: Options<PrepareBacktestData, ThrowOnError>
@@ -385,6 +507,9 @@ export const prepareBacktest = <ThrowOnError extends boolean = false>(
  * Retrieves the current state of the prepare job identified by `jobId`.
  * Poll until `status` is `Completed`, `Failed`, or `Aborted`.
  *
+ * For a dataset prepare (`exchangeId: user`), coverage is reported against the dataset's own
+ * cadence grid instead of hours — see `cadence`/`gaps`/`largestGapSteps` on `PrepareJobState`.
+ *
  */
 export const getPrepareStatus = <ThrowOnError extends boolean = false>(
   options: Options<GetPrepareStatusData, ThrowOnError>
@@ -576,6 +701,9 @@ export const getSweepSensitivity = <ThrowOnError extends boolean = false>(
  * The same params (same `prepareJobId`, `strategyId`, `storeSignals`) always return the same
  * `jobId` (idempotent).
  *
+ * Works unchanged for a dataset-backed prepare (`exchangeId: user`) — the request body is
+ * identical either way, since the instrument and range are recovered from `prepareJobId`.
+ *
  */
 export const executeBacktest = <ThrowOnError extends boolean = false>(
   options: Options<ExecuteBacktestData, ThrowOnError>
@@ -655,3 +783,172 @@ export const getBacktestResult = <ThrowOnError extends boolean = false>(
     ...options,
   });
 };
+
+/**
+ * List your datasets
+ * Every dataset you have created and not deleted, most recently created first. Never a `404`
+ * — an empty array if you have none, same convention as `GET /strategies`.
+ *
+ */
+export const listDatasets = <ThrowOnError extends boolean = false>(
+  options?: Options<ListDatasetsData, ThrowOnError>
+) => {
+  return (options?.client ?? _heyApiClient).get<
+    ListDatasetsResponse,
+    unknown,
+    ThrowOnError
+  >({
+    security: [
+      {
+        scheme: "bearer",
+        type: "http",
+      },
+    ],
+    url: "/datasets",
+    ...options,
+  });
+};
+
+/**
+ * Create a dataset and get a URL to upload it to
+ * Creates a dataset AND its first upload session in one call — a presigned URL your client
+ * PUTs the file to directly, no API credentials involved in that PUT. Call
+ * `POST /datasets/{datasetId}/uploads/{uploadId}/finalize` once the upload completes to kick
+ * off ingest.
+ *
+ * v1 is ticker data only — `type` is not a request field, it is always `"ticker"` in the
+ * response. `instrument` must be a plain spot pair (`BASE/QUOTE`, exactly one `/`); derivative
+ * forms (e.g. `BTC/USDT:USDT`) are rejected.
+ *
+ * **Upload format.** A CSV with a header row. Required columns: `timestamp` (ISO-8601, or
+ * numeric epoch seconds/millis/micros — detected from the first row, then enforced for every
+ * later row), `close`. Optional columns: `open`, `high`, `low`, `volume`, `quoteVolume`,
+ * `bid`, `bidSize`, `ask`, `askSize`. Cadence and timestamp unit are discovered from the data,
+ * not declared.
+ *
+ */
+export const createDataset = <ThrowOnError extends boolean = false>(
+  options: Options<CreateDatasetData, ThrowOnError>
+) => {
+  return (options.client ?? _heyApiClient).post<
+    CreateDatasetResponse,
+    CreateDatasetError,
+    ThrowOnError
+  >({
+    security: [
+      {
+        scheme: "bearer",
+        type: "http",
+      },
+    ],
+    url: "/datasets",
+    ...options,
+    headers: {
+      "Content-Type": "application/json",
+      ...options?.headers,
+    },
+  });
+};
+
+/**
+ * Delete a dataset
+ * Soft-delete — the dataset stops appearing in `GET /datasets`/`GET /datasets/{datasetId}` and
+ * can no longer be prepared from, but its object data is reclaimed later rather than purged
+ * inline, so a backtest already running against one of its versions is not disrupted.
+ *
+ */
+export const deleteDataset = <ThrowOnError extends boolean = false>(
+  options: Options<DeleteDatasetData, ThrowOnError>
+) => {
+  return (options.client ?? _heyApiClient).delete<
+    DeleteDatasetResponse,
+    DeleteDatasetError,
+    ThrowOnError
+  >({
+    security: [
+      {
+        scheme: "bearer",
+        type: "http",
+      },
+    ],
+    url: "/datasets/{datasetId}",
+    ...options,
+  });
+};
+
+/**
+ * Get a dataset by id
+ * Detail for one dataset, plus a self link.
+ */
+export const getDataset = <ThrowOnError extends boolean = false>(
+  options: Options<GetDatasetData, ThrowOnError>
+) => {
+  return (options.client ?? _heyApiClient).get<
+    GetDatasetResponse,
+    GetDatasetError,
+    ThrowOnError
+  >({
+    security: [
+      {
+        scheme: "bearer",
+        type: "http",
+      },
+    ],
+    url: "/datasets/{datasetId}",
+    ...options,
+  });
+};
+
+/**
+ * Finalize an uploaded file and start ingest
+ * Call once the file has been PUT to the `upload.url` from `POST /datasets`. Enqueues ingest
+ * and returns immediately; poll
+ * `GET /datasets/{datasetId}/uploads/{uploadId}` for the result.
+ *
+ * Idempotent — a repeat finalize of the same upload returns the same `jobId` rather than
+ * enqueueing a second ingest.
+ *
+ */
+export const finalizeDatasetUpload = <ThrowOnError extends boolean = false>(
+  options: Options<FinalizeDatasetUploadData, ThrowOnError>
+) => {
+  return (options.client ?? _heyApiClient).post<
+    FinalizeDatasetUploadResponse,
+    FinalizeDatasetUploadError,
+    ThrowOnError
+  >({
+    security: [
+      {
+        scheme: "bearer",
+        type: "http",
+      },
+    ],
+    url: "/datasets/{datasetId}/uploads/{uploadId}/finalize",
+    ...options,
+  });
+};
+
+/**
+ * Get the state of an upload/ingest
+ * Poll after `POST .../finalize` until `status` is `ready` or `failed`. Also reports
+ * `uploading` (finalize not called yet, but the file was PUT) before you finalize at all.
+ *
+ */
+export const getDatasetUpload = <ThrowOnError extends boolean = false>(
+  options: Options<GetDatasetUploadData, ThrowOnError>
+) => {
+  return (options.client ?? _heyApiClient).get<
+    GetDatasetUploadResponse,
+    GetDatasetUploadError,
+    ThrowOnError
+  >({
+    security: [
+      {
+        scheme: "bearer",
+        type: "http",
+      },
+    ],
+    url: "/datasets/{datasetId}/uploads/{uploadId}",
+    ...options,
+  });
+};