@tarkahq/sdk 0.0.0-stage → 0.3.0

package/dist/cjs/resources/provisioning.d.ts

@@ -0,0 +1,389 @@
+import type { ProvisioningRpc, SandboxRpc } from "../rpc-types.js";
+import { OrganizationSandboxes } from "./sandboxes.js";
+import type { RequestOptions, User, Organization, OrganizationInput, OrganizationMember, ProductAccessRequest, ProductAccessInput, ProductAccessFilter, ApiKey, CreatedApiKey, ApiKeyInput, QuotaPolicy, QuotaPolicyInput, UsageEvent, UsageSummary, ComputeResource, InferenceServiceInput, AgentHostInput, JobInput, StorageBucket, StorageCredential, CreatedStorageCredential, GitRepository, GitRepositoryInput, GitAccess } from "../types.js";
+/** The authenticated account and its initial organization. Access through `client.user`. */
+export declare class Users {
+    #private;
+    constructor(rpc: ProvisioningRpc);
+    /**
+     * Retrieve the current user, organization memberships, and default organization.
+     *
+     * @param options - Per-call timeout in milliseconds, cancellation signal, and metadata.
+     */
+    get(options?: RequestOptions): Promise<User>;
+    /**
+     * Initialize the authenticated account and its first organization.
+     *
+     * @param input - Optional organization display name; when omitted, the server derives a name.
+     * @param options - Per-call timeout in milliseconds, cancellation signal, and metadata.
+     */
+    bootstrap(input?: {
+        orgName?: string;
+    }, options?: RequestOptions): Promise<User>;
+}
+/** Organizations accessible to the authenticated account. Access through `client.organizations`. */
+export declare class Organizations {
+    #private;
+    constructor(rpc: ProvisioningRpc);
+    /**
+     * Return the current user's organizations as an array.
+     *
+     * @param options - Per-call timeout in milliseconds, cancellation signal, and metadata.
+     */
+    list(options?: RequestOptions): Promise<Organization[]>;
+    /**
+     * Retrieve an organization record.
+     *
+     * @param id - Organization identifier.
+     * @param options - Per-call timeout in milliseconds, cancellation signal, and metadata.
+     */
+    get(id: string, options?: RequestOptions): Promise<Organization>;
+    /**
+     * Create an organization with the authenticated caller as its owner.
+     *
+     * @param input - Display name and optional globally unique slug. The server allocates an omitted slug.
+     * @returns The organization record; use `client.org(result.id)` to access its resources.
+     * @param options - Per-call timeout in milliseconds, cancellation signal, and metadata.
+     */
+    create(input: OrganizationInput, options?: RequestOptions): Promise<Organization>;
+}
+/** Memberships of the bound organization. Access through `client.org(orgId).members`. */
+export declare class Members {
+    #private;
+    private readonly orgId;
+    constructor(rpc: ProvisioningRpc, orgId: string);
+    /**
+     * Return the organization's members as an array.
+     *
+     * @param options - Per-call timeout in milliseconds, cancellation signal, and metadata.
+     */
+    list(options?: RequestOptions): Promise<OrganizationMember[]>;
+}
+/** Product access requests for the bound organization. Access through `org.accessRequests`. */
+export declare class AccessRequests {
+    #private;
+    private readonly orgId;
+    constructor(rpc: ProvisioningRpc, orgId: string);
+    /**
+     * List recent product access requests, newest first.
+     *
+     * @param filter - Optional product and result limit; the server defaults to 25 and caps the limit at 100.
+     * @returns An array from one server response; the SDK does not fetch additional pages.
+     * @param options - Per-call timeout in milliseconds, cancellation signal, and metadata.
+     */
+    list(filter?: ProductAccessFilter, options?: RequestOptions): Promise<ProductAccessRequest[]>;
+    /**
+     * Submit a product access request for this organization.
+     *
+     * @param input - Product, use case, and optional contact/company details. Omitted contact email uses the authenticated account.
+     * @param options - Per-call timeout in milliseconds, cancellation signal, and metadata.
+     */
+    create(input: ProductAccessInput, options?: RequestOptions): Promise<ProductAccessRequest>;
+}
+/** API keys for the bound organization. Access through `org.apiKeys`. */
+export declare class ApiKeys {
+    #private;
+    private readonly orgId;
+    constructor(rpc: ProvisioningRpc, orgId: string);
+    /**
+     * List API key metadata. Previously issued plaintext secrets are not returned.
+     *
+     * @param options - Per-call timeout in milliseconds, cancellation signal, and metadata.
+     */
+    list(options?: RequestOptions): Promise<ApiKey[]>;
+    /**
+     * Create an API key and return its metadata with a one-time `secret`.
+     *
+     * @param input - Optional label, product scopes, and allowed model aliases. Omitted scopes use the server's inference default.
+     * @returns The key record plus `secret`; store the secret at creation because it cannot be retrieved later.
+     * @example
+     * const key = await org.apiKeys.create({ label: "worker", scopes: ["inference"] });
+     * @param options - Per-call timeout in milliseconds, cancellation signal, and metadata.
+     */
+    create(input?: ApiKeyInput, options?: RequestOptions): Promise<CreatedApiKey>;
+    /**
+     * Revoke an API key and return its updated metadata.
+     *
+     * @param id - API key identifier, not its secret.
+     * @param input - Optional human-readable revocation reason.
+     * @param options - Per-call timeout in milliseconds, cancellation signal, and metadata.
+     */
+    revoke(id: string, input?: {
+        reason?: string;
+    }, options?: RequestOptions): Promise<ApiKey>;
+}
+/** Inference limits and model policy for the bound organization. Access through `org.quotas`. */
+export declare class Quotas {
+    #private;
+    private readonly orgId;
+    constructor(rpc: ProvisioningRpc, orgId: string);
+    /**
+     * Retrieve the organization's effective inference quota policy.
+     *
+     * @param options - Per-call timeout in milliseconds, cancellation signal, and metadata.
+     */
+    get(options?: RequestOptions): Promise<QuotaPolicy>;
+    /**
+     * Replace the organization's quota policy.
+     *
+     * Omitted optional limits become unlimited. This is a replacement, so include all limits you intend to retain.
+     * @param input - Complete desired policy. Supply `allowedModelAliases` when `allowAllModels` is false; 64-bit budgets use bigint.
+     * @param options - Per-call timeout in milliseconds, cancellation signal, and metadata.
+     */
+    update(input: QuotaPolicyInput, options?: RequestOptions): Promise<QuotaPolicy>;
+}
+/** Inference usage for the bound organization. Access through `org.usage`. */
+export declare class Usage {
+    #private;
+    private readonly orgId;
+    constructor(rpc: ProvisioningRpc, orgId: string);
+    /**
+     * List usage events as an array.
+     *
+     * @param filter - Optional result limit; omitted values use the server default.
+     * @returns One server response without automatic pagination; 64-bit counters and IDs remain bigint.
+     * @param options - Per-call timeout in milliseconds, cancellation signal, and metadata.
+     */
+    list(filter?: {
+        limit?: number;
+    }, options?: RequestOptions): Promise<UsageEvent[]>;
+    /**
+     * Retrieve the organization's aggregate usage counters.
+     *
+     * @returns A usage summary with lossless bigint counters.
+     * @param options - Per-call timeout in milliseconds, cancellation signal, and metadata.
+     */
+    summary(options?: RequestOptions): Promise<UsageSummary>;
+}
+/** Observed and desired state of managed compute. Access through `org.compute.resources`. */
+export declare class ComputeResources {
+    #private;
+    private readonly orgId;
+    constructor(rpc: ProvisioningRpc, orgId: string);
+    /**
+     * List provisioned compute resources as an array.
+     *
+     * @param filter - Optional resource type filter.
+     * @param options - Per-call timeout in milliseconds, cancellation signal, and metadata.
+     */
+    list(filter?: {
+        resourceType?: string;
+    }, options?: RequestOptions): Promise<ComputeResource[]>;
+    /**
+     * Retrieve the current record for a provisioned compute resource.
+     *
+     * @param id - Resource identifier returned by a compute creation method.
+     * @param options - Per-call timeout in milliseconds, cancellation signal, and metadata.
+     */
+    get(id: string, options?: RequestOptions): Promise<ComputeResource>;
+}
+/** Managed inference service creation. Access through `org.compute.inferenceServices`. */
+export declare class InferenceServices {
+    #private;
+    private readonly orgId;
+    constructor(rpc: ProvisioningRpc, orgId: string);
+    /**
+     * Request a managed inference service and return its resource record.
+     *
+     * @param input - DNS-label name, model alias, and optional capacity/specification fields.
+     * @returns Desired and observed resource state. Creation does not poll for readiness; inspect `org.compute.resources.get(id)`.
+     * @param options - Per-call timeout in milliseconds, cancellation signal, and metadata.
+     */
+    create(input: InferenceServiceInput, options?: RequestOptions): Promise<ComputeResource>;
+}
+/** Managed agent host creation. Access through `org.compute.agentHosts`. */
+export declare class AgentHosts {
+    #private;
+    private readonly orgId;
+    constructor(rpc: ProvisioningRpc, orgId: string);
+    /**
+     * Request an agent host and return its resource record.
+     *
+     * @param input - DNS-label name, container image, and optional service/capacity settings. Extension `spec` must not contain secrets.
+     * @returns Desired and observed resource state, without readiness polling.
+     * @param options - Per-call timeout in milliseconds, cancellation signal, and metadata.
+     */
+    create(input: AgentHostInput, options?: RequestOptions): Promise<ComputeResource>;
+}
+/** Finite-duration container jobs. Access through `org.compute.jobs`. */
+export declare class Jobs {
+    #private;
+    private readonly orgId;
+    constructor(rpc: ProvisioningRpc, orgId: string);
+    /**
+     * Request a container job and return its resource record.
+     *
+     * @param input - DNS-label name, container image, optional argv `command`, and server execution limit in `timeoutSeconds`.
+     * @returns Desired and observed resource state, without waiting for the job to finish. Commands are passed without shell expansion.
+     * @param options - Per-call timeout in milliseconds, cancellation signal, and metadata.
+     */
+    create(input: JobInput, options?: RequestOptions): Promise<ComputeResource>;
+}
+/** Managed compute for the bound organization. Access through `org.compute`. */
+export declare class Compute {
+    /** List and inspect all provisioned compute resource types. */
+    readonly resources: ComputeResources;
+    /** Create managed inference services. */
+    readonly inferenceServices: InferenceServices;
+    /** Create managed agent hosts. */
+    readonly agentHosts: AgentHosts;
+    /** Create container jobs. */
+    readonly jobs: Jobs;
+    constructor(rpc: ProvisioningRpc, orgId: string);
+}
+/** Storage buckets for the bound organization. Access through `org.storage.buckets`. */
+export declare class StorageBuckets {
+    #private;
+    private readonly orgId;
+    constructor(rpc: ProvisioningRpc, orgId: string);
+    /**
+     * List the organization's bucket records as an array.
+     *
+     * @param options - Per-call timeout in milliseconds, cancellation signal, and metadata.
+     */
+    list(options?: RequestOptions): Promise<StorageBucket[]>;
+    /**
+     * Create a storage bucket and return its record.
+     *
+     * @param input - Requested bucket name.
+     * @param options - Per-call timeout in milliseconds, cancellation signal, and metadata.
+     */
+    create(input: {
+        name: string;
+    }, options?: RequestOptions): Promise<StorageBucket>;
+    /**
+     * Request deletion of a storage bucket.
+     *
+     * @param id - Bucket identifier, not its display name.
+     * @returns Resolves without a value after acknowledgement.
+     * @param options - Per-call timeout in milliseconds, cancellation signal, and metadata.
+     */
+    delete(id: string, options?: RequestOptions): Promise<void>;
+}
+/** Credentials scoped to one organization and bucket. Obtain through `org.storage.credentials(bucketId)`. */
+export declare class StorageCredentials {
+    #private;
+    private readonly orgId;
+    private readonly bucketId;
+    constructor(rpc: ProvisioningRpc, orgId: string, bucketId: string);
+    /**
+     * List credential metadata for this bucket; plaintext secrets are not returned.
+     *
+     * @param options - Per-call timeout in milliseconds, cancellation signal, and metadata.
+     */
+    list(options?: RequestOptions): Promise<StorageCredential[]>;
+    /**
+     * Create a bucket credential with one-time access credentials.
+     *
+     * @param input - Optional display label for the credential.
+     * @returns Credential metadata plus `accessKeyId`, `secretAccessKey`, `endpoint`, and `region`. Store the secret at creation.
+     * @param options - Per-call timeout in milliseconds, cancellation signal, and metadata.
+     */
+    create(input?: {
+        label?: string;
+    }, options?: RequestOptions): Promise<CreatedStorageCredential>;
+    /**
+     * Revoke a bucket credential and return its updated metadata.
+     *
+     * @param id - Credential identifier from its record, not the access key or secret.
+     * @param options - Per-call timeout in milliseconds, cancellation signal, and metadata.
+     */
+    revoke(id: string, options?: RequestOptions): Promise<StorageCredential>;
+}
+/** Storage resources for the bound organization. Access through `org.storage`. */
+export declare class Storage {
+    #private;
+    private readonly orgId;
+    /** Create, list, and delete storage buckets. */
+    readonly buckets: StorageBuckets;
+    constructor(rpc: ProvisioningRpc, orgId: string);
+    /**
+     * Bind credential operations to a bucket without making a network request.
+     *
+     * @param bucketId - Bucket identifier returned by `buckets.create()` or `buckets.list()`.
+     * @example
+     * const credentials = org.storage.credentials(bucket.id);
+     * const key = await credentials.create({ label: "worker" });
+     */
+    credentials(bucketId: string): StorageCredentials;
+}
+/** Hosted Git repositories for the bound organization. Access through `org.repositories`. */
+export declare class GitRepositories {
+    #private;
+    private readonly orgId;
+    constructor(rpc: ProvisioningRpc, orgId: string);
+    /**
+     * List hosted Git repository records as an array.
+     *
+     * @param options - Per-call timeout in milliseconds, cancellation signal, and metadata.
+     */
+    list(options?: RequestOptions): Promise<GitRepository[]>;
+    /**
+     * Create a hosted Git repository and return its record.
+     *
+     * @param input - Repository name and optional description, visibility, and initialization settings.
+     * @param options - Per-call timeout in milliseconds, cancellation signal, and metadata.
+     */
+    create(input: GitRepositoryInput, options?: RequestOptions): Promise<GitRepository>;
+    /**
+     * Request deletion of a hosted Git repository.
+     *
+     * @param id - Repository identifier.
+     * @returns Resolves without a value after acknowledgement.
+     * @param options - Per-call timeout in milliseconds, cancellation signal, and metadata.
+     */
+    delete(id: string, options?: RequestOptions): Promise<void>;
+}
+/** Hosted Git access for the authenticated account. Access through `client.git`. */
+export declare class Git {
+    #private;
+    constructor(rpc: ProvisioningRpc);
+    /**
+     * Ensure the account has a hosted Git identity and return its current access state.
+     *
+     * @param options - Per-call timeout in milliseconds, cancellation signal, and metadata.
+     */
+    ensureAccess(options?: RequestOptions): Promise<GitAccess>;
+}
+/** Organization context created by `client.org(id)`. Construction makes no network request; nested calls retain this organization ID. */
+export declare class OrganizationScope {
+    #private;
+    /** Organization identifier automatically included in this scope's requests. */
+    readonly id: string;
+    /** Organization memberships. */
+    readonly members: Members;
+    /** Product entitlement requests. */
+    readonly accessRequests: AccessRequests;
+    /** API key creation, metadata, and revocation. */
+    readonly apiKeys: ApiKeys;
+    /** Inference quota and model policy. */
+    readonly quotas: Quotas;
+    /** Usage events and aggregate counters. */
+    readonly usage: Usage;
+    /** Managed inference services, agent hosts, and jobs. */
+    readonly compute: Compute;
+    /** Storage buckets and bucket-scoped credentials. */
+    readonly storage: Storage;
+    /** Hosted Git repositories. */
+    readonly repositories: GitRepositories;
+    /** Sandbox lifecycle, reusable templates, and code execution. */
+    readonly sandboxes: OrganizationSandboxes;
+    constructor(rpc: ProvisioningRpc, sandboxRpc: SandboxRpc, 
+    /** Organization identifier automatically included in this scope's requests. */
+    id: string);
+    /**
+     * Fetch this organization's record.
+     *
+     * @param options - Per-call timeout in milliseconds, cancellation signal, and metadata.
+     */
+    get(options?: RequestOptions): Promise<Organization>;
+    /**
+     * Update this organization's display name and return its record.
+     *
+     * @param input - New non-empty display name; the immutable slug is unchanged.
+     * @param options - Per-call timeout in milliseconds, cancellation signal, and metadata.
+     */
+    update(input: {
+        name: string;
+    }, options?: RequestOptions): Promise<Organization>;
+}