Function DeprecatedAPIApiFactory

  • DeprecatedAPIApi - factory interface

    Export

    Parameters

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

    Returns {
        apiV1DappSearchByIdGet(dappId: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Dapp>>;
        dAppFilesForm(dappId: string, field: string, dAppFiles: Blob[], options?: AxiosRequestConfig): Promise<AxiosResponse<InlineResponse2001>>;
        dappCategoriesGet(options?: AxiosRequestConfig): Promise<AxiosResponse<InlineResponse2002>>;
        dappRateDappIdGet(dappId: string, page?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<DappRatingResponse>>;
        dappRateGet(dappId: string, userId?: string, userAddress?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<DappRatingRes>>;
        dappRatePost(body?: DappRating, options?: AxiosRequestConfig): Promise<AxiosResponse<DappRatingRes>>;
        dappSearchByIdGet(dappId: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Dapp>>;
        domainverificationGetVerificationIdPost(body?: DomainverificationGetVerificationIdBody, options?: AxiosRequestConfig): Promise<AxiosResponse<DappGetVerificationId>>;
        domainverificationVerifyPost(body?: DomainverificationVerifyBody, options?: AxiosRequestConfig): Promise<AxiosResponse<DappVerify>>;
        downloadBuildUrl(dappId: string, options?: AxiosRequestConfig): Promise<AxiosResponse<PreSignedUrlResponse>>;
        downloadDapp(dappId: string, userId?: string, userAddress?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
        getDApp(page?: number, limit?: number, search?: string, isListed?: boolean, chainId?: number, language?: string, availableOnPlatform?: string[], matureForAudience?: boolean, minAge?: number, listedOnOrAfter?: string, listedOnOrBefore?: string, allowedInCountries?: string[], blockedInCountries?: string[], categories?: string[][], orderBy?: string, subCategory?: string[][], options?: AxiosRequestConfig): Promise<AxiosResponse<InlineResponse200>>;
        getDAppV1(page?: number, limit?: number, search?: string, isListed?: boolean, chainId?: number, language?: string, availableOnPlatform?: string[], matureForAudience?: boolean, minAge?: number, listedOnOrAfter?: string, listedOnOrBefore?: string, allowedInCountries?: string[], blockedInCountries?: string[], categories?: string[][], orderBy?: string, subCategory?: string[][], storeKey?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<InlineResponse200>>;
        getFeaturedDApps(storeKey?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<FeaturedSection[]>>;
        getStore(key: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Store>>;
        getStoreTitle(options?: AxiosRequestConfig): Promise<AxiosResponse<string>>;
        getStoreV1(key: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Store>>;
        visitDapp(dappId: string, userId?: string, userAddress?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>;
    }

    • apiV1DappSearchByIdGet:function
      • Summary

        Search DApp By Dapp Id

        Throws

        Parameters

        • dappId: string
        • Optional options: AxiosRequestConfig

          Override http request option.

        Returns Promise<AxiosResponse<Dapp>>

    • dAppFilesForm:function
      • Uploading dapp screenshots | logo | banner | dApp file to the servers

        Summary

        Upload dApp files

        Throws

        Parameters

        • dappId: string
        • field: string
        • dAppFiles: Blob[]
        • Optional options: AxiosRequestConfig

          Override http request option.

        Returns Promise<AxiosResponse<InlineResponse2001>>

    • dappCategoriesGet:function
    • dappRateDappIdGet:function
      • Summary

        Get All rating of a dapp

        Throws

        Parameters

        • dappId: string
        • Optional page: string
        • Optional options: AxiosRequestConfig

          Override http request option.

        Returns Promise<AxiosResponse<DappRatingResponse>>

    • dappRateGet:function
      • Use this to get a user's rating for a dapp

        Summary

        Get User dApp Rating

        Throws

        Parameters

        • dappId: string
        • Optional userId: string
        • Optional userAddress: string
        • Optional options: AxiosRequestConfig

          Override http request option.

        Returns Promise<AxiosResponse<DappRatingRes>>

    • dappRatePost:function
      • Use this to register a rating from a user for a dApp

        Summary

        Rate the dApp

        Throws

        Parameters

        • Optional body: DappRating

          Send the request with dApp parameters

        • Optional options: AxiosRequestConfig

          Override http request option.

        Returns Promise<AxiosResponse<DappRatingRes>>

    • dappSearchByIdGet:function
      • Summary

        Search DApp By Dapp Id

        Throws

        Parameters

        • dappId: string
        • Optional options: AxiosRequestConfig

          Override http request option.

        Returns Promise<AxiosResponse<Dapp>>

    • domainverificationGetVerificationIdPost:function
    • domainverificationVerifyPost:function
    • downloadBuildUrl:function
      • Summary

        Build Download URL

        Throws

        Parameters

        • dappId: string

          Dapp Id where upload will happen

        • Optional options: AxiosRequestConfig

          Override http request option.

        Returns Promise<AxiosResponse<PreSignedUrlResponse>>

    • downloadDapp:function
      • Summary

        Download dapp Build

        Throws

        Parameters

        • dappId: string

          The dappId of dapp where to visit.

        • Optional userId: string
        • Optional userAddress: string
        • Optional options: AxiosRequestConfig

          Override http request option.

        Returns Promise<AxiosResponse<void>>

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

        Summary

        Get dApp

        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 isListed: boolean

          DApp is listed or not

        • Optional chainId: number

          DApp supported chainId's. Only dApps belonging to this chainID will be returned.

        • Optional language: string

          DApp's language

        • Optional availableOnPlatform: string[]

          DApp is listed or not

        • Optional matureForAudience: 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 allowedInCountries: string[]

          dApp allowed countries

        • Optional blockedInCountries: string[]

          dApp blocked countries

        • Optional categories: string[][]

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

        • Optional orderBy: string

          Want to get dapp by order(asc, desc) by one or more params.

        • Optional subCategory: string[][]

          The sub-category in which dApps belong. Multiple sub-category are joined using OR operator.

        • Optional options: AxiosRequestConfig

          Override http request option.

        Returns Promise<AxiosResponse<InlineResponse200>>

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

        Summary

        Get dApp

        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 isListed: boolean

          DApp is listed or not

        • Optional chainId: number

          DApp supported chainId's. Only dApps belonging to this chainID will be returned.

        • Optional language: string

          DApp's language

        • Optional availableOnPlatform: string[]

          DApp is listed or not

        • Optional matureForAudience: 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 allowedInCountries: string[]

          dApp allowed countries

        • Optional blockedInCountries: string[]

          dApp blocked countries

        • Optional categories: string[][]

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

        • Optional orderBy: string

          Want to get dapp by order(asc, desc) by one or more params.

        • Optional subCategory: string[][]

          The sub-category in which dApps belong. Multiple sub-category are joined using OR operator.

        • Optional storeKey: string

          The name of store for which whitelisted dapps have to fetch

        • Optional options: AxiosRequestConfig

          Override http request option.

        Returns Promise<AxiosResponse<InlineResponse200>>

    • getFeaturedDApps:function
      • Fetch featured sections of registry OR if you provide storeKey in query it will fetch featured sections from store.

        Summary

        Get Featured Sections

        Throws

        Parameters

        • Optional storeKey: string

          Unique Id of a particular store. provide only if you want to fetch feature section form a particular store.

        • Optional options: AxiosRequestConfig

          Override http request option.

        Returns Promise<AxiosResponse<FeaturedSection[]>>

    • getStore:function
      • Get the particular store

        Summary

        Get Store

        Throws

        Parameters

        • key: string

          unique id of a store.

        • Optional options: AxiosRequestConfig

          Override http request option.

        Returns Promise<AxiosResponse<Store>>

    • getStoreTitle:function
      • Returns the store title

        Summary

        Registry title

        Throws

        Parameters

        • Optional options: AxiosRequestConfig

          Override http request option.

        Returns Promise<AxiosResponse<string>>

    • getStoreV1:function
      • Get the particular store

        Summary

        Get Store

        Throws

        Parameters

        • key: string

          unique id of a store.

        • Optional options: AxiosRequestConfig

          Override http request option.

        Returns Promise<AxiosResponse<Store>>

    • visitDapp:function
      • Summary

        Visit dapp's homepage

        Throws

        Parameters

        • dappId: string

          The dappId of dapp where to visit.

        • Optional userId: string
        • Optional userAddress: string
        • Optional options: AxiosRequestConfig

          Override http request option.

        Returns Promise<AxiosResponse<void>>

Generated using TypeDoc