Interface FiHgComJokerDomainManagementAPI

Joker.com DMAPI client interface

See

https://github.com/heusalagroup/fi.hg.node for NodeJS implementation

Hierarchy

FiHgComJokerDomainManagementAPI

Implemented by

FiHgComJokerDomainManagementService

Index

Methods

domainCheck domainModify domainRegister domainRenew grantsInvite grantsList hasSession isReady loginWithApiKey loginWithUsername logout queryDomainList queryPriceList queryProfile queryWhoisByContact queryWhoisByDomain queryWhoisByHost

Methods

domainCheck

domainCheck(domain: string, checkPrice?: JokerComApiDomainPriceType, periods?: number, periodType?: JokerComApiPeriodType, language?: string): Promise<JokerComApiDomainCheckDTO>
domain-check

See
https://joker.com/faq/content/27/497/en/domain_check.html
Parameters
- domain: string
- Optional checkPrice: JokerComApiDomainPriceType
- Optional periods: number
- Optional periodType: JokerComApiPeriodType
- Optional language: string
Returns Promise<JokerComApiDomainCheckDTO>
- Defined in fi/hg/core/com/joker/dmapi/FiHgComJokerDomainManagementAPI.ts:123

domainModify

domainModify(domain: string, billingContact?: string, adminContact?: string, techContact?: string, nsList?: readonly string[], registerTag?: string, dnssec?: boolean, ds?: readonly string[]): Promise<void>
domain-modify

See
https://joker.com/faq/content/27/24/en/domain_modify.html
Parameters
- domain: string
- Optional billingContact: string
- Optional adminContact: string
- Optional techContact: string
- Optional nsList: readonly string[]
- Optional registerTag: string
- Optional dnssec: boolean
- Optional ds: readonly string[]
Returns Promise<void>
- Defined in fi/hg/core/com/joker/dmapi/FiHgComJokerDomainManagementAPI.ts:184

domainRegister

domainRegister(domain: string, period: number, ownerContact: string, billingContact: string, adminContact: string, techContact: string, nsList: readonly string[], autoRenew?: boolean, language?: string, registrarTag?: string, privacy?: JokerPrivacyType, maxPrice?: number): Promise<JokerComApiRegisterDTO>
domain-register

See
https://joker.com/faq/content/27/21/en/domain_register.html
Parameters
- domain: string
- period: number
  
  Registration period in months, not years!
- ownerContact: string
- billingContact: string
- adminContact: string
- techContact: string
- nsList: readonly string[]
- Optional autoRenew: boolean
  
  Optional
- Optional language: string
  
  Optional
- Optional registrarTag: string
  
  Only needed for .xxx domains
- Optional privacy: JokerPrivacyType
  
  Optional
- Optional maxPrice: number
  
  Optional
Returns Promise<JokerComApiRegisterDTO>
- Defined in fi/hg/core/com/joker/dmapi/FiHgComJokerDomainManagementAPI.ts:147

domainRenew

domainRenew(domain: string, period: number, expyear: string, privacy: JokerPrivacyType, maxPrice: number): Promise<void>
domain-renew

See
https://joker.com/faq/content/27/22/en/domain_renew.html
Parameters
- domain: string
- period: number
- expyear: string
- privacy: JokerPrivacyType
- maxPrice: number
Returns Promise<void>
- Defined in fi/hg/core/com/joker/dmapi/FiHgComJokerDomainManagementAPI.ts:107

grantsInvite

grantsInvite(domain: string, email: string, clientUid: string, role: string, nickname: string): Promise<boolean>
grants-invite

See
https://joker.com/faq/content/76/449/en/grants_invite.html
Parameters
- domain: string
- email: string
- clientUid: string
- role: string
- nickname: string
Returns Promise<boolean>
- Defined in fi/hg/core/com/joker/dmapi/FiHgComJokerDomainManagementAPI.ts:173

grantsList

grantsList(domain: string, showKey: string): Promise<string>
grants-list

See
https://joker.com/faq/content/76/448/en/grants_list.html
Parameters
- domain: string
- showKey: string
Returns Promise<string>
- Defined in fi/hg/core/com/joker/dmapi/FiHgComJokerDomainManagementAPI.ts:165

hasSession

hasSession(): boolean
Returns boolean
- Defined in fi/hg/core/com/joker/dmapi/FiHgComJokerDomainManagementAPI.ts:26

isReady

isReady(): Promise<boolean>
Returns Promise<boolean>
- Defined in fi/hg/core/com/joker/dmapi/FiHgComJokerDomainManagementAPI.ts:31

loginWithApiKey

loginWithApiKey(apiKey: string): Promise<JokerComApiLoginDTO>
Login using api key

See
https://joker.com/faq/content/26/14/en/login.html
Parameters
- apiKey: string
Returns Promise<JokerComApiLoginDTO>
- Defined in fi/hg/core/com/joker/dmapi/FiHgComJokerDomainManagementAPI.ts:36

loginWithUsername

loginWithUsername(username: string, password: string): Promise<JokerComApiLoginDTO>
Login using username and password

See
https://joker.com/faq/content/26/14/en/login.html
Parameters
- username: string
- password: string
Returns Promise<JokerComApiLoginDTO>
- Defined in fi/hg/core/com/joker/dmapi/FiHgComJokerDomainManagementAPI.ts:41

logout

logout(): Promise<void>
Logout

See
https://joker.com/faq/content/26/15/en/logout.html

Returns Promise<void>
- Defined in fi/hg/core/com/joker/dmapi/FiHgComJokerDomainManagementAPI.ts:49

queryDomainList

queryDomainList(pattern?: string, from?: string, to?: string, showStatus?: boolean, showGrants?: boolean, showJokerNS?: boolean): Promise<JokerComApiDomainListDTO>
query-domain-list

Params
pattern Pattern to match (glob-like)

Params
from Pattern to match (glob-like)

Params
to End by this

Params
showStatus

Params
showGrants

Params
showJokerNS

See
https://joker.com/faq/content/27/20/en/query_domain_list.html
Parameters
- Optional pattern: string
- Optional from: string
- Optional to: string
- Optional showStatus: boolean
- Optional showGrants: boolean
- Optional showJokerNS: boolean
Returns Promise<JokerComApiDomainListDTO>
- Defined in fi/hg/core/com/joker/dmapi/FiHgComJokerDomainManagementAPI.ts:60

queryPriceList

queryPriceList(): Promise<JokerComApiPriceListDTO>
query-price-list

See
https://joker.com/faq/content/79/509/en/query_price_list.html

Returns Promise<JokerComApiPriceListDTO>
- Defined in fi/hg/core/com/joker/dmapi/FiHgComJokerDomainManagementAPI.ts:102

queryProfile

queryProfile(): Promise<JokerComApiProfileDTO>
query-profile

Returns Promise<JokerComApiProfileDTO>
- Defined in fi/hg/core/com/joker/dmapi/FiHgComJokerDomainManagementAPI.ts:97

queryWhoisByContact

queryWhoisByContact(contact: string): Promise<JokerComApiWhoisContactDTO>
query-whois for contacts At least one of the arguments must be specified

See
https://joker.com/faq/content/79/455/en/query_whois.html
Parameters
- contact: string
  
  Contact handle
Returns Promise<JokerComApiWhoisContactDTO>
- Defined in fi/hg/core/com/joker/dmapi/FiHgComJokerDomainManagementAPI.ts:83

queryWhoisByDomain

queryWhoisByDomain(domain: string): Promise<JokerComApiWhoisDTO>
query-whois for domains At least one of the arguments must be specified

See
https://joker.com/faq/content/79/455/en/query_whois.html
Parameters
- domain: string
Returns Promise<JokerComApiWhoisDTO>
- Defined in fi/hg/core/com/joker/dmapi/FiHgComJokerDomainManagementAPI.ts:74

queryWhoisByHost

queryWhoisByHost(host: string): Promise<JokerComApiWhoisDTO>
query-whois for nameservers At least one of the arguments must be specified

See
https://joker.com/faq/content/79/455/en/query_whois.html
Parameters
- host: string
Returns Promise<JokerComApiWhoisDTO>
- Defined in fi/hg/core/com/joker/dmapi/FiHgComJokerDomainManagementAPI.ts:92

Interface FiHgComJokerDomainManagementAPI

See

Hierarchy

Implemented by

Index

Methods

Methods

domainCheck

See

Parameters

domain: string

Optional checkPrice: JokerComApiDomainPriceType

Optional periods: number

Optional periodType: JokerComApiPeriodType

Optional language: string

Returns Promise<JokerComApiDomainCheckDTO>

domainModify

See

Parameters

domain: string

Optional billingContact: string

Optional adminContact: string

Optional techContact: string

Optional nsList: readonly string[]

Optional registerTag: string

Optional dnssec: boolean

Optional ds: readonly string[]

Returns Promise<void>

domainRegister

See

Parameters

domain: string

period: number

ownerContact: string

billingContact: string

adminContact: string

techContact: string

nsList: readonly string[]

Optional autoRenew: boolean

Optional language: string

Optional registrarTag: string

Optional privacy: JokerPrivacyType

Optional maxPrice: number

Returns Promise<JokerComApiRegisterDTO>

domainRenew

See

Parameters

domain: string

period: number

expyear: string

privacy: JokerPrivacyType

maxPrice: number

Returns Promise<void>

grantsInvite

See

Parameters

domain: string

email: string

clientUid: string

role: string

nickname: string

Returns Promise<boolean>

grantsList

See

Parameters

domain: string

showKey: string

Returns Promise<string>

hasSession

Returns boolean

isReady

Returns Promise<boolean>

loginWithApiKey

See

Parameters

apiKey: string

Returns Promise<JokerComApiLoginDTO>

loginWithUsername

See

Parameters

`Optional` checkPrice: JokerComApiDomainPriceType

`Optional` periods: number

`Optional` periodType: JokerComApiPeriodType

`Optional` language: string

`Optional` billingContact: string

`Optional` adminContact: string

`Optional` techContact: string

`Optional` nsList: readonly string[]

`Optional` registerTag: string

`Optional` dnssec: boolean

`Optional` ds: readonly string[]

`Optional` autoRenew: boolean

`Optional` language: string

`Optional` registrarTag: string

`Optional` privacy: JokerPrivacyType

`Optional` maxPrice: number

`Optional` pattern: string

`Optional` from: string

`Optional` to: string

`Optional` showStatus: boolean

`Optional` showGrants: boolean

`Optional` showJokerNS: boolean