Class: DomainsService

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:55

Extends

• BaseService

Constructors

Constructor

new DomainsService(client): DomainsService

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:12

Parameters

client

TanqoryClient

Returns

DomainsService

Inherited from

BaseService.constructor

Properties

client

protected client: TanqoryClient

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:10

Inherited from

BaseService.client

Methods

add()

add(storeId, data): Promise<{ createdAt: Date; domain: string; expiresAt: Date; id: string; isPrimary: boolean; sslStatus?: string; status: "PENDING" | "EXPIRED" | "FAILED" | "ACTIVE" | "VERIFYING"; storeId: string; updatedAt: Date; verificationToken?: string; verifiedAt: Date; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:62

Parameters

storeId

string

data

domain

string

Returns

Promise<{ createdAt: Date; domain: string; expiresAt: Date; id: string; isPrimary: boolean; sslStatus?: string; status: "PENDING" | "EXPIRED" | "FAILED" | "ACTIVE" | "VERIFYING"; storeId: string; updatedAt: Date; verificationToken?: string; verifiedAt: Date; }>

---

addExternalDomain()

addExternalDomain(storeId, domain): Promise<CustomDomainResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:195

Parameters

storeId

string

domain

string

Returns

Promise<CustomDomainResponse>

---

autoConnectDomain()

autoConnectDomain(storeId, domainId): Promise<AutoConnectDomainResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:555

Parameters

storeId

string

domainId

string

Returns

Promise<AutoConnectDomainResponse>

---

buildQuery()

protected buildQuery(options?): Record<string, any>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:26

Build query parameters

Parameters

options?

ListOptions

Returns

Record<string, any>

Inherited from

BaseService.buildQuery

---

cancelTransfer()

cancelTransfer(storeId, transferId): Promise<DomainTransferResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:407

Parameters

storeId

string

transferId

string

Returns

Promise<DomainTransferResponse>

---

changeSubdomain()

changeSubdomain(storeId, newSubdomain): Promise<TanqorySubdomainResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:101

Parameters

storeId

string

newSubdomain

string

Returns

Promise<TanqorySubdomainResponse>

---

checkARecordVerification()

checkARecordVerification(storeId, domainId, domain): Promise<DnsVerificationCheckResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:562

Parameters

storeId

string

domainId

string

domain

string

Returns

Promise<DnsVerificationCheckResponse>

---

checkAvailability()

checkAvailability(domain): Promise<DomainAvailabilityResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:86

Parameters

domain

string

Returns

Promise<DomainAvailabilityResponse>

---

checkAvailabilityWithFallback()

checkAvailabilityWithFallback(domain): Promise<DomainAvailabilityResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:600

Check domain availability with fallback mock

Tries backend API first, falls back to mock data if unavailable.

Parameters

domain

string

Returns

Promise<DomainAvailabilityResponse>

Warning

Returns mock/estimated data when API is unavailable.

---

checkCnameVerification()

checkCnameVerification(storeId, domainId, subdomain): Promise<DnsVerificationCheckResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:574

Parameters

storeId

string

domainId

string

subdomain

string

Returns

Promise<DnsVerificationCheckResponse>

---

checkDomainConnectSupport()

checkDomainConnectSupport(storeId, domainId): Promise<DomainConnectSupportResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:521

Parameters

storeId

string

domainId

string

Returns

Promise<DomainConnectSupportResponse>

---

completeSSLValidation()

completeSSLValidation(storeId, _domainId, certId): Promise<SSLCertificateResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:471

Parameters

storeId

string

_domainId

string

certId

string

Returns

Promise<SSLCertificateResponse>

---

connectCloudflare()

connectCloudflare(storeId, domain): Promise<CloudflareConnectResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:547

Parameters

storeId

string

domain

string

Returns

Promise<CloudflareConnectResponse>

---

connectCustomDomain()

connectCustomDomain(storeId, domain): Promise<CustomDomainResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:150

Parameters

storeId

string

domain

string

Returns

Promise<CustomDomainResponse>

---

createSSLCertificate()

createSSLCertificate(storeId, domain, email?): Promise<SSLCertificateResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:457

Parameters

storeId

string

domain

string

email?

string

Returns

Promise<SSLCertificateResponse>

---

delete()

delete(id, storeId): Promise<DeletedResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:82

Parameters

id

string

storeId

string

Returns

Promise<DeletedResponse>

---

deleteCustomDomain()

deleteCustomDomain(storeId, domainId): Promise<DeletedResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:184

Parameters

storeId

string

domainId

string

Returns

Promise<DeletedResponse>

---

deleteSSLCertificate()

deleteSSLCertificate(storeId, _domainId, certId): Promise<DeletedResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:508

Parameters

storeId

string

_domainId

string

certId

string

Returns

Promise<DeletedResponse>

---

generateIdempotencyKey()

protected generateIdempotencyKey(prefix): string

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:19

Generate idempotency key

Parameters

prefix

string

Returns

string

Inherited from

BaseService.generateIdempotencyKey

---

getAllDomains()

getAllDomains(storeId): Promise<AllDomainsResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:127

Parameters

storeId

string

Returns

Promise<AllDomainsResponse>

---

getAuthCode()

getAuthCode(storeId, domainId): Promise<AuthCodeResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:352

Parameters

storeId

string

domainId

string

Returns

Promise<AuthCodeResponse>

---

getCloudflareStatus()

getCloudflareStatus(storeId): Promise<CloudflareStatusResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:540

Parameters

storeId

string

Returns

Promise<CloudflareStatusResponse>

---

getCustomDomains()

getCustomDomains(storeId, params?): Promise<ListResponse<CustomDomainResponse>>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:113

Parameters

storeId

string

params?

limit?

number

page?

number

Returns

Promise<ListResponse<CustomDomainResponse>>

---

getDnsDebugInfo()

getDnsDebugInfo(storeId, domainId): Promise<DnsDebugInfoResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:201

Parameters

storeId

string

domainId

string

Returns

Promise<DnsDebugInfoResponse>

---

getDNSHosts()

getDNSHosts(storeId, domainId): Promise<DnsHostsResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:280

Parameters

storeId

string

domainId

string

Returns

Promise<DnsHostsResponse>

---

getDNSNameservers()

getDNSNameservers(storeId, domainId): Promise<DnsNameserversResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:301

Parameters

storeId

string

domainId

string

Returns

Promise<DnsNameserversResponse>

---

getDomainById()

getDomainById(storeId, domainId): Promise<{ createdAt: Date; domain: string; expiresAt: Date; id: string; isPrimary: boolean; sslStatus?: string; status: "PENDING" | "EXPIRED" | "FAILED" | "ACTIVE" | "VERIFYING"; storeId: string; updatedAt: Date; verificationToken?: string; verifiedAt: Date; } | TanqorySubdomainResponse | CustomDomainResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:140

Get domain by ID.

Returns a union type (DomainResponse | CustomDomainResponse | TanqorySubdomainResponse) because a domain ID can refer to either a Tanqory subdomain (e.g. mystore.tanqory.com) or a custom domain (purchased or externally connected). The API resolves the ID and returns the corresponding shape, so callers should narrow the result using a type guard or discriminant field before accessing type-specific properties.

Parameters

storeId

string

domainId

string

Returns

Promise<{ createdAt: Date; domain: string; expiresAt: Date; id: string; isPrimary: boolean; sslStatus?: string; status: "PENDING" | "EXPIRED" | "FAILED" | "ACTIVE" | "VERIFYING"; storeId: string; updatedAt: Date; verificationToken?: string; verifiedAt: Date; } | TanqorySubdomainResponse | CustomDomainResponse>

---

getDomainConnectUrl()

getDomainConnectUrl(storeId, domainId): Promise<DomainConnectUrlResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:531

Parameters

storeId

string

domainId

string

Returns

Promise<DomainConnectUrlResponse>

---

getDomainPurchases()

getDomainPurchases(storeId, params?): Promise<ListResponse<DomainPurchaseResponse>>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:219

Parameters

storeId

string

params?

limit?

number

page?

number

Returns

Promise<ListResponse<DomainPurchaseResponse>>

---

getDomainStats()

getDomainStats(storeId): Promise<DomainStatsResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:274

Parameters

storeId

string

Returns

Promise<DomainStatsResponse>

---

getEmailForwarding()

getEmailForwarding(storeId, domainId): Promise<EmailForwardingResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:329

Parameters

storeId

string

domainId

string

Returns

Promise<EmailForwardingResponse>

---

getEmailForwards()

getEmailForwards(storeId, domainId, params?): Promise<ListResponse<EmailForwardRule>>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:414

Parameters

storeId

string

domainId

string

params?

limit?

number

page?

number

Returns

Promise<ListResponse<EmailForwardRule>>

---

getExportMimeType()

protected getExportMimeType(format): string

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/base.ts:45

Get MIME type for export format

Parameters

format

string

Returns

string

Inherited from

BaseService.getExportMimeType

---

getSSLCertificate()

getSSLCertificate(storeId, _domainId, certId): Promise<SSLCertificateResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:446

Parameters

storeId

string

_domainId

string

certId

string

Returns

Promise<SSLCertificateResponse>

---

getSSLCertificates()

getSSLCertificates(storeId, _domainId?, params?): Promise<ListResponse<SSLCertificateResponse>>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:431

Parameters

storeId

string

_domainId?

string

params?

limit?

number

page?

number

Returns

Promise<ListResponse<SSLCertificateResponse>>

---

getTanqorySubdomain()

getTanqorySubdomain(storeId): Promise<TanqorySubdomainResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:94

Parameters

storeId

string

Returns

Promise<TanqorySubdomainResponse>

---

getTransfers()

getTransfers(storeId, params?): Promise<ListResponse<DomainTransferResponse>>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:386

Parameters

storeId

string

params?

limit?

number

page?

number

Returns

Promise<ListResponse<DomainTransferResponse>>

---

getTransferStatus()

getTransferStatus(storeId, transferId): Promise<DomainTransferResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:400

Parameters

storeId

string

transferId

string

Returns

Promise<DomainTransferResponse>

---

initiateTransferIn()

initiateTransferIn(storeId, data): Promise<DomainTransferResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:359

Parameters

storeId

string

data

authCode

string

currentRegistrar?

string

domain

string

years?

number

Returns

Promise<DomainTransferResponse>

---

initiateTransferOut()

initiateTransferOut(storeId, domainId, data): Promise<DomainTransferResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:372

Parameters

storeId

string

domainId

string

data

targetRegistrar?

string

Returns

Promise<DomainTransferResponse>

---

purchaseDomain()

purchaseDomain(storeId, data): Promise<DomainPurchaseResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:210

Parameters

storeId

string

data

PurchaseDomainInput

Returns

Promise<DomainPurchaseResponse>

---

renewDomain()

renewDomain(storeId, domainId, years): Promise<DomainPurchaseResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:232

Parameters

storeId

string

domainId

string

years

number

Returns

Promise<DomainPurchaseResponse>

---

renewSSLCertificate()

renewSSLCertificate(storeId, _domainId, certId): Promise<SSLCertificateResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:482

Parameters

storeId

string

_domainId

string

certId

string

Returns

Promise<SSLCertificateResponse>

---

resetDNSToDefault()

resetDNSToDefault(storeId, domainId): Promise<SuccessMessageResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:322

Parameters

storeId

string

domainId

string

Returns

Promise<SuccessMessageResponse>

---

retrieve()

retrieve(id, storeId): Promise<{ createdAt: Date; domain: string; expiresAt: Date; id: string; isPrimary: boolean; sslStatus?: string; status: "PENDING" | "EXPIRED" | "FAILED" | "ACTIVE" | "VERIFYING"; storeId: string; updatedAt: Date; verificationToken?: string; verifiedAt: Date; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:58

Parameters

id

string

storeId

string

Returns

Promise<{ createdAt: Date; domain: string; expiresAt: Date; id: string; isPrimary: boolean; sslStatus?: string; status: "PENDING" | "EXPIRED" | "FAILED" | "ACTIVE" | "VERIFYING"; storeId: string; updatedAt: Date; verificationToken?: string; verifiedAt: Date; }>

---

searchDomains()

searchDomains(searchTerm): Promise<DomainSearchResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:588

Parameters

searchTerm

string

Returns

Promise<DomainSearchResponse>

---

searchDomainsWithFallback()

searchDomainsWithFallback(searchTerm): Promise<DomainSearchResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:614

Search domains with fallback mock suggestions

Tries backend API first for exact match, generates suggestions locally.

Parameters

searchTerm

string

Returns

Promise<DomainSearchResponse>

Warning

Returns mock/estimated data when API is unavailable.

---

setPrimary()

setPrimary(id, storeId): Promise<{ createdAt: Date; domain: string; expiresAt: Date; id: string; isPrimary: boolean; sslStatus?: string; status: "PENDING" | "EXPIRED" | "FAILED" | "ACTIVE" | "VERIFYING"; storeId: string; updatedAt: Date; verificationToken?: string; verifiedAt: Date; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:75

Parameters

id

string

storeId

string

Returns

Promise<{ createdAt: Date; domain: string; expiresAt: Date; id: string; isPrimary: boolean; sslStatus?: string; status: "PENDING" | "EXPIRED" | "FAILED" | "ACTIVE" | "VERIFYING"; storeId: string; updatedAt: Date; verificationToken?: string; verifiedAt: Date; }>

---

toggleAutoRenew()

toggleAutoRenew(storeId, domainId, autoRenew): Promise<ToggleAutoRenewResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:246

Parameters

storeId

string

domainId

string

autoRenew

boolean

Returns

Promise<ToggleAutoRenewResponse>

---

toggleSSLAutoRenew()

toggleSSLAutoRenew(storeId, _domainId, certId, autoRenew): Promise<ToggleAutoRenewResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:493

Parameters

storeId

string

_domainId

string

certId

string

autoRenew

boolean

Returns

Promise<ToggleAutoRenewResponse>

---

toggleWhoisPrivacy()

toggleWhoisPrivacy(storeId, domainId, whoisPrivacy): Promise<ToggleWhoisPrivacyResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:260

Parameters

storeId

string

domainId

string

whoisPrivacy

boolean

Returns

Promise<ToggleWhoisPrivacyResponse>

---

updateDNSHosts()

updateDNSHosts(storeId, domainId, records): Promise<DnsHostsResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:287

Parameters

storeId

string

domainId

string

records

DnsHostRecord[]

Returns

Promise<DnsHostsResponse>

---

updateDNSNameservers()

updateDNSNameservers(storeId, domainId, nameservers): Promise<DnsNameserversResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:308

Parameters

storeId

string

domainId

string

nameservers

string[]

Returns

Promise<DnsNameserversResponse>

---

updateDomainTarget()

updateDomainTarget(storeId, domainId, target): Promise<CustomDomainResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:170

Parameters

storeId

string

domainId

string

target

DomainTarget

Returns

Promise<CustomDomainResponse>

---

updateDomainType()

updateDomainType(storeId, domainId, type): Promise<CustomDomainResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:156

Parameters

storeId

string

domainId

string

type

DomainType

Returns

Promise<CustomDomainResponse>

---

updateEmailForwarding()

updateEmailForwarding(storeId, domainId, forwards): Promise<EmailForwardingResponse>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:336

Parameters

storeId

string

domainId

string

forwards

Omit<EmailForwardRule, "id" | "createdAt">[]

Returns

Promise<EmailForwardingResponse>

---

verify()

verify(id, storeId): Promise<{ currentRecords?: object[]; isVerified: boolean; message?: string; requiredRecords: object[]; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:68

Parameters

id

string

storeId

string

Returns

Promise<{ currentRecords?: object[]; isVerified: boolean; message?: string; requiredRecords: object[]; }>

---

verifyDomainDNS()

verifyDomainDNS(storeId, domainId): Promise<{ currentRecords?: object[]; isVerified: boolean; message?: string; requiredRecords: object[]; }>

Defined in: tanqory-platform-packages/packages/api/sdk/src/services/domains.ts:188

Parameters

storeId

string

domainId

string

Returns

Promise<{ currentRecords?: object[]; isVerified: boolean; message?: string; requiredRecords: object[]; }>