Class DeprecatedAPIApi

DeprecatedAPIApi - object-oriented interface

Export

Hierarchy

BaseAPI
- DeprecatedAPIApi

Constructors

constructor

new DeprecatedAPIApi(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): DeprecatedAPIApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns DeprecatedAPIApi
Inherited from BaseAPI.constructor
- Defined in base.ts:50

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: Configuration

Methods

apiV1DappSearchByIdGet

apiV1DappSearchByIdGet(dappId: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Dapp>>
Summary
Search DApp By Dapp Id

Throws

Memberof
DeprecatedAPIApi
Parameters
- dappId: string
- Optional options: AxiosRequestConfig
  
  Override http request option.
Returns Promise<AxiosResponse<Dapp>>
- Defined in apis/deprecated-apiapi.ts:1668

dAppFilesForm

dAppFilesForm(dappId: string, field: string, dAppFiles: Blob[], options?: AxiosRequestConfig): Promise<AxiosResponse<InlineResponse2001>>
Uploading dapp screenshots | logo | banner | dApp file to the servers

Summary
Upload dApp files

Throws

Memberof
DeprecatedAPIApi
Parameters
- dappId: string
- field: string
- dAppFiles: Blob[]
- Optional options: AxiosRequestConfig
  
  Override http request option.
Returns Promise<AxiosResponse<InlineResponse2001>>
- Defined in apis/deprecated-apiapi.ts:1681

dappCategoriesGet

dappCategoriesGet(options?: AxiosRequestConfig): Promise<AxiosResponse<InlineResponse2002>>
Summary
Get All category with subcategories.

Throws

Memberof
DeprecatedAPIApi
Parameters
- Optional options: AxiosRequestConfig
  
  Override http request option.
Returns Promise<AxiosResponse<InlineResponse2002>>
- Defined in apis/deprecated-apiapi.ts:1691

dappRateDappIdGet

dappRateDappIdGet(dappId: string, page?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<DappRatingResponse>>
Summary
Get All rating of a dapp

Throws

Memberof
DeprecatedAPIApi
Parameters
- dappId: string
- Optional page: string
- Optional options: AxiosRequestConfig
  
  Override http request option.
Returns Promise<AxiosResponse<DappRatingResponse>>
- Defined in apis/deprecated-apiapi.ts:1703

dappRateGet

dappRateGet(dappId: string, userId?: string, userAddress?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<DappRatingRes>>
Use this to get a user's rating for a dapp

Summary
Get User dApp Rating

Throws

Memberof
DeprecatedAPIApi
Parameters
- dappId: string
- Optional userId: string
- Optional userAddress: string
- Optional options: AxiosRequestConfig
  
  Override http request option.
Returns Promise<AxiosResponse<DappRatingRes>>
- Defined in apis/deprecated-apiapi.ts:1716

dappRatePost

dappRatePost(body?: DappRating, options?: AxiosRequestConfig): Promise<AxiosResponse<DappRatingRes>>
Use this to register a rating from a user for a dApp

Summary
Rate the dApp

Throws

Memberof
DeprecatedAPIApi
Parameters
- Optional body: DappRating
  
  Send the request with dApp parameters
- Optional options: AxiosRequestConfig
  
  Override http request option.
Returns Promise<AxiosResponse<DappRatingRes>>
- Defined in apis/deprecated-apiapi.ts:1727

dappSearchByIdGet

dappSearchByIdGet(dappId: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Dapp>>
Summary
Search DApp By Dapp Id

Throws

Memberof
DeprecatedAPIApi
Parameters
- dappId: string
- Optional options: AxiosRequestConfig
  
  Override http request option.
Returns Promise<AxiosResponse<Dapp>>
- Defined in apis/deprecated-apiapi.ts:1738

domainverificationGetVerificationIdPost

domainverificationGetVerificationIdPost(body?: DomainverificationGetVerificationIdBody, options?: AxiosRequestConfig): Promise<AxiosResponse<DappGetVerificationId>>
Use this to get a domain verification to code to verify domain ownership.

Summary
Get a domain verification code

Throws

Memberof
DeprecatedAPIApi
Parameters
- Optional body: DomainverificationGetVerificationIdBody
  
  Send the request with githubId and domain.
- Optional options: AxiosRequestConfig
  
  Override http request option.
Returns Promise<AxiosResponse<DappGetVerificationId>>
- Defined in apis/deprecated-apiapi.ts:1749

domainverificationVerifyPost

domainverificationVerifyPost(body?: DomainverificationVerifyBody, options?: AxiosRequestConfig): Promise<AxiosResponse<DappVerify>>
Use this to verify your domain ownership.

Summary
Verify domain txt records.

Throws

Memberof
DeprecatedAPIApi
Parameters
- Optional body: DomainverificationVerifyBody
  
  Send the request with githubId and domain.
- Optional options: AxiosRequestConfig
  
  Override http request option.
Returns Promise<AxiosResponse<DappVerify>>
- Defined in apis/deprecated-apiapi.ts:1760

downloadBuildUrl

downloadBuildUrl(dappId: string, options?: AxiosRequestConfig): Promise<AxiosResponse<PreSignedUrlResponse>>
Summary
Build Download URL

Throws

Memberof
DeprecatedAPIApi
Parameters
- dappId: string
  
  Dapp Id where upload will happen
- Optional options: AxiosRequestConfig
  
  Override http request option.
Returns Promise<AxiosResponse<PreSignedUrlResponse>>
- Defined in apis/deprecated-apiapi.ts:1771

downloadDapp

downloadDapp(dappId: string, userId?: string, userAddress?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>
Summary
Download dapp Build

Throws

Memberof
DeprecatedAPIApi
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>>
- Defined in apis/deprecated-apiapi.ts:1784

getDApp

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>>
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

Memberof
DeprecatedAPIApi
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>>
- Defined in apis/deprecated-apiapi.ts:1810

getDAppV1

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>>
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

Memberof
DeprecatedAPIApi
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>>
- Defined in apis/deprecated-apiapi.ts:1837

getFeaturedDApps

getFeaturedDApps(storeKey?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<FeaturedSection[]>>
Fetch featured sections of registry OR if you provide storeKey in query it will fetch featured sections from store.

Summary
Get Featured Sections

Throws

Memberof
DeprecatedAPIApi
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[]>>
- Defined in apis/deprecated-apiapi.ts:1848

getStore

getStore(key: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Store>>
Get the particular store

Summary
Get Store

Throws

Memberof
DeprecatedAPIApi
Parameters
- key: string
  
  unique id of a store.
- Optional options: AxiosRequestConfig
  
  Override http request option.
Returns Promise<AxiosResponse<Store>>
- Defined in apis/deprecated-apiapi.ts:1859

getStoreTitle

getStoreTitle(options?: AxiosRequestConfig): Promise<AxiosResponse<string>>
Returns the store title

Summary
Registry title

Throws

Memberof
DeprecatedAPIApi
Parameters
- Optional options: AxiosRequestConfig
  
  Override http request option.
Returns Promise<AxiosResponse<string>>
- Defined in apis/deprecated-apiapi.ts:1869

getStoreV1

getStoreV1(key: string, options?: AxiosRequestConfig): Promise<AxiosResponse<Store>>
Get the particular store

Summary
Get Store

Throws

Memberof
DeprecatedAPIApi
Parameters
- key: string
  
  unique id of a store.
- Optional options: AxiosRequestConfig
  
  Override http request option.
Returns Promise<AxiosResponse<Store>>
- Defined in apis/deprecated-apiapi.ts:1880

visitDapp

visitDapp(dappId: string, userId?: string, userAddress?: string, options?: AxiosRequestConfig): Promise<AxiosResponse<void>>
Summary
Visit dapp's homepage

Throws

Memberof
DeprecatedAPIApi
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>>
- Defined in apis/deprecated-apiapi.ts:1893

Class DeprecatedAPIApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional configuration: Configuration

basePath: string = BASE_PATH

axios: AxiosInstance = globalAxios

Returns DeprecatedAPIApi

Properties

Protected axios

Protected basePath

Protected configuration

Methods

apiV1DappSearchByIdGet

Summary

Throws

Memberof

Parameters

dappId: string

Optional options: AxiosRequestConfig

Returns Promise<AxiosResponse<Dapp>>

dAppFilesForm

Summary

Throws

Memberof

Parameters

dappId: string

field: string

dAppFiles: Blob[]

Optional options: AxiosRequestConfig

Returns Promise<AxiosResponse<InlineResponse2001>>

dappCategoriesGet

Summary

Throws

Memberof

Parameters

Optional options: AxiosRequestConfig

Returns Promise<AxiosResponse<InlineResponse2002>>

dappRateDappIdGet

Summary

Throws

Memberof

Parameters

dappId: string

Optional page: string

Optional options: AxiosRequestConfig

Returns Promise<AxiosResponse<DappRatingResponse>>

dappRateGet

Summary

Throws

Memberof

Parameters

dappId: string

Optional userId: string

Optional userAddress: string

Optional options: AxiosRequestConfig

Returns Promise<AxiosResponse<DappRatingRes>>

dappRatePost

Summary

Throws

Memberof

Parameters

Optional body: DappRating

Optional options: AxiosRequestConfig

Returns Promise<AxiosResponse<DappRatingRes>>

dappSearchByIdGet

Summary

Throws

Memberof

Parameters

dappId: string

Optional options: AxiosRequestConfig

Returns Promise<AxiosResponse<Dapp>>

domainverificationGetVerificationIdPost

`Optional` configuration: Configuration

`Protected` axios

`Protected` basePath

`Protected` configuration

`Optional` options: AxiosRequestConfig

`Optional` options: AxiosRequestConfig

`Optional` options: AxiosRequestConfig

`Optional` page: string

`Optional` options: AxiosRequestConfig

`Optional` userId: string

`Optional` userAddress: string

`Optional` options: AxiosRequestConfig

`Optional` body: DappRating

`Optional` options: AxiosRequestConfig

`Optional` options: AxiosRequestConfig

`Optional` body: DomainverificationGetVerificationIdBody

`Optional` options: AxiosRequestConfig

`Optional` body: DomainverificationVerifyBody

`Optional` options: AxiosRequestConfig

`Optional` options: AxiosRequestConfig

`Optional` userId: string

`Optional` userAddress: string

`Optional` options: AxiosRequestConfig

`Optional` page: number

`Optional` limit: number

`Optional` search: string

`Optional` isListed: boolean

`Optional` chainId: number

`Optional` language: string

`Optional` availableOnPlatform: string[]

`Optional` matureForAudience: boolean

`Optional` minAge: number

`Optional` listedOnOrAfter: string

`Optional` listedOnOrBefore: string

`Optional` allowedInCountries: string[]

`Optional` blockedInCountries: string[]

`Optional` categories: string[][]

`Optional` orderBy: string

`Optional` subCategory: string[][]

`Optional` options: AxiosRequestConfig

`Optional` page: number

`Optional` limit: number

`Optional` search: string

`Optional` isListed: boolean

`Optional` chainId: number

`Optional` language: string

`Optional` availableOnPlatform: string[]

`Optional` matureForAudience: boolean

`Optional` minAge: number