@highlightxyz/sdk 0.1.0

package/lib/v1/gen/sdk.gen.d.ts

@@ -0,0 +1,689 @@
+import { type Client, type Options as Options2, type TDataShape } from "./client";
+import { type ApiKeyCreateErrors, type ApiKeyCreateResponses, type ApiKeyListErrors, type ApiKeyListResponses, type ApiKeyRevokeErrors, type ApiKeyRevokeResponses, CaptureSettingsTrigger, type CollectionAddSaleErrors, type CollectionAddSaleResponses, type CollectionBidSaleErrors, type CollectionBidSaleResponses, type CollectionClaimSaleErrors, type CollectionClaimSaleResponses, type CollectionConfirmBidErrors, type CollectionConfirmBidResponses, type CollectionConfirmSaleErrors, type CollectionConfirmSaleResponses, type CollectionCreateErrors, type CollectionCreateResponses, type CollectionDeleteSaleErrors, type CollectionDeleteSaleResponses, type CollectionDeployConfirmErrors, type CollectionDeployConfirmResponses, type CollectionDeployErrors, type CollectionDeployResponses, type CollectionDeployStatusErrors, type CollectionDeployStatusResponses, type CollectionFinalizeBaseUriErrors, type CollectionFinalizeBaseUriResponses, type CollectionGetErrors, type CollectionGetResponses, type CollectionGetSalesErrors, type CollectionGetSalesResponses, type CollectionListErrors, type CollectionListResponses, CollectionType, type CollectionUpdateEditionDetailsErrors, type CollectionUpdateEditionDetailsResponses, type CollectionUpdateGenerativeDetailsErrors, type CollectionUpdateGenerativeDetailsResponses, type CollectionUpdateSaleErrors, type CollectionUpdateSaleResponses, type CollectionUpdateSeriesDetailsErrors, type CollectionUpdateSeriesDetailsResponses, type ConfigChainsResponses, type ConfigSystemContractErrors, type ConfigSystemContractResponses, type ContractGetErrors, type ContractGetResponses, type ContractListErrors, type ContractListResponses, ContractStandard, type GateCreateErrors, type GateCreateResponses, type GateGetErrors, type GateGetResponses, type GateListErrors, type GateListResponses, GateMatchMode, type GateRemoveErrors, type GateRemoveResponses, type GateUpdateErrors, type GateUpdateResponses, GenerativeEditionType, type HealthGetResponses, type MechanicAddDeploymentErrors, type MechanicAddDeploymentResponses, type MechanicCreateErrors, type MechanicCreateResponses, type MechanicGetErrors, type MechanicGetResponses, type MechanicListResponses, type MechanicRemoveDeploymentErrors, type MechanicRemoveDeploymentResponses, type MechanicUpdateErrors, type MechanicUpdateResponses, type MediaCreateUploadSessionErrors, type MediaCreateUploadSessionResponses, type MediaDeleteErrors, type MediaDeleteResponses, type MediaGetChildErrors, type MediaGetChildResponses, type MediaGetErrors, type MediaGetResponses, MediaKind, type MediaListChildrenErrors, type MediaListChildrenResponses, type MediaProcessErrors, type MediaProcessResponses, type MediaPublishErrors, type MediaPublishResponses, MediaScope, type MediaUploadErrors, type MediaUploadResponses, type PostIndexerChainsByChainIdActivateResponses, type PostIndexerChainsByChainIdPollResponses, type PostIndexerChainsByChainIdResetResponses, SaleAccessMode, SaleType, SelectorType, type TokenGetErrors, type TokenGetResponses, type TokenListErrors, type TokenListResponses, type UserSigninErrors, type UserSigninResponses, type UserSiweNonceErrors, type UserSiweNonceResponses } from "./types.gen";
+export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = Options2<TData, ThrowOnError> & {
+    /**
+     * You can provide a client instance returned by `createClient()` instead of
+     * individual options. This might be also useful if you want to implement a
+     * custom client.
+     */
+    client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: Record<string, unknown>;
+};
+declare class HeyApiClient {
+    protected client: Client;
+    constructor(args?: {
+        client?: Client;
+    });
+}
+declare class HeyApiRegistry<T> {
+    private readonly defaultKey;
+    private readonly instances;
+    get(key?: string): T;
+    set(value: T, key?: string): void;
+}
+export declare class Collection extends HeyApiClient {
+    /**
+     * List collections
+     *
+     * Get a paginated list of collections.
+     */
+    list<ThrowOnError extends boolean = false>(parameters: {
+        page?: number;
+        limit?: number;
+        sortBy?: "CREATED_DATE" | "NAME";
+        sortDirection?: "ASC" | "DESC";
+        status?: "Draft" | "InProgress" | "Live" | "Migrated" | "Disabled";
+        blockchains: Array<number>;
+        testnet: boolean;
+        types: Array<"OpenEdition" | "LimitedEdition" | "OneOfOne" | "Series" | "GenerativeSeries">;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionListResponses, CollectionListErrors, ThrowOnError, "fields">;
+    /**
+     * Create collection
+     *
+     * Create a draft collection and bind it to an existing or new draft contract.
+     */
+    create<ThrowOnError extends boolean = false>(parameters: {
+        name: string;
+        description: string;
+        contractId?: string;
+        contract?: {
+            chainId: number;
+            name: string;
+            symbol: string;
+            standard: ContractStandard;
+        };
+        logoMediaId: string;
+        image: string;
+        type: CollectionType;
+        royalty?: {
+            address: string;
+            amount: number;
+        };
+        tokenManager?: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionCreateResponses, CollectionCreateErrors, ThrowOnError, "fields">;
+    /**
+     * Get collection
+     *
+     * Get a collection by its highlight ID.
+     */
+    get<ThrowOnError extends boolean = false>(parameters: {
+        highlightId: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionGetResponses, CollectionGetErrors, ThrowOnError, "fields">;
+    /**
+     * Finalize collection base URI to Arweave
+     *
+     * Publish the collection's token-metadata base URI Directory to Arweave. Call once the collection is complete (sellout or manual trigger) to freeze metadata permanently. Idempotent — safe to call if already archived.
+     */
+    finalizeBaseUri<ThrowOnError extends boolean = false>(parameters: {
+        highlightId: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionFinalizeBaseUriResponses, CollectionFinalizeBaseUriErrors, ThrowOnError, "fields">;
+    /**
+     * Update generative draft details
+     *
+     * Update generative-specific details for an existing draft.
+     */
+    updateGenerativeDetails<ThrowOnError extends boolean = false>(parameters: {
+        highlightId: string;
+        generative: {
+            size: number;
+            codeMediaId: string;
+            isCurated?: boolean;
+            isGpuRendering?: boolean;
+            editionType?: GenerativeEditionType;
+            allowedHashes?: Array<string>;
+            requiredParams?: Array<string>;
+            captureSettings?: {
+                trigger: CaptureSettingsTrigger;
+                delay?: number;
+                selector?: string;
+                selectorType?: SelectorType;
+                viewPortHeight?: number;
+                viewPortWidth?: number;
+            };
+        };
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionUpdateGenerativeDetailsResponses, CollectionUpdateGenerativeDetailsErrors, ThrowOnError, "fields">;
+    /**
+     * Update series draft details
+     *
+     * Update series-specific details for an existing draft.
+     */
+    updateSeriesDetails<ThrowOnError extends boolean = false>(parameters: {
+        highlightId: string;
+        series: {
+            size: number;
+            isCollectorsChoice?: boolean;
+            assetsMediaId?: string;
+        };
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionUpdateSeriesDetailsResponses, CollectionUpdateSeriesDetailsErrors, ThrowOnError, "fields">;
+    /**
+     * Update edition draft details
+     *
+     * Update edition-specific details for an existing draft.
+     */
+    updateEditionDetails<ThrowOnError extends boolean = false>(parameters: {
+        highlightId: string;
+        edition: {
+            size: number;
+            name?: string;
+            description?: string;
+            imageMediaId: string;
+            animationMediaId?: string | null;
+            attributes?: Array<{
+                traitType: string;
+                value: string;
+            }>;
+        };
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionUpdateEditionDetailsResponses, CollectionUpdateEditionDetailsErrors, ThrowOnError, "fields">;
+    /**
+     * Get collection sales
+     *
+     * Get all sales for a collection.
+     */
+    getSales<ThrowOnError extends boolean = false>(parameters: {
+        highlightId: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionGetSalesResponses, CollectionGetSalesErrors, ThrowOnError, "fields">;
+    /**
+     * Add a sale to a collection
+     *
+     * Add a new sale to a collection. Draft collections can have one sale at a time. For live collections, gated sales go live immediately; public sales return a contract execution for on-chain registration.
+     */
+    addSale<ThrowOnError extends boolean = false>(parameters: {
+        highlightId: string;
+        name?: string | null;
+        type: SaleType;
+        startAt: string;
+        endAt?: string | null;
+        price: string;
+        currency: string;
+        maxPerTransaction: number;
+        maxPerWallet: number;
+        maxTotal: number;
+        paymentRecipient: string;
+        accessMode?: SaleAccessMode;
+        gateId?: string | null;
+        gasSponsored?: boolean;
+        mechanicId?: string | null;
+        typeConfig?: unknown | null;
+        collectorMessage?: string | null;
+        customMintFee?: string | null;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionAddSaleResponses, CollectionAddSaleErrors, ThrowOnError, "fields">;
+    /**
+     * Delete a sale
+     *
+     * Delete a draft sale from a collection. Live sales cannot be deleted — use update to pause or set an end date instead.
+     */
+    deleteSale<ThrowOnError extends boolean = false>(parameters: {
+        highlightId: string;
+        saleId: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionDeleteSaleResponses, CollectionDeleteSaleErrors, ThrowOnError, "fields">;
+    /**
+     * Update a sale
+     *
+     * Update an existing sale. Draft sales can be updated freely. Live public sales return a contract execution for on-chain updates when on-chain fields change.
+     */
+    updateSale<ThrowOnError extends boolean = false>(parameters: {
+        highlightId: string;
+        saleId: string;
+        name?: string | null;
+        startAt?: string;
+        endAt?: string | null;
+        price?: string;
+        currency?: string;
+        maxPerTransaction?: number;
+        maxPerWallet?: number;
+        maxTotal?: number;
+        paymentRecipient?: string;
+        paused?: boolean;
+        collectorMessage?: string | null;
+        customMintFee?: string | null;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionUpdateSaleResponses, CollectionUpdateSaleErrors, ThrowOnError, "fields">;
+    /**
+     * Claim collection sale
+     *
+     * Build a claim transaction configuration for a collector sale action.
+     */
+    claimSale<ThrowOnError extends boolean = false>(parameters: {
+        highlightId: string;
+        saleId: string;
+        amount: number;
+        tokenIds?: Array<number>;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionClaimSaleResponses, CollectionClaimSaleErrors, ThrowOnError, "fields">;
+    /**
+     * Bid on ranked auction sale
+     *
+     * Build a bid transaction configuration for a ranked auction sale. Returns contract execution data for placing or updating a bid.
+     */
+    bidSale<ThrowOnError extends boolean = false>(parameters: {
+        highlightId: string;
+        saleId: string;
+        bidAmount: string;
+        bidId?: number;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionBidSaleResponses, CollectionBidSaleErrors, ThrowOnError, "fields">;
+    /**
+     * Confirm ranked auction bid
+     *
+     * Record a confirmed on-chain bid for a ranked auction sale. Called after the bid transaction is confirmed on-chain.
+     */
+    confirmBid<ThrowOnError extends boolean = false>(parameters: {
+        highlightId: string;
+        saleId: string;
+        txHash: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionConfirmBidResponses, CollectionConfirmBidErrors, ThrowOnError, "fields">;
+    /**
+     * Confirm sale deployment
+     *
+     * Confirm on-chain deployment of a public sale added to a live collection. Extracts the vector ID from the transaction receipt and sets the sale status to Live.
+     */
+    confirmSale<ThrowOnError extends boolean = false>(parameters: {
+        highlightId: string;
+        saleId: string;
+        txHash: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionConfirmSaleResponses, CollectionConfirmSaleErrors, ThrowOnError, "fields">;
+    /**
+     * Initiate collection deployment
+     *
+     * Start the deployment workflow for a draft collection.
+     */
+    deploy<ThrowOnError extends boolean = false>(parameters: {
+        highlightId: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionDeployResponses, CollectionDeployErrors, ThrowOnError, "fields">;
+    /**
+     * Get deployment status
+     *
+     * Get the current deployment status for a collection.
+     */
+    deployStatus<ThrowOnError extends boolean = false>(parameters: {
+        highlightId: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionDeployStatusResponses, CollectionDeployStatusErrors, ThrowOnError, "fields">;
+    /**
+     * Confirm deployment transaction
+     *
+     * Submit the transaction hash for a deployment awaiting confirmation.
+     */
+    deployConfirm<ThrowOnError extends boolean = false>(parameters: {
+        highlightId: string;
+        txHash: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionDeployConfirmResponses, CollectionDeployConfirmErrors, ThrowOnError, "fields">;
+}
+export declare class Token extends HeyApiClient {
+    /**
+     * List tokens
+     *
+     * Get a paginated list of minted tokens for a collection. Returns tokens for public collections without authentication. Supports filtering by owner address.
+     */
+    list<ThrowOnError extends boolean = false>(parameters: {
+        highlightId: string;
+        page?: number;
+        limit?: number;
+        sort?: "tokenId" | "name" | "mintedAt" | "createdAt";
+        order?: "asc" | "desc";
+        ownerAddress?: string;
+        search?: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<TokenListResponses, TokenListErrors, ThrowOnError, "fields">;
+    /**
+     * Get token
+     *
+     * Get a single minted token by its on-chain token ID. Returns token details for public collections without authentication.
+     */
+    get<ThrowOnError extends boolean = false>(parameters: {
+        highlightId: string;
+        tokenId: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<TokenGetResponses, TokenGetErrors, ThrowOnError, "fields">;
+}
+export declare class Config extends HeyApiClient {
+    /**
+     * List chains
+     *
+     * Get the list of supported chains and their configuration.
+     */
+    chains<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): import("./client").RequestResult<ConfigChainsResponses, unknown, ThrowOnError, "fields">;
+    /**
+     * Get system contract
+     *
+     * Get a configured system contract address for a chain and contract type.
+     */
+    systemContract<ThrowOnError extends boolean = false>(parameters: {
+        chainId: number;
+        type: "CollectionFactory" | "MintManager" | "AuctionManager" | "PermissionsRegistry" | "EditionsMetadataRenderer" | "NonTransferableTokenManager" | "ConsensualNonTransferableTokenManager" | "ConsensualNonTransferableTokenManager2" | "GenerativeSeriesImplementation" | "SeriesImplementation" | "MultipleEditionsImplementation" | "MultipleEditionsDFSImplementation" | "SingleEditionImplementation" | "SingleEditionDFSImplementation" | "MinimalForwarder" | "Observability" | "RandomSeriesImplementation" | "MintFeeOracle" | "GengineObservability" | "ReferralManager" | "RazorWorksImplementation" | "EditionsDFS1155Implementation" | "ObservabilityV2" | "BitstreamSeedManager";
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<ConfigSystemContractResponses, ConfigSystemContractErrors, ThrowOnError, "fields">;
+}
+export declare class Contract extends HeyApiClient {
+    /**
+     * List contracts
+     *
+     * Get a cursor-paginated list of contracts.
+     */
+    list<ThrowOnError extends boolean = false>(parameters?: {
+        limit?: number;
+        cursor?: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<ContractListResponses, ContractListErrors, ThrowOnError, "fields">;
+    /**
+     * Get contract
+     *
+     * Get a contract by its ID.
+     */
+    get<ThrowOnError extends boolean = false>(parameters: {
+        contractId: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<ContractGetResponses, ContractGetErrors, ThrowOnError, "fields">;
+}
+export declare class Gate extends HeyApiClient {
+    /**
+     * List gates
+     *
+     * List all gates for the authenticated user.
+     */
+    list<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): import("./client").RequestResult<GateListResponses, GateListErrors, ThrowOnError, "fields">;
+    /**
+     * Create gate
+     *
+     * Create a new gate with conditions.
+     */
+    create<ThrowOnError extends boolean = false>(parameters: {
+        name: string;
+        matchMode?: GateMatchMode;
+        conditions: Array<{
+            type: "ALLOWLIST";
+            config: {
+                addresses: Array<string>;
+            };
+        } | {
+            type: "TOKEN_OWNERSHIP";
+            config: {
+                contractAddress: string;
+                chainId: number;
+                minAmount?: number;
+            };
+        } | {
+            type: "SPECIFIC_TOKEN";
+            config: {
+                contractAddress: string;
+                chainId: number;
+                tokenId: string;
+            };
+        } | {
+            type: "TOKEN_ATTRIBUTE";
+            config: {
+                contractAddress: string;
+                chainId: number;
+                traitType: string;
+                traitValue: string;
+            };
+        } | {
+            type: "CURRENCY_BALANCE";
+            config: {
+                chainId: number;
+                contractAddress?: string;
+                minBalance: string;
+            };
+        } | {
+            type: "FARCASTER_FOLLOW";
+            config: {
+                fid: number;
+            };
+        }>;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<GateCreateResponses, GateCreateErrors, ThrowOnError, "fields">;
+    /**
+     * Delete gate
+     *
+     * Delete a gate and all its conditions.
+     */
+    remove<ThrowOnError extends boolean = false>(parameters: {
+        gateId: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<GateRemoveResponses, GateRemoveErrors, ThrowOnError, "fields">;
+    /**
+     * Get gate
+     *
+     * Get a gate by its ID.
+     */
+    get<ThrowOnError extends boolean = false>(parameters: {
+        gateId: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<GateGetResponses, GateGetErrors, ThrowOnError, "fields">;
+    /**
+     * Update gate
+     *
+     * Update a gate's name, match mode, or conditions.
+     */
+    update<ThrowOnError extends boolean = false>(parameters: {
+        gateId: string;
+        name?: string;
+        matchMode?: GateMatchMode;
+        conditions?: Array<{
+            type: "ALLOWLIST";
+            config: {
+                addresses: Array<string>;
+            };
+        } | {
+            type: "TOKEN_OWNERSHIP";
+            config: {
+                contractAddress: string;
+                chainId: number;
+                minAmount?: number;
+            };
+        } | {
+            type: "SPECIFIC_TOKEN";
+            config: {
+                contractAddress: string;
+                chainId: number;
+                tokenId: string;
+            };
+        } | {
+            type: "TOKEN_ATTRIBUTE";
+            config: {
+                contractAddress: string;
+                chainId: number;
+                traitType: string;
+                traitValue: string;
+            };
+        } | {
+            type: "CURRENCY_BALANCE";
+            config: {
+                chainId: number;
+                contractAddress?: string;
+                minBalance: string;
+            };
+        } | {
+            type: "FARCASTER_FOLLOW";
+            config: {
+                fid: number;
+            };
+        }>;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<GateUpdateResponses, GateUpdateErrors, ThrowOnError, "fields">;
+}
+export declare class Mechanic extends HeyApiClient {
+    /**
+     * List mechanics
+     *
+     * List all registered mechanics. Optionally filter by built-in status.
+     */
+    list<ThrowOnError extends boolean = false>(parameters?: {
+        builtIn?: boolean | string;
+        type?: "SEED_BASED_MINT" | "DISCRETE_DUTCH_AUCTION" | "RANKED_AUCTION" | "GASLESS" | "CUSTOM";
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<MechanicListResponses, unknown, ThrowOnError, "fields">;
+    /**
+     * Create mechanic
+     *
+     * Register a new custom mechanic contract.
+     */
+    create<ThrowOnError extends boolean = false>(parameters: {
+        slug: string;
+        name: string;
+        description?: string | null;
+        configSchema?: unknown | null;
+        encodingAbi?: unknown | null;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<MechanicCreateResponses, MechanicCreateErrors, ThrowOnError, "fields">;
+    /**
+     * Get mechanic
+     *
+     * Get a mechanic by its ID.
+     */
+    get<ThrowOnError extends boolean = false>(parameters: {
+        mechanicId: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<MechanicGetResponses, MechanicGetErrors, ThrowOnError, "fields">;
+    /**
+     * Update mechanic
+     *
+     * Update a custom mechanic. Built-in mechanics cannot be modified.
+     */
+    update<ThrowOnError extends boolean = false>(parameters: {
+        mechanicId: string;
+        name?: string;
+        description?: string | null;
+        configSchema?: unknown | null;
+        encodingAbi?: unknown | null;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<MechanicUpdateResponses, MechanicUpdateErrors, ThrowOnError, "fields">;
+    /**
+     * Remove mechanic deployment
+     *
+     * Remove a mechanic contract deployment from a specific chain.
+     */
+    removeDeployment<ThrowOnError extends boolean = false>(parameters: {
+        mechanicId: string;
+        chainId: number;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<MechanicRemoveDeploymentResponses, MechanicRemoveDeploymentErrors, ThrowOnError, "fields">;
+    /**
+     * Add mechanic deployment
+     *
+     * Register a mechanic contract deployment on a specific chain. Upserts if a deployment already exists for the chain.
+     */
+    addDeployment<ThrowOnError extends boolean = false>(parameters: {
+        mechanicId: string;
+        chainId: number;
+        address: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<MechanicAddDeploymentResponses, MechanicAddDeploymentErrors, ThrowOnError, "fields">;
+}
+export declare class Media extends HeyApiClient {
+    /**
+     * Create media upload session
+     *
+     * Create a media asset and return the worker upload URL the client should PUT bytes to. Call /:mediaId/process once the PUT completes.
+     */
+    createUploadSession<ThrowOnError extends boolean = false>(parameters: {
+        kind: MediaKind;
+        scope?: MediaScope;
+        fileName: string;
+        mimeType: string;
+        fileSize: number;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<MediaCreateUploadSessionResponses, MediaCreateUploadSessionErrors, ThrowOnError, "fields">;
+    /**
+     * Upload media bytes
+     *
+     * Stream the file body to the worker, which writes it to storage and immediately drives the asset through processing. File assets come back Ready; Directory assets come back Processing (zip extraction running). Call /:mediaId/process to retry a Failed Directory.
+     */
+    upload<ThrowOnError extends boolean = false>(parameters: {
+        mediaId: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<MediaUploadResponses, MediaUploadErrors, ThrowOnError, "fields">;
+    /**
+     * Process a media asset
+     *
+     * Drive the media asset toward Ready. Call after PUTting bytes to /:mediaId/upload to finalize the upload (File assets become Ready; Directory assets trigger zip extraction). Idempotent — assets that are already Ready or currently Processing are returned as-is. Failed Directory assets re-trigger extraction.
+     */
+    process<ThrowOnError extends boolean = false>(parameters: {
+        mediaId: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<MediaProcessResponses, MediaProcessErrors, ThrowOnError, "fields">;
+    /**
+     * List children of a Directory media asset
+     *
+     * Returns a paginated list of File children (e.g. per-token metadata or extracted archive files).
+     */
+    listChildren<ThrowOnError extends boolean = false>(parameters: {
+        mediaId: string;
+        cursor?: string;
+        limit?: number;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<MediaListChildrenResponses, MediaListChildrenErrors, ThrowOnError, "fields">;
+    /**
+     * Delete a media asset
+     *
+     * Delete the media asset and its R2 objects. Arweave archive locations remain on-chain (immutable) but are no longer referenced. Fails with 409 if still referenced by a collection contract or generative collection code.
+     */
+    delete<ThrowOnError extends boolean = false>(parameters: {
+        mediaId: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<MediaDeleteResponses, MediaDeleteErrors, ThrowOnError, "fields">;
+    /**
+     * Get media asset
+     *
+     * Get media asset details including kind, locations, and status.
+     */
+    get<ThrowOnError extends boolean = false>(parameters: {
+        mediaId: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<MediaGetResponses, MediaGetErrors, ThrowOnError, "fields">;
+    /**
+     * Publish media to archive
+     *
+     * Mirror the media asset to its immutable archive provider (Arweave). File media publishes the single blob; Directory media publishes a manifest of all children. Idempotent — returns early if already archived.
+     */
+    publish<ThrowOnError extends boolean = false>(parameters: {
+        mediaId: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<MediaPublishResponses, MediaPublishErrors, ThrowOnError, "fields">;
+    /**
+     * Get a child File Entity by path
+     *
+     * Returns the child File's full Entity (with locations and status). Use `entity.url` to fetch bytes directly from the storage provider.
+     */
+    getChild<ThrowOnError extends boolean = false>(parameters: {
+        mediaId: string;
+        path: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<MediaGetChildResponses, MediaGetChildErrors, ThrowOnError, "fields">;
+}
+export declare class Siwe extends HeyApiClient {
+    /**
+     * Issue a SIWE nonce
+     *
+     * Issues a single-use, short-lived nonce for use as the `nonce` field of a SIWE (EIP-4361) message.
+     */
+    nonce<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): import("./client").RequestResult<UserSiweNonceResponses, UserSiweNonceErrors, ThrowOnError, "fields">;
+}
+export declare class User extends HeyApiClient {
+    /**
+     * Sign in user
+     *
+     * Sign in with a provider credential (Privy id_token or SIWE message + signature) and receive access/refresh tokens plus user.
+     */
+    signin<ThrowOnError extends boolean = false>(parameters: {
+        body: {
+            providerType: "Privy";
+            token: string;
+        } | {
+            providerType: "Siwe";
+            message: string;
+            signature: string;
+        };
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<UserSigninResponses, UserSigninErrors, ThrowOnError, "fields">;
+    private _siwe?;
+    get siwe(): Siwe;
+}
+export declare class ApiKey extends HeyApiClient {
+    /**
+     * List API keys
+     *
+     * List all API keys for the authenticated account.
+     */
+    list<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): import("./client").RequestResult<ApiKeyListResponses, ApiKeyListErrors, ThrowOnError, "fields">;
+    /**
+     * Create API key
+     *
+     * Create a new API key. The plaintext key is returned only once in this response.
+     */
+    create<ThrowOnError extends boolean = false>(parameters: {
+        name: string;
+        expiresAt?: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<ApiKeyCreateResponses, ApiKeyCreateErrors, ThrowOnError, "fields">;
+    /**
+     * Revoke API key
+     *
+     * Revoke an API key. Revoked keys can no longer authenticate requests.
+     */
+    revoke<ThrowOnError extends boolean = false>(parameters: {
+        apiKeyId: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<ApiKeyRevokeResponses, ApiKeyRevokeErrors, ThrowOnError, "fields">;
+}
+export declare class Health extends HeyApiClient {
+    /**
+     * Health check
+     *
+     * Check if the service is healthy.
+     */
+    get<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): import("./client").RequestResult<HealthGetResponses, unknown, ThrowOnError, "fields">;
+}
+export declare class HighlightClient extends HeyApiClient {
+    static readonly __registry: HeyApiRegistry<HighlightClient>;
+    constructor(args?: {
+        client?: Client;
+        key?: string;
+    });
+    postIndexerChainsByChainIdActivate<ThrowOnError extends boolean = false>(parameters: {
+        chainId: number;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<PostIndexerChainsByChainIdActivateResponses, unknown, ThrowOnError, "fields">;
+    postIndexerChainsByChainIdReset<ThrowOnError extends boolean = false>(parameters: {
+        chainId: number;
+        blockNumber: number;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<PostIndexerChainsByChainIdResetResponses, unknown, ThrowOnError, "fields">;
+    postIndexerChainsByChainIdPoll<ThrowOnError extends boolean = false>(parameters: {
+        chainId: number;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<PostIndexerChainsByChainIdPollResponses, unknown, ThrowOnError, "fields">;
+    private _collection?;
+    get collection(): Collection;
+    private _token?;
+    get token(): Token;
+    private _config?;
+    get config(): Config;
+    private _contract?;
+    get contract(): Contract;
+    private _gate?;
+    get gate(): Gate;
+    private _mechanic?;
+    get mechanic(): Mechanic;
+    private _media?;
+    get media(): Media;
+    private _user?;
+    get user(): User;
+    private _apiKey?;
+    get apiKey(): ApiKey;
+    private _health?;
+    get health(): Health;
+}
+export {};
+//# sourceMappingURL=sdk.gen.d.ts.map