@0xsequence/metadata 1.9.6 → 1.9.8

package/dist/declarations/src/metadata.gen.d.ts

@@ -1,6 +1,6 @@
 export declare const WebRPCVersion = "v1";
 export declare const WebRPCSchemaVersion = "v0.4.0";
-export declare const WebRPCSchemaHash = "4abf3a2d23aa0f4c036e7392ac23919dc611f1c3";
+export declare const WebRPCSchemaHash = "ae7e843bd6e50f2634c3f663d49c5c7d1678c2b2";
 export declare enum ContractType {
     UNKNOWN = "UNKNOWN",
     ERC20 = "ERC20",
@@ -18,10 +18,6 @@ export declare enum SwapType {
     BUY = "BUY",
     SELL = "SELL"
 }
-export declare enum SortOrder {
-    DESC = "DESC",
-    ASC = "ASC"
-}
 export declare enum TaskStatus {
     PENDING = "PENDING",
     PAUSED = "PAUSED",
@@ -47,6 +43,7 @@ export interface RuntimeStatus {
 export interface RuntimeChecks {
 }
 export interface ContractIndex {
+    collectionId?: number;
     chainId: number;
     address: string;
     type: ContractType;
@@ -97,24 +94,24 @@ export interface ContractInfoExtensions {
 }
 export interface TokenMetadata {
     tokenId: string;
-    contractAddress: string;
     name: string;
     description: string;
     image: string;
-    decimals: number;
+    video: string;
+    audio: string;
     properties: {
         [key: string]: any;
     };
-    video: string;
-    audio: string;
+    attributes: Array<{
+        [key: string]: any;
+    }>;
     image_data: string;
     external_url: string;
     background_color: string;
     animation_url: string;
-    attributes: Array<{
-        [key: string]: any;
-    }>;
+    decimals?: number;
     updatedAt: string;
+    assets?: Array<Asset>;
 }
 export interface PropertyFilter {
     name: string;
@@ -127,6 +124,53 @@ export interface Filter {
     text?: string;
     properties?: Array<PropertyFilter>;
 }
+export interface Collection {
+    id: number;
+    projectId: number;
+    metadata: CollectionMetadata;
+    private: boolean;
+    revealKey: string;
+    createdAt: string;
+    updatedAt: string;
+    deletedAt?: string;
+    baseURIs?: CollectionBaseURIs;
+}
+export interface CollectionMetadata {
+    name: string;
+    description: string;
+    image: string;
+    externalLink: string;
+    properties: {
+        [key: string]: any;
+    };
+    attributes: Array<{
+        [key: string]: any;
+    }>;
+}
+export interface CollectionBaseURIs {
+    contractMetadataURI: string;
+    tokenMetadataURI: string;
+}
+export interface Asset {
+    id: number;
+    collectionId: number;
+    tokenId: string;
+    url: string;
+    metadataField: string;
+    name: string;
+    filesize: number;
+    mimeType: string;
+    width?: number;
+    height?: number;
+    updatedAt: string;
+}
+export interface Token {
+    collectionId: number;
+    tokenId: string;
+    metadata: TokenMetadata;
+    private: boolean;
+    updatedAt: string;
+}
 export interface GetNiftyswapUnitPricesRequest {
     swapType: SwapType;
     ids: Array<string>;
@@ -138,12 +182,12 @@ export interface GetNiftyswapUnitPricesResponse {
     availableAmount: string;
 }
 export interface Page {
-    pageSize?: number;
     page?: number;
-}
-export interface SortBy {
-    column: string;
-    order: SortOrder;
+    column?: string;
+    before?: any;
+    after?: any;
+    pageSize?: number;
+    more?: boolean;
 }
 export interface TaskRunner {
     id: number;
@@ -166,6 +210,7 @@ export interface Metadata {
     version(headers?: object): Promise<VersionReturn>;
     runtimeStatus(headers?: object): Promise<RuntimeStatusReturn>;
     getTokenMetadata(args: GetTokenMetadataArgs, headers?: object): Promise<GetTokenMetadataReturn>;
+    refreshTokenMetadata(args: RefreshTokenMetadataArgs, headers?: object): Promise<RefreshTokenMetadataReturn>;
     enqueueTokensForRefresh(args: EnqueueTokensForRefreshArgs, headers?: object): Promise<EnqueueTokensForRefreshReturn>;
     getTokenRefreshStatus(args: GetTokenRefreshStatusArgs, headers?: object): Promise<GetTokenRefreshStatusReturn>;
     getTokenRefreshResult(args: GetTokenRefreshResultArgs, headers?: object): Promise<GetTokenRefreshResultReturn>;
@@ -179,7 +224,6 @@ export interface Metadata {
     searchContractInfo(args: SearchContractInfoArgs, headers?: object): Promise<SearchContractInfoReturn>;
     searchContractInfoBatch(args: SearchContractInfoBatchArgs, headers?: object): Promise<SearchContractInfoBatchReturn>;
     searchMetadata(args: SearchMetadataArgs, headers?: object): Promise<SearchMetadataReturn>;
-    projectSetTokenMetadata(args: ProjectSetTokenMetadataArgs, headers?: object): Promise<ProjectSetTokenMetadataReturn>;
     getNiftyswapTokenQuantity(args: GetNiftyswapTokenQuantityArgs, headers?: object): Promise<GetNiftyswapTokenQuantityReturn>;
     getNiftyswapUnitPrices(args: GetNiftyswapUnitPricesArgs, headers?: object): Promise<GetNiftyswapUnitPricesReturn>;
     getNiftyswapUnitPricesWithQuantities(args: GetNiftyswapUnitPricesWithQuantitiesArgs, headers?: object): Promise<GetNiftyswapUnitPricesWithQuantitiesReturn>;
@@ -211,6 +255,15 @@ export interface GetTokenMetadataArgs {
 export interface GetTokenMetadataReturn {
     tokenMetadata: Array<TokenMetadata>;
 }
+export interface RefreshTokenMetadataArgs {
+    chainID: string;
+    contractAddress: string;
+    tokenIDs?: Array<string>;
+    refreshAll?: boolean;
+}
+export interface RefreshTokenMetadataReturn {
+    taskId: number;
+}
 export interface EnqueueTokensForRefreshArgs {
     chainID: string;
     contractAddress: string;
@@ -322,14 +375,6 @@ export interface SearchMetadataReturn {
     tokenMetadata: Array<TokenMetadata>;
     contractInfo: Array<ContractInfo>;
 }
-export interface ProjectSetTokenMetadataArgs {
-    projectID?: number;
-    chainID: string;
-    tokenMetadata: TokenMetadata;
-}
-export interface ProjectSetTokenMetadataReturn {
-    ok: boolean;
-}
 export interface GetNiftyswapTokenQuantityArgs {
     chainID: string;
     contractAddress: string;
@@ -390,6 +435,148 @@ export interface MintMonitorTriggerJobArgs {
 export interface MintMonitorTriggerJobReturn {
     ok: boolean;
 }
+export interface Collections {
+    createCollection(args: CreateCollectionArgs, headers?: object): Promise<CreateCollectionReturn>;
+    getCollection(args: GetCollectionArgs, headers?: object): Promise<GetCollectionReturn>;
+    listCollections(args: ListCollectionsArgs, headers?: object): Promise<ListCollectionsReturn>;
+    updateCollection(args: UpdateCollectionArgs, headers?: object): Promise<UpdateCollectionReturn>;
+    deleteCollection(args: DeleteCollectionArgs, headers?: object): Promise<DeleteCollectionReturn>;
+    publishCollection(args: PublishCollectionArgs, headers?: object): Promise<PublishCollectionReturn>;
+    unpublishCollection(args: UnpublishCollectionArgs, headers?: object): Promise<UnpublishCollectionReturn>;
+    createToken(args: CreateTokenArgs, headers?: object): Promise<CreateTokenReturn>;
+    getToken(args: GetTokenArgs, headers?: object): Promise<GetTokenReturn>;
+    listTokens(args: ListTokensArgs, headers?: object): Promise<ListTokensReturn>;
+    updateToken(args: UpdateTokenArgs, headers?: object): Promise<UpdateTokenReturn>;
+    deleteToken(args: DeleteTokenArgs, headers?: object): Promise<DeleteTokenReturn>;
+    createAsset(args: CreateAssetArgs, headers?: object): Promise<CreateAssetReturn>;
+    getAsset(args: GetAssetArgs, headers?: object): Promise<GetAssetReturn>;
+    updateAsset(args: UpdateAssetArgs, headers?: object): Promise<UpdateAssetReturn>;
+    deleteAsset(args: DeleteAssetArgs, headers?: object): Promise<DeleteAssetReturn>;
+}
+export interface CreateCollectionArgs {
+    projectId?: number;
+    collection: Collection;
+}
+export interface CreateCollectionReturn {
+    collection: Collection;
+}
+export interface GetCollectionArgs {
+    projectId?: number;
+    collectionId: number;
+}
+export interface GetCollectionReturn {
+    collection: Collection;
+}
+export interface ListCollectionsArgs {
+    projectId?: number;
+    page?: Page;
+}
+export interface ListCollectionsReturn {
+    page: Page;
+    collections: Array<Collection>;
+}
+export interface UpdateCollectionArgs {
+    projectId?: number;
+    collection: Collection;
+}
+export interface UpdateCollectionReturn {
+    collection: Collection;
+}
+export interface DeleteCollectionArgs {
+    projectId?: number;
+    collectionId: number;
+}
+export interface DeleteCollectionReturn {
+    status: boolean;
+}
+export interface PublishCollectionArgs {
+    projectId?: number;
+    collectionId: number;
+}
+export interface PublishCollectionReturn {
+    collection: Collection;
+}
+export interface UnpublishCollectionArgs {
+    projectId?: number;
+    collectionId: number;
+}
+export interface UnpublishCollectionReturn {
+    collection: Collection;
+}
+export interface CreateTokenArgs {
+    projectId?: number;
+    collectionId: number;
+    token: TokenMetadata;
+    private?: boolean;
+}
+export interface CreateTokenReturn {
+    token: TokenMetadata;
+    assets: Array<Asset>;
+}
+export interface GetTokenArgs {
+    projectId?: number;
+    collectionId: number;
+    tokenId: string;
+}
+export interface GetTokenReturn {
+    token: TokenMetadata;
+    assets: Array<Asset>;
+}
+export interface ListTokensArgs {
+    projectId?: number;
+    collectionId: number;
+    page?: Page;
+}
+export interface ListTokensReturn {
+    page: Page;
+    tokens: Array<TokenMetadata>;
+}
+export interface UpdateTokenArgs {
+    projectId?: number;
+    collectionId: number;
+    tokenId: string;
+    token: TokenMetadata;
+    private?: boolean;
+}
+export interface UpdateTokenReturn {
+    token: TokenMetadata;
+}
+export interface DeleteTokenArgs {
+    projectId?: number;
+    collectionId: number;
+    tokenId: string;
+}
+export interface DeleteTokenReturn {
+    status: boolean;
+}
+export interface CreateAssetArgs {
+    projectId?: number;
+    asset: Asset;
+}
+export interface CreateAssetReturn {
+    asset: Asset;
+}
+export interface GetAssetArgs {
+    projectId?: number;
+    assetId: number;
+}
+export interface GetAssetReturn {
+    asset: Asset;
+}
+export interface UpdateAssetArgs {
+    projectId?: number;
+    asset: Asset;
+}
+export interface UpdateAssetReturn {
+    asset: Asset;
+}
+export interface DeleteAssetArgs {
+    projectId?: number;
+    assetId: number;
+}
+export interface DeleteAssetReturn {
+    status: boolean;
+}
 export declare class Metadata implements Metadata {
     protected hostname: string;
     protected fetch: Fetch;
@@ -400,6 +587,7 @@ export declare class Metadata implements Metadata {
     version: (headers?: object | undefined) => Promise<VersionReturn>;
     runtimeStatus: (headers?: object | undefined) => Promise<RuntimeStatusReturn>;
     getTokenMetadata: (args: GetTokenMetadataArgs, headers?: object | undefined) => Promise<GetTokenMetadataReturn>;
+    refreshTokenMetadata: (args: RefreshTokenMetadataArgs, headers?: object | undefined) => Promise<RefreshTokenMetadataReturn>;
     enqueueTokensForRefresh: (args: EnqueueTokensForRefreshArgs, headers?: object | undefined) => Promise<EnqueueTokensForRefreshReturn>;
     getTokenRefreshStatus: (args: GetTokenRefreshStatusArgs, headers?: object | undefined) => Promise<GetTokenRefreshStatusReturn>;
     getTokenRefreshResult: (args: GetTokenRefreshResultArgs, headers?: object | undefined) => Promise<GetTokenRefreshResultReturn>;
@@ -413,7 +601,6 @@ export declare class Metadata implements Metadata {
     searchContractInfo: (args: SearchContractInfoArgs, headers?: object | undefined) => Promise<SearchContractInfoReturn>;
     searchContractInfoBatch: (args: SearchContractInfoBatchArgs, headers?: object | undefined) => Promise<SearchContractInfoBatchReturn>;
     searchMetadata: (args: SearchMetadataArgs, headers?: object | undefined) => Promise<SearchMetadataReturn>;
-    projectSetTokenMetadata: (args: ProjectSetTokenMetadataArgs, headers?: object | undefined) => Promise<ProjectSetTokenMetadataReturn>;
     getNiftyswapTokenQuantity: (args: GetNiftyswapTokenQuantityArgs, headers?: object | undefined) => Promise<GetNiftyswapTokenQuantityReturn>;
     getNiftyswapUnitPrices: (args: GetNiftyswapUnitPricesArgs, headers?: object | undefined) => Promise<GetNiftyswapUnitPricesReturn>;
     getNiftyswapUnitPricesWithQuantities: (args: GetNiftyswapUnitPricesWithQuantitiesArgs, headers?: object | undefined) => Promise<GetNiftyswapUnitPricesWithQuantitiesReturn>;
@@ -422,6 +609,29 @@ export declare class Metadata implements Metadata {
     mintMonitorJobStatus: (args: MintMonitorJobStatusArgs, headers?: object | undefined) => Promise<MintMonitorJobStatusReturn>;
     mintMonitorTriggerJob: (args: MintMonitorTriggerJobArgs, headers?: object | undefined) => Promise<MintMonitorTriggerJobReturn>;
 }
+export declare class Collections implements Collections {
+    protected hostname: string;
+    protected fetch: Fetch;
+    protected path: string;
+    constructor(hostname: string, fetch: Fetch);
+    private url;
+    createCollection: (args: CreateCollectionArgs, headers?: object | undefined) => Promise<CreateCollectionReturn>;
+    getCollection: (args: GetCollectionArgs, headers?: object | undefined) => Promise<GetCollectionReturn>;
+    listCollections: (args: ListCollectionsArgs, headers?: object | undefined) => Promise<ListCollectionsReturn>;
+    updateCollection: (args: UpdateCollectionArgs, headers?: object | undefined) => Promise<UpdateCollectionReturn>;
+    deleteCollection: (args: DeleteCollectionArgs, headers?: object | undefined) => Promise<DeleteCollectionReturn>;
+    publishCollection: (args: PublishCollectionArgs, headers?: object | undefined) => Promise<PublishCollectionReturn>;
+    unpublishCollection: (args: UnpublishCollectionArgs, headers?: object | undefined) => Promise<UnpublishCollectionReturn>;
+    createToken: (args: CreateTokenArgs, headers?: object | undefined) => Promise<CreateTokenReturn>;
+    getToken: (args: GetTokenArgs, headers?: object | undefined) => Promise<GetTokenReturn>;
+    listTokens: (args: ListTokensArgs, headers?: object | undefined) => Promise<ListTokensReturn>;
+    updateToken: (args: UpdateTokenArgs, headers?: object | undefined) => Promise<UpdateTokenReturn>;
+    deleteToken: (args: DeleteTokenArgs, headers?: object | undefined) => Promise<DeleteTokenReturn>;
+    createAsset: (args: CreateAssetArgs, headers?: object | undefined) => Promise<CreateAssetReturn>;
+    getAsset: (args: GetAssetArgs, headers?: object | undefined) => Promise<GetAssetReturn>;
+    updateAsset: (args: UpdateAssetArgs, headers?: object | undefined) => Promise<UpdateAssetReturn>;
+    deleteAsset: (args: DeleteAssetArgs, headers?: object | undefined) => Promise<DeleteAssetReturn>;
+}
 export interface WebRPCError extends Error {
     code: string;
     msg: string;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@0xsequence/metadata",
-  "version": "1.9.6",
+  "version": "1.9.8",
   "description": "metadata sub-package for Sequence",
   "repository": "https://github.com/0xsequence/sequence.js/tree/master/packages/metadata",
   "source": "src/index.ts",