SDK API Reference

This documentation is auto-generated from the cloud-sdk repository using TypeDoc.

@alternatefutures/sdk

@alternatefutures/sdk

Table of contents

Classes

• AlternateFuturesSdk
• ApplicationAccessTokenService
• BillingClient
• PersonalAccessTokenService
• StaticAccessTokenService

Interfaces

• ApplicationWhiteLabelDomain
• ApplicationWhitelistDomain
• Client

Type Aliases

• AFFunction
• AFFunctionStatus
• Application
• CurrentUsage
• Customer
• Deployment
• Domain
• DomainStatus
• EnsRecord
• Invoice
• InvoiceLineItem
• IpfsFile
• IpnsRecord
• Payment
• PaymentMethod
• PrivateGateway
• Project
• Site
• StoragePin
• Subscription
• UploadContentOptions
• UploadPinResponse
• UploadProgress
• UsageMetric
• UsageRecord
• Zone

Functions

• createClient

Type Aliases

AFFunction

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

Defined in

src/clients/functions.ts:14

---

AFFunctionStatus

Ƭ AFFunctionStatus: "ACTIVE" | "INACTIVE"

Defined in

node_modules/.pnpm/@alternatefutures+utils-genql-client@0.2.0/node_modules/@alternatefutures/utils-genql-client/dist/schema.ts:551

---

Application

Ƭ Application: Omit<ApplicationWithRelations, "__typename" | "whitelistDomains"> & { whitelistDomains: string[] } & { whiteLabelDomains: string[] }

Defined in

src/clients/applications.ts:8

---

CurrentUsage

Ƭ CurrentUsage: Object

Type declaration

Name	Type
bandwidth	UsageMetric
compute	UsageMetric
periodEnd?	number
periodStart?	number
requests	UsageMetric
storage	UsageMetric
total	number

Defined in

src/clients/billing.ts:96

---

Customer

Ƭ Customer: Object

Type declaration

Name	Type
createdAt	number
email?	string
id	string
name?	string

Defined in

src/clients/billing.ts:9

---

Deployment

Ƭ Deployment: Pick<DeploymentWithRelations, "id" | "status" | "storageType" | "siteId" | "cid" | "updatedAt" | "createdAt">

Defined in

src/clients/sites.ts:22

---

Domain

Ƭ Domain: Pick<DomainWithRelations, "id" | "zone" | "hostname" | "isVerified" | "updatedAt" | "createdAt" | "dnsConfigs" | "status"> & { arnsName?: string ; dnsCheckAttempts?: number ; dnsVerifiedAt?: string ; domainType?: "WEB2" | "ARNS" | "ENS" | "IPNS" ; ensName?: string ; expectedARecord?: string ; expectedCname?: string ; ipnsHash?: string ; lastDnsCheck?: string ; sslAutoRenew?: boolean ; sslExpiresAt?: string ; sslIssuedAt?: string ; sslStatus?: "NONE" | "PENDING" | "ACTIVE" | "EXPIRED" | "FAILED" ; txtVerificationStatus?: "PENDING" | "VERIFIED" | "FAILED" ; txtVerificationToken?: string ; verified?: boolean }

Defined in

src/clients/domains.ts:23

---

DomainStatus

Ƭ DomainStatus: "ACTIVE" | "CREATED" | "CREATING" | "CREATING_FAILED" | "DELETING" | "DELETING_FAILED" | "VERIFYING" | "VERIFYING_FAILED"

Defined in

node_modules/.pnpm/@alternatefutures+utils-genql-client@0.2.0/node_modules/@alternatefutures/utils-genql-client/dist/schema.ts:375

---

EnsRecord

Ƭ EnsRecord: Omit<EnsRecordWithRelations, "site" | "ipnsRecord"> & { ipnsRecord: Pick<EnsRecordWithRelations["ipnsRecord"], "id" | "name" | "hash"> & { id: string } ; site: Pick<EnsRecordWithRelations["site"], "id"> }

Defined in

src/clients/ens.ts:7

---

Invoice

Ƭ Invoice: Object

Type declaration

Name	Type
amountDue	number
amountPaid	number
createdAt	number
currency	string
dueDate?	number
id	string
invoiceNumber	string
lineItems?	InvoiceLineItem[]
paidAt?	number
pdfUrl?	string
periodEnd?	number
periodStart?	number
status	"DRAFT" | "OPEN" | "PAID" | "VOID" | "UNCOLLECTIBLE"
subtotal	number
tax	number
total	number

Defined in

src/clients/billing.ts:60

---

InvoiceLineItem

Ƭ InvoiceLineItem: Object

Type declaration

Name	Type
amount	number
description	string
id	string
quantity	number
unitPrice	number

Defined in

src/clients/billing.ts:52

---

IpfsFile

Ƭ IpfsFile: Object

Type declaration

Name	Type
content	ArrayBuffer | string
path?	string

Defined in

src/clients/ipfs.ts:17

---

IpnsRecord

Ƭ IpnsRecord: Pick<IpnsRecordWithRelations, "id" | "name" | "hash"> & { ensRecords: Pick<IpnsRecordWithRelations["ensRecords"][number], "id">[] }

Defined in

src/clients/ipns.ts:37

---

Payment

Ƭ Payment: Object

Type declaration

Name	Type
amount	number
blockchain?	string
createdAt	number
currency	string
id	string
invoiceId?	string
provider?	string
status	"PENDING" | "SUCCEEDED" | "FAILED"
txHash?	string

Defined in

src/clients/billing.ts:79

---

PaymentMethod

Ƭ PaymentMethod: Object

Type declaration

Name	Type
blockchain?	string
cardBrand?	string
cardExpMonth?	number
cardExpYear?	number
cardLast4?	string
createdAt	number
id	string
isDefault	boolean
provider?	string
type	"CARD" | "CRYPTO"
walletAddress?	string

Defined in

src/clients/billing.ts:16

---

PrivateGateway

Ƭ PrivateGateway: Omit<PrivateGatewayWithRelations, "project" | "domains" | "domainsPaginated" | "primaryDomain"> & { project: Pick<Project, "id"> }

Defined in

src/clients/privateGateway.ts:26

---

Project

Ƭ Project: Omit<ProjectWithRelations, "currentUserMembership" | "memberships" | "membershipsPaginated">

Defined in

src/clients/projects.ts:26

---

Site

Ƭ Site: Pick<SiteWithRelations, "id" | "name" | "slug"> & { deployments: Deployment[] ; domains: Pick<SiteWithRelations["domains"][number], "id" | "hostname">[] ; ipnsRecords: Pick<SiteWithRelations["ipnsRecords"][number], "id">[] ; primaryDomain?: Pick<DomainWithRelations, "id" | "hostname"> ; zones: Pick<SiteWithRelations["zones"][number], "id" | "status">[] }

Defined in

src/clients/sites.ts:27

---

StoragePin

Ƭ StoragePin: Pick<Pin, "cid" | "filename" | "extension" | "arweavePin"> & { arweaveId?: string ; filecoinDealIds?: string }

Defined in

src/clients/storage.ts:36

---

Subscription

Ƭ Subscription: Object

Type declaration

Name	Type
basePricePerSeat	number
cancelAt?	number
createdAt	number
currentPeriodEnd	number
currentPeriodStart	number
id	string
plan	"FREE" | "STARTER" | "PRO" | "ENTERPRISE"
seats	number
status	"ACTIVE" | "CANCELED" | "PAST_DUE" | "UNPAID" | "TRIALING"
trialEnd?	number
usageMarkup	number

Defined in

src/clients/billing.ts:38

---

UploadContentOptions

Ƭ UploadContentOptions: Object

Type declaration

Name	Type
functionName?	string
siteId?	string

Defined in

src/clients/uploadProxy.ts:60

---

UploadPinResponse

Ƭ UploadPinResponse: Object

Type declaration

Name	Type
duplicate	boolean
pin	Pick<Pin, "cid" | "size">

Defined in

src/clients/uploadProxy.ts:65

---

UploadProgress

Ƭ UploadProgress: Object

Type declaration

Name	Type
loadedSize	number
totalSize?	number

Defined in

src/clients/uploadProxy.ts:36

---

UsageMetric

Ƭ UsageMetric: Object

Type declaration

Name	Type
amount	number
quantity	number

Defined in

src/clients/billing.ts:91

---

UsageRecord

Ƭ UsageRecord: Object

Type declaration

Name	Type
amount	number
createdAt	number
id	string
metricType	"storage" | "bandwidth" | "compute" | "requests"
periodEnd	number
periodStart	number
quantity	number
recordedAt	number
unitPrice	number

Defined in

src/clients/billing.ts:106

---

Zone

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

Defined in

src/clients/domains.ts:53

Functions

createClient

▸ createClient(options?): Client

Parameters

Name	Type
options?	ClientOptions

Returns

Client

Defined in

node_modules/.pnpm/@alternatefutures+utils-genql-client@0.2.0/node_modules/@alternatefutures/utils-genql-client/dist/index.ts:34