@nosana/api 2.6.1 → 2.7.3

package/README.md

@@ -59,10 +59,134 @@ await vault.topup({ NOS: 100 });
 
 ## API Modules
 
-- `api.jobs` - Job management
-- `api.credits` - Credit balance
-- `api.markets` - Market data
-- `api.deployments` - Deployments and vaults
+### `api.auth` — Authentication
+
+| Method | Parameters | Returns |
+|--------|-----------|---------|
+| `signMessage` | `message: string, options?: { includeTime?: boolean }` | `Promise<string>` |
+| `validateSession` | `cookieHeader?: string` | `Promise<ValidateSessionResponse>` |
+| `validateApiKey` | `apiKey: string` | `Promise<ValidateApiKeyResponse>` |
+
+### `api.user` — API Key Management
+
+| Method | Parameters | Returns |
+|--------|-----------|---------|
+| `apiKeys.create` | `request: CreateApiKeyRequest` | `Promise<ApiKeyCreated>` |
+| `apiKeys.list` | — | `Promise<{ keys: ApiKey[]; total: number }>` |
+| `apiKeys.get` | `id: string` | `Promise<ApiKey>` |
+| `apiKeys.update` | `id: string, request: UpdateApiKeyRequest` | `Promise<ApiKey>` |
+| `apiKeys.delete` | `id: string` | `Promise<{ success: boolean }>` |
+
+### `api.jobs` — Job Operations
+
+| Method | Parameters | Returns |
+|--------|-----------|---------|
+| `get` | `address: string` | `Promise<Job>` |
+| `getAll` | `request?: NosanaApiGetAllJobsRequest` | `Promise<Job[]>` |
+| `list` | `request: NosanaApiListJobRequest` | `Promise<NosanaApiListJobResponse>` |
+| `extend` | `{ address, ...body }: NosanaApiExtendJobRequest` | `Promise<NosanaApiExtendJobResponse>` |
+| `stop` | `address: string` | `Promise<StopJobWithCreditsResponse>` |
+| `getRunning` | — | `Promise<Record<string, unknown>>` |
+| `getRunningNodes` | `request: JobRunningNodesRequest` | `Promise<Record<string, unknown>>` |
+| `getLongRunning` | `request?: JobLongRunningRequest` | `Promise<Record<string, unknown>>` |
+| `getStats` | `request?: JobStatsRequest` | `Promise<Record<string, unknown>>` |
+| `getStatsTimestamps` | `request?: JobStatsTimestampsRequest` | `Promise<Record<string, unknown>>` |
+| `getCount` | `request?: JobCountRequest` | `Promise<JobCountResponse>` |
+| `getBatch` | `request: JobBatchRequest` | `Promise<Job[]>` |
+
+### `api.credits` — Credits & Invitations
+
+| Method | Parameters | Returns |
+|--------|-----------|---------|
+| `balance` | — | `Promise<Balance>` |
+| `claim` | `code: string` | `Promise<Record<string, unknown>>` |
+| `request` | — | `Promise<Record<string, unknown>>` |
+| `checkEligibility` | — | `Promise<Record<string, unknown>>` |
+| `invitations.get` | `token: string` | `Promise<Record<string, unknown>>` |
+| `invitations.claim` | `token: string` | `Promise<Record<string, unknown>>` |
+
+### `api.markets` — GPU Markets & Pricing
+
+| Method | Parameters | Returns |
+|--------|-----------|---------|
+| `list` | — | `Promise<Market[]>` |
+| `get` | `market: string` | `Promise<Market>` |
+| `getRequiredResources` | `market: string` | `Promise<MarketRequiredResources>` |
+| `getPrices` | — | `Promise<Record<string, unknown>>` |
+| `getPrice` | — | `Promise<Record<string, unknown>>` |
+| `getGpuTypes` | — | `Promise<Record<string, unknown>[]>` |
+| `getDockerImages` | — | `Promise<Record<string, unknown>[]>` |
+
+### `api.deployments` — Deployment Lifecycle
+
+| Method | Parameters | Returns |
+|--------|-----------|---------|
+| `create` | `deploymentBody: CreateDeployment` | `Promise<Deployment>` |
+| `get` | `deployment: string` | `Promise<Deployment>` |
+| `list` | `searchParams?: DeploymentsSearchParams` | `Promise<DeploymentListResult>` |
+| `pipe` | `deploymentIDorCreateObject, ...actions` | `Promise<Deployment>` |
+| `getJobDefinition` | `job: string` | `Promise<unknown>` |
+| `submitJobResults` | `job: string, results: JobResults` | `Promise<void>` |
+| `vaults.create` | — | `Promise<Vault>` |
+| `vaults.list` | — | `Promise<Vault[]>` |
+
+**Deployment instance methods** (returned by `create`, `get`, `pipe`):
+
+| Method | Parameters | Returns |
+|--------|-----------|---------|
+| `start` | — | `Promise<void>` |
+| `stop` | — | `Promise<void>` |
+| `archive` | — | `Promise<void>` |
+| `delete` | — | `Promise<void>` |
+| `getTasks` | `params?: PaginationParams` | `Promise<TaskListResult>` |
+| `getJob` | `job: string` | `Promise<unknown>` |
+| `getJobs` | `searchParams?: DeploymentJobsSearchParams` | `Promise<JobListResult>` |
+| `getRevisions` | `searchParams?: DeploymentRevisionsSearchParams` | `Promise<RevisionListResult>` |
+| `getEvents` | `searchParams?: DeploymentEventsSearchParams` | `Promise<EventListResult>` |
+| `createRevision` | `jobDefinition: JobDefinition` | `Promise<void>` |
+| `updateReplicaCount` | `replicas: number` | `Promise<void>` |
+| `updateTimeout` | `timeout: number` | `Promise<void>` |
+| `updateActiveRevision` | `active_revision: number` | `Promise<void>` |
+| `updateSchedule` | `schedule: string` | `Promise<void>` |
+| `generateAuthHeader` | — | `Promise<unknown>` |
+
+### `api.templates` — Deployment Templates
+
+| Method | Parameters | Returns |
+|--------|-----------|---------|
+| `list` | — | `Promise<Template[]>` |
+| `getAllGrouped` | — | `Promise<Record<string, unknown>>` |
+| `get` | `id: string` | `Promise<Template>` |
+| `getVariant` | `id: string, variantId: string` | `Promise<Template>` |
+
+### `api.hosts` — Nodes & Hosts
+
+| Method | Parameters | Returns |
+|--------|-----------|---------|
+| `list` | `request?: NodeListRequest` | `Promise<Record<string, unknown>>` |
+| `get` | `id: string` | `Promise<Record<string, unknown>>` |
+| `getSpecs` | `id: string` | `Promise<Record<string, unknown>>` |
+| `getAvailableGpus` | — | `Promise<Record<string, unknown>>` |
+| `getStats` | — | `Promise<Record<string, unknown>>` |
+| `getQueuedNodes` | `request?: NodeQueuedRequest` | `Promise<Record<string, unknown>>` |
+| `getUptime` | `node: string, request?: NodeUptimeRequest` | `Promise<Record<string, unknown>>` |
+| `getByCountry` | — | `Promise<Record<string, unknown>>` |
+| `getAvailableHosts` | `request?: HostsFilterRequest` | `Promise<Record<string, unknown>>` |
+| `getFilters` | `request?: HostsFiltersOptionsRequest` | `Promise<Record<string, unknown>>` |
+| `getBenchmarkReport` | `request?: BenchmarkReportRequest` | `Promise<Record<string, unknown>>` |
+| `getTemplatePerformance` | `nodeId: string` | `Promise<Record<string, unknown>>` |
+| `getBenchmarkSummary` | `request?: BenchmarkSummaryRequest` | `Promise<Record<string, unknown>>` |
+
+### `api.stats` — Platform Statistics
+
+| Method | Parameters | Returns |
+|--------|-----------|---------|
+| `get` | — | `Promise<Record<string, unknown>>` |
+| `getPrice` | `request?: StatsPriceRequest` | `Promise<unknown>` |
+| `getSpendingHistory` | `request: StatsHistoryRequest` | `Promise<Record<string, unknown>>` |
+| `getEarningHistory` | `request: StatsHistoryRequest` | `Promise<Record<string, unknown>>` |
+
+See [API_ENDPOINTS.md](./API_ENDPOINTS.md) for the full endpoint reference.
 
 ## Development
 

package/dist/client/blockchain-indexer/index.d.ts

@@ -0,0 +1,7 @@
+import type { paths } from './schema.js';
+import type { AuthenticatedClient } from '../type.utils.js';
+import type { NosanaNetwork, ApiKeyAuth, SignerAuth, CreateNosanaApiOptions } from '../../types.js';
+export type BlockchainIndexerClient = AuthenticatedClient<paths>;
+export declare function createBlockchainIndexerClient(environment: NosanaNetwork, authParams: ApiKeyAuth | SignerAuth | undefined, options?: CreateNosanaApiOptions): BlockchainIndexerClient;
+export type { paths } from './schema.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/client/blockchain-indexer/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/client/blockchain-indexer/index.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC;AACzC,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAC5D,OAAO,KAAK,EAAE,aAAa,EAAE,UAAU,EAAE,UAAU,EAAE,sBAAsB,EAAE,MAAM,gBAAgB,CAAC;AAEpG,MAAM,MAAM,uBAAuB,GAAG,mBAAmB,CAAC,KAAK,CAAC,CAAC;AAEjE,wBAAgB,6BAA6B,CAC3C,WAAW,EAAE,aAAa,EAC1B,UAAU,EAAE,UAAU,GAAG,UAAU,GAAG,SAAS,EAC/C,OAAO,CAAC,EAAE,sBAAsB,GAC/B,uBAAuB,CAGzB;AAED,YAAY,EAAE,KAAK,EAAE,MAAM,aAAa,CAAC"}

package/dist/client/blockchain-indexer/index.js

@@ -0,0 +1,7 @@
+import { createAuthenticatedClient } from '../createClient.js';
+import { defaultConfig } from '../../defaults/index.js';
+export function createBlockchainIndexerClient(environment, authParams, options) {
+    const baseUrl = options?.blockchain_indexer_url || defaultConfig[environment].blockchain_indexer_url;
+    return createAuthenticatedClient(baseUrl, authParams, options);
+}
+//# sourceMappingURL=index.js.map

package/dist/client/blockchain-indexer/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/client/blockchain-indexer/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,MAAM,oBAAoB,CAAC;AAC/D,OAAO,EAAE,aAAa,EAAE,MAAM,yBAAyB,CAAC;AAQxD,MAAM,UAAU,6BAA6B,CAC3C,WAA0B,EAC1B,UAA+C,EAC/C,OAAgC;IAEhC,MAAM,OAAO,GAAG,OAAO,EAAE,sBAAsB,IAAI,aAAa,CAAC,WAAW,CAAC,CAAC,sBAAsB,CAAC;IACrG,OAAO,yBAAyB,CAAQ,OAAO,EAAE,UAAU,EAAE,OAAO,CAAC,CAAC;AACxE,CAAC"}