Class StoreRegistryApi

StoreRegistryApi - object-oriented interface

Export

Hierarchy

BaseAPI
- StoreRegistryApi

Index

Constructors

constructor

new StoreRegistryApi(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): StoreRegistryApi
Parameters
- Optional configuration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns StoreRegistryApi
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

autocompleteStores

autocompleteStores(search: string, options?: AxiosRequestConfig): Promise<AxiosResponse<InlineResponse2005>>
Summary
Auto-Complete search

Throws

Memberof
StoreRegistryApi
Parameters
- search: string
- Optional options: AxiosRequestConfig
  
  Override http request option.
Returns Promise<AxiosResponse<InlineResponse2005>>
- Defined in apis/store-registry-api.ts:442

searchStores

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

Memberof
StoreRegistryApi
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>>
- Defined in apis/store-registry-api.ts:465

searchStoresByOwnerAddress

searchStoresByOwnerAddress(ownerAddress: string, options?: AxiosRequestConfig): Promise<AxiosResponse<InlineResponse2004>>
Summary
Search store By owner Address

Throws

Memberof
StoreRegistryApi
Parameters
- ownerAddress: string
- Optional options: AxiosRequestConfig
  
  Override http request option.
Returns Promise<AxiosResponse<InlineResponse2004>>
- Defined in apis/store-registry-api.ts:476

searchStoresByStoreId

searchStoresByStoreId(storeId: string, options?: AxiosRequestConfig): Promise<AxiosResponse<InlineResponse2004>>
Summary
Search store By store Id

Throws

Memberof
StoreRegistryApi
Parameters
- storeId: string
- Optional options: AxiosRequestConfig
  
  Override http request option.
Returns Promise<AxiosResponse<InlineResponse2004>>
- Defined in apis/store-registry-api.ts:487

Class StoreRegistryApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Optional configuration: Configuration

basePath: string = BASE_PATH

axios: AxiosInstance = globalAxios

Returns StoreRegistryApi

Properties

Protected axios

Protected basePath

Protected configuration

Methods

autocompleteStores

Summary

Throws

Memberof

Parameters

search: string

Optional options: AxiosRequestConfig

Returns Promise<AxiosResponse<InlineResponse2005>>

searchStores

Summary

Throws

Memberof

Parameters

Optional page: number

Optional limit: number

Optional search: string

Optional categories: string[]

Optional isListed: boolean

Optional isMinted: boolean

Optional language: string

Optional allowedInCountries: string[]

Optional blockedInCountries: string[]

Optional isForMatureAudience: boolean

Optional minAge: number

Optional listedOnOrAfter: string

Optional listedOnOrBefore: string

Optional options: AxiosRequestConfig

Returns Promise<AxiosResponse<InlineResponse2003>>

searchStoresByOwnerAddress

Summary

Throws

Memberof

Parameters

ownerAddress: string

Optional options: AxiosRequestConfig

Returns Promise<AxiosResponse<InlineResponse2004>>

searchStoresByStoreId

Summary

Throws

Memberof

Parameters

storeId: string

Optional options: AxiosRequestConfig

Returns Promise<AxiosResponse<InlineResponse2004>>

Settings

Member Visibility

Theme

`Optional` configuration: Configuration

`Protected` axios

`Protected` basePath

`Protected` configuration

`Optional` options: AxiosRequestConfig

`Optional` page: number

`Optional` limit: number

`Optional` search: string

`Optional` categories: string[]

`Optional` isListed: boolean

`Optional` isMinted: boolean

`Optional` language: string

`Optional` allowedInCountries: string[]

`Optional` blockedInCountries: string[]

`Optional` isForMatureAudience: boolean

`Optional` minAge: number

`Optional` listedOnOrAfter: string

`Optional` listedOnOrBefore: string

`Optional` options: AxiosRequestConfig

`Optional` options: AxiosRequestConfig

`Optional` options: AxiosRequestConfig