@highlightxyz/sdk 0.2.0 → 0.4.0

package/lib/client.d.ts

@@ -4,6 +4,13 @@ import { HighlightClient } from "./v1/gen/sdk.gen.js";
 export { createClient, HighlightClient };
 export type { Client };
 export type HighlightClientConfig = Config & {
+    /**
+     * Highlight API key sent as a bearer token.
+     *
+     * This is a convenience alias for configuring `auth` and `security`
+     * explicitly. `auth` takes precedence when both are provided.
+     */
+    apiKey?: string;
     security?: ReadonlyArray<Auth>;
 };
 export declare function createHighlightClient(config?: HighlightClientConfig): HighlightClient;

package/lib/client.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AAEtC,OAAO,EAAE,YAAY,EAAE,KAAK,IAAI,EAAE,KAAK,MAAM,EAAE,KAAK,MAAM,EAAE,MAAM,iBAAiB,CAAC;AACpF,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,CAAC;AACzC,YAAY,EAAE,MAAM,EAAE,CAAC;AAEvB,MAAM,MAAM,qBAAqB,GAAG,MAAM,GAAG;IAC3C,QAAQ,CAAC,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC;CAChC,CAAC;AAEF,wBAAgB,qBAAqB,CAAC,MAAM,CAAC,EAAE,qBAAqB,mBAGnE"}
+{"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAAA,cAAc,uBAAuB,CAAC;AAEtC,OAAO,EAAE,YAAY,EAAE,KAAK,IAAI,EAAE,KAAK,MAAM,EAAE,KAAK,MAAM,EAAE,MAAM,iBAAiB,CAAC;AACpF,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AACtD,OAAO,EAAE,YAAY,EAAE,eAAe,EAAE,CAAC;AACzC,YAAY,EAAE,MAAM,EAAE,CAAC;AAEvB,MAAM,MAAM,qBAAqB,GAAG,MAAM,GAAG;IAC3C;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,aAAa,CAAC,IAAI,CAAC,CAAC;CAChC,CAAC;AAEF,wBAAgB,qBAAqB,CAAC,MAAM,CAAC,EAAE,qBAAqB,mBAYnE"}

package/lib/client.js

@@ -3,6 +3,14 @@ import { createClient } from "./v1/gen/client";
 import { HighlightClient } from "./v1/gen/sdk.gen.js";
 export { createClient, HighlightClient };
 export function createHighlightClient(config) {
-    const client = createClient(config);
+    const resolvedConfig = {
+        ...config,
+        auth: config?.auth ?? config?.apiKey,
+        security: config?.security ??
+            (config?.auth || config?.apiKey
+                ? [{ type: "http", scheme: "bearer" }]
+                : undefined),
+    };
+    const client = createClient(resolvedConfig);
     return new HighlightClient({ client });
 }

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 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 PostIndexerChainsByChainIdActivateResponses, type PostIndexerChainsByChainIdPollResponses, type PostIndexerChainsByChainIdResetResponses, SaleAccessMode, SaleType, SelectorType, type TokenAttributeFacetsErrors, type TokenAttributeFacetsResponses, type TokenGetErrors, type TokenGetResponses, type TokenListErrors, type TokenListOwnersErrors, type TokenListOwnersResponses, type TokenListResponses, type TxStatusErrors, type TxStatusResponses, type TxSubmitErrors, type TxSubmitResponses, 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 CollectionArchiveBaseUriErrors, type CollectionArchiveBaseUriResponses, type CollectionBidSaleErrors, type CollectionBidSaleResponses, type CollectionCancelEnglishAuctionErrors, type CollectionCancelEnglishAuctionResponses, type CollectionClaimAuctionEarningsErrors, type CollectionClaimAuctionEarningsResponses, type CollectionClaimDutchRebateErrors, type CollectionClaimDutchRebateResponses, type CollectionClaimSaleErrors, type CollectionClaimSaleResponses, type CollectionCreateErrors, type CollectionCreateMediaUploadSessionErrors, type CollectionCreateMediaUploadSessionResponses, type CollectionCreateResponses, type CollectionDeleteSaleErrors, type CollectionDeleteSaleResponses, type CollectionDeployCancelErrors, type CollectionDeployCancelResponses, type CollectionDeployErrors, type CollectionDeployResponses, type CollectionDeployStatusErrors, type CollectionDeployStatusResponses, type CollectionDutchAuctionStandingErrors, type CollectionDutchAuctionStandingResponses, type CollectionEnglishAuctionBidsErrors, type CollectionEnglishAuctionBidsResponses, type CollectionEnglishAuctionStandingErrors, type CollectionEnglishAuctionStandingResponses, type CollectionFeaturedErrors, type CollectionFeaturedResponses, 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 CollectionUpdateMetadataErrors, type CollectionUpdateMetadataInput, type CollectionUpdateMetadataResponses, type CollectionUpdateSaleErrors, type CollectionUpdateSaleResponses, type CollectionUpdateSeriesDetailsErrors, type CollectionUpdateSeriesDetailsResponses, type ConfigChainsResponses, type ConfigMediaHostsResponses, 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 MediaContentHash, type MediaDeleteErrors, type MediaDeleteResponses, type MediaFinalizeUploadErrors, type MediaFinalizeUploadResponses, type MediaGetChildErrors, type MediaGetChildResponses, type MediaGetErrors, type MediaGetResponses, type MediaListChildrenErrors, type MediaListChildrenResponses, type MediaPublishErrors, type MediaPublishResponses, MediaPurpose, 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 UserCreateMediaUploadSessionErrors, type UserCreateMediaUploadSessionResponses, 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
@@ -56,8 +56,6 @@ export declare class Collection extends HeyApiClient {
             symbol: string;
             standard: ContractStandard;
         };
-        logoMediaId: string;
-        image: string;
         type: CollectionType;
         royalty?: {
             address: string;
@@ -68,7 +66,7 @@ export declare class Collection extends HeyApiClient {
     /**
      * Trending collections
      *
-     * Public leaderboard of collections ranked by units minted within a rolling time window (24h / 7d / 28d), computed live from the mint ledger.
+     * 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";
@@ -78,7 +76,7 @@ export declare class Collection extends HeyApiClient {
     /**
      * Featured collections
      *
-     * Public curated showcase of collections for the home page, ordered by editorial position and paginated by cursor.
+     * List curated home-page collections in editorial order with cursor pagination.
      */
     featured<ThrowOnError extends boolean = false>(parameters?: {
         limit?: number;
@@ -87,7 +85,7 @@ export declare class Collection extends HeyApiClient {
     /**
      * Get collection
      *
-     * Get a collection by its highlight ID, or by a contract reference of the form `<chain>:<contractAddress>[:<editionId>]` (chain slug or numeric chainId; editionId defaults to 0), e.g. `ethereum:0x0c3dd3c403b6B5c0CCe2a97F15820a4Eae347FE7:0`.
+     * 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 | string;
@@ -95,20 +93,42 @@ export declare class Collection extends HeyApiClient {
     /**
      * List series previews
      *
-     * List sample artwork for a series collection, resolved from its uploaded assets. Returns an empty list for non-series collections or when assets are not ready. Available for public collections without authentication.
+     * 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">;
     /**
-     * Finalize collection base URI to Arweave
+     * 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 current token-metadata directory snapshot to Arweave. The operation is archive-once, leaves the R2 directory appendable, and does not change the contract's base URI.
      */
-    finalizeBaseUri<ThrowOnError extends boolean = false>(parameters: {
+    archiveBaseUri<ThrowOnError extends boolean = false>(parameters: {
         highlightId: string;
-    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionFinalizeBaseUriResponses, CollectionFinalizeBaseUriErrors, ThrowOnError, "fields">;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionArchiveBaseUriResponses, CollectionArchiveBaseUriErrors, ThrowOnError, "fields">;
+    /**
+     * Create a collection media upload session
+     *
+     * Start an upload for one of the collection media purposes and return an upload URL with the required request headers.
+     */
+    createMediaUploadSession<ThrowOnError extends boolean = false>(parameters: {
+        highlightId: string;
+        purpose: MediaPurpose;
+        fileName: string;
+        mimeType: string;
+        fileSize: number;
+        contentHash: MediaContentHash;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionCreateMediaUploadSessionResponses, CollectionCreateMediaUploadSessionErrors, ThrowOnError, "fields">;
+    /**
+     * Update collection display metadata
+     *
+     * Update a collection's name, description, and logo. Every field is optional; absent fields are left unchanged.
+     */
+    updateMetadata<ThrowOnError extends boolean = false>(parameters: {
+        highlightId: string;
+        collectionUpdateMetadataInput: CollectionUpdateMetadataInput;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionUpdateMetadataResponses, CollectionUpdateMetadataErrors, ThrowOnError, "fields">;
     /**
      * Update generative draft details
      *
@@ -150,7 +170,7 @@ export declare class Collection extends HeyApiClient {
     /**
      * Update edition details
      *
-     * Update edition-specific details (name, description, image, animation, attributes). For a draft collection the change is saved directly. For a live collection it returns a `setEditionURI` transaction to sign — once confirmed on-chain, the backend re-derives the edition and refreshes every token.
+     * 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;
@@ -169,7 +189,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;
@@ -177,7 +197,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;
@@ -193,7 +213,6 @@ export declare class Collection extends HeyApiClient {
         paymentRecipient: string;
         accessMode?: SaleAccessMode;
         gateId?: string | null;
-        gasSponsored?: boolean;
         mechanicId?: string | null;
         typeConfig?: unknown | null;
         collectorMessage?: string | null;
@@ -202,7 +221,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;
@@ -211,7 +230,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;
@@ -232,7 +251,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;
@@ -243,7 +262,7 @@ export declare class Collection extends HeyApiClient {
     /**
      * Bid on an auction sale
      *
-     * Build a bid transaction configuration for an auction sale. For ranked auctions, places or updates an on-chain bid. For English auctions, returns an executor-signed bid claim plus the `AuctionManager.bid` call (with `value` = the bid amount); the optional `preferredNftRecipient` sets where the NFT is delivered if this bidder wins.
+     * 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;
@@ -255,7 +274,7 @@ export declare class Collection extends HeyApiClient {
     /**
      * Reclaim a non-winning ranked-auction bid
      *
-     * Build a transaction to reclaim the funds locked in a non-winning ranked-auction bid after the auction has ended.
+     * Build a transaction that reclaims a non-winning ranked-auction bid after the auction ends.
      */
     reclaimBid<ThrowOnError extends boolean = false>(parameters: {
         highlightId: string;
@@ -265,7 +284,7 @@ export declare class Collection extends HeyApiClient {
     /**
      * Withdraw ranked-auction earnings
      *
-     * Build a transaction to withdraw a ranked auction's cumulative earnings to the payment recipient after the auction has ended. Native-currency auctions only.
+     * Build a transaction that sends a completed ranked auction's native-currency earnings to its payment recipient.
      */
     claimAuctionEarnings<ThrowOnError extends boolean = false>(parameters: {
         highlightId: string;
@@ -274,7 +293,7 @@ export declare class Collection extends HeyApiClient {
     /**
      * Get ranked-auction live standings
      *
-     * Public read-model for a ranked auction: the current clearing price and each bid's winning/losing status (provisional while live, frozen once settled). Includes the authenticated viewer's winning-bid count and tokens left to claim when a bearer token is supplied.
+     * 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;
@@ -283,7 +302,7 @@ export declare class Collection extends HeyApiClient {
     /**
      * Fulfill (settle) an English auction
      *
-     * Build the permissionless `AuctionManager.fulfillAuction` transaction. After the auction's end time anyone may settle it: the contract delivers the escrowed NFT to the winner's preferred recipient and splits the proceeds (95% recipient / 5% platform).
+     * 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;
@@ -292,7 +311,7 @@ export declare class Collection extends HeyApiClient {
     /**
      * Cancel an English auction
      *
-     * Build the `AuctionManager.cancelAuctionOnChain` transaction. The contract enforces owner-only and that no reserve-meeting bid has landed; any escrowed NFT is returned to the owner. Creator only.
+     * 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;
@@ -301,7 +320,7 @@ export declare class Collection extends HeyApiClient {
     /**
      * Get English auction standings
      *
-     * Public read-model for an English auction: lifecycle state, reserve, current highest bid/bidder, end time, escrowed token, and creator earnings — served from the chain-reconciled projection. Includes whether the authenticated viewer is the current highest bidder when a bearer token is supplied.
+     * 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;
@@ -310,12 +329,30 @@ export declare class Collection extends HeyApiClient {
     /**
      * Get English auction bid history
      *
-     * Public read-model: the English auction's bid history (newest first), sourced from the indexer's `Bid`-event ledger. Amounts are raw on-chain base units (wei) in the sale's currency.
+     * 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">;
+    /**
+     * Get Dutch auction standing
+     *
+     * Get a Dutch auction's descending price ladder, its clock, and its supply/escrow state. An authenticated response also includes the caller's purchase position and any rebate owed. Amounts use the currency's raw on-chain base unit.
+     */
+    dutchAuctionStanding<ThrowOnError extends boolean = false>(parameters: {
+        highlightId: string;
+        saleId: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionDutchAuctionStandingResponses, CollectionDutchAuctionStandingErrors, ThrowOnError, "fields">;
+    /**
+     * Claim a Dutch auction rebate
+     *
+     * Build a transaction that refunds the caller the difference between what they paid and the auction's final clearing price. Only available once the auction has reached its resting price or sold out.
+     */
+    claimDutchRebate<ThrowOnError extends boolean = false>(parameters: {
+        highlightId: string;
+        saleId: string;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<CollectionClaimDutchRebateResponses, CollectionClaimDutchRebateErrors, ThrowOnError, "fields">;
     /**
      * Initiate collection deployment
      *
@@ -335,7 +372,7 @@ 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;
@@ -360,7 +397,7 @@ export declare class Token extends HeyApiClient {
     /**
      * List token attribute facets
      *
-     * Get the trait/value facets with token counts for a collection — the data a filter sidebar renders. Available for public collections without authentication.
+     * List trait values and token counts for collection filters. Public collections do not require authentication.
      */
     attributeFacets<ThrowOnError extends boolean = false>(parameters: {
         highlightId: string;
@@ -383,6 +420,14 @@ export declare class Token extends HeyApiClient {
         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 {
     /**
@@ -391,6 +436,12 @@ export declare class Config extends HeyApiClient {
      * 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 media delivery hosts
+     *
+     * Public hosts a client uses to build media URLs from a storage location's provider and reference.
+     */
+    mediaHosts<ThrowOnError extends boolean = false>(options?: Options<never, ThrowOnError>): import("./client").RequestResult<ConfigMediaHostsResponses, unknown, ThrowOnError, "fields">;
     /**
      * Get system contract
      *
@@ -424,7 +475,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">;
     /**
@@ -551,7 +602,7 @@ export declare class Gate extends HeyApiClient {
     /**
      * Preview a collection
      *
-     * Resolve an NFT contract for the gate builder — a Highlight collection if we host it, otherwise external NFT data.
+     * 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;
@@ -613,7 +664,7 @@ export declare class Mechanic extends HeyApiClient {
      */
     list<ThrowOnError extends boolean = false>(parameters?: {
         builtIn?: boolean | string;
-        type?: "SEED_BASED_MINT" | "DISCRETE_DUTCH_AUCTION" | "RANKED_AUCTION" | "GASLESS" | "CUSTOM";
+        type?: "SEED_BASED_MINT" | "DISCRETE_DUTCH_AUCTION" | "RANKED_AUCTION" | "CUSTOM";
     }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<MechanicListResponses, unknown, ThrowOnError, "fields">;
     /**
      * Create mechanic
@@ -659,7 +710,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;
@@ -669,37 +720,17 @@ export declare class Mechanic extends HeyApiClient {
 }
 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
+     * Finalize a direct media upload
      *
-     * 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.
+     * Verify the exact object, size, content type, and R2 SHA-256 checksum before exposing it or starting directory extraction. Duplicate calls are idempotent.
      */
-    process<ThrowOnError extends boolean = false>(parameters: {
+    finalizeUpload<ThrowOnError extends boolean = false>(parameters: {
         mediaId: string;
-    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<MediaProcessResponses, MediaProcessErrors, ThrowOnError, "fields">;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<MediaFinalizeUploadResponses, MediaFinalizeUploadErrors, 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;
@@ -709,7 +740,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. Referenced media returns 409. Immutable Arweave archives remain available.
      */
     delete<ThrowOnError extends boolean = false>(parameters: {
         mediaId: string;
@@ -725,15 +756,15 @@ 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 a location's `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;
@@ -742,9 +773,9 @@ export declare class Media extends HeyApiClient {
 }
 export declare class Tx extends HeyApiClient {
     /**
-     * Get transaction finalization status
+     * Get transaction status
      *
-     * Returns the current finalization status for a transaction: the set of domain milestones (e.g. collection going live, sale going live) it must complete, and whether each is done. Overall is `Ready` only when every expected milestone is done. Use the `/ws` variant for live push updates instead of polling.
+     * 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;
@@ -753,7 +784,7 @@ export declare class Tx extends HeyApiClient {
     /**
      * Submit a transaction for tracking
      *
-     * Hand a broadcast transaction hash to the backend so it is processed end-to-end (collection/sale/bid/mint effects) and its finalization milestones become available. Returns the current status snapshot; subscribe to the `/ws` variant to await finalization.
+     * 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;
@@ -764,15 +795,27 @@ 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
+     * Create a user media upload session
+     *
+     * Start an upload for one of the user media purposes and return an upload URL with the required request headers.
+     */
+    createMediaUploadSession<ThrowOnError extends boolean = false>(parameters: {
+        purpose: MediaPurpose;
+        fileName: string;
+        mimeType: string;
+        fileSize: number;
+        contentHash: MediaContentHash;
+    }, options?: Options<never, ThrowOnError>): import("./client").RequestResult<UserCreateMediaUploadSessionResponses, UserCreateMediaUploadSessionErrors, ThrowOnError, "fields">;
+    /**
+     * 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: {
@@ -787,6 +830,47 @@ export declare class User extends HeyApiClient {
     private _siwe?;
     get siwe(): Siwe;
 }
+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-namespace 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 ApiKey extends HeyApiClient {
     /**
      * List API keys
@@ -826,16 +910,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?;
@@ -854,6 +953,8 @@ export declare class HighlightClient extends HeyApiClient {
     get tx(): Tx;
     private _user?;
     get user(): User;
+    private _profile?;
+    get profile(): Profile;
     private _apiKey?;
     get apiKey(): ApiKey;
     private _health?;