@highlightxyz/sdk 0.4.0 → 0.7.0

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

@@ -146,6 +146,38 @@ export declare enum SaleLifecycle {
     Ended = "Ended",
     Paused = "Paused"
 }
+export declare enum MintStatus {
+    Minting = "minting",
+    Upcoming = "upcoming",
+    Ended = "ended"
+}
+export type CollectionDiscoverItem = {
+    highlightId: string;
+    collectionId: string | null;
+    name: string;
+    type: CollectionType;
+    chainId: number;
+    imageMedia: MediaAsset | null;
+    creator: {
+        id: string;
+        displayName: string | null;
+        primaryAddress: string | null;
+        ensName: string | null;
+    };
+    price: string | null;
+    currency: SaleCurrency | null;
+    mintCount: number;
+    mintStatus: MintStatus | null;
+};
+export type CollectionDiscoverResponse = {
+    items: Array<CollectionDiscoverItem>;
+    total: number;
+};
+export declare enum CollectionDiscoverSort {
+    Trending = "trending",
+    Recent = "recent",
+    Minted = "minted"
+}
 export type CollectionTrendingItem = {
     rank: number;
     highlightId: string;
@@ -166,8 +198,40 @@ export type CollectionTrendingItem = {
 export type CollectionTrendingResponse = {
     items: Array<CollectionTrendingItem>;
 };
+export declare enum TokenStatus {
+    PendingReveal = "PendingReveal",
+    PendingIndex = "PendingIndex",
+    Ready = "Ready",
+    FailedReveal = "FailedReveal",
+    FailedIndex = "FailedIndex"
+}
+export type Token = {
+    id: string;
+    collectionId: string;
+    tokenId: string;
+    status: TokenStatus;
+    name: string | null;
+    description: string | null;
+    externalUrl: string | null;
+    attributes: Array<{
+        trait_type: string;
+        value: string | number;
+        display_type?: string;
+    }> | null;
+    properties: {
+        [key: string]: unknown;
+    } | null;
+    imageMediaId: string | null;
+    imageMedia: MediaAsset | null;
+    animationMediaId: string | null;
+    animationMedia: MediaAsset | null;
+    mintedAt: string | null;
+    createdAt: string;
+    updatedAt: string;
+};
 export type CollectionFeaturedItem = {
     highlightId: string;
+    collectionId: string | null;
     name: string;
     imageMedia: MediaAsset | null;
     creator: {
@@ -176,6 +240,11 @@ export type CollectionFeaturedItem = {
         primaryAddress: string | null;
         ensName: string | null;
     };
+    chainId: number;
+    type: CollectionType;
+    price: string | null;
+    currency: SaleCurrency | null;
+    firstToken: Token | null;
     note: string | null;
 };
 export type CollectionFeaturedResponse = {
@@ -434,13 +503,6 @@ export type DutchAuctionStanding = {
     auctionInFPP: boolean;
     viewer: DutchAuctionViewerStanding | null;
 };
-export declare enum TokenStatus {
-    PendingReveal = "PendingReveal",
-    PendingIndex = "PendingIndex",
-    Ready = "Ready",
-    FailedReveal = "FailedReveal",
-    FailedIndex = "FailedIndex"
-}
 export type TokenAttributeFacet = {
     traitType: string;
     values: Array<{
@@ -524,6 +586,16 @@ export type GateFarcasterUserPreview = {
     displayName: string | null;
     pfpUrl: string | null;
 };
+export type IndexerStatusChain = {
+    chainId: number;
+    chainName: string;
+    lastProcessedBlock: string;
+    lastBlockHash: string | null;
+    updatedAt: string;
+};
+export type IndexerStatusResponse = {
+    chains: Array<IndexerStatusChain>;
+};
 export type MediaChildrenList = {
     items: Array<MediaAsset>;
     nextCursor: string | null;
@@ -584,6 +656,31 @@ export type UserProfile = {
     avatarMediaId: string | null;
     avatarMedia: MediaAsset | null;
 };
+export type Artist = {
+    id: string;
+    displayName: string | null;
+    primaryAddress: string | null;
+    ensName: string | null;
+    bio: string | null;
+    avatarMedia: MediaAsset | null;
+    collectionCount: number;
+    hasLiveSale: boolean;
+    previewMedia: Array<MediaAsset>;
+};
+export type ArtistsResponse = {
+    items: Array<Artist>;
+    total: number;
+};
+export declare enum ArtistSort {
+    Collections = "collections",
+    Recent = "recent",
+    Az = "az"
+}
+export type ArtistSpotlight = {
+    artist: Artist;
+    note: string | null;
+    curated: boolean;
+};
 export type PublicUserProfile = {
     primaryAddress: string;
     walletAddresses: Array<string>;
@@ -760,7 +857,7 @@ export type CollectionListResponse = CollectionListResponses[keyof CollectionLis
 export type CollectionCreateData = {
     body: {
         name: string;
-        description: string;
+        description?: string;
         contractId?: string;
         contract?: {
             chainId: number;
@@ -914,6 +1011,32 @@ export type CollectionCreateResponses = {
     };
 };
 export type CollectionCreateResponse = CollectionCreateResponses[keyof CollectionCreateResponses];
+export type CollectionDiscoverData = {
+    body?: never;
+    path?: never;
+    query?: {
+        type?: CollectionType;
+        chainId?: number;
+        sort?: CollectionDiscoverSort;
+        limit?: number;
+        offset?: number;
+    };
+    url: "/collection/discover";
+};
+export type CollectionDiscoverErrors = {
+    /**
+     * Invalid request
+     */
+    400: ApiErrorResponse;
+};
+export type CollectionDiscoverError = CollectionDiscoverErrors[keyof CollectionDiscoverErrors];
+export type CollectionDiscoverResponses = {
+    /**
+     * Discovered collections
+     */
+    200: CollectionDiscoverResponse;
+};
+export type CollectionDiscoverResponse2 = CollectionDiscoverResponses[keyof CollectionDiscoverResponses];
 export type CollectionTrendingData = {
     body?: never;
     path?: never;
@@ -2619,30 +2742,7 @@ export type TokenListResponses = {
      * List of tokens
      */
     200: {
-        items: Array<{
-            id: string;
-            collectionId: string;
-            tokenId: string;
-            status: TokenStatus;
-            name: string | null;
-            description: string | null;
-            externalUrl: string | null;
-            attributes: Array<{
-                trait_type: string;
-                value: string | number;
-                display_type?: string;
-            }> | null;
-            properties: {
-                [key: string]: unknown;
-            } | null;
-            imageMediaId: string | null;
-            imageMedia: MediaAsset | null;
-            animationMediaId: string | null;
-            animationMedia: MediaAsset | null;
-            mintedAt: string | null;
-            createdAt: string;
-            updatedAt: string;
-        }>;
+        items: Array<Token>;
         pageInfo: {
             page: number;
             limit: number;
@@ -2698,30 +2798,7 @@ export type TokenGetResponses = {
     /**
      * Token details
      */
-    200: {
-        id: string;
-        collectionId: string;
-        tokenId: string;
-        status: TokenStatus;
-        name: string | null;
-        description: string | null;
-        externalUrl: string | null;
-        attributes: Array<{
-            trait_type: string;
-            value: string | number;
-            display_type?: string;
-        }> | null;
-        properties: {
-            [key: string]: unknown;
-        } | null;
-        imageMediaId: string | null;
-        imageMedia: MediaAsset | null;
-        animationMediaId: string | null;
-        animationMedia: MediaAsset | null;
-        mintedAt: string | null;
-        createdAt: string;
-        updatedAt: string;
-    };
+    200: Token;
 };
 export type TokenGetResponse = TokenGetResponses[keyof TokenGetResponses];
 export type TokenListOwnersData = {
@@ -3416,6 +3493,26 @@ export type GatePreviewFarcasterResponses = {
     200: GateFarcasterUserPreview;
 };
 export type GatePreviewFarcasterResponse = GatePreviewFarcasterResponses[keyof GatePreviewFarcasterResponses];
+export type GetIndexerStatusData = {
+    body?: never;
+    path?: never;
+    query?: never;
+    url: "/indexer/status";
+};
+export type GetIndexerStatusErrors = {
+    /**
+     * Unauthorized
+     */
+    401: ApiErrorResponse;
+};
+export type GetIndexerStatusError = GetIndexerStatusErrors[keyof GetIndexerStatusErrors];
+export type GetIndexerStatusResponses = {
+    /**
+     * Per-chain indexer cursors
+     */
+    200: IndexerStatusResponse;
+};
+export type GetIndexerStatusResponse = GetIndexerStatusResponses[keyof GetIndexerStatusResponses];
 export type PostIndexerChainsByChainIdActivateData = {
     body?: never;
     path: {
@@ -3464,31 +3561,6 @@ export type PostIndexerChainsByChainIdResetResponses = {
      */
     200: unknown;
 };
-export type PostIndexerChainsByChainIdPollData = {
-    body?: never;
-    path: {
-        chainId: number;
-    };
-    query?: never;
-    url: "/indexer/chains/{chainId}/poll";
-};
-export type PostIndexerChainsByChainIdPollErrors = {
-    /**
-     * Unauthorized
-     */
-    401: ApiErrorResponse;
-    /**
-     * Poll failed
-     */
-    500: ApiErrorResponse;
-};
-export type PostIndexerChainsByChainIdPollError = PostIndexerChainsByChainIdPollErrors[keyof PostIndexerChainsByChainIdPollErrors];
-export type PostIndexerChainsByChainIdPollResponses = {
-    /**
-     * Poll completed
-     */
-    200: unknown;
-};
 export type MechanicListData = {
     body?: never;
     path?: never;
@@ -4040,7 +4112,7 @@ export type TxSubmitErrors = {
 export type TxSubmitError = TxSubmitErrors[keyof TxSubmitErrors];
 export type TxSubmitResponses = {
     /**
-     * Transaction accepted for processing
+     * Transaction accepted for tracking
      */
     202: TxStatusSnapshot;
 };
@@ -4144,6 +4216,53 @@ export type ProfileUpdateResponses = {
     200: UserProfile;
 };
 export type ProfileUpdateResponse = ProfileUpdateResponses[keyof ProfileUpdateResponses];
+export type ProfileArtistsData = {
+    body?: never;
+    path?: never;
+    query?: {
+        search?: string;
+        sort?: ArtistSort;
+        limit?: number;
+        offset?: number;
+    };
+    url: "/user/artists";
+};
+export type ProfileArtistsErrors = {
+    /**
+     * Invalid request
+     */
+    400: ApiErrorResponse;
+};
+export type ProfileArtistsError = ProfileArtistsErrors[keyof ProfileArtistsErrors];
+export type ProfileArtistsResponses = {
+    /**
+     * Ranked artist directory
+     */
+    200: ArtistsResponse;
+};
+export type ProfileArtistsResponse = ProfileArtistsResponses[keyof ProfileArtistsResponses];
+export type ProfileArtistSpotlightData = {
+    body?: never;
+    path?: never;
+    query?: {
+        surface?: string;
+    };
+    url: "/user/artists/spotlight";
+};
+export type ProfileArtistSpotlightErrors = {
+    /**
+     * No artist to spotlight
+     */
+    404: ApiErrorResponse;
+};
+export type ProfileArtistSpotlightError = ProfileArtistSpotlightErrors[keyof ProfileArtistSpotlightErrors];
+export type ProfileArtistSpotlightResponses = {
+    /**
+     * Spotlighted artist
+     */
+    200: ArtistSpotlight;
+};
+export type ProfileArtistSpotlightResponse = ProfileArtistSpotlightResponses[keyof ProfileArtistSpotlightResponses];
 export type ProfilePublicData = {
     body?: never;
     path: {
@@ -4193,30 +4312,7 @@ export type ProfileTokensResponses = {
      * Paginated wallet token holdings
      */
     200: {
-        items: Array<{
-            id: string;
-            collectionId: string;
-            tokenId: string;
-            status: TokenStatus;
-            name: string | null;
-            description: string | null;
-            externalUrl: string | null;
-            attributes: Array<{
-                trait_type: string;
-                value: string | number;
-                display_type?: string;
-            }> | null;
-            properties: {
-                [key: string]: unknown;
-            } | null;
-            imageMediaId: string | null;
-            imageMedia: MediaAsset | null;
-            animationMediaId: string | null;
-            animationMedia: MediaAsset | null;
-            mintedAt: string | null;
-            createdAt: string;
-            updatedAt: string;
-        }>;
+        items: Array<Token>;
         pageInfo: {
             page: number;
             limit: number;