@highlightxyz/sdk 0.1.1 → 0.3.0

package/lib/v1/gen/sdk.gen.js

@@ -81,10 +81,51 @@ export class Collection extends HeyApiClient {
             },
         });
     }
+    /**
+     * Trending collections
+     *
+     * List live collections ranked by units minted in a 24-hour, 7-day, or 28-day rolling window.
+     */
+    trending(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "query", key: "window" },
+                    { in: "query", key: "chainId" },
+                    { in: "query", key: "limit" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).get({
+            url: "/collection/trending",
+            ...options,
+            ...params,
+        });
+    }
+    /**
+     * Featured collections
+     *
+     * List curated home-page collections in editorial order with cursor pagination.
+     */
+    featured(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "query", key: "limit" },
+                    { in: "query", key: "cursor" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).get({
+            url: "/collection/featured",
+            ...options,
+            ...params,
+        });
+    }
     /**
      * 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(parameters, options) {
         const params = buildClientParams([parameters], [{ args: [{ in: "path", key: "highlightId" }] }]);
@@ -95,9 +136,29 @@ export class Collection extends HeyApiClient {
         });
     }
     /**
-     * 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(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "highlightId" },
+                    { in: "query", key: "limit" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).get({
+            url: "/collection/{highlightId}/previews",
+            ...options,
+            ...params,
+        });
+    }
+    /**
+     * 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(parameters, options) {
         const params = buildClientParams([parameters], [{ args: [{ in: "path", key: "highlightId" }] }]);
@@ -158,9 +219,9 @@ export class Collection extends HeyApiClient {
         });
     }
     /**
-     * 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(parameters, options) {
         const params = buildClientParams([parameters], [
@@ -185,7 +246,7 @@ export class Collection extends HeyApiClient {
     /**
      * Get collection sales
      *
-     * Get all sales for a collection.
+     * List the draft and live sales attached to a collection.
      */
     getSales(parameters, options) {
         const params = buildClientParams([parameters], [{ args: [{ in: "path", key: "highlightId" }] }]);
@@ -198,7 +259,7 @@ export 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(parameters, options) {
         const params = buildClientParams([parameters], [
@@ -239,7 +300,7 @@ export 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(parameters, options) {
         const params = buildClientParams([parameters], [
@@ -259,7 +320,7 @@ export 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(parameters, options) {
         const params = buildClientParams([parameters], [
@@ -296,7 +357,7 @@ export 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(parameters, options) {
         const params = buildClientParams([parameters], [
@@ -321,9 +382,9 @@ export class Collection extends HeyApiClient {
         });
     }
     /**
-     * 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(parameters, options) {
         const params = buildClientParams([parameters], [
@@ -333,6 +394,7 @@ export class Collection extends HeyApiClient {
                     { in: "body", key: "saleId" },
                     { in: "body", key: "bidAmount" },
                     { in: "body", key: "bidId" },
+                    { in: "body", key: "preferredNftRecipient" },
                 ],
             },
         ]);
@@ -348,22 +410,47 @@ export class Collection extends HeyApiClient {
         });
     }
     /**
-     * Confirm ranked auction bid
+     * Reclaim a non-winning ranked-auction bid
+     *
+     * Build a transaction that reclaims a non-winning ranked-auction bid after the auction ends.
+     */
+    reclaimBid(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "highlightId" },
+                    { in: "body", key: "saleId" },
+                    { in: "body", key: "bidId" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).post({
+            url: "/collection/{highlightId}/sales/reclaim",
+            ...options,
+            ...params,
+            headers: {
+                "Content-Type": "application/json",
+                ...options?.headers,
+                ...params.headers,
+            },
+        });
+    }
+    /**
+     * Withdraw ranked-auction earnings
      *
-     * Record a confirmed on-chain bid for a ranked auction sale. Called after the bid transaction is confirmed on-chain.
+     * Build a transaction that sends a completed ranked auction's native-currency earnings to its payment recipient.
      */
-    confirmBid(parameters, options) {
+    claimAuctionEarnings(parameters, options) {
         const params = buildClientParams([parameters], [
             {
                 args: [
                     { in: "path", key: "highlightId" },
                     { in: "body", key: "saleId" },
-                    { in: "body", key: "txHash" },
                 ],
             },
         ]);
         return (options?.client ?? this.client).post({
-            url: "/collection/{highlightId}/sales/bid/confirm",
+            url: "/collection/{highlightId}/sales/earnings",
             ...options,
             ...params,
             headers: {
@@ -374,22 +461,41 @@ export class Collection extends HeyApiClient {
         });
     }
     /**
-     * Confirm sale deployment
+     * Get ranked-auction live standings
      *
-     * 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.
+     * 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.
      */
-    confirmSale(parameters, options) {
+    rankedAuctionStandings(parameters, options) {
         const params = buildClientParams([parameters], [
             {
                 args: [
                     { in: "path", key: "highlightId" },
                     { in: "path", key: "saleId" },
-                    { in: "body", key: "txHash" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).get({
+            url: "/collection/{highlightId}/sales/{saleId}/standings",
+            ...options,
+            ...params,
+        });
+    }
+    /**
+     * 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(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "highlightId" },
+                    { in: "body", key: "saleId" },
                 ],
             },
         ]);
         return (options?.client ?? this.client).post({
-            url: "/collection/{highlightId}/sales/{saleId}/confirm",
+            url: "/collection/{highlightId}/sales/auction/fulfill",
             ...options,
             ...params,
             headers: {
@@ -399,6 +505,71 @@ export class Collection extends HeyApiClient {
             },
         });
     }
+    /**
+     * 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(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "highlightId" },
+                    { in: "body", key: "saleId" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).post({
+            url: "/collection/{highlightId}/sales/auction/cancel",
+            ...options,
+            ...params,
+            headers: {
+                "Content-Type": "application/json",
+                ...options?.headers,
+                ...params.headers,
+            },
+        });
+    }
+    /**
+     * 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(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "highlightId" },
+                    { in: "path", key: "saleId" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).get({
+            url: "/collection/{highlightId}/sales/{saleId}/auction",
+            ...options,
+            ...params,
+        });
+    }
+    /**
+     * 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(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "highlightId" },
+                    { in: "path", key: "saleId" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).get({
+            url: "/collection/{highlightId}/sales/{saleId}/auction/bids",
+            ...options,
+            ...params,
+        });
+    }
     /**
      * Initiate collection deployment
      *
@@ -428,7 +599,7 @@ export 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(parameters, options) {
         const params = buildClientParams([parameters], [{ args: [{ in: "path", key: "highlightId" }] }]);
@@ -438,37 +609,12 @@ export class Collection extends HeyApiClient {
             ...params,
         });
     }
-    /**
-     * Confirm deployment transaction
-     *
-     * Submit the transaction hash for a deployment awaiting confirmation.
-     */
-    deployConfirm(parameters, options) {
-        const params = buildClientParams([parameters], [
-            {
-                args: [
-                    { in: "path", key: "highlightId" },
-                    { in: "body", key: "txHash" },
-                ],
-            },
-        ]);
-        return (options?.client ?? this.client).post({
-            url: "/collection/{highlightId}/deploy/confirm",
-            ...options,
-            ...params,
-            headers: {
-                "Content-Type": "application/json",
-                ...options?.headers,
-                ...params.headers,
-            },
-        });
-    }
 }
 export 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(parameters, options) {
         const params = buildClientParams([parameters], [
@@ -481,6 +627,7 @@ export class Token extends HeyApiClient {
                     { in: "query", key: "order" },
                     { in: "query", key: "ownerAddress" },
                     { in: "query", key: "search" },
+                    { in: "query", key: "attributes" },
                 ],
             },
         ]);
@@ -490,6 +637,19 @@ export class Token extends HeyApiClient {
             ...params,
         });
     }
+    /**
+     * List token attribute facets
+     *
+     * List trait values and token counts for collection filters. Public collections do not require authentication.
+     */
+    attributeFacets(parameters, options) {
+        const params = buildClientParams([parameters], [{ args: [{ in: "path", key: "highlightId" }] }]);
+        return (options?.client ?? this.client).get({
+            url: "/collection/{highlightId}/tokens/attributes",
+            ...options,
+            ...params,
+        });
+    }
     /**
      * Get token
      *
@@ -510,6 +670,39 @@ export class Token extends HeyApiClient {
             ...params,
         });
     }
+    /**
+     * 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(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "highlightId" },
+                    { in: "path", key: "tokenId" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).get({
+            url: "/collection/{highlightId}/tokens/{tokenId}/owners",
+            ...options,
+            ...params,
+        });
+    }
+    /**
+     * 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(parameters, options) {
+        const params = buildClientParams([parameters], [{ args: [{ in: "path", key: "highlightId" }] }]);
+        return (options?.client ?? this.client).post({
+            url: "/collection/{highlightId}/tokens/redrive-reveals",
+            ...options,
+            ...params,
+        });
+    }
 }
 export class Config extends HeyApiClient {
     /**
@@ -583,7 +776,7 @@ export class Gate extends HeyApiClient {
     /**
      * List gates
      *
-     * List all gates for the authenticated user.
+     * List gates owned by the authenticated account.
      */
     list(options) {
         return (options?.client ?? this.client).get({
@@ -670,6 +863,122 @@ export class Gate extends HeyApiClient {
             },
         });
     }
+    /**
+     * Preview a collection
+     *
+     * Resolve an NFT contract for a gate builder. Returns a Highlight collection when available, otherwise external NFT data.
+     */
+    previewCollection(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "chainId" },
+                    { in: "path", key: "address" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).get({
+            url: "/gate/preview/collection/{chainId}/{address}",
+            ...options,
+            ...params,
+        });
+    }
+    /**
+     * Preview collection attributes
+     *
+     * List a collection's trait types and values for the TOKEN_ATTRIBUTE builder.
+     */
+    previewAttributes(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "chainId" },
+                    { in: "path", key: "address" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).get({
+            url: "/gate/preview/collection/{chainId}/{address}/attributes",
+            ...options,
+            ...params,
+        });
+    }
+    /**
+     * Preview collection tokens
+     *
+     * Page through a collection's tokens for the SPECIFIC_TOKEN builder.
+     */
+    previewTokens(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "chainId" },
+                    { in: "path", key: "address" },
+                    { in: "query", key: "cursor" },
+                    { in: "query", key: "limit" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).get({
+            url: "/gate/preview/collection/{chainId}/{address}/tokens",
+            ...options,
+            ...params,
+        });
+    }
+    /**
+     * Preview a token
+     *
+     * Resolve a single token to confirm a SPECIFIC_TOKEN condition.
+     */
+    previewToken(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "chainId" },
+                    { in: "path", key: "address" },
+                    { in: "path", key: "tokenId" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).get({
+            url: "/gate/preview/collection/{chainId}/{address}/token/{tokenId}",
+            ...options,
+            ...params,
+        });
+    }
+    /**
+     * Preview a currency
+     *
+     * Resolve the native gas token (no contractAddress) or an ERC-20 for the CURRENCY_BALANCE builder.
+     */
+    previewCurrency(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "chainId" },
+                    { in: "query", key: "contractAddress" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).get({
+            url: "/gate/preview/currency/{chainId}",
+            ...options,
+            ...params,
+        });
+    }
+    /**
+     * Preview a Farcaster user
+     *
+     * Resolve a numeric fid or @handle to a Farcaster user for the FARCASTER_FOLLOW builder.
+     */
+    previewFarcaster(parameters, options) {
+        const params = buildClientParams([parameters], [{ args: [{ in: "query", key: "query" }] }]);
+        return (options?.client ?? this.client).get({
+            url: "/gate/preview/farcaster/user",
+            ...options,
+            ...params,
+        });
+    }
 }
 export class Mechanic extends HeyApiClient {
     /**
@@ -789,7 +1098,7 @@ export 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(parameters, options) {
         const params = buildClientParams([parameters], [
@@ -817,7 +1126,7 @@ export 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(parameters, options) {
         const params = buildClientParams([parameters], [
@@ -845,7 +1154,7 @@ export 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(parameters, options) {
         const params = buildClientParams([parameters], [{ args: [{ in: "path", key: "mediaId" }] }]);
@@ -858,7 +1167,7 @@ export 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(parameters, options) {
         const params = buildClientParams([parameters], [{ args: [{ in: "path", key: "mediaId" }] }]);
@@ -869,9 +1178,9 @@ export class Media extends HeyApiClient {
         });
     }
     /**
-     * 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(parameters, options) {
         const params = buildClientParams([parameters], [
@@ -892,7 +1201,7 @@ export 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(parameters, options) {
         const params = buildClientParams([parameters], [{ args: [{ in: "path", key: "mediaId" }] }]);
@@ -918,7 +1227,7 @@ export 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(parameters, options) {
         const params = buildClientParams([parameters], [{ args: [{ in: "path", key: "mediaId" }] }]);
@@ -929,9 +1238,9 @@ export class Media extends HeyApiClient {
         });
     }
     /**
-     * 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(parameters, options) {
         const params = buildClientParams([parameters], [
@@ -949,11 +1258,128 @@ export class Media extends HeyApiClient {
         });
     }
 }
+export 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(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "chainId" },
+                    { in: "path", key: "txHash" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).get({
+            url: "/tx/{chainId}/{txHash}",
+            ...options,
+            ...params,
+        });
+    }
+    /**
+     * 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(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "chainId" },
+                    { in: "path", key: "txHash" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).post({
+            url: "/tx/{chainId}/{txHash}",
+            ...options,
+            ...params,
+        });
+    }
+}
+export class Profile extends HeyApiClient {
+    /**
+     * Get authenticated profile
+     *
+     * Get the private profile for the authenticated account, including its email.
+     */
+    get(options) {
+        return (options?.client ?? this.client).get({ url: "/user/profile", ...options });
+    }
+    /**
+     * Update authenticated profile
+     *
+     * Update private profile fields. Avatar media must be an owned, ready User-scope image file.
+     */
+    update(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "body", key: "displayName" },
+                    { in: "body", key: "bio" },
+                    { in: "body", key: "website" },
+                    { in: "body", key: "avatarMediaId" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).patch({
+            url: "/user/profile",
+            ...options,
+            ...params,
+            headers: {
+                "Content-Type": "application/json",
+                ...options?.headers,
+                ...params.headers,
+            },
+        });
+    }
+    /**
+     * Get public profile
+     *
+     * Get a wallet's public profile. Valid wallet addresses without a registered account return an address-only fallback profile.
+     */
+    public(parameters, options) {
+        const params = buildClientParams([parameters], [{ args: [{ in: "path", key: "walletAddress" }] }]);
+        return (options?.client ?? this.client).get({
+            url: "/user/{walletAddress}/profile",
+            ...options,
+            ...params,
+        });
+    }
+    /**
+     * 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(parameters, options) {
+        const params = buildClientParams([parameters], [
+            {
+                args: [
+                    { in: "path", key: "walletAddress" },
+                    { in: "query", key: "page" },
+                    { in: "query", key: "limit" },
+                    { in: "query", key: "sort" },
+                    { in: "query", key: "order" },
+                    { in: "query", key: "collectionId" },
+                    { in: "query", key: "search" },
+                ],
+            },
+        ]);
+        return (options?.client ?? this.client).get({
+            url: "/user/{walletAddress}/tokens",
+            ...options,
+            ...params,
+        });
+    }
+}
 export 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(options) {
         return (options?.client ?? this.client).post({ url: "/user/signin/siwe/nonce", ...options });
@@ -961,9 +1387,9 @@ export class Siwe extends HeyApiClient {
 }
 export 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(parameters, options) {
         const params = buildClientParams([parameters], [{ args: [{ key: "body", map: "body" }] }]);
@@ -1050,6 +1476,11 @@ export class HighlightClient extends HeyApiClient {
         super(args);
         HighlightClient.__registry.set(this, args?.key);
     }
+    /**
+     * Activate a chain indexer
+     *
+     * Start or wake indexing for an enabled chain. Administrative use only.
+     */
     postIndexerChainsByChainIdActivate(parameters, options) {
         const params = buildClientParams([parameters], [{ args: [{ in: "path", key: "chainId" }] }]);
         return (options?.client ?? this.client).post({
@@ -1058,6 +1489,11 @@ export class HighlightClient extends HeyApiClient {
             ...params,
         });
     }
+    /**
+     * Reset a chain indexer
+     *
+     * Move a chain's indexing cursor to a block so later polls reprocess from that point. Administrative use only.
+     */
     postIndexerChainsByChainIdReset(parameters, options) {
         const params = buildClientParams([parameters], [
             {
@@ -1078,6 +1514,11 @@ export class HighlightClient extends HeyApiClient {
             },
         });
     }
+    /**
+     * Poll a chain indexer
+     *
+     * Run one indexing cycle for an enabled chain. Administrative use only.
+     */
     postIndexerChainsByChainIdPoll(parameters, options) {
         const params = buildClientParams([parameters], [{ args: [{ in: "path", key: "chainId" }] }]);
         return (options?.client ?? this.client).post({
@@ -1114,6 +1555,14 @@ export class HighlightClient extends HeyApiClient {
     get media() {
         return (this._media ??= new Media({ client: this.client }));
     }
+    _tx;
+    get tx() {
+        return (this._tx ??= new Tx({ client: this.client }));
+    }
+    _profile;
+    get profile() {
+        return (this._profile ??= new Profile({ client: this.client }));
+    }
     _user;
     get user() {
         return (this._user ??= new User({ client: this.client }));