Function StoreRegistryApiFactory

  • StoreRegistryApi - factory interface

    Export

    Parameters

    • Optional configuration: Configuration
    • Optional basePath: string
    • Optional axios: AxiosInstance

    Returns {
        autocompleteStores(search: string, options?: AxiosRequestConfig): Promise<AxiosResponse<InlineResponse2005>>;
        searchStores(page?: number, limit?: number, search?: string, categories?: string[], isListed?: boolean, isMinted?: boolean, language?: string, allowedInCountries?: string[], blockedInCountries?: string[], isForMatureAudience?: boolean, minAge?: number, listedOnOrAfter?: string, listedOnOrBefore?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<InlineResponse2003>>;
        searchStoresByOwnerAddress(ownerAddress: string, options?: AxiosRequestConfig): Promise<AxiosResponse<InlineResponse2004>>;
        searchStoresByStoreId(storeId: string, options?: AxiosRequestConfig): Promise<AxiosResponse<InlineResponse2004>>;
    }

    • autocompleteStores:function
      • Summary

        Auto-Complete search

        Throws

        Parameters

        • search: string
        • Optional options: AxiosRequestConfig

          Override http request option.

        Returns Promise<AxiosResponse<InlineResponse2005>>

    • searchStores:function
      • Get all stores or search by a keyword. Optionally, filter on specific attributes of the store. This API call will get all the store or perform a text search.

        Summary

        Search Store

        Throws

        Parameters

        • Optional page: number

          Current page

        • Optional limit: number

          Page size

        • Optional search: string

          A string to be used for search. The search happens on the `name` and `tags` fields of the dApp. If this is not present, all dApps are returned.

        • Optional categories: string[]

          The categories in which dApps belong. Multiple categories are joined using OR operator.

        • Optional isListed: boolean

          DApp is listed or not

        • Optional isMinted: boolean

          DApp is listed or not

        • Optional language: string

          DApp's language

        • Optional allowedInCountries: string[]

          dApp allowed countries

        • Optional blockedInCountries: string[]

          dApp blocked countries

        • Optional isForMatureAudience: boolean

          Mentions if the app is for all ages or only mature audience

        • Optional minAge: number

          Minimum age

        • Optional listedOnOrAfter: string

          The date dApp was listed on or after. Date should be in ISO format.

        • Optional listedOnOrBefore: string

          The date dApp was listed on or before. Date should be in ISO format.

        • Optional options: AxiosRequestConfig

          Override http request option.

        Returns Promise<AxiosResponse<InlineResponse2003>>

    • searchStoresByOwnerAddress:function
      • Summary

        Search store By owner Address

        Throws

        Parameters

        • ownerAddress: string
        • Optional options: AxiosRequestConfig

          Override http request option.

        Returns Promise<AxiosResponse<InlineResponse2004>>

    • searchStoresByStoreId:function
      • Summary

        Search store By store Id

        Throws

        Parameters

        • storeId: string
        • Optional options: AxiosRequestConfig

          Override http request option.

        Returns Promise<AxiosResponse<InlineResponse2004>>

Generated using TypeDoc