@alternatefutures/sdk • Docs

@alternatefutures/sdk

Modules

• clients/applications
• clients/billing
• clients/domains
• clients/ens
• clients/functions
• clients/ipfs
• clients/ipns
• clients/privateGateway
• clients/projects
• clients/sites
• clients/storage
• clients/uploadProxy
• clients/user
• index

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/applications

clients/applications

Index

Classes

• ApplicationsClient

Type Aliases

• Application
• ApplicationsClientOptions
• CreateApplicationArgs
• DeleteApplicationArgs
• GetApplicationArgs
• UpdateApplicationArgs

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/applications / ApplicationsClient

Class: ApplicationsClient

Constructors

new ApplicationsClient()

new ApplicationsClient(options): ApplicationsClient

Parameters

• options: ApplicationsClientOptions

Returns

ApplicationsClient

Defined in

src/clients/applications.ts:53

Methods

create()

create(__namedParameters): Promise<Pick<object, "whitelistDomains" | "clientId" | "createdAt" | "id" | "name" | "updatedAt" | "whiteLabelDomains">>

Parameters

• __namedParameters: CreateApplicationArgs

Returns

Promise<Pick<object, "whitelistDomains" | "clientId" | "createdAt" | "id" | "name" | "updatedAt" | "whiteLabelDomains">>

Defined in

src/clients/applications.ts:84

delete()

delete(__namedParameters): Promise<Pick<object, "whitelistDomains" | "clientId" | "createdAt" | "id" | "name" | "updatedAt" | "whiteLabelDomains">>

Parameters

• __namedParameters: DeleteApplicationArgs

Returns

Promise<Pick<object, "whitelistDomains" | "clientId" | "createdAt" | "id" | "name" | "updatedAt" | "whiteLabelDomains">>

Defined in

src/clients/applications.ts:129

get()

get(__namedParameters): Promise<Pick<object, "whitelistDomains" | "clientId" | "createdAt" | "id" | "name" | "updatedAt" | "whiteLabelDomains">>

Parameters

• __namedParameters: GetApplicationArgs

Returns

Promise<Pick<object, "whitelistDomains" | "clientId" | "createdAt" | "id" | "name" | "updatedAt" | "whiteLabelDomains">>

Defined in

src/clients/applications.ts:57

list()

list(): Promise<Pick<object, "whitelistDomains" | "clientId" | "createdAt" | "id" | "name" | "updatedAt" | "whiteLabelDomains">[]>

Returns

Promise<Pick<object, "whitelistDomains" | "clientId" | "createdAt" | "id" | "name" | "updatedAt" | "whiteLabelDomains">[]>

Defined in

src/clients/applications.ts:73

update()

update(__namedParameters): Promise<Pick<object, "whitelistDomains" | "clientId" | "createdAt" | "id" | "name" | "updatedAt" | "whiteLabelDomains">>

Parameters

• __namedParameters: UpdateApplicationArgs

Returns

Promise<Pick<object, "whitelistDomains" | "clientId" | "createdAt" | "id" | "name" | "updatedAt" | "whiteLabelDomains">>

Defined in

src/clients/applications.ts:104

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/applications / Application

Type Alias: Application

Application: Omit<ApplicationWithRelations, "__typename" | "whitelistDomains"> & object & object

Type declaration

whitelistDomains

whitelistDomains: string[]

Type declaration

whiteLabelDomains

whiteLabelDomains: string[]

Defined in

src/clients/applications.ts:8

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/applications / ApplicationsClientOptions

Type Alias: ApplicationsClientOptions

ApplicationsClientOptions: object

Type declaration

graphqlClient

graphqlClient: Client

Defined in

src/clients/applications.ts:17

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/applications / CreateApplicationArgs

Type Alias: CreateApplicationArgs

CreateApplicationArgs: Pick<Application, "name" | "whitelistDomains">

Defined in

src/clients/applications.ts:24

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/applications / DeleteApplicationArgs

Type Alias: DeleteApplicationArgs

DeleteApplicationArgs: Pick<Application, "id">

Defined in

src/clients/applications.ts:33

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/applications / GetApplicationArgs

Type Alias: GetApplicationArgs

GetApplicationArgs: Pick<Application, "id">

Defined in

src/clients/applications.ts:21

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/applications / UpdateApplicationArgs

Type Alias: UpdateApplicationArgs

UpdateApplicationArgs: Pick<Application, "id"> & Partial<Pick<Application, "name" | "whitelistDomains">>

Defined in

src/clients/applications.ts:30

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/billing

clients/billing

Index

Classes

• BillingClient

Type Aliases

• BillingClientOptions
• ConnectedAccount
• CryptoPaymentRequest
• CurrentUsage
• Customer
• Invoice
• InvoiceLineItem
• Payment
• PaymentMethod
• Subscription
• SubscriptionPlan
• Transfer
• UsageMetric
• UsageRecord

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/billing / BillingClient

Class: BillingClient

Constructors

new BillingClient()

new BillingClient(options): BillingClient

Parameters

• options: BillingClientOptions

Returns

BillingClient

Defined in

src/clients/billing.ts:163

Methods

addPaymentMethod()

addPaymentMethod(input): Promise<PaymentMethod>

Parameters

• input

• input.blockchain?: string

• input.paymentMethodId?: string

• input.provider?: "stripe" | "stax"

• input.setDefault?: boolean

• input.walletAddress?: string

Returns

Promise<PaymentMethod>

Defined in

src/clients/billing.ts:214

cancelSubscription()

cancelSubscription(__namedParameters): Promise<Subscription>

Parameters

• __namedParameters

• __namedParameters.id: string

• __namedParameters.immediately?: boolean = false

Returns

Promise<Subscription>

Defined in

src/clients/billing.ts:291

createConnectedAccount()

createConnectedAccount(input): Promise<ConnectedAccount>

Parameters

• input

• input.accountType?: "standard" | "express" | "custom"

• input.businessName?: string

• input.country?: string

• input.email: string

• input.provider?: "stripe" | "stax"

Returns

Promise<ConnectedAccount>

Defined in

src/clients/billing.ts:444

createCryptoPayment()

createCryptoPayment(__namedParameters): Promise<CryptoPaymentRequest>

Parameters

• __namedParameters

• __namedParameters.chainId?: number = 1

• __namedParameters.invoiceId: string

• __namedParameters.tokenSymbol?: string = 'usdc'

Returns

Promise<CryptoPaymentRequest>

Defined in

src/clients/billing.ts:405

createDashboardLink()

createDashboardLink(accountId): Promise<object>

Parameters

• accountId: string

Returns

Promise<object>

url

url: string

Defined in

src/clients/billing.ts:482

createOnboardingLink()

createOnboardingLink(__namedParameters): Promise<object>

Parameters

• __namedParameters

• __namedParameters.accountId: string

• __namedParameters.refreshUrl: string

• __namedParameters.returnUrl: string

Returns

Promise<object>

expiresAt

expiresAt: number

url

url: string

Defined in

src/clients/billing.ts:463

createSubscription()

createSubscription(input): Promise<Subscription>

Parameters

• input

• input.paymentMethodId?: string

• input.planId: string

• input.seats?: number

Returns

Promise<Subscription>

Defined in

src/clients/billing.ts:279

createTransfer()

createTransfer(input): Promise<Transfer>

Parameters

• input

• input.amount: number

• input.connectedAccountId: string

• input.currency?: string

• input.description?: string

• input.sourcePaymentId?: string

Returns

Promise<Transfer>

Defined in

src/clients/billing.ts:505

deleteConnectedAccount()

deleteConnectedAccount(id): Promise<boolean>

Parameters

• id: string

Returns

Promise<boolean>

Defined in

src/clients/billing.ts:489

generateInvoice()

generateInvoice(): Promise<Invoice>

Returns

Promise<Invoice>

Defined in

src/clients/billing.ts:343

getActiveSubscription()

getActiveSubscription(): Promise<null | Subscription>

Returns

Promise<null | Subscription>

Defined in

src/clients/billing.ts:269

getConnectedAccount()

getConnectedAccount(id): Promise<null | ConnectedAccount>

Parameters

• id: string

Returns

Promise<null | ConnectedAccount>

Defined in

src/clients/billing.ts:458

getCurrentUsage()

getCurrentUsage(): Promise<null | CurrentUsage>

Returns

Promise<null | CurrentUsage>

Defined in

src/clients/billing.ts:354

getCustomer()

getCustomer(): Promise<null | Customer>

Returns

Promise<null | Customer>

Defined in

src/clients/billing.ts:192

getInvoice()

getInvoice(__namedParameters): Promise<null | Invoice>

Parameters

• __namedParameters

• __namedParameters.id: string

Returns

Promise<null | Invoice>

Defined in

src/clients/billing.ts:338

getPlatformBalance()

getPlatformBalance(): Promise<object[]>

Returns

Promise<object[]>

Defined in

src/clients/billing.ts:519

getSubscriptionPlans()

getSubscriptionPlans(): Promise<SubscriptionPlan[]>

Returns

Promise<SubscriptionPlan[]>

Defined in

src/clients/billing.ts:274

getUsageHistory()

getUsageHistory(limit): Promise<UsageRecord[]>

Parameters

• limit: number = 100

Returns

Promise<UsageRecord[]>

Defined in

src/clients/billing.ts:359

listConnectedAccounts()

listConnectedAccounts(): Promise<ConnectedAccount[]>

Returns

Promise<ConnectedAccount[]>

Defined in

src/clients/billing.ts:439

listInvoices()

listInvoices(__namedParameters): Promise<Invoice[]>

Parameters

• __namedParameters = {}

• __namedParameters.limit?: number = 50

• __namedParameters.status?: string

Returns

Promise<Invoice[]>

Defined in

src/clients/billing.ts:323

listPaymentMethods()

listPaymentMethods(): Promise<PaymentMethod[]>

Returns

Promise<PaymentMethod[]>

Defined in

src/clients/billing.ts:209

listPayments()

listPayments(limit): Promise<Payment[]>

Parameters

• limit: number = 50

Returns

Promise<Payment[]>

Defined in

src/clients/billing.ts:380

listSubscriptions()

listSubscriptions(): Promise<Subscription[]>

Returns

Promise<Subscription[]>

Defined in

src/clients/billing.ts:264

listTransfers()

listTransfers(connectedAccountId?, limit?): Promise<Transfer[]>

Parameters

• connectedAccountId?: string

• limit?: number = 50

Returns

Promise<Transfer[]>

Defined in

src/clients/billing.ts:496

processPayment()

processPayment(__namedParameters): Promise<Payment & object>

Parameters

• __namedParameters

• __namedParameters.amount?: number

• __namedParameters.invoiceId: string

• __namedParameters.paymentMethodId?: string

Returns

Promise<Payment & object>

Defined in

src/clients/billing.ts:385

recordCryptoPayment()

recordCryptoPayment(input): Promise<Payment>

Parameters

• input

• input.amount: number

• input.blockchain: string

• input.fromAddress: string

• input.invoiceId: string

• input.txHash: string

Returns

Promise<Payment>

Defined in

src/clients/billing.ts:421

recordUsage()

recordUsage(input): Promise<UsageRecord>

Parameters

• input

• input.metricType: "storage" | "bandwidth" | "compute" | "requests"

• input.quantity: number

• input.timestamp?: number

Returns

Promise<UsageRecord>

Defined in

src/clients/billing.ts:364

removePaymentMethod()

removePaymentMethod(__namedParameters): Promise<boolean>

Parameters

• __namedParameters

• __namedParameters.id: string

Returns

Promise<boolean>

Defined in

src/clients/billing.ts:246

setDefaultPaymentMethod()

setDefaultPaymentMethod(__namedParameters): Promise<boolean>

Parameters

• __namedParameters

• __namedParameters.id: string

Returns

Promise<boolean>

Defined in

src/clients/billing.ts:253

updateCustomer()

updateCustomer(data): Promise<Customer>

Parameters

• data

• data.email?: string

• data.name?: string

Returns

Promise<Customer>

Defined in

src/clients/billing.ts:197

updateSubscriptionSeats()

updateSubscriptionSeats(__namedParameters): Promise<Subscription>

Parameters

• __namedParameters

• __namedParameters.id: string

• __namedParameters.seats: number

Returns

Promise<Subscription>

Defined in

src/clients/billing.ts:305

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/billing / BillingClientOptions

Type Alias: BillingClientOptions

BillingClientOptions: object

Type declaration

accessTokenService

accessTokenService: AccessTokenService

authServiceUrl

authServiceUrl: string

Defined in

src/clients/billing.ts:154

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/billing / ConnectedAccount

Type Alias: ConnectedAccount

ConnectedAccount: object

Type declaration

accountType

accountType: "standard" | "express" | "custom"

businessName?

optional businessName: string

chargesEnabled

chargesEnabled: boolean

country?

optional country: string

createdAt

createdAt: number

detailsSubmitted

detailsSubmitted: boolean

email?

optional email: string

id

id: string

payoutsEnabled

payoutsEnabled: boolean

provider

provider: "stripe" | "stax"

Defined in

src/clients/billing.ts:119

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/billing / CryptoPaymentRequest

Type Alias: CryptoPaymentRequest

CryptoPaymentRequest: object

Type declaration

amount

amount: number

chainId

chainId: number

currency

currency: string

depositAddress

depositAddress: string

expiresAt

expiresAt: number

id

id: string

status

status: "PENDING"

tokenAddress?

optional tokenAddress: string

tokenSymbol

tokenSymbol: string

Defined in

src/clients/billing.ts:142

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/billing / CurrentUsage

Type Alias: CurrentUsage

CurrentUsage: object

Type declaration

bandwidth

bandwidth: UsageMetric

compute

compute: UsageMetric

periodEnd?

optional periodEnd: number

periodStart?

optional periodStart: number

requests

requests: UsageMetric

storage

storage: UsageMetric

total

total: number

Defined in

src/clients/billing.ts:96

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/billing / Customer

Type Alias: Customer

Customer: object

Type declaration

createdAt

createdAt: number

email?

optional email: string

id

id: string

name?

optional name: string

Defined in

src/clients/billing.ts:9

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/billing / Invoice

Type Alias: Invoice

Invoice: object

Type declaration

amountDue

amountDue: number

amountPaid

amountPaid: number

createdAt

createdAt: number

currency

currency: string

dueDate?

optional dueDate: number

id

id: string

invoiceNumber

invoiceNumber: string

lineItems?

optional lineItems: InvoiceLineItem[]

paidAt?

optional paidAt: number

pdfUrl?

optional pdfUrl: string

periodEnd?

optional periodEnd: number

periodStart?

optional periodStart: number

status

status: "DRAFT" | "OPEN" | "PAID" | "VOID" | "UNCOLLECTIBLE"

subtotal

subtotal: number

tax

tax: number

total

total: number

Defined in

src/clients/billing.ts:60

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/billing / InvoiceLineItem

Type Alias: InvoiceLineItem

InvoiceLineItem: object

Type declaration

amount

amount: number

description

description: string

id

id: string

quantity

quantity: number

unitPrice

unitPrice: number

Defined in

src/clients/billing.ts:52

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/billing / Payment

Type Alias: Payment

Payment: object

Type declaration

amount

amount: number

blockchain?

optional blockchain: string

createdAt

createdAt: number

currency

currency: string

id

id: string

invoiceId?

optional invoiceId: string

provider?

optional provider: string

status

status: "PENDING" | "SUCCEEDED" | "FAILED"

txHash?

optional txHash: string

Defined in

src/clients/billing.ts:79

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/billing / PaymentMethod

Type Alias: PaymentMethod

PaymentMethod: object

Type declaration

blockchain?

optional blockchain: string

cardBrand?

optional cardBrand: string

cardExpMonth?

optional cardExpMonth: number

cardExpYear?

optional cardExpYear: number

cardLast4?

optional cardLast4: string

createdAt

createdAt: number

id

id: string

isDefault

isDefault: boolean

provider?

optional provider: string

type

type: "CARD" | "CRYPTO"

walletAddress?

optional walletAddress: string

Defined in

src/clients/billing.ts:16

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/billing / Subscription

Type Alias: Subscription

Subscription: object

Type declaration

basePricePerSeat

basePricePerSeat: number

cancelAt?

optional cancelAt: number

createdAt

createdAt: number

currentPeriodEnd

currentPeriodEnd: number

currentPeriodStart

currentPeriodStart: number

id

id: string

plan

plan: "FREE" | "STARTER" | "PRO" | "ENTERPRISE"

seats

seats: number

status

status: "ACTIVE" | "CANCELED" | "PAST_DUE" | "UNPAID" | "TRIALING"

trialEnd?

optional trialEnd: number

usageMarkup

usageMarkup: number

Defined in

src/clients/billing.ts:38

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/billing / SubscriptionPlan

Type Alias: SubscriptionPlan

SubscriptionPlan: object

Type declaration

basePricePerSeat

basePricePerSeat: number

features?

optional features: Record<string, unknown>

id

id: string

name

name: "FREE" | "STARTER" | "PRO" | "ENTERPRISE"

usageMarkup

usageMarkup: number

Defined in

src/clients/billing.ts:30

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/billing / Transfer

Type Alias: Transfer

Transfer: object

Type declaration

amount

amount: number

connectedAccountId

connectedAccountId: string

createdAt

createdAt: number

currency

currency: string

description?

optional description: string

id

id: string

status

status: "pending" | "paid" | "failed" | "canceled"

Defined in

src/clients/billing.ts:132

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/billing / UsageMetric

Type Alias: UsageMetric

UsageMetric: object

Type declaration

amount

amount: number

quantity

quantity: number

Defined in

src/clients/billing.ts:91

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/billing / UsageRecord

Type Alias: UsageRecord

UsageRecord: object

Type declaration

amount

amount: number

createdAt

createdAt: number

id

id: string

metricType

metricType: "storage" | "bandwidth" | "compute" | "requests"

periodEnd

periodEnd: number

periodStart

periodStart: number

quantity

quantity: number

recordedAt

recordedAt: number

unitPrice

unitPrice: number

Defined in

src/clients/billing.ts:106

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/domains

clients/domains

Index

Classes

• DomainsClient

Type Aliases

• Domain
• DomainsClientOptions
• Zone

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/domains / DomainsClient

Class: DomainsClient

Constructors

new DomainsClient()

new DomainsClient(options): DomainsClient

Parameters

• options: DomainsClientOptions

Returns

DomainsClient

Defined in

src/clients/domains.ts:110

Methods

createCustomDomain()

createCustomDomain(options): Promise<Pick<object, "__typename" | "createdAt" | "id" | "updatedAt" | "hostname" | "status" | "dnslinkStatus" | "errorMessage" | "isVerified">>

Creates a custom domain for a site with DNS verification.

Supports multiple domain types including traditional Web2 domains and Web3 domains (ARNS, ENS, IPNS). Choose your preferred DNS verification method.

Parameters

• options

Domain creation options

• options.domainType?: "WEB2" | "ARNS" | "ENS" | "IPNS" = 'WEB2'

Domain type: 'WEB2' (default), 'ARNS', 'ENS', or 'IPNS'

• options.hostname: string

The domain hostname (e.g., 'example.com', 'mysite.eth')

• options.siteId: string

The ID of the site to attach the domain to

• options.verificationMethod?: "A" | "CNAME" | "TXT" = 'TXT'

DNS verification method: 'TXT' (default), 'CNAME', or 'A'

Returns

Promise<Pick<object, "__typename" | "createdAt" | "id" | "updatedAt" | "hostname" | "status" | "dnslinkStatus" | "errorMessage" | "isVerified">>

Promise<Domain> Domain object with verification instructions

Examples

// Create a standard web domain with TXT verification
const domain = await sdk.domains().createCustomDomain({
  siteId: 'site-123',
  hostname: 'example.com',
  verificationMethod: 'TXT',
  domainType: 'WEB2'
});
console.log(domain.txtVerificationToken); // 'af-verify-abc123'

// Create an ENS domain
const ensDomain = await sdk.domains().createCustomDomain({
  siteId: 'site-123',
  hostname: 'mysite.eth',
  domainType: 'ENS'
});

// Create domain with CNAME verification
const domain = await sdk.domains().createCustomDomain({
  siteId: 'site-123',
  hostname: 'www.example.com',
  verificationMethod: 'CNAME'
});

Defined in

src/clients/domains.ts:383

createDomain()

createDomain(__namedParameters): Promise<any>

Parameters

• __namedParameters

• __namedParameters.hostname: string

• __namedParameters.zoneId: string

Returns

Promise<any>

Deprecated

Use createCustomDomain instead for new domain creation with SSL support

Defined in

src/clients/domains.ts:209

createZoneForPrivateGateway()

createZoneForPrivateGateway(): Promise<Zone>

Returns

Promise<Zone>

Defined in

src/clients/domains.ts:308

createZoneForSite()

createZoneForSite(__namedParameters): Promise<Zone>

Parameters

• __namedParameters

• __namedParameters.siteId: string

Returns

Promise<Zone>

Defined in

src/clients/domains.ts:287

deleteDomain()

deleteDomain(__namedParameters): Promise<Pick<object, "__typename" | "createdAt" | "id" | "updatedAt" | "hostname" | "status" | "dnslinkStatus" | "errorMessage" | "isVerified">>

Parameters

• __namedParameters

• __namedParameters.domainId: string

Returns

Promise<Pick<object, "__typename" | "createdAt" | "id" | "updatedAt" | "hostname" | "status" | "dnslinkStatus" | "errorMessage" | "isVerified">>

Defined in

src/clients/domains.ts:234

deleteZone()

deleteZone(__namedParameters): Promise<Zone>

Parameters

• __namedParameters

• __namedParameters.id: string

Returns

Promise<Zone>

Defined in

src/clients/domains.ts:317

get()

get(__namedParameters): Promise<Domain>

Parameters

• __namedParameters

• __namedParameters.domainId: string

Returns

Promise<Domain>

Defined in

src/clients/domains.ts:141

getByHostname()

getByHostname(__namedParameters): Promise<Domain>

Parameters

• __namedParameters

• __namedParameters.hostname: string

Returns

Promise<Domain>

Defined in

src/clients/domains.ts:161

getVerificationInstructions()

getVerificationInstructions(options): Promise<any>

Retrieves DNS verification instructions for a domain.

Returns detailed instructions on which DNS records to add for domain verification. Instructions include record type (TXT, CNAME, or A), hostname, and value.

Parameters

• options

Instruction retrieval options

• options.domainId: string

The ID of the domain

Returns

Promise<any>

Promise<VerificationInstructions> Object containing DNS record instructions

Example

// Get verification instructions
const domain = await sdk.domains().createCustomDomain({
  siteId: 'site-123',
  hostname: 'example.com'
});

const instructions = await sdk.domains().getVerificationInstructions({
  domainId: domain.id
});

console.log(instructions.instructions);
// Output: "Add a TXT record to your DNS..."
console.log(instructions.recordType); // "TXT"
console.log(instructions.value); // "af-verify-abc123"

Defined in

src/clients/domains.ts:628

getZone()

getZone(__namedParameters): Promise<Zone>

Parameters

• __namedParameters

• __namedParameters.id: string

Returns

Promise<Zone>

Defined in

src/clients/domains.ts:271

list()

list(): Promise<Domain[]>

Returns

Promise<Domain[]>

Defined in

src/clients/domains.ts:116

listByZoneId()

listByZoneId(__namedParameters): Promise<Domain[]>

Parameters

• __namedParameters

• __namedParameters.zoneId: string

Returns

Promise<Domain[]>

Defined in

src/clients/domains.ts:183

listDomainsForSite()

listDomainsForSite(options): Promise<Pick<object, "__typename" | "createdAt" | "id" | "updatedAt" | "hostname" | "status" | "dnslinkStatus" | "errorMessage" | "isVerified">[]>

Lists all custom domains associated with a site.

Returns all domains (verified and unverified) configured for the specified site. Includes domain status, SSL information, and verification details.

Parameters

• options

List options

• options.siteId: string

The ID of the site

Returns

Promise<Pick<object, "__typename" | "createdAt" | "id" | "updatedAt" | "hostname" | "status" | "dnslinkStatus" | "errorMessage" | "isVerified">[]>

Promise<Domain[]> Array of domain objects

Examples

// List all domains for a site
const domains = await sdk.domains().listDomainsForSite({
  siteId: 'site-123'
});

domains.forEach(domain => {
  console.log(`${domain.hostname}: ${domain.verified ? 'Verified' : 'Pending'}`);
  console.log(`SSL: ${domain.sslStatus}`);
});

// Filter domains by status
const domains = await sdk.domains().listDomainsForSite({ siteId: 'site-123' });

const verified = domains.filter(d => d.verified);
const withSsl = domains.filter(d => d.sslStatus === 'ACTIVE');
const web3 = domains.filter(d => ['ENS', 'ARNS', 'IPNS'].includes(d.domainType));

console.log(`Verified: ${verified.length}, SSL Active: ${withSsl.length}, Web3: ${web3.length}`);

Defined in

src/clients/domains.ts:682

listZones()

listZones(): Promise<Zone[]>

Returns

Promise<Zone[]>

Defined in

src/clients/domains.ts:262

provisionSsl()

provisionSsl(options): Promise<any>

Provisions an SSL certificate for a verified domain.

Automatically provisions and configures an SSL certificate for your custom domain. The certificate is issued via Let's Encrypt and includes automatic renewal. Domain must be verified before SSL can be provisioned.

Parameters

• options

SSL provisioning options

• options.domainId: string

The ID of the verified domain

• options.email: string

Contact email for SSL expiration notifications and renewal alerts

Returns

Promise<any>

Promise<Domain> Updated domain object with SSL status

Example

// Provision SSL after domain verification
const domainWithSsl = await sdk.domains().provisionSsl({
  domainId: 'domain-123',
  email: 'admin@example.com'
});

console.log(domainWithSsl.sslStatus); // 'PENDING' or 'ACTIVE'
console.log(domainWithSsl.sslAutoRenew); // true

Defined in

src/clients/domains.ts:480

removeCustomDomain()

removeCustomDomain(options): Promise<Pick<object, "__typename" | "createdAt" | "id" | "updatedAt" | "hostname" | "status" | "dnslinkStatus" | "errorMessage" | "isVerified">>

Removes a custom domain from a site.

Permanently deletes a custom domain. This action cannot be undone. The domain can be re-added later if needed.

Parameters

• options

Deletion options

• options.domainId: string

The ID of the domain to remove

Returns

Promise<Pick<object, "__typename" | "createdAt" | "id" | "updatedAt" | "hostname" | "status" | "dnslinkStatus" | "errorMessage" | "isVerified">>

Promise<boolean> True if deletion successful

Examples

// Remove a domain
await sdk.domains().removeCustomDomain({
  domainId: 'domain-123'
});

// Remove all unverified domains
const domains = await sdk.domains().listDomainsForSite({ siteId: 'site-123' });
const unverified = domains.filter(d => !d.verified);

for (const domain of unverified) {
  await sdk.domains().removeCustomDomain({ domainId: domain.id });
}

Defined in

src/clients/domains.ts:585

setPrimaryDomain()

setPrimaryDomain(options): Promise<any>

Sets a domain as the primary domain for a site.

The primary domain is the main domain used to access your site. Only one domain can be set as primary per site.

Parameters

• options

Primary domain options

• options.domainId: string

The ID of the domain to set as primary

• options.siteId: string

The ID of the site

Returns

Promise<any>

Promise<boolean> True if successful

Examples

// Set primary domain for a site
await sdk.domains().setPrimaryDomain({
  siteId: 'site-123',
  domainId: 'domain-456'
});

// Switch primary domain
const domains = await sdk.domains().listDomainsForSite({ siteId: 'site-123' });
const newPrimary = domains.find(d => d.hostname === 'www.example.com');

await sdk.domains().setPrimaryDomain({
  siteId: 'site-123',
  domainId: newPrimary.id
});

Defined in

src/clients/domains.ts:534

verifyCustomDomain()

verifyCustomDomain(options): Promise<Pick<object, "__typename" | "createdAt" | "id" | "updatedAt" | "hostname" | "status" | "dnslinkStatus" | "errorMessage" | "isVerified">>

Verifies domain ownership via DNS record check.

This checks if the required DNS records (TXT, CNAME, or A) have been properly configured and are propagating correctly. DNS propagation can take up to 48 hours.

Parameters

• options

Verification options

• options.domainId: string

The ID of the domain to verify

Returns

Promise<Pick<object, "__typename" | "createdAt" | "id" | "updatedAt" | "hostname" | "status" | "dnslinkStatus" | "errorMessage" | "isVerified">>

Promise<boolean> True if verification successful, false otherwise

Example

// Verify domain after adding DNS records
const domain = await sdk.domains().createCustomDomain({
  siteId: 'site-123',
  hostname: 'example.com'
});

// Add DNS record as instructed, then verify
const isVerified = await sdk.domains().verifyCustomDomain({
  domainId: domain.id
});

if (isVerified) {
  console.log('Domain verified successfully!');
}

Defined in

src/clients/domains.ts:441

verifyDomain()

verifyDomain(__namedParameters): Promise<Pick<object, "__typename" | "createdAt" | "id" | "updatedAt" | "hostname" | "status" | "dnslinkStatus" | "errorMessage" | "isVerified">>

Parameters

• __namedParameters

• __namedParameters.domainId: string

Returns

Promise<Pick<object, "__typename" | "createdAt" | "id" | "updatedAt" | "hostname" | "status" | "dnslinkStatus" | "errorMessage" | "isVerified">>

Defined in

src/clients/domains.ts:248

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/domains / Domain

Type Alias: Domain

Domain: Pick<DomainWithRelations, "id" | "zone" | "hostname" | "isVerified" | "updatedAt" | "createdAt" | "dnsConfigs" | "status"> & object

Type declaration

arnsName?

optional arnsName: string

dnsCheckAttempts?

optional dnsCheckAttempts: number

dnsVerifiedAt?

optional dnsVerifiedAt: string

domainType?

optional domainType: "WEB2" | "ARNS" | "ENS" | "IPNS"

ensName?

optional ensName: string

expectedARecord?

optional expectedARecord: string

expectedCname?

optional expectedCname: string

ipnsHash?

optional ipnsHash: string

lastDnsCheck?

optional lastDnsCheck: string

sslAutoRenew?

optional sslAutoRenew: boolean

sslExpiresAt?

optional sslExpiresAt: string

sslIssuedAt?

optional sslIssuedAt: string

sslStatus?

optional sslStatus: "NONE" | "PENDING" | "ACTIVE" | "EXPIRED" | "FAILED"

txtVerificationStatus?

optional txtVerificationStatus: "PENDING" | "VERIFIED" | "FAILED"

txtVerificationToken?

optional txtVerificationToken: string

verified?

optional verified: boolean

Defined in

src/clients/domains.ts:23

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/domains / DomainsClientOptions

Type Alias: DomainsClientOptions

DomainsClientOptions: object

Type declaration

graphqlClient

graphqlClient: Client

Defined in

src/clients/domains.ts:19

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/domains / Zone

Type Alias: Zone

Zone: Pick<ZoneWithRelations, "id" | "originUrl" | "createdAt" | "updatedAt" | "type" | "status">

Defined in

src/clients/domains.ts:53

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/ens

clients/ens

Index

Classes

• EnsClient

Type Aliases

• EnsClientOptions
• EnsRecord

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/ens / EnsClient

Class: EnsClient

Constructors

new EnsClient()

new EnsClient(options): EnsClient

Parameters

• options: EnsClientOptions

Returns

EnsClient

Defined in

src/clients/ens.ts:40

Methods

create()

create(__namedParameters): Promise<EnsRecord>

Parameters

• __namedParameters

• __namedParameters.ipnsRecordId: string

• __namedParameters.name: string

• __namedParameters.siteId: string

Returns

Promise<EnsRecord>

Defined in

src/clients/ens.ts:44

delete()

delete(__namedParameters): Promise<EnsRecord>

Parameters

• __namedParameters

• __namedParameters.id: string

Returns

Promise<EnsRecord>

Defined in

src/clients/ens.ts:120

get()

get(__namedParameters): Promise<EnsRecord>

Parameters

• __namedParameters

• __namedParameters.id: string

Returns

Promise<EnsRecord>

Defined in

src/clients/ens.ts:72

getByName()

getByName(__namedParameters): Promise<EnsRecord>

Parameters

• __namedParameters

• __namedParameters.name: string

Returns

Promise<EnsRecord>

Defined in

src/clients/ens.ts:88

list()

list(): Promise<EnsRecord[]>

Returns

Promise<EnsRecord[]>

Defined in

src/clients/ens.ts:136

listByIpnsRecordId()

listByIpnsRecordId(__namedParameters): Promise<EnsRecord[]>

Parameters

• __namedParameters

• __namedParameters.ipnsRecordId: string

Returns

Promise<EnsRecord[]>

Defined in

src/clients/ens.ts:149

verify()

verify(__namedParameters): Promise<EnsRecord>

Parameters

• __namedParameters

• __namedParameters.id: string

Returns

Promise<EnsRecord>

Defined in

src/clients/ens.ts:104

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/ens / EnsClientOptions

Type Alias: EnsClientOptions

EnsClientOptions: object

Type declaration

graphqlClient

graphqlClient: Client

Defined in

src/clients/ens.ts:17

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/ens / EnsRecord

Type Alias: EnsRecord

EnsRecord: Omit<EnsRecordWithRelations, "site" | "ipnsRecord"> & object

Type declaration

ipnsRecord

ipnsRecord: Pick<EnsRecordWithRelations["ipnsRecord"], "id" | "name" | "hash"> & object

Type declaration

id

id: string

site

site: Pick<EnsRecordWithRelations["site"], "id">

Defined in

src/clients/ens.ts:7

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/functions

clients/functions

Index

Classes

• FunctionsClient

Type Aliases

• AFFunction
• CreateAFFunctionArgs
• DeleteAFFunctionArgs
• DeployAFFunctionArgs
• FunctionsClientOptions
• GetAFFunctionArgs
• ListAFFunctionArgs
• UpdateAFFunctionArgs

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/functions / FunctionsClient

Class: FunctionsClient

Constructors

new FunctionsClient()

new FunctionsClient(options): FunctionsClient

Parameters

• options: FunctionsClientOptions

Returns

FunctionsClient

Defined in

src/clients/functions.ts:72

Methods

create()

create(__namedParameters): Promise<Pick<object, "__typename" | "createdAt" | "id" | "name" | "updatedAt" | "deployments" | "site" | "status" | "siteId" | "currentDeployment" | "currentDeploymentId" | "invokeUrl" | "projectId" | "slug">>

Parameters

• __namedParameters: CreateAFFunctionArgs

Returns

Promise<Pick<object, "__typename" | "createdAt" | "id" | "name" | "updatedAt" | "deployments" | "site" | "status" | "siteId" | "currentDeployment" | "currentDeploymentId" | "invokeUrl" | "projectId" | "slug">>

Defined in

src/clients/functions.ts:123

delete()

delete(__namedParameters): Promise<Pick<object, "__typename" | "createdAt" | "id" | "name" | "updatedAt" | "deployments" | "site" | "status" | "siteId" | "currentDeployment" | "currentDeploymentId" | "invokeUrl" | "projectId" | "slug">>

Parameters

• __namedParameters: DeleteAFFunctionArgs

Returns

Promise<Pick<object, "__typename" | "createdAt" | "id" | "name" | "updatedAt" | "deployments" | "site" | "status" | "siteId" | "currentDeployment" | "currentDeploymentId" | "invokeUrl" | "projectId" | "slug">>

Defined in

src/clients/functions.ts:162

deploy()

deploy(__namedParameters): Promise<AFFunctionDeployment>

Parameters

• __namedParameters: DeployAFFunctionArgs

Returns

Promise<AFFunctionDeployment>

Defined in

src/clients/functions.ts:141

get()

get(__namedParameters): Promise<AFFunction>

Parameters

• __namedParameters: GetAFFunctionArgs

Returns

Promise<AFFunction>

Defined in

src/clients/functions.ts:76

list()

list(): Promise<AFFunction[]>

Returns

Promise<AFFunction[]>

Defined in

src/clients/functions.ts:92

listDeployments()

listDeployments(__namedParameters): Promise<AFFunctionDeployment[]>

Parameters

• __namedParameters: ListAFFunctionArgs

Returns

Promise<AFFunctionDeployment[]>

Defined in

src/clients/functions.ts:106

update()

update(__namedParameters): Promise<Pick<object, "__typename" | "createdAt" | "id" | "name" | "updatedAt" | "deployments" | "site" | "status" | "siteId" | "currentDeployment" | "currentDeploymentId" | "invokeUrl" | "projectId" | "slug">>

Parameters

• __namedParameters: UpdateAFFunctionArgs

Returns

Promise<Pick<object, "__typename" | "createdAt" | "id" | "name" | "updatedAt" | "deployments" | "site" | "status" | "siteId" | "currentDeployment" | "currentDeploymentId" | "invokeUrl" | "projectId" | "slug">>

Defined in

src/clients/functions.ts:178

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/functions / AFFunction

Type Alias: AFFunction

AFFunction: Omit<OriginalAFFunction, "projectId" | "site">

Defined in

src/clients/functions.ts:14

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/functions / CreateAFFunctionArgs

Type Alias: CreateAFFunctionArgs

CreateAFFunctionArgs: object

Type declaration

name

name: string

routes?

optional routes: Record<string, string> | null

siteId?

optional siteId: string

Defined in

src/clients/functions.ts:19

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/functions / DeleteAFFunctionArgs

Type Alias: DeleteAFFunctionArgs

DeleteAFFunctionArgs: object

Type declaration

id

id: string

Defined in

src/clients/functions.ts:24

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/functions / DeployAFFunctionArgs

Type Alias: DeployAFFunctionArgs

DeployAFFunctionArgs: object

Type declaration

assetsCid?

optional assetsCid: string

blake3Hash?

optional blake3Hash: string

cid

cid: string

functionId

functionId: string

sgx?

optional sgx: boolean

Defined in

src/clients/functions.ts:34

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/functions / FunctionsClientOptions

Type Alias: FunctionsClientOptions

FunctionsClientOptions: object

Type declaration

graphqlClient

graphqlClient: Client

Defined in

src/clients/functions.ts:10

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/functions / GetAFFunctionArgs

Type Alias: GetAFFunctionArgs

GetAFFunctionArgs: object

Type declaration

name

name: string

Defined in

src/clients/functions.ts:16

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/functions / ListAFFunctionArgs

Type Alias: ListAFFunctionArgs

ListAFFunctionArgs: object

Type declaration

functionId

functionId: string

Defined in

src/clients/functions.ts:41

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/functions / UpdateAFFunctionArgs

Type Alias: UpdateAFFunctionArgs

UpdateAFFunctionArgs: object

Type declaration

id

id: string

name?

optional name: string

routes?

optional routes: Record<string, string> | null

slug?

optional slug: string

status?

optional status: AFFunctionStatus

Defined in

src/clients/functions.ts:27

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/ipfs

clients/ipfs

Index

Classes

• IpfsClient

Type Aliases

• AddAllOptions
• AddFromPathOptions
• IpfsClientOptions
• IpfsFile
• UploadResult

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/ipfs / IpfsClient

Class: IpfsClient

Constructors

new IpfsClient()

new IpfsClient(options): IpfsClient

Parameters

• options: IpfsClientOptions

Returns

IpfsClient

Defined in

src/clients/ipfs.ts:47

Methods

add()

add(file): Promise<UploadResult>

Parameters

• file: IpfsFile

Returns

Promise<UploadResult>

Defined in

src/clients/ipfs.ts:68

addAll()

addAll(files, options): Promise<UploadResult[]>

Parameters

• files: IpfsFile[] | AsyncGenerator<GlobSourceResult, void, unknown>

• options: AddAllOptions = {}

Returns

Promise<UploadResult[]>

Defined in

src/clients/ipfs.ts:89

addFromPath()

addFromPath(path, options): Promise<object[]>

Parameters

• path: string

• options: AddFromPathOptions = {}

Returns

Promise<object[]>

Defined in

src/clients/ipfs.ts:161

addSitesToIpfs()

addSitesToIpfs(path, options): Promise<object[]>

Parameters

• path: string

• options: AddFromPathOptions = {}

Returns

Promise<object[]>

Defined in

src/clients/ipfs.ts:201

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/ipfs / AddAllOptions

Type Alias: AddAllOptions

AddAllOptions: object

Type declaration

basename?

optional basename: string

searchParams?

optional searchParams: URLSearchParams

siteId?

optional siteId: string

wrapWithDirectory?

optional wrapWithDirectory: boolean

Defined in

src/clients/ipfs.ts:26

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/ipfs / AddFromPathOptions

Type Alias: AddFromPathOptions

AddFromPathOptions: object

Type declaration

searchParams?

optional searchParams: URLSearchParams

siteId?

optional siteId: string

wrapWithDirectory?

optional wrapWithDirectory: boolean

Defined in

src/clients/ipfs.ts:33

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/ipfs / IpfsClientOptions

Type Alias: IpfsClientOptions

IpfsClientOptions: object

Type declaration

uploadProxyClient

uploadProxyClient: UploadProxyClient

Defined in

src/clients/ipfs.ts:22

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/ipfs / IpfsFile

Type Alias: IpfsFile

IpfsFile: object

Type declaration

content

content: ArrayBuffer | string

path?

optional path: string

Defined in

src/clients/ipfs.ts:17

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/ipfs / UploadResult

Type Alias: UploadResult

UploadResult: object

Type declaration

cid

cid: CID

path

path: string

size

size: number

Defined in

src/clients/ipfs.ts:39

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/ipns

clients/ipns

Index

Classes

• IpnsClient

Type Aliases

• CreateRecordForSiteArgs
• DeleteRecordArgs
• GetRecordArgs
• IpnsClientOptions
• IpnsRecord
• PublishRecordArgs
• PublishSignedNameArgs
• ResolveNameArgs

@alternatefutures/sdk • Docs

@alternatefutures/sdk / clients/ipns / IpnsClient

Class: IpnsClient

Constructors

new IpnsClient()

new IpnsClient(options): IpnsClient

Parameters

• options: IpnsClientOptions

Returns

IpnsClient

Defined in

src/clients/ipns.ts:54

Methods

createRecord()

createRecord(): Promise<IpnsRecord>

Returns

Promise<IpnsRecord>

Defined in

src/clients/ipns.ts:110

createRecordForSite()

createRecordForSite(__namedParameters): Promise<IpnsRecord>

Parameters

• __namedParameters: CreateRecordForSiteArgs

Returns

Promise<IpnsRecord>

Defined in

src/clients/ipns.ts:119

deleteRecord()

deleteRecord(__namedParameters): Promise<IpnsRecord>

Parameters

• __namedParameters: DeleteRecordArgs

Returns