@story-protocol/ipkit 0.4.0-beta.9

package/dist/lib/api/getIpAssets.d.ts

@@ -0,0 +1,675 @@
+import { paths } from "@/types/schema";
+import { Address } from "viem";
+import { ApiClient } from "./apiClient";
+export type IpAssetsResponse = paths["/assets"]["post"]["responses"][200]["content"]["application/json"];
+export type IpAssetsOptions = Partial<paths["/assets"]["post"]["requestBody"]["content"]["application/json"]>;
+export type GetIpAssetsOptions = {
+    apiClient: ApiClient;
+    ownerAddress?: Address;
+    tokenContract?: Address;
+    includeLicenses?: boolean;
+    moderated?: boolean;
+    ipIds?: Address[];
+    options?: IpAssetsOptions;
+    apiKey: string;
+};
+export declare function getIpAssets({ apiClient, ownerAddress, tokenContract, includeLicenses, moderated, ipIds, options, apiKey, }: GetIpAssetsOptions): Promise<import("openapi-fetch").FetchResponse<{
+    parameters: {
+        query?: undefined;
+        header?: undefined;
+        path?: undefined;
+        cookie?: undefined;
+    };
+    requestBody: {
+        content: {
+            "application/json": {
+                readonly $schema?: string | undefined;
+                includeLicenses?: boolean | undefined;
+                moderated?: boolean | undefined;
+                orderBy: "blockNumber" | "descendantCount" | "createdAt";
+                orderDirection: "asc" | "desc";
+                pagination?: {
+                    limit: number;
+                    offset: number;
+                } | undefined;
+                where?: {
+                    ipIds?: string[] | null | undefined;
+                    ownerAddress?: string | undefined;
+                    tokenContract?: string | undefined;
+                } | undefined;
+            };
+        };
+    };
+    responses: {
+        200: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/json": {
+                    readonly $schema?: string | undefined;
+                    data: {
+                        ancestorsCount: number;
+                        blockNumber: number;
+                        chainId: string;
+                        childrenCount: number;
+                        createdAt: string;
+                        descendantsCount: number;
+                        description: string;
+                        infringementStatus?: {
+                            createdAt: string;
+                            customData: string;
+                            infringementDetails: string;
+                            isInfringing: boolean;
+                            providerName: string;
+                            providerURL: string;
+                            responseTime: string;
+                            status: string;
+                            updatedAt: string;
+                        }[] | null | undefined;
+                        ipId: string;
+                        ipaMetadataUri?: string | undefined;
+                        isInGroup: boolean;
+                        lastUpdatedAt: string;
+                        licenses?: {
+                            createdAt: string;
+                            licenseTemplateId: string;
+                            licenseTermsId: string;
+                            licensingConfig: {
+                                commercialRevShare: number;
+                                disabled: boolean;
+                                expectGroupRewardPool: string;
+                                expectMinimumGroupRewardShare: number;
+                                hookData: string;
+                                isSet: boolean;
+                                licensingHook: string;
+                                mintingFee: number;
+                            };
+                            templateMetadataUri: string;
+                            templateName: string;
+                            terms: {
+                                commercialAttribution: boolean;
+                                commercialRevCeiling: string;
+                                commercialRevShare: number;
+                                commercialUse: boolean;
+                                commercializerChecker: string;
+                                commercializerCheckerData: string;
+                                currency: string;
+                                defaultMintingFee: string;
+                                derivativeRevCeiling: string;
+                                derivativesAllowed: boolean;
+                                derivativesApproval: boolean;
+                                derivativesAttribution: boolean;
+                                derivativesReciprocal: boolean;
+                                expiration: string;
+                                royaltyPolicy: string;
+                                transferable: boolean;
+                                uri: string;
+                            };
+                            updatedAt: string;
+                        }[] | null | undefined;
+                        logIndex: number;
+                        moderationStatus?: {
+                            adult: string;
+                            medical: string;
+                            racy: string;
+                            spoof: string;
+                            violence: string;
+                        } | undefined;
+                        name: string;
+                        nftMetadata?: {
+                            animation: {
+                                cachedUrl: string;
+                                contentType: string;
+                                originalUrl: string;
+                                size: number;
+                            };
+                            collection: {
+                                bannerImageUrl: string;
+                                externalUrl: string | null;
+                                name: string;
+                                slug: string;
+                            };
+                            contract: {
+                                address: string;
+                                chain: string;
+                                contractDeployer: string;
+                                deployedBlockNumber: number;
+                                name: string;
+                                openSeaMetadata: {
+                                    bannerImageUrl: string;
+                                    collectionName: string;
+                                    collectionSlug: string;
+                                    description: string;
+                                    discordUrl: string;
+                                    externalUrl: string | null;
+                                    floorPrice: number;
+                                    imageUrl: string;
+                                    lastIngestedAt: string;
+                                    safelistRequestStatus: string;
+                                    twitterUsername: string;
+                                };
+                                symbol: string;
+                                tokenType: string;
+                                totalSupply: string;
+                            };
+                            contract_address: string;
+                            description: string | null;
+                            image: {
+                                cachedUrl: string;
+                                contentType: string;
+                                originalUrl: string;
+                                pngUrl: string;
+                                size: number;
+                                thumbnailUrl: string;
+                            };
+                            mint: {
+                                blockNumber: number | null;
+                                mintAddress: string | null;
+                                timestamp: string | null;
+                                transactionHash: string | null;
+                            };
+                            name: string;
+                            nft_id: string;
+                            raw: unknown;
+                            timeLastUpdated: string;
+                            tokenId: string;
+                            tokenType: string;
+                            tokenUri: string;
+                        } | undefined;
+                        ownerAddress: string;
+                        parentsCount: number;
+                        registrationDate: string;
+                        rootIPs: string[] | null;
+                        title: string;
+                        tokenContract: string;
+                        tokenId: string;
+                        txHash: string;
+                        uri: string;
+                    }[] | null;
+                    pagination?: {
+                        hasMore: boolean;
+                        limit: number;
+                        offset: number;
+                        total?: number | undefined;
+                    } | undefined;
+                };
+            };
+        };
+        default: {
+            headers: {
+                [name: string]: unknown;
+            };
+            content: {
+                "application/problem+json": {
+                    readonly $schema?: string | undefined;
+                    detail?: string | undefined;
+                    errors?: {
+                        location?: string | undefined;
+                        message?: string | undefined;
+                        value?: unknown;
+                    }[] | null | undefined;
+                    instance?: string | undefined;
+                    status?: number | undefined;
+                    title?: string | undefined;
+                    type: string;
+                };
+            };
+        };
+    };
+}, {
+    params?: {
+        query?: undefined;
+        header?: undefined;
+        path?: undefined;
+        cookie?: undefined;
+    } | undefined;
+} & {
+    body: {
+        readonly $schema?: string | undefined;
+        includeLicenses?: boolean | undefined;
+        moderated?: boolean | undefined;
+        orderBy: "blockNumber" | "descendantCount" | "createdAt";
+        orderDirection: "asc" | "desc";
+        pagination?: {
+            limit: number;
+            offset: number;
+        } | undefined;
+        where?: {
+            ipIds?: string[] | null | undefined;
+            ownerAddress?: string | undefined;
+            tokenContract?: string | undefined;
+        } | undefined;
+    };
+} & {
+    baseUrl?: string | undefined;
+    querySerializer?: import("openapi-fetch").QuerySerializerOptions | import("openapi-fetch").QuerySerializer<{
+        parameters: {
+            query?: undefined;
+            header?: undefined;
+            path?: undefined;
+            cookie?: undefined;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    readonly $schema?: string | undefined;
+                    includeLicenses?: boolean | undefined;
+                    moderated?: boolean | undefined;
+                    orderBy: "blockNumber" | "descendantCount" | "createdAt";
+                    orderDirection: "asc" | "desc";
+                    pagination?: {
+                        limit: number;
+                        offset: number;
+                    } | undefined;
+                    where?: {
+                        ipIds?: string[] | null | undefined;
+                        ownerAddress?: string | undefined;
+                        tokenContract?: string | undefined;
+                    } | undefined;
+                };
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        readonly $schema?: string | undefined;
+                        data: {
+                            ancestorsCount: number;
+                            blockNumber: number;
+                            chainId: string;
+                            childrenCount: number;
+                            createdAt: string;
+                            descendantsCount: number;
+                            description: string;
+                            infringementStatus?: {
+                                createdAt: string;
+                                customData: string;
+                                infringementDetails: string;
+                                isInfringing: boolean;
+                                providerName: string;
+                                providerURL: string;
+                                responseTime: string;
+                                status: string;
+                                updatedAt: string;
+                            }[] | null | undefined;
+                            ipId: string;
+                            ipaMetadataUri?: string | undefined;
+                            isInGroup: boolean;
+                            lastUpdatedAt: string;
+                            licenses?: {
+                                createdAt: string;
+                                licenseTemplateId: string;
+                                licenseTermsId: string;
+                                licensingConfig: {
+                                    commercialRevShare: number;
+                                    disabled: boolean;
+                                    expectGroupRewardPool: string;
+                                    expectMinimumGroupRewardShare: number;
+                                    hookData: string;
+                                    isSet: boolean;
+                                    licensingHook: string;
+                                    mintingFee: number;
+                                };
+                                templateMetadataUri: string;
+                                templateName: string;
+                                terms: {
+                                    commercialAttribution: boolean;
+                                    commercialRevCeiling: string;
+                                    commercialRevShare: number;
+                                    commercialUse: boolean;
+                                    commercializerChecker: string;
+                                    commercializerCheckerData: string;
+                                    currency: string;
+                                    defaultMintingFee: string;
+                                    derivativeRevCeiling: string;
+                                    derivativesAllowed: boolean;
+                                    derivativesApproval: boolean;
+                                    derivativesAttribution: boolean;
+                                    derivativesReciprocal: boolean;
+                                    expiration: string;
+                                    royaltyPolicy: string;
+                                    transferable: boolean;
+                                    uri: string;
+                                };
+                                updatedAt: string;
+                            }[] | null | undefined;
+                            logIndex: number;
+                            moderationStatus?: {
+                                adult: string;
+                                medical: string;
+                                racy: string;
+                                spoof: string;
+                                violence: string;
+                            } | undefined;
+                            name: string;
+                            nftMetadata?: {
+                                animation: {
+                                    cachedUrl: string;
+                                    contentType: string;
+                                    originalUrl: string;
+                                    size: number;
+                                };
+                                collection: {
+                                    bannerImageUrl: string;
+                                    externalUrl: string | null;
+                                    name: string;
+                                    slug: string;
+                                };
+                                contract: {
+                                    address: string;
+                                    chain: string;
+                                    contractDeployer: string;
+                                    deployedBlockNumber: number;
+                                    name: string;
+                                    openSeaMetadata: {
+                                        bannerImageUrl: string;
+                                        collectionName: string;
+                                        collectionSlug: string;
+                                        description: string;
+                                        discordUrl: string;
+                                        externalUrl: string | null;
+                                        floorPrice: number;
+                                        imageUrl: string;
+                                        lastIngestedAt: string;
+                                        safelistRequestStatus: string;
+                                        twitterUsername: string;
+                                    };
+                                    symbol: string;
+                                    tokenType: string;
+                                    totalSupply: string;
+                                };
+                                contract_address: string;
+                                description: string | null;
+                                image: {
+                                    cachedUrl: string;
+                                    contentType: string;
+                                    originalUrl: string;
+                                    pngUrl: string;
+                                    size: number;
+                                    thumbnailUrl: string;
+                                };
+                                mint: {
+                                    blockNumber: number | null;
+                                    mintAddress: string | null;
+                                    timestamp: string | null;
+                                    transactionHash: string | null;
+                                };
+                                name: string;
+                                nft_id: string;
+                                raw: unknown;
+                                timeLastUpdated: string;
+                                tokenId: string;
+                                tokenType: string;
+                                tokenUri: string;
+                            } | undefined;
+                            ownerAddress: string;
+                            parentsCount: number;
+                            registrationDate: string;
+                            rootIPs: string[] | null;
+                            title: string;
+                            tokenContract: string;
+                            tokenId: string;
+                            txHash: string;
+                            uri: string;
+                        }[] | null;
+                        pagination?: {
+                            hasMore: boolean;
+                            limit: number;
+                            offset: number;
+                            total?: number | undefined;
+                        } | undefined;
+                    };
+                };
+            };
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": {
+                        readonly $schema?: string | undefined;
+                        detail?: string | undefined;
+                        errors?: {
+                            location?: string | undefined;
+                            message?: string | undefined;
+                            value?: unknown;
+                        }[] | null | undefined;
+                        instance?: string | undefined;
+                        status?: number | undefined;
+                        title?: string | undefined;
+                        type: string;
+                    };
+                };
+            };
+        };
+    }> | undefined;
+    bodySerializer?: import("openapi-fetch").BodySerializer<{
+        parameters: {
+            query?: undefined;
+            header?: undefined;
+            path?: undefined;
+            cookie?: undefined;
+        };
+        requestBody: {
+            content: {
+                "application/json": {
+                    readonly $schema?: string | undefined;
+                    includeLicenses?: boolean | undefined;
+                    moderated?: boolean | undefined;
+                    orderBy: "blockNumber" | "descendantCount" | "createdAt";
+                    orderDirection: "asc" | "desc";
+                    pagination?: {
+                        limit: number;
+                        offset: number;
+                    } | undefined;
+                    where?: {
+                        ipIds?: string[] | null | undefined;
+                        ownerAddress?: string | undefined;
+                        tokenContract?: string | undefined;
+                    } | undefined;
+                };
+            };
+        };
+        responses: {
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": {
+                        readonly $schema?: string | undefined;
+                        data: {
+                            ancestorsCount: number;
+                            blockNumber: number;
+                            chainId: string;
+                            childrenCount: number;
+                            createdAt: string;
+                            descendantsCount: number;
+                            description: string;
+                            infringementStatus?: {
+                                createdAt: string;
+                                customData: string;
+                                infringementDetails: string;
+                                isInfringing: boolean;
+                                providerName: string;
+                                providerURL: string;
+                                responseTime: string;
+                                status: string;
+                                updatedAt: string;
+                            }[] | null | undefined;
+                            ipId: string;
+                            ipaMetadataUri?: string | undefined;
+                            isInGroup: boolean;
+                            lastUpdatedAt: string;
+                            licenses?: {
+                                createdAt: string;
+                                licenseTemplateId: string;
+                                licenseTermsId: string;
+                                licensingConfig: {
+                                    commercialRevShare: number;
+                                    disabled: boolean;
+                                    expectGroupRewardPool: string;
+                                    expectMinimumGroupRewardShare: number;
+                                    hookData: string;
+                                    isSet: boolean;
+                                    licensingHook: string;
+                                    mintingFee: number;
+                                };
+                                templateMetadataUri: string;
+                                templateName: string;
+                                terms: {
+                                    commercialAttribution: boolean;
+                                    commercialRevCeiling: string;
+                                    commercialRevShare: number;
+                                    commercialUse: boolean;
+                                    commercializerChecker: string;
+                                    commercializerCheckerData: string;
+                                    currency: string;
+                                    defaultMintingFee: string;
+                                    derivativeRevCeiling: string;
+                                    derivativesAllowed: boolean;
+                                    derivativesApproval: boolean;
+                                    derivativesAttribution: boolean;
+                                    derivativesReciprocal: boolean;
+                                    expiration: string;
+                                    royaltyPolicy: string;
+                                    transferable: boolean;
+                                    uri: string;
+                                };
+                                updatedAt: string;
+                            }[] | null | undefined;
+                            logIndex: number;
+                            moderationStatus?: {
+                                adult: string;
+                                medical: string;
+                                racy: string;
+                                spoof: string;
+                                violence: string;
+                            } | undefined;
+                            name: string;
+                            nftMetadata?: {
+                                animation: {
+                                    cachedUrl: string;
+                                    contentType: string;
+                                    originalUrl: string;
+                                    size: number;
+                                };
+                                collection: {
+                                    bannerImageUrl: string;
+                                    externalUrl: string | null;
+                                    name: string;
+                                    slug: string;
+                                };
+                                contract: {
+                                    address: string;
+                                    chain: string;
+                                    contractDeployer: string;
+                                    deployedBlockNumber: number;
+                                    name: string;
+                                    openSeaMetadata: {
+                                        bannerImageUrl: string;
+                                        collectionName: string;
+                                        collectionSlug: string;
+                                        description: string;
+                                        discordUrl: string;
+                                        externalUrl: string | null;
+                                        floorPrice: number;
+                                        imageUrl: string;
+                                        lastIngestedAt: string;
+                                        safelistRequestStatus: string;
+                                        twitterUsername: string;
+                                    };
+                                    symbol: string;
+                                    tokenType: string;
+                                    totalSupply: string;
+                                };
+                                contract_address: string;
+                                description: string | null;
+                                image: {
+                                    cachedUrl: string;
+                                    contentType: string;
+                                    originalUrl: string;
+                                    pngUrl: string;
+                                    size: number;
+                                    thumbnailUrl: string;
+                                };
+                                mint: {
+                                    blockNumber: number | null;
+                                    mintAddress: string | null;
+                                    timestamp: string | null;
+                                    transactionHash: string | null;
+                                };
+                                name: string;
+                                nft_id: string;
+                                raw: unknown;
+                                timeLastUpdated: string;
+                                tokenId: string;
+                                tokenType: string;
+                                tokenUri: string;
+                            } | undefined;
+                            ownerAddress: string;
+                            parentsCount: number;
+                            registrationDate: string;
+                            rootIPs: string[] | null;
+                            title: string;
+                            tokenContract: string;
+                            tokenId: string;
+                            txHash: string;
+                            uri: string;
+                        }[] | null;
+                        pagination?: {
+                            hasMore: boolean;
+                            limit: number;
+                            offset: number;
+                            total?: number | undefined;
+                        } | undefined;
+                    };
+                };
+            };
+            default: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": {
+                        readonly $schema?: string | undefined;
+                        detail?: string | undefined;
+                        errors?: {
+                            location?: string | undefined;
+                            message?: string | undefined;
+                            value?: unknown;
+                        }[] | null | undefined;
+                        instance?: string | undefined;
+                        status?: number | undefined;
+                        title?: string | undefined;
+                        type: string;
+                    };
+                };
+            };
+        };
+    }> | undefined;
+    parseAs?: keyof import("openapi-fetch").BodyType<unknown> | undefined;
+    fetch?: ((input: Request) => Promise<Response>) | undefined;
+    headers?: import("openapi-fetch").HeadersOptions | undefined;
+} & Omit<RequestInit, "headers" | "body"> & {
+    readonly $schema?: string | undefined;
+    includeLicenses?: boolean | undefined;
+    moderated?: boolean | undefined;
+    orderBy: "blockNumber" | "descendantCount" | "createdAt";
+    orderDirection: "asc" | "desc";
+    pagination?: {
+        limit: number;
+        offset: number;
+    } | undefined;
+    where?: {
+        ipIds?: string[] | null | undefined;
+        ownerAddress?: string | undefined;
+        tokenContract?: string | undefined;
+    } | undefined;
+}, `${string}/${string}`>>;
+//# sourceMappingURL=getIpAssets.d.ts.map

package/dist/lib/api/getIpAssets.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getIpAssets.d.ts","sourceRoot":"","sources":["../../../src/lib/api/getIpAssets.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,EAAE,MAAM,gBAAgB,CAAA;AACtC,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAA;AAE9B,OAAO,EAAE,SAAS,EAAE,MAAM,aAAa,CAAA;AAGvC,MAAM,MAAM,gBAAgB,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,WAAW,CAAC,CAAC,GAAG,CAAC,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAA;AACxG,MAAM,MAAM,eAAe,GAAG,OAAO,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAAC,aAAa,CAAC,CAAC,SAAS,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAA;AAE7G,MAAM,MAAM,kBAAkB,GAAG;IAC/B,SAAS,EAAE,SAAS,CAAA;IACpB,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,aAAa,CAAC,EAAE,OAAO,CAAA;IACvB,eAAe,CAAC,EAAE,OAAO,CAAA;IACzB,SAAS,CAAC,EAAE,OAAO,CAAA;IACnB,KAAK,CAAC,EAAE,OAAO,EAAE,CAAA;IACjB,OAAO,CAAC,EAAE,eAAe,CAAA;IACzB,MAAM,EAAE,MAAM,CAAA;CACf,CAAA;AAED,wBAAgB,WAAW,CAAC,EAC1B,SAAS,EACT,YAAY,EACZ,aAAa,EACb,eAAe,EACf,SAAS,EACT,KAAK,EACL,OAAO,EACP,MAAM,GACP,EAAE,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;2BAmBpB"}