@highlightxyz/sdk 0.1.1 → 0.3.0

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

@@ -1,5 +1,5 @@
 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 CollectionDeployCancelErrors, type CollectionDeployCancelResponses, 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";
+import { type ApiKeyCreateErrors, type ApiKeyCreateResponses, type ApiKeyListErrors, type ApiKeyListResponses, type ApiKeyRevokeErrors, type ApiKeyRevokeResponses, CaptureSettingsTrigger, type CollectionAddSaleErrors, type CollectionAddSaleResponses, type CollectionBidSaleErrors, type CollectionBidSaleResponses, type CollectionCancelEnglishAuctionErrors, type CollectionCancelEnglishAuctionResponses, type CollectionClaimAuctionEarningsErrors, type CollectionClaimAuctionEarningsResponses, type CollectionClaimSaleErrors, type CollectionClaimSaleResponses, type CollectionCreateErrors, type CollectionCreateResponses, type CollectionDeleteSaleErrors, type CollectionDeleteSaleResponses, type CollectionDeployCancelErrors, type CollectionDeployCancelResponses, type CollectionDeployErrors, type CollectionDeployResponses, type CollectionDeployStatusErrors, type CollectionDeployStatusResponses, type CollectionEnglishAuctionBidsErrors, type CollectionEnglishAuctionBidsResponses, type CollectionEnglishAuctionStandingErrors, type CollectionEnglishAuctionStandingResponses, type CollectionFeaturedErrors, type CollectionFeaturedResponses, type CollectionFinalizeBaseUriErrors, type CollectionFinalizeBaseUriResponses, type CollectionFulfillEnglishAuctionErrors, type CollectionFulfillEnglishAuctionResponses, type CollectionGetErrors, type CollectionGetResponses, type CollectionGetSalesErrors, type CollectionGetSalesResponses, type CollectionListErrors, type CollectionListPreviewsErrors, type CollectionListPreviewsResponses, type CollectionListResponses, type CollectionRankedAuctionStandingsErrors, type CollectionRankedAuctionStandingsResponses, type CollectionReclaimBidErrors, type CollectionReclaimBidResponses, type CollectionTrendingErrors, type CollectionTrendingResponses, 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 GatePreviewAttributesErrors, type GatePreviewAttributesResponses, type GatePreviewCollectionErrors, type GatePreviewCollectionResponses, type GatePreviewCurrencyErrors, type GatePreviewCurrencyResponses, type GatePreviewFarcasterErrors, type GatePreviewFarcasterResponses, type GatePreviewTokenErrors, type GatePreviewTokenResponses, type GatePreviewTokensErrors, type GatePreviewTokensResponses, 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 PostIndexerChainsByChainIdActivateErrors, type PostIndexerChainsByChainIdActivateResponses, type PostIndexerChainsByChainIdPollErrors, type PostIndexerChainsByChainIdPollResponses, type PostIndexerChainsByChainIdResetErrors, type PostIndexerChainsByChainIdResetResponses, type ProfileGetErrors, type ProfileGetResponses, type ProfilePublicErrors, type ProfilePublicResponses, type ProfileTokensErrors, type ProfileTokensResponses, type ProfileUpdateErrors, type ProfileUpdateResponses, SaleAccessMode, SaleType, SelectorType, type TokenAttributeFacetsErrors, type TokenAttributeFacetsResponses, type TokenGetErrors, type TokenGetResponses, type TokenListErrors, type TokenListOwnersErrors, type TokenListOwnersResponses, type TokenListResponses, type TokenRedriveRevealsErrors, type TokenRedriveRevealsResponses, type TxStatusErrors, type TxStatusResponses, type TxSubmitErrors, type TxSubmitResponses, 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
@@ -31,15 +31,15 @@ export declare class Collection extends HeyApiClient {
      *
      * Get a paginated list of collections.
      */
-    list<ThrowOnError extends boolean = false>(parameters: {
+    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">;
+        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
@@ -65,18 +65,46 @@ export declare class Collection extends HeyApiClient {
         };
         tokenManager?: string;
     }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionCreateResponses, CollectionCreateErrors, ThrowOnError, "fields">;
+    /**
+     * Trending collections
+     *
+     * List live collections ranked by units minted in a 24-hour, 7-day, or 28-day rolling window.
+     */
+    trending<ThrowOnError extends boolean = false>(parameters?: {
+        window?: "24h" | "7d" | "28d";
+        chainId?: number;
+        limit?: number;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionTrendingResponses, CollectionTrendingErrors, ThrowOnError, "fields">;
+    /**
+     * Featured collections
+     *
+     * List curated home-page collections in editorial order with cursor pagination.
+     */
+    featured<ThrowOnError extends boolean = false>(parameters?: {
+        limit?: number;
+        cursor?: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionFeaturedResponses, CollectionFeaturedErrors, ThrowOnError, "fields">;
     /**
      * Get collection
      *
-     * Get a collection by its highlight ID.
+     * Get a collection by `highlightId` or by `<chain>:<contractAddress>[:<editionId>]`. The chain can be a slug or numeric ID. `editionId` defaults to 0.
      */
     get<ThrowOnError extends boolean = false>(parameters: {
-        highlightId: string;
+        highlightId: string | string;
     }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionGetResponses, CollectionGetErrors, ThrowOnError, "fields">;
     /**
-     * Finalize collection base URI to Arweave
+     * List series previews
+     *
+     * List sample artwork from a series collection's uploaded assets. Returns an empty list for other collection types or when the assets are not ready. Public collections do not require authentication.
+     */
+    listPreviews<ThrowOnError extends boolean = false>(parameters: {
+        highlightId: string;
+        limit?: number;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionListPreviewsResponses, CollectionListPreviewsErrors, ThrowOnError, "fields">;
+    /**
+     * Archive collection metadata 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.
+     * Archive the collection's token-metadata directory to Arweave. The operation is idempotent and does not change the contract's base URI.
      */
     finalizeBaseUri<ThrowOnError extends boolean = false>(parameters: {
         highlightId: string;
@@ -120,9 +148,9 @@ export declare class Collection extends HeyApiClient {
         };
     }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionUpdateSeriesDetailsResponses, CollectionUpdateSeriesDetailsErrors, ThrowOnError, "fields">;
     /**
-     * Update edition draft details
+     * Update edition details
      *
-     * Update edition-specific details for an existing draft.
+     * Update an edition's name, description, image, animation, or attributes. Draft changes are saved directly. Live changes return a `setEditionURI` transaction to sign. After confirmation, the backend re-derives the edition and refreshes every token.
      */
     updateEditionDetails<ThrowOnError extends boolean = false>(parameters: {
         highlightId: string;
@@ -141,7 +169,7 @@ export declare class Collection extends HeyApiClient {
     /**
      * Get collection sales
      *
-     * Get all sales for a collection.
+     * List the draft and live sales attached to a collection.
      */
     getSales<ThrowOnError extends boolean = false>(parameters: {
         highlightId: string;
@@ -149,7 +177,7 @@ export declare class Collection extends HeyApiClient {
     /**
      * 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.
+     * Add a sale. A draft collection can have one sale at a time. On a live collection, a gated sale activates immediately and a public sale returns a vector-registration transaction.
      */
     addSale<ThrowOnError extends boolean = false>(parameters: {
         highlightId: string;
@@ -174,7 +202,7 @@ export declare class Collection extends HeyApiClient {
     /**
      * 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.
+     * Delete a draft sale. A live sale cannot be deleted; pause it or set an end date.
      */
     deleteSale<ThrowOnError extends boolean = false>(parameters: {
         highlightId: string;
@@ -183,7 +211,7 @@ export declare class Collection extends HeyApiClient {
     /**
      * 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.
+     * Update a sale. Draft and gated sales update off-chain. Supported changes to a live public sale return an on-chain vector-update transaction.
      */
     updateSale<ThrowOnError extends boolean = false>(parameters: {
         highlightId: string;
@@ -204,7 +232,7 @@ export declare class Collection extends HeyApiClient {
     /**
      * Claim collection sale
      *
-     * Build a claim transaction configuration for a collector sale action.
+     * Build a collector's mint transaction for a fixed-price, Dutch, or ranked sale.
      */
     claimSale<ThrowOnError extends boolean = false>(parameters: {
         highlightId: string;
@@ -213,36 +241,81 @@ export declare class Collection extends HeyApiClient {
         tokenIds?: Array<number>;
     }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionClaimSaleResponses, CollectionClaimSaleErrors, ThrowOnError, "fields">;
     /**
-     * Bid on ranked auction sale
+     * Bid on an auction sale
      *
-     * Build a bid transaction configuration for a ranked auction sale. Returns contract execution data for placing or updating a bid.
+     * Build a ranked- or English-auction bid transaction. For an English auction, `preferredNftRecipient` sets the wallet that receives the NFT if the bid wins.
      */
     bidSale<ThrowOnError extends boolean = false>(parameters: {
         highlightId: string;
         saleId: string;
         bidAmount: string;
         bidId?: number;
+        preferredNftRecipient?: string;
     }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionBidSaleResponses, CollectionBidSaleErrors, ThrowOnError, "fields">;
     /**
-     * Confirm ranked auction bid
+     * Reclaim a non-winning ranked-auction bid
      *
-     * Record a confirmed on-chain bid for a ranked auction sale. Called after the bid transaction is confirmed on-chain.
+     * Build a transaction that reclaims a non-winning ranked-auction bid after the auction ends.
      */
-    confirmBid<ThrowOnError extends boolean = false>(parameters: {
+    reclaimBid<ThrowOnError extends boolean = false>(parameters: {
         highlightId: string;
         saleId: string;
-        txHash: string;
-    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionConfirmBidResponses, CollectionConfirmBidErrors, ThrowOnError, "fields">;
+        bidId: number;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionReclaimBidResponses, CollectionReclaimBidErrors, ThrowOnError, "fields">;
     /**
-     * Confirm sale deployment
+     * Withdraw ranked-auction earnings
      *
-     * 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.
+     * Build a transaction that sends a completed ranked auction's native-currency earnings to its payment recipient.
      */
-    confirmSale<ThrowOnError extends boolean = false>(parameters: {
+    claimAuctionEarnings<ThrowOnError extends boolean = false>(parameters: {
         highlightId: string;
         saleId: string;
-        txHash: string;
-    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionConfirmSaleResponses, CollectionConfirmSaleErrors, ThrowOnError, "fields">;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionClaimAuctionEarningsResponses, CollectionClaimAuctionEarningsErrors, ThrowOnError, "fields">;
+    /**
+     * Get ranked-auction live standings
+     *
+     * Get a ranked auction's clearing price and bid standings. Results are provisional before settlement. An authenticated response also includes the caller's winning bids and unclaimed tokens.
+     */
+    rankedAuctionStandings<ThrowOnError extends boolean = false>(parameters: {
+        highlightId: string;
+        saleId: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionRankedAuctionStandingsResponses, CollectionRankedAuctionStandingsErrors, ThrowOnError, "fields">;
+    /**
+     * Fulfill (settle) an English auction
+     *
+     * Build an `AuctionManager.fulfillAuction` transaction after the auction ends. Any authenticated caller can settle; the contract sends the NFT to the winner's preferred recipient and splits the proceeds.
+     */
+    fulfillEnglishAuction<ThrowOnError extends boolean = false>(parameters: {
+        highlightId: string;
+        saleId: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionFulfillEnglishAuctionResponses, CollectionFulfillEnglishAuctionErrors, ThrowOnError, "fields">;
+    /**
+     * Cancel an English auction
+     *
+     * Build the creator-only `AuctionManager.cancelAuctionOnChain` transaction. Cancellation fails after a bid meets the reserve. The contract returns any escrowed NFT to the owner.
+     */
+    cancelEnglishAuction<ThrowOnError extends boolean = false>(parameters: {
+        highlightId: string;
+        saleId: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionCancelEnglishAuctionResponses, CollectionCancelEnglishAuctionErrors, ThrowOnError, "fields">;
+    /**
+     * Get English auction standings
+     *
+     * Get an English auction's status, reserve, highest bid and bidder, end time, escrowed token, and creator earnings. An authenticated response indicates whether the caller is the highest bidder.
+     */
+    englishAuctionStanding<ThrowOnError extends boolean = false>(parameters: {
+        highlightId: string;
+        saleId: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionEnglishAuctionStandingResponses, CollectionEnglishAuctionStandingErrors, ThrowOnError, "fields">;
+    /**
+     * Get English auction bid history
+     *
+     * List an English auction's indexed bids from newest to oldest. Amounts use the currency's raw on-chain base unit.
+     */
+    englishAuctionBids<ThrowOnError extends boolean = false>(parameters: {
+        highlightId: string;
+        saleId: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionEnglishAuctionBidsResponses, CollectionEnglishAuctionBidsErrors, ThrowOnError, "fields">;
     /**
      * Initiate collection deployment
      *
@@ -262,26 +335,17 @@ export declare class Collection extends HeyApiClient {
     /**
      * Cancel a deployment
      *
-     * Cancel a deployment that has not yet completed. Terminates the running workflow, deletes the deployment row, and rolls the collection back to Draft. On contracts shared with other collections the contract is left unchanged; otherwise it is reset to Draft. After cancelling, the collection can be re-deployed from scratch.
+     * Cancel an incomplete deployment and return the collection to Draft. A shared contract keeps its current status; a non-shared contract returns to Draft. The collection can then be deployed again.
      */
     deployCancel<ThrowOnError extends boolean = false>(parameters: {
         highlightId: string;
     }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionDeployCancelResponses, CollectionDeployCancelErrors, 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.
+     * Get a paginated list of minted tokens for a collection. Returns tokens for public collections without authentication. Supports filtering by owner address and by trait attributes.
      */
     list<ThrowOnError extends boolean = false>(parameters: {
         highlightId: string;
@@ -291,7 +355,16 @@ export declare class Token extends HeyApiClient {
         order?: "asc" | "desc";
         ownerAddress?: string;
         search?: string;
+        attributes?: string;
     }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<TokenListResponses, TokenListErrors, ThrowOnError, "fields">;
+    /**
+     * List token attribute facets
+     *
+     * List trait values and token counts for collection filters. Public collections do not require authentication.
+     */
+    attributeFacets<ThrowOnError extends boolean = false>(parameters: {
+        highlightId: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<TokenAttributeFacetsResponses, TokenAttributeFacetsErrors, ThrowOnError, "fields">;
     /**
      * Get token
      *
@@ -301,6 +374,23 @@ export declare class Token extends HeyApiClient {
         highlightId: string;
         tokenId: string;
     }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<TokenGetResponses, TokenGetErrors, ThrowOnError, "fields">;
+    /**
+     * List token owners
+     *
+     * Get the current owners of a minted token with their balances. A single entry for ERC721 tokens; ERC1155 tokens can have many. Available for public collections without authentication.
+     */
+    listOwners<ThrowOnError extends boolean = false>(parameters: {
+        highlightId: string;
+        tokenId: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<TokenListOwnersResponses, TokenListOwnersErrors, ThrowOnError, "fields">;
+    /**
+     * Re-drive stuck token reveals
+     *
+     * Reschedule failed and stale pending token reveals. Minted tokens restart from their original mint transaction. Imported tokens without transfer history rerun metadata indexing only.
+     */
+    redriveReveals<ThrowOnError extends boolean = false>(parameters: {
+        highlightId: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<TokenRedriveRevealsResponses, TokenRedriveRevealsErrors, ThrowOnError, "fields">;
 }
 export declare class Config extends HeyApiClient {
     /**
@@ -342,7 +432,7 @@ export declare class Gate extends HeyApiClient {
     /**
      * List gates
      *
-     * List all gates for the authenticated user.
+     * List gates owned by the authenticated account.
      */
     list<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): import("./client").RequestResult<GateListResponses, GateListErrors, ThrowOnError, "fields">;
     /**
@@ -391,6 +481,9 @@ export declare class Gate extends HeyApiClient {
             type: "FARCASTER_FOLLOW";
             config: {
                 fid: number;
+                username?: string;
+                displayName?: string;
+                pfpUrl?: string;
             };
         }>;
     }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<GateCreateResponses, GateCreateErrors, ThrowOnError, "fields">;
@@ -457,9 +550,68 @@ export declare class Gate extends HeyApiClient {
             type: "FARCASTER_FOLLOW";
             config: {
                 fid: number;
+                username?: string;
+                displayName?: string;
+                pfpUrl?: string;
             };
         }>;
     }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<GateUpdateResponses, GateUpdateErrors, ThrowOnError, "fields">;
+    /**
+     * Preview a collection
+     *
+     * Resolve an NFT contract for a gate builder. Returns a Highlight collection when available, otherwise external NFT data.
+     */
+    previewCollection<ThrowOnError extends boolean = false>(parameters: {
+        chainId: number;
+        address: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<GatePreviewCollectionResponses, GatePreviewCollectionErrors, ThrowOnError, "fields">;
+    /**
+     * Preview collection attributes
+     *
+     * List a collection's trait types and values for the TOKEN_ATTRIBUTE builder.
+     */
+    previewAttributes<ThrowOnError extends boolean = false>(parameters: {
+        chainId: number;
+        address: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<GatePreviewAttributesResponses, GatePreviewAttributesErrors, ThrowOnError, "fields">;
+    /**
+     * Preview collection tokens
+     *
+     * Page through a collection's tokens for the SPECIFIC_TOKEN builder.
+     */
+    previewTokens<ThrowOnError extends boolean = false>(parameters: {
+        chainId: number;
+        address: string;
+        cursor?: string;
+        limit?: number;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<GatePreviewTokensResponses, GatePreviewTokensErrors, ThrowOnError, "fields">;
+    /**
+     * Preview a token
+     *
+     * Resolve a single token to confirm a SPECIFIC_TOKEN condition.
+     */
+    previewToken<ThrowOnError extends boolean = false>(parameters: {
+        chainId: number;
+        address: string;
+        tokenId: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<GatePreviewTokenResponses, GatePreviewTokenErrors, ThrowOnError, "fields">;
+    /**
+     * Preview a currency
+     *
+     * Resolve the native gas token (no contractAddress) or an ERC-20 for the CURRENCY_BALANCE builder.
+     */
+    previewCurrency<ThrowOnError extends boolean = false>(parameters: {
+        chainId: number;
+        contractAddress?: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<GatePreviewCurrencyResponses, GatePreviewCurrencyErrors, ThrowOnError, "fields">;
+    /**
+     * Preview a Farcaster user
+     *
+     * Resolve a numeric fid or @handle to a Farcaster user for the FARCASTER_FOLLOW builder.
+     */
+    previewFarcaster<ThrowOnError extends boolean = false>(parameters: {
+        query: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<GatePreviewFarcasterResponses, GatePreviewFarcasterErrors, ThrowOnError, "fields">;
 }
 export declare class Mechanic extends HeyApiClient {
     /**
@@ -515,7 +667,7 @@ export declare class Mechanic extends HeyApiClient {
     /**
      * Add mechanic deployment
      *
-     * Register a mechanic contract deployment on a specific chain. Upserts if a deployment already exists for the chain.
+     * Register a mechanic's contract address on a chain. Replaces the address if that chain already has one.
      */
     addDeployment<ThrowOnError extends boolean = false>(parameters: {
         mechanicId: string;
@@ -527,7 +679,7 @@ 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.
+     * Create a pending media asset and return an upload URL with the required request headers.
      */
     createUploadSession<ThrowOnError extends boolean = false>(parameters: {
         kind: MediaKind;
@@ -539,7 +691,7 @@ export declare class Media extends HeyApiClient {
     /**
      * 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.
+     * Write the request body to storage and start processing. Files return Ready; directories return Processing while extraction runs.
      */
     upload<ThrowOnError extends boolean = false>(parameters: {
         mediaId: string;
@@ -547,15 +699,15 @@ export declare class Media extends HeyApiClient {
     /**
      * 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.
+     * Retry processing for a failed directory. The operation is idempotent and leaves Ready or Processing assets unchanged.
      */
     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
+     * List directory files
      *
-     * Returns a paginated list of File children (e.g. per-token metadata or extracted archive files).
+     * List the extracted files in a directory with cursor pagination.
      */
     listChildren<ThrowOnError extends boolean = false>(parameters: {
         mediaId: string;
@@ -565,7 +717,7 @@ export declare class Media extends HeyApiClient {
     /**
      * 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 a media record and its R2 objects. An immutable Arweave archive remains available. Returns 409 when a contract or generative collection still references the media.
      */
     delete<ThrowOnError extends boolean = false>(parameters: {
         mediaId: string;
@@ -581,34 +733,95 @@ export declare class Media extends HeyApiClient {
     /**
      * 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.
+     * Archive media to Arweave. Files publish one blob; directories publish their children and a manifest. The operation is idempotent.
      */
     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
+     * Get a child file by path
      *
-     * Returns the child File's full Entity (with locations and status). Use `entity.url` to fetch bytes directly from the storage provider.
+     * Get an extracted file by path, including its status and storage locations.
      */
     getChild<ThrowOnError extends boolean = false>(parameters: {
         mediaId: string;
         path: string;
     }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<MediaGetChildResponses, MediaGetChildErrors, ThrowOnError, "fields">;
 }
+export declare class Tx extends HeyApiClient {
+    /**
+     * Get transaction status
+     *
+     * Get the transaction's domain milestones and their status. The overall status reaches Ready after all expected milestones finish. Use the `/ws` route for live updates.
+     */
+    status<ThrowOnError extends boolean = false>(parameters: {
+        chainId: number;
+        txHash: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<TxStatusResponses, TxStatusErrors, ThrowOnError, "fields">;
+    /**
+     * Submit a transaction for tracking
+     *
+     * Submit a broadcast transaction hash for domain processing and milestone tracking. Returns the current snapshot; use the `/ws` route for live updates.
+     */
+    submit<ThrowOnError extends boolean = false>(parameters: {
+        chainId: number;
+        txHash: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<TxSubmitResponses, TxSubmitErrors, ThrowOnError, "fields">;
+}
+export declare class Profile extends HeyApiClient {
+    /**
+     * Get authenticated profile
+     *
+     * Get the private profile for the authenticated account, including its email.
+     */
+    get<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): import("./client").RequestResult<ProfileGetResponses, ProfileGetErrors, ThrowOnError, "fields">;
+    /**
+     * Update authenticated profile
+     *
+     * Update private profile fields. Avatar media must be an owned, ready User-scope image file.
+     */
+    update<ThrowOnError extends boolean = false>(parameters?: {
+        displayName?: string | null;
+        bio?: string | null;
+        website?: string | null;
+        avatarMediaId?: string | null;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<ProfileUpdateResponses, ProfileUpdateErrors, ThrowOnError, "fields">;
+    /**
+     * Get public profile
+     *
+     * Get a wallet's public profile. Valid wallet addresses without a registered account return an address-only fallback profile.
+     */
+    public<ThrowOnError extends boolean = false>(parameters: {
+        walletAddress: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<ProfilePublicResponses, ProfilePublicErrors, ThrowOnError, "fields">;
+    /**
+     * List public wallet tokens
+     *
+     * Get a wallet's token holdings across live collections. This is available for every valid EVM address, including addresses without a registered account.
+     */
+    tokens<ThrowOnError extends boolean = false>(parameters: {
+        walletAddress: string;
+        page?: number;
+        limit?: number;
+        sort?: "tokenId" | "name" | "mintedAt";
+        order?: "asc" | "desc";
+        collectionId?: string;
+        search?: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<ProfileTokensResponses, ProfileTokensErrors, 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.
+     * Issue a single-use, short-lived nonce for 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
      *
-     * Sign in with a provider credential (Privy id_token or SIWE message + signature) and receive access/refresh tokens plus user.
+     * Exchange a Privy ID token or signed SIWE message for Highlight access and refresh tokens.
      */
     signin<ThrowOnError extends boolean = false>(parameters: {
         body: {
@@ -662,16 +875,31 @@ export declare class HighlightClient extends HeyApiClient {
         client?: Client;
         key?: string;
     });
+    /**
+     * Activate a chain indexer
+     *
+     * Start or wake indexing for an enabled chain. Administrative use only.
+     */
     postIndexerChainsByChainIdActivate<ThrowOnError extends boolean = false>(parameters: {
         chainId: number;
-    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<PostIndexerChainsByChainIdActivateResponses, unknown, ThrowOnError, "fields">;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<PostIndexerChainsByChainIdActivateResponses, PostIndexerChainsByChainIdActivateErrors, ThrowOnError, "fields">;
+    /**
+     * Reset a chain indexer
+     *
+     * Move a chain's indexing cursor to a block so later polls reprocess from that point. Administrative use only.
+     */
     postIndexerChainsByChainIdReset<ThrowOnError extends boolean = false>(parameters: {
         chainId: number;
         blockNumber: number;
-    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<PostIndexerChainsByChainIdResetResponses, unknown, ThrowOnError, "fields">;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<PostIndexerChainsByChainIdResetResponses, PostIndexerChainsByChainIdResetErrors, ThrowOnError, "fields">;
+    /**
+     * Poll a chain indexer
+     *
+     * Run one indexing cycle for an enabled chain. Administrative use only.
+     */
     postIndexerChainsByChainIdPoll<ThrowOnError extends boolean = false>(parameters: {
         chainId: number;
-    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<PostIndexerChainsByChainIdPollResponses, unknown, ThrowOnError, "fields">;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<PostIndexerChainsByChainIdPollResponses, PostIndexerChainsByChainIdPollErrors, ThrowOnError, "fields">;
     private _collection?;
     get collection(): Collection;
     private _token?;
@@ -686,6 +914,10 @@ export declare class HighlightClient extends HeyApiClient {
     get mechanic(): Mechanic;
     private _media?;
     get media(): Media;
+    private _tx?;
+    get tx(): Tx;
+    private _profile?;
+    get profile(): Profile;
     private _user?;
     get user(): User;
     private _apiKey?;