Class CollectionsApi

Hierarchy

  • CollectionsApi
    • CollectionsApi

Constructors

constructor

Properties

basePath axios configuration

Methods

createCollection getCollection listCollectionFilters listCollections summarizeCollections updateCollection

Constructors

constructor

  • new CollectionsApi(configuration?, basePath?, axios?): CollectionsApi

  • Parameters

    • Optionalconfiguration: Configuration
    • OptionalbasePath: string
    • Optionalaxios: AxiosInstance

    Returns CollectionsApi

Properties

ProtectedbasePath

basePath: string

Protectedaxios

axios: AxiosInstance

Protectedconfiguration

configuration: undefined | Configuration

Methods

createCollection

  • createCollection(requestParameters, options?): Promise<AxiosResponse<Collection, any>>

  • Create collection

    Parameters

    • requestParameters: CollectionsApiCreateCollectionRequest

      Request parameters.

    • Optionaloptions: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<Collection, any>>

    Summary

    Create collection

    Throws

    Memberof

    CollectionsApi

getCollection

  • getCollection(requestParameters, options?): Promise<AxiosResponse<Collection, any>>

  • Get details of a collection at the given address

    Parameters

    • requestParameters: CollectionsApiGetCollectionRequest

      Request parameters.

    • Optionaloptions: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<Collection, any>>

    Summary

    Get details of a collection at the given address

    Throws

    Memberof

    CollectionsApi

listCollectionFilters

  • listCollectionFilters(requestParameters, options?): Promise<AxiosResponse<CollectionFilter[], any>>

  • Get a list of collection filters

    Parameters

    • requestParameters: CollectionsApiListCollectionFiltersRequest

      Request parameters.

    • Optionaloptions: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<CollectionFilter[], any>>

    Summary

    Get a list of collection filters

    Throws

    Memberof

    CollectionsApi

listCollections

  • listCollections(requestParameters?, options?): Promise<AxiosResponse<ListCollectionsResponse, any>>

  • Get a list of collections

    Parameters

    • OptionalrequestParameters: CollectionsApiListCollectionsRequest

      Request parameters.

    • Optionaloptions: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<ListCollectionsResponse, any>>

    Summary

    Get a list of collections

    Throws

    Memberof

    CollectionsApi

summarizeCollections

  • summarizeCollections(requestParameters, options?): Promise<AxiosResponse<ApiSummarizeCollectionsResponse, any>>

  • Get details of the collections from which a set of wallets hold tokens, along with the number of tokens held in each collection.

    Parameters

    • requestParameters: CollectionsApiSummarizeCollectionsRequest

      Request parameters.

    • Optionaloptions: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<ApiSummarizeCollectionsResponse, any>>

    Summary

    Get metadata about the collections held by a set of wallets

    Throws

    Memberof

    CollectionsApi

updateCollection

  • updateCollection(requestParameters, options?): Promise<AxiosResponse<Collection, any>>

  • Update collection

    Parameters

    • requestParameters: CollectionsApiUpdateCollectionRequest

      Request parameters.

    • Optionaloptions: AxiosRequestConfig<any>

      Override http request option.

    Returns Promise<AxiosResponse<Collection, any>>

    Summary

    Update collection

    Throws

    Memberof

    CollectionsApi

Settings

Member Visibility

On This Page

Constructors
Properties
Methods