Subnames
@justaname.id/sdk • Docs
@justaname.id/sdk / Subnames
Class: Subnames
Constructors
new Subnames()
new Subnames(
params):Subnames
Parameters
• params: SubnamesConfig
Returns
Defined in
packages/@justaname.id/sdk/src/lib/features/subnames/index.ts:58
Methods
acceptSubname()
acceptSubname(
params,headers):Promise<SubnameResponse>
Parameters
• params: Omit<MakeOptionalProps<SubnameAcceptRequest, "chainId" | "ensDomain">, "addresses" | "text"> & object
• headers: ApiKeyHeaders & SIWEHeaders
Returns
Promise<SubnameResponse>
Defined in
packages/@justaname.id/sdk/src/lib/features/subnames/index.ts:65
addSubname()
addSubname(
params,headers):Promise<SubnameResponse>
Parameters
• params: Omit<MakeOptionalProps<SubnameAddRequest, "chainId" | "ensDomain">, "addresses" | "text"> & object
• headers: ApiKeyHeaders & SIWEHeaders
Returns
Promise<SubnameResponse>
Defined in
packages/@justaname.id/sdk/src/lib/features/subnames/index.ts:137
getInvitationsByAddress()
getInvitationsByAddress(
params):Promise<SubnameGetInvitationsByAddressResponse>
Parameters
• params: Omit<MakeOptionalProps<SubnameGetInvitationsByAddressRequest, "coinType" | "chainId">, "isClaimed">
Returns
Promise<SubnameGetInvitationsByAddressResponse>
Defined in
packages/@justaname.id/sdk/src/lib/features/subnames/index.ts:340
getPrimaryNameByAddress()
getPrimaryNameByAddress(
params):Promise<PrimaryNameGetByAddressResponse>
Parameters
• params: Omit<MakeOptionalProps<PrimaryNameGetByAddressRequest, "chainId">, never>
Returns
Promise<PrimaryNameGetByAddressResponse>
Defined in
packages/@justaname.id/sdk/src/lib/features/subnames/index.ts:439
getRecords()
getRecords(
params):Promise<SubnameResponse>
Parameters
• params: Omit<MakeOptionalProps<SubnameRecordsRequest, "providerUrl">, never> & object
Returns
Promise<SubnameResponse>
Defined in
packages/@justaname.id/sdk/src/lib/features/subnames/index.ts:419
getSubname()
getSubname(
params):Promise<SubnameResponse>
Parameters
• params: Omit<MakeOptionalProps<SubnameGetBySubnameRequest, "chainId">, never>
Returns
Promise<SubnameResponse>
Defined in
packages/@justaname.id/sdk/src/lib/features/subnames/index.ts:302
getSubnamesByAddress()
getSubnamesByAddress(
params):Promise<SubnameGetAllByAddressResponse>
Parameters
• params: Omit<MakeOptionalProps<SubnameGetAllByAddressRequest, "coinType" | "chainId" | "isClaimed">, never>
Returns
Promise<SubnameGetAllByAddressResponse>
Defined in
packages/@justaname.id/sdk/src/lib/features/subnames/index.ts:320
getSubnamesByEnsDomain()
getSubnamesByEnsDomain(
params):Promise<SubnameGetAllByDomainChainIdResponse>
Parameters
• params: Omit<MakeOptionalProps<SubnameGetAllByDomainChainIdRequest, "chainId" | "ensDomain">, never>
Returns
Promise<SubnameGetAllByDomainChainIdResponse>
Defined in
packages/@justaname.id/sdk/src/lib/features/subnames/index.ts:360
getSubnamesByEnsDomainWithCount()
getSubnamesByEnsDomainWithCount(
params):Promise<SubnameGetAllByEnsDomainWithCountResponse>
Parameters
• params: Omit<MakeOptionalProps<SubnameGetAllByEnsDomainWithCountRequest, "chainId">, never>
Returns
Promise<SubnameGetAllByEnsDomainWithCountResponse>
Defined in
packages/@justaname.id/sdk/src/lib/features/subnames/index.ts:283
isSubnameAvailable()
isSubnameAvailable(
params):Promise<IsSubnameAvailableResponse>
Parameters
• params: Omit<MakeOptionalProps<IsSubnameAvailableRequest, "chainId">, never>
Returns
Promise<IsSubnameAvailableResponse>
Defined in
packages/@justaname.id/sdk/src/lib/features/subnames/index.ts:401
rejectSubname()
rejectSubname(
params,headers):Promise<SubnameResponse>
Parameters
• params: Omit<MakeOptionalProps<SubnameRejectRequest, "chainId" | "ensDomain">, never>
• headers: SIWEHeaders
Returns
Promise<SubnameResponse>
Defined in
packages/@justaname.id/sdk/src/lib/features/subnames/index.ts:254
reserveSubname()
reserveSubname(
params):Promise<SubnameResponse>
Parameters
• params: Omit<MakeOptionalProps<SubnameReserveRequest, "chainId" | "ensDomain">, never> & object
Returns
Promise<SubnameResponse>
Defined in
packages/@justaname.id/sdk/src/lib/features/subnames/index.ts:108
revokeSubname()
revokeSubname(
params,headers):Promise<SubnameResponse>
Parameters
• params: Omit<MakeOptionalProps<SubnameRevokeRequest, "chainId" | "ensDomain">, never> & object
• headers: ApiKeyHeaders & SIWEHeaders
Returns
Promise<SubnameResponse>
Defined in
packages/@justaname.id/sdk/src/lib/features/subnames/index.ts:219
searchSubnames()
searchSubnames(
params):Promise<SubnameSearchResponse>
Parameters
• params: Omit<MakeOptionalProps<SubnameSearchRequest, "chainId">, never>
Returns
Promise<SubnameSearchResponse>
Defined in
packages/@justaname.id/sdk/src/lib/features/subnames/index.ts:383
updateSubname()
updateSubname(
params,headers):Promise<SubnameResponse>
Parameters
• params: Omit<MakeOptionalProps<SubnameUpdateRequest, "chainId" | "ensDomain">, "addresses" | "text"> & object
• headers: SIWEHeaders
Returns
Promise<SubnameResponse>
Defined in
packages/@justaname.id/sdk/src/lib/features/subnames/index.ts:188
Last updated