Class FiHgComJokerDomainManagementService

Joker.com DMAPI client library for NodeJS

Hierarchy

FiHgComJokerDomainManagementService

Implements

FiHgComJokerDomainManagementAPI

Constructors

constructor

new FiHgComJokerDomainManagementService(url?: string, authId?: string, loginTime?: number, ttl?: number): FiHgComJokerDomainManagementService
Creates a client service for Joker.com DMAPI
Parameters
- url: string = 'https://dmapi.joker.com'
  
  For testing purposes, you may use https://dmapi.ote.joker.com
- authId: string = undefined
  
  Previously saved auth-sid
- loginTime: number = undefined
  
  Previously saved auth-sid creation time
- ttl: number = undefined
  
  Previously saved auth-sid time to life
Returns FiHgComJokerDomainManagementService
- Defined in fi/hg/node/com/joker/dmapi/FiHgComJokerDomainManagementService.ts:64

Properties

`Private` _authSID

_authSID: string

`Private` _time

_time: number

`Private` _ttl

_ttl: number

`Private` `Readonly` _url

_url: string

Methods

`Private` _login

_login(username: string, password: string, apiKey?: string): Promise<JokerComApiLoginDTO>
Login implementation

See
https://joker.com/faq/content/26/14/en/login.html
Parameters
- username: string
- password: string
- apiKey: string = undefined
Returns Promise<JokerComApiLoginDTO>
- Defined in fi/hg/node/com/joker/dmapi/FiHgComJokerDomainManagementService.ts:165

`Private` _queryWhois

_queryWhois(domain?: string, contact?: string, host?: string): Promise<JokerComApiWhoisDTO>
query-whois At least one of the arguments must be specified

See
https://joker.com/faq/content/79/455/en/query_whois.html
Parameters
- Optional domain: string
- Optional contact: string
- Optional host: string
Returns Promise<JokerComApiWhoisDTO>
- Defined in fi/hg/node/com/joker/dmapi/FiHgComJokerDomainManagementService.ts:365

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>
Implementation of FiHgComJokerDomainManagementAPI.domainCheck
- Defined in fi/hg/node/com/joker/dmapi/FiHgComJokerDomainManagementService.ts:515

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>
Implementation of FiHgComJokerDomainManagementAPI.domainModify
- Defined in fi/hg/node/com/joker/dmapi/FiHgComJokerDomainManagementService.ts:683

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>
Implementation of FiHgComJokerDomainManagementAPI.domainRegister
- Defined in fi/hg/node/com/joker/dmapi/FiHgComJokerDomainManagementService.ts:583

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>
Implementation of FiHgComJokerDomainManagementAPI.domainRenew
- Defined in fi/hg/node/com/joker/dmapi/FiHgComJokerDomainManagementService.ts:478

getTimeoutThreshold

getTimeoutThreshold(): number
Returns number
- Defined in fi/hg/node/com/joker/dmapi/FiHgComJokerDomainManagementService.ts:87

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>
Implementation of FiHgComJokerDomainManagementAPI.grantsInvite
- Defined in fi/hg/node/com/joker/dmapi/FiHgComJokerDomainManagementService.ts:657

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>
Implementation of FiHgComJokerDomainManagementAPI.grantsList
- Defined in fi/hg/node/com/joker/dmapi/FiHgComJokerDomainManagementService.ts:637

hasSession

hasSession(): boolean
Returns true if has session key saved

Returns boolean
Implementation of FiHgComJokerDomainManagementAPI.hasSession
- Defined in fi/hg/node/com/joker/dmapi/FiHgComJokerDomainManagementService.ts:79

isReady

isReady(): Promise<boolean>
Returns true if session is OK.

This method will test the connection by fetching the profile.

Returns Promise<boolean>
Implementation of FiHgComJokerDomainManagementAPI.isReady
- Defined in fi/hg/node/com/joker/dmapi/FiHgComJokerDomainManagementService.ts:120

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>
Implementation of FiHgComJokerDomainManagementAPI.loginWithUsername
- Defined in fi/hg/node/com/joker/dmapi/FiHgComJokerDomainManagementService.ts:155

logout

logout(): Promise<void>
Logout

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

Returns Promise<void>
Implementation of FiHgComJokerDomainManagementAPI.logout
- Defined in fi/hg/node/com/joker/dmapi/FiHgComJokerDomainManagementService.ts:244

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>
Implementation of FiHgComJokerDomainManagementAPI.queryDomainList
- Defined in fi/hg/node/com/joker/dmapi/FiHgComJokerDomainManagementService.ts:265

queryPriceList

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

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

Returns Promise<JokerComApiPriceListDTO>
Implementation of FiHgComJokerDomainManagementAPI.queryPriceList
- Defined in fi/hg/node/com/joker/dmapi/FiHgComJokerDomainManagementService.ts:453

queryProfile

queryProfile(): Promise<JokerComApiProfileDTO>
query-profile

Returns Promise<JokerComApiProfileDTO>
Implementation of FiHgComJokerDomainManagementAPI.queryProfile
- Defined in fi/hg/node/com/joker/dmapi/FiHgComJokerDomainManagementService.ts:389

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>
Implementation of FiHgComJokerDomainManagementAPI.queryWhoisByContact
- Defined in fi/hg/node/com/joker/dmapi/FiHgComJokerDomainManagementService.ts:317

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>
Implementation of FiHgComJokerDomainManagementAPI.queryWhoisByDomain
- Defined in fi/hg/node/com/joker/dmapi/FiHgComJokerDomainManagementService.ts:306

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>
Implementation of FiHgComJokerDomainManagementAPI.queryWhoisByHost
- Defined in fi/hg/node/com/joker/dmapi/FiHgComJokerDomainManagementService.ts:352

Class FiHgComJokerDomainManagementService

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

url: string = 'https://dmapi.joker.com'

authId: string = undefined

loginTime: number = undefined

ttl: number = undefined

Returns FiHgComJokerDomainManagementService

Properties

Private _authSID

Private _time

Private _ttl

Private Readonly _url

Methods

Private _login

See

Parameters

username: string

password: string

apiKey: string = undefined

Returns Promise<JokerComApiLoginDTO>

Private _queryWhois

See

Parameters

Optional domain: string

Optional contact: string

Optional host: string

Returns Promise<JokerComApiWhoisDTO>

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

`Private` _authSID

`Private` _time

`Private` _ttl

`Private` `Readonly` _url

`Private` _login

`Private` _queryWhois

`Optional` domain: string

`Optional` contact: string

`Optional` host: string

`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