Class NamesApi

Hierarchy

BaseAPI
- NamesApi

Implements

NamesApiInterface

Constructors

constructor

new NamesApi(configuration?: Configuration): NamesApi
Parameters
- configuration: Configuration = ...
Returns NamesApi
Inherited from BaseAPI.constructor
- Defined in src/generated/runtime.ts:27

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

fetchSubdomainsListForName

fetchSubdomainsListForName(requestParameters: FetchSubdomainsListForNameRequest, initOverrides?: RequestInit): Promise<string[]>
Retrieves the list of subdomains for a specific name Get Name Subdomains
Parameters
- requestParameters: FetchSubdomainsListForNameRequest
- Optional initOverrides: RequestInit
Returns Promise<string[]>
Implementation of NamesApiInterface.fetchSubdomainsListForName
- Defined in src/generated/apis/NamesApi.ts:280

fetchSubdomainsListForNameRaw

fetchSubdomainsListForNameRaw(requestParameters: FetchSubdomainsListForNameRequest, initOverrides?: RequestInit): Promise<ApiResponse<string[]>>
Retrieves the list of subdomains for a specific name Get Name Subdomains
Parameters
- requestParameters: FetchSubdomainsListForNameRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<string[]>>
Implementation of NamesApiInterface.fetchSubdomainsListForNameRaw
- Defined in src/generated/apis/NamesApi.ts:257

fetchZoneFile

fetchZoneFile(requestParameters: FetchZoneFileRequest, initOverrides?: RequestInit): Promise<object>
Retrieves a user’s raw zone file. This only works for RFC-compliant zone files. This method returns an error for names that have non-standard zone files. Get Zone File
Parameters
- requestParameters: FetchZoneFileRequest
- Optional initOverrides: RequestInit
Returns Promise<object>
Implementation of NamesApiInterface.fetchZoneFile
- Defined in src/generated/apis/NamesApi.ts:312

fetchZoneFileRaw

fetchZoneFileRaw(requestParameters: FetchZoneFileRequest, initOverrides?: RequestInit): Promise<ApiResponse<object>>
Retrieves a user’s raw zone file. This only works for RFC-compliant zone files. This method returns an error for names that have non-standard zone files. Get Zone File
Parameters
- requestParameters: FetchZoneFileRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<object>>
Implementation of NamesApiInterface.fetchZoneFileRaw
- Defined in src/generated/apis/NamesApi.ts:289

getAllNames

getAllNames(requestParameters: GetAllNamesRequest, initOverrides?: RequestInit): Promise<string[]>
Retrieves a list of all names known to the node. Get All Names
Parameters
- requestParameters: GetAllNamesRequest
- Optional initOverrides: RequestInit
Returns Promise<string[]>
Implementation of NamesApiInterface.getAllNames
- Defined in src/generated/apis/NamesApi.ts:344

getAllNamesRaw

getAllNamesRaw(requestParameters: GetAllNamesRequest, initOverrides?: RequestInit): Promise<ApiResponse<string[]>>
Retrieves a list of all names known to the node. Get All Names
Parameters
- requestParameters: GetAllNamesRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<string[]>>
Implementation of NamesApiInterface.getAllNamesRaw
- Defined in src/generated/apis/NamesApi.ts:321

getAllNamespaces

getAllNamespaces(initOverrides?: RequestInit): Promise<BnsGetAllNamespacesResponse>
Retrieves a list of all namespaces known to the node. Get All Namespaces
Parameters
- Optional initOverrides: RequestInit
Returns Promise<BnsGetAllNamespacesResponse>
Implementation of NamesApiInterface.getAllNamespaces
- Defined in src/generated/apis/NamesApi.ts:372

getAllNamespacesRaw

getAllNamespacesRaw(initOverrides?: RequestInit): Promise<ApiResponse<BnsGetAllNamespacesResponse>>
Retrieves a list of all namespaces known to the node. Get All Namespaces
Parameters
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<BnsGetAllNamespacesResponse>>
Implementation of NamesApiInterface.getAllNamespacesRaw
- Defined in src/generated/apis/NamesApi.ts:353

getHistoricalZoneFile

getHistoricalZoneFile(requestParameters: GetHistoricalZoneFileRequest, initOverrides?: RequestInit): Promise<object>
Retrieves the historical zonefile specified by the username and zone hash. Get Historical Zone File
Parameters
- requestParameters: GetHistoricalZoneFileRequest
- Optional initOverrides: RequestInit
Returns Promise<object>
Implementation of NamesApiInterface.getHistoricalZoneFile
- Defined in src/generated/apis/NamesApi.ts:408

getHistoricalZoneFileRaw

getHistoricalZoneFileRaw(requestParameters: GetHistoricalZoneFileRequest, initOverrides?: RequestInit): Promise<ApiResponse<object>>
Retrieves the historical zonefile specified by the username and zone hash. Get Historical Zone File
Parameters
- requestParameters: GetHistoricalZoneFileRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<object>>
Implementation of NamesApiInterface.getHistoricalZoneFileRaw
- Defined in src/generated/apis/NamesApi.ts:381

getNameInfo

getNameInfo(requestParameters: GetNameInfoRequest, initOverrides?: RequestInit): Promise<BnsGetNameInfoResponse>
Retrieves details of a given name including the address, status and last transaction id - last_txid. Get Name Details
Parameters
- requestParameters: GetNameInfoRequest
- Optional initOverrides: RequestInit
Returns Promise<BnsGetNameInfoResponse>
Implementation of NamesApiInterface.getNameInfo
- Defined in src/generated/apis/NamesApi.ts:440

getNameInfoRaw

getNameInfoRaw(requestParameters: GetNameInfoRequest, initOverrides?: RequestInit): Promise<ApiResponse<BnsGetNameInfoResponse>>
Retrieves details of a given name including the address, status and last transaction id - last_txid. Get Name Details
Parameters
- requestParameters: GetNameInfoRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<BnsGetNameInfoResponse>>
Implementation of NamesApiInterface.getNameInfoRaw
- Defined in src/generated/apis/NamesApi.ts:417

getNamePrice

getNamePrice(requestParameters: GetNamePriceRequest, initOverrides?: RequestInit): Promise<BnsGetNamePriceResponse>
Retrieves the price of a name. The amount given will be in the smallest possible units of the currency. Get Name Price
Parameters
- requestParameters: GetNamePriceRequest
- Optional initOverrides: RequestInit
Returns Promise<BnsGetNamePriceResponse>
Implementation of NamesApiInterface.getNamePrice
- Defined in src/generated/apis/NamesApi.ts:472

getNamePriceRaw

getNamePriceRaw(requestParameters: GetNamePriceRequest, initOverrides?: RequestInit): Promise<ApiResponse<BnsGetNamePriceResponse>>
Retrieves the price of a name. The amount given will be in the smallest possible units of the currency. Get Name Price
Parameters
- requestParameters: GetNamePriceRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<BnsGetNamePriceResponse>>
Implementation of NamesApiInterface.getNamePriceRaw
- Defined in src/generated/apis/NamesApi.ts:449

getNamesOwnedByAddress

getNamesOwnedByAddress(requestParameters: GetNamesOwnedByAddressRequest, initOverrides?: RequestInit): Promise<BnsNamesOwnByAddressResponse>
Retrieves a list of names owned by the address provided. Get Names Owned by Address
Parameters
- requestParameters: GetNamesOwnedByAddressRequest
- Optional initOverrides: RequestInit
Returns Promise<BnsNamesOwnByAddressResponse>
Implementation of NamesApiInterface.getNamesOwnedByAddress
- Defined in src/generated/apis/NamesApi.ts:508

getNamesOwnedByAddressRaw

getNamesOwnedByAddressRaw(requestParameters: GetNamesOwnedByAddressRequest, initOverrides?: RequestInit): Promise<ApiResponse<BnsNamesOwnByAddressResponse>>
Retrieves a list of names owned by the address provided. Get Names Owned by Address
Parameters
- requestParameters: GetNamesOwnedByAddressRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<BnsNamesOwnByAddressResponse>>
Implementation of NamesApiInterface.getNamesOwnedByAddressRaw
- Defined in src/generated/apis/NamesApi.ts:481

getNamespaceNames

getNamespaceNames(requestParameters: GetNamespaceNamesRequest, initOverrides?: RequestInit): Promise<string[]>
Retrieves a list of names within a given namespace. Get Namespace Names
Parameters
- requestParameters: GetNamespaceNamesRequest
- Optional initOverrides: RequestInit
Returns Promise<string[]>
Implementation of NamesApiInterface.getNamespaceNames
- Defined in src/generated/apis/NamesApi.ts:544

getNamespaceNamesRaw

getNamespaceNamesRaw(requestParameters: GetNamespaceNamesRequest, initOverrides?: RequestInit): Promise<ApiResponse<string[]>>
Retrieves a list of names within a given namespace. Get Namespace Names
Parameters
- requestParameters: GetNamespaceNamesRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<string[]>>
Implementation of NamesApiInterface.getNamespaceNamesRaw
- Defined in src/generated/apis/NamesApi.ts:517

getNamespacePrice

getNamespacePrice(requestParameters: GetNamespacePriceRequest, initOverrides?: RequestInit): Promise<BnsGetNamespacePriceResponse>
Retrieves the price of a namespace. The amount given will be in the smallest possible units of the currency. Get Namespace Price
Parameters
- requestParameters: GetNamespacePriceRequest
- Optional initOverrides: RequestInit
Returns Promise<BnsGetNamespacePriceResponse>
Implementation of NamesApiInterface.getNamespacePrice
- Defined in src/generated/apis/NamesApi.ts:576

getNamespacePriceRaw

getNamespacePriceRaw(requestParameters: GetNamespacePriceRequest, initOverrides?: RequestInit): Promise<ApiResponse<BnsGetNamespacePriceResponse>>
Retrieves the price of a namespace. The amount given will be in the smallest possible units of the currency. Get Namespace Price
Parameters
- requestParameters: GetNamespacePriceRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<BnsGetNamespacePriceResponse>>
Implementation of NamesApiInterface.getNamespacePriceRaw
- Defined in src/generated/apis/NamesApi.ts:553

`Protected` request

request(context: RequestOpts, initOverrides?: RequestInit): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in src/generated/runtime.ts:47

withMiddleware

withMiddleware<T>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in src/generated/runtime.ts:31

withPostMiddleware

withPostMiddleware<T>(this: T, ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in src/generated/runtime.ts:42

withPreMiddleware

withPreMiddleware<T>(this: T, ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in src/generated/runtime.ts:37

Class NamesApi

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration = ...

Returns NamesApi

Properties

Protected configuration

Methods

fetchSubdomainsListForName

Parameters

requestParameters: FetchSubdomainsListForNameRequest

Optional initOverrides: RequestInit

Returns Promise<string[]>

fetchSubdomainsListForNameRaw

Parameters

requestParameters: FetchSubdomainsListForNameRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<string[]>>

fetchZoneFile

Parameters

requestParameters: FetchZoneFileRequest

Optional initOverrides: RequestInit

Returns Promise<object>

fetchZoneFileRaw

Parameters

requestParameters: FetchZoneFileRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<object>>

getAllNames

Parameters

requestParameters: GetAllNamesRequest

Optional initOverrides: RequestInit

Returns Promise<string[]>

getAllNamesRaw

Parameters

requestParameters: GetAllNamesRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<string[]>>

getAllNamespaces

Parameters

Optional initOverrides: RequestInit

Returns Promise<BnsGetAllNamespacesResponse>

getAllNamespacesRaw

Parameters

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<BnsGetAllNamespacesResponse>>

getHistoricalZoneFile

Parameters

requestParameters: GetHistoricalZoneFileRequest

Optional initOverrides: RequestInit

Returns Promise<object>

getHistoricalZoneFileRaw

Parameters

requestParameters: GetHistoricalZoneFileRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<object>>

getNameInfo

Parameters

requestParameters: GetNameInfoRequest

Optional initOverrides: RequestInit

Returns Promise<BnsGetNameInfoResponse>

getNameInfoRaw

Parameters

requestParameters: GetNameInfoRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<BnsGetNameInfoResponse>>

getNamePrice

Parameters

requestParameters: GetNamePriceRequest

Optional initOverrides: RequestInit

Returns Promise<BnsGetNamePriceResponse>

getNamePriceRaw

Parameters

`Protected` configuration

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Protected` request

`Optional` initOverrides: RequestInit

`Rest` ...middlewares: Middleware[]

`Rest` ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]

`Rest` ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]