@tarkahq/sdk 0.0.0-stage → 0.3.0

package/dist/cjs/generated/tarka/provisioning/v1/billing_quote.d.ts

@@ -0,0 +1,171 @@
+import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
+import { JobResources } from "./job.js";
+export declare const protobufPackage = "tarka.provisioning.v1";
+/**
+ * CreateComputeQuoteRequest prices normalized resource allocation in the
+ * organization's billing currency. It does not reserve funds or create work.
+ * An omitted location uses the product default from ListLocations. Existing
+ * resources retain their location; accepting a quote never moves them.
+ */
+export interface CreateComputeQuoteRequest {
+    orgId: string;
+    /** product is agents, sandboxes or jobs. Availability follows the live quote. */
+    product: string;
+    location: string;
+    resources: JobResources | undefined;
+    /**
+     * max_runtime_seconds bounds the reservation. An Agent Host quote covers
+     * the next prepaid lease; renewal is separately admitted at the same rates.
+     */
+    maxRuntimeSeconds: number;
+    /**
+     * max_network_bytes bounds combined forwarded upload and download bytes.
+     * US East omission defaults to 1 GiB; explicit zero disables outbound networking.
+     */
+    maxNetworkBytes?: bigint | undefined;
+    /**
+     * US East Agent Host retained disk allocation. Compose dry-runs derive this from
+     * the actual volumes. Other products and EU quotes leave this at zero.
+     */
+    persistentStorageBytes: bigint;
+}
+/**
+ * ComputeQuote is immutable and expires five minutes after issuance. Amounts
+ * use the named currency's microcents (100,000,000 = one currency unit).
+ * Acceptance on creation binds org, product, location, resources and limits.
+ * A changed catalog, currency, expired quote or changed allocation needs a new
+ * quote. Legacy EU clients may omit acceptance; US East callers must supply it.
+ */
+export interface ComputeQuote {
+    id: string;
+    orgId: string;
+    product: string;
+    location: string;
+    resources: JobResources | undefined;
+    maxRuntimeSeconds: number;
+    maxNetworkBytes: bigint;
+    currency: string;
+    hourlyMicrocents: bigint;
+    minimumRuntimeSeconds: number;
+    minimumChargeMicrocents: bigint;
+    maximumReservationMicrocents: bigint;
+    networkGibMicrocents: bigint;
+    pricingVersion: string;
+    fxNumerator: bigint;
+    fxDenominator: bigint;
+    expiresAt: Date | undefined;
+    /** available=false is an estimate only; it cannot authorize creation. */
+    available: boolean;
+    /** Exact Agent Host allocation; resources.memory_mib rounds up for display. */
+    allocatedMemoryBytes: bigint;
+    /**
+     * US East Agent Host disks remain allocated and metered while paused. Charges
+     * begin after allocation, stop after deletion, and never authorize debt or
+     * automatic deletion. Existing EU data usage policy remains separate.
+     */
+    persistentStorageBytes: bigint;
+    persistentStorageGibMonthMicrocents: bigint;
+    persistentStoragePeriodSeconds: number;
+    /**
+     * Initial temporary hold while a node/image starts. Unexecuted runtime is
+     * not billed. Once ready, maximum_reservation_microcents covers each lease.
+     */
+    startupReservationMicrocents: bigint;
+    /**
+     * Agent Host max_network_bytes is a renewable five-minute allowance;
+     * forwarded upload and download bytes are billed at network_gib_microcents.
+     * Exhausting it suspends networking until the next funded allowance.
+     */
+    networkAllowancePeriodSeconds: number;
+    /** Advisory admission snapshot; creation rechecks capacity atomically. */
+    admission: AdmissionAssessment | undefined;
+}
+/**
+ * AdmissionAssessment distinguishes valid input from available deployment
+ * capacity. It reserves no capacity or funds and is not a deployment guarantee.
+ */
+export interface AdmissionAssessment {
+    available: boolean;
+    reason: string;
+    checkedAt: Date | undefined;
+    capacityReserved: boolean;
+}
+export interface GetUsagePolicyRequest {
+    orgId: string;
+}
+/**
+ * UsageAllowance combines retained data continuously; time/transfer allowances
+ * reset at the UTC month boundary with no rollover. Grants are account-level
+ * and assigned to one organization, never multiplied by additional owners.
+ */
+export interface UsageAllowance {
+    /** meter is retained_bytes, volume_bytes, build_seconds or download_bytes. */
+    meter: string;
+    freeUnits: bigint;
+    usedUnits: bigint;
+    remainingUnits: bigint;
+    rateMicrocents: bigint;
+    /** unit_quantity and period_seconds describe the rate denominator. */
+    unitQuantity: bigint;
+    periodSeconds: bigint;
+}
+/**
+ * UsagePolicy is a quote for explicit owner acceptance of storage, Git,
+ * build, volume and EU download usage charging. Existing data is never billed
+ * before acceptance; stale inventory cannot authorize new paid growth.
+ */
+export interface UsagePolicy {
+    orgId: string;
+    version: string;
+    currency: string;
+    estimateId: string;
+    estimateExpiresAt: Date | undefined;
+    estimated720HourMicrocents: bigint;
+    allowances: UsageAllowance[];
+    acceptedVersion: string;
+    acceptedAt: Date | undefined;
+    inventoryAt: Date | undefined;
+    /** mode is shadow, awaiting_acceptance, active, read_only or meter_stale. */
+    mode: string;
+    /**
+     * charging_ready follows the completed shadow-meter gate; acceptance is
+     * rejected until all backend enforcement and meters are qualified.
+     */
+    chargingReady: boolean;
+}
+/**
+ * AcceptUsagePolicyRequest requires the organization owner and the current
+ * unexpired estimate. Acceptance records version, owner, time and estimate.
+ * It never creates unpaid debt or authorizes automatic deletion of data.
+ */
+export interface AcceptUsagePolicyRequest {
+    orgId: string;
+    version: string;
+    estimateId: string;
+}
+export declare const CreateComputeQuoteRequest: MessageFns<CreateComputeQuoteRequest>;
+export declare const ComputeQuote: MessageFns<ComputeQuote>;
+export declare const AdmissionAssessment: MessageFns<AdmissionAssessment>;
+export declare const GetUsagePolicyRequest: MessageFns<GetUsagePolicyRequest>;
+export declare const UsageAllowance: MessageFns<UsageAllowance>;
+export declare const UsagePolicy: MessageFns<UsagePolicy>;
+export declare const AcceptUsagePolicyRequest: MessageFns<AcceptUsagePolicyRequest>;
+type Builtin = Date | Function | Uint8Array | string | number | boolean | bigint | undefined;
+export type DeepPartial<T> = T extends bigint ? string | number | bigint : T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {
+    $case: string;
+    value: unknown;
+} ? {
+    $case: T["$case"];
+    value?: DeepPartial<T["value"]>;
+} : T extends {} ? {
+    [K in keyof T]?: DeepPartial<T[K]>;
+} : Partial<T>;
+export interface MessageFns<T> {
+    encode(message: T, writer?: BinaryWriter): BinaryWriter;
+    decode(input: BinaryReader | Uint8Array, length?: number): T;
+    fromJSON(object: any): T;
+    toJSON(message: T): unknown;
+    create(base?: DeepPartial<T>): T;
+    fromPartial(object: DeepPartial<T>): T;
+}
+export {};