# SDK API reference (/sdk/api) {/* AUTO-GENERATED by scripts/generate-sdk-docs.mjs from @alternatefutures/sdk@0.2.5 - do not edit by hand. */} **@alternatefutures/sdk** • **Docs** *** # @alternatefutures/sdk [#alternatefuturessdk] ## Modules [#modules] * [clients/applications](clients/applications/README.md) * [clients/billing](clients/billing/README.md) * [clients/domains](clients/domains/README.md) * [clients/ens](clients/ens/README.md) * [clients/functions](clients/functions/README.md) * [clients/ipfs](clients/ipfs/README.md) * [clients/ipns](clients/ipns/README.md) * [clients/privateGateway](clients/privateGateway/README.md) * [clients/projects](clients/projects/README.md) * [clients/sites](clients/sites/README.md) * [clients/storage](clients/storage/README.md) * [clients/uploadProxy](clients/uploadProxy/README.md) * [clients/user](clients/user/README.md) * [index](index/README.md) *** [**@alternatefutures/sdk**](../../README.md) • **Docs** *** [@alternatefutures/sdk](../../README.md) / clients/applications # clients/applications [#clientsapplications] ## Index [#index] ### Classes [#classes] * [ApplicationsClient](classes/ApplicationsClient.md) ### Type Aliases [#type-aliases] * [Application](type-aliases/Application.md) * [ApplicationsClientOptions](type-aliases/ApplicationsClientOptions.md) * [CreateApplicationArgs](type-aliases/CreateApplicationArgs.md) * [DeleteApplicationArgs](type-aliases/DeleteApplicationArgs.md) * [GetApplicationArgs](type-aliases/GetApplicationArgs.md) * [UpdateApplicationArgs](type-aliases/UpdateApplicationArgs.md) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/applications](../README.md) / ApplicationsClient # Class: ApplicationsClient [#class-applicationsclient] ## Constructors [#constructors] ### new ApplicationsClient() [#new-applicationsclient] > **new ApplicationsClient**(`options`): [`ApplicationsClient`](ApplicationsClient.md) #### Parameters [#parameters] • **options**: [`ApplicationsClientOptions`](../type-aliases/ApplicationsClientOptions.md) #### Returns [#returns] [`ApplicationsClient`](ApplicationsClient.md) #### Defined in [#defined-in] [src/clients/applications.ts:53](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/applications.ts#L53) ## Methods [#methods] ### create() [#create] > **create**(`__namedParameters`): `Promise`\<`Pick`\<`object`, `"whitelistDomains"` | `"clientId"` | `"createdAt"` | `"id"` | `"name"` | `"updatedAt"` | `"whiteLabelDomains"`>> #### Parameters [#parameters-1] • **\_\_namedParameters**: [`CreateApplicationArgs`](../type-aliases/CreateApplicationArgs.md) #### Returns [#returns-1] `Promise`\<`Pick`\<`object`, `"whitelistDomains"` | `"clientId"` | `"createdAt"` | `"id"` | `"name"` | `"updatedAt"` | `"whiteLabelDomains"`>> #### Defined in [#defined-in-1] [src/clients/applications.ts:84](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/applications.ts#L84) *** ### delete() [#delete] > **delete**(`__namedParameters`): `Promise`\<`Pick`\<`object`, `"whitelistDomains"` | `"clientId"` | `"createdAt"` | `"id"` | `"name"` | `"updatedAt"` | `"whiteLabelDomains"`>> #### Parameters [#parameters-2] • **\_\_namedParameters**: [`DeleteApplicationArgs`](../type-aliases/DeleteApplicationArgs.md) #### Returns [#returns-2] `Promise`\<`Pick`\<`object`, `"whitelistDomains"` | `"clientId"` | `"createdAt"` | `"id"` | `"name"` | `"updatedAt"` | `"whiteLabelDomains"`>> #### Defined in [#defined-in-2] [src/clients/applications.ts:129](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/applications.ts#L129) *** ### get() [#get] > **get**(`__namedParameters`): `Promise`\<`Pick`\<`object`, `"whitelistDomains"` | `"clientId"` | `"createdAt"` | `"id"` | `"name"` | `"updatedAt"` | `"whiteLabelDomains"`>> #### Parameters [#parameters-3] • **\_\_namedParameters**: [`GetApplicationArgs`](../type-aliases/GetApplicationArgs.md) #### Returns [#returns-3] `Promise`\<`Pick`\<`object`, `"whitelistDomains"` | `"clientId"` | `"createdAt"` | `"id"` | `"name"` | `"updatedAt"` | `"whiteLabelDomains"`>> #### Defined in [#defined-in-3] [src/clients/applications.ts:57](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/applications.ts#L57) *** ### list() [#list] > **list**(): `Promise`\<`Pick`\<`object`, `"whitelistDomains"` | `"clientId"` | `"createdAt"` | `"id"` | `"name"` | `"updatedAt"` | `"whiteLabelDomains"`>\[]> #### Returns [#returns-4] `Promise`\<`Pick`\<`object`, `"whitelistDomains"` | `"clientId"` | `"createdAt"` | `"id"` | `"name"` | `"updatedAt"` | `"whiteLabelDomains"`>\[]> #### Defined in [#defined-in-4] [src/clients/applications.ts:73](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/applications.ts#L73) *** ### update() [#update] > **update**(`__namedParameters`): `Promise`\<`Pick`\<`object`, `"whitelistDomains"` | `"clientId"` | `"createdAt"` | `"id"` | `"name"` | `"updatedAt"` | `"whiteLabelDomains"`>> #### Parameters [#parameters-4] • **\_\_namedParameters**: [`UpdateApplicationArgs`](../type-aliases/UpdateApplicationArgs.md) #### Returns [#returns-5] `Promise`\<`Pick`\<`object`, `"whitelistDomains"` | `"clientId"` | `"createdAt"` | `"id"` | `"name"` | `"updatedAt"` | `"whiteLabelDomains"`>> #### Defined in [#defined-in-5] [src/clients/applications.ts:104](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/applications.ts#L104) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/applications](../README.md) / Application # Type Alias: Application [#type-alias-application] > **Application**: `Omit`\<`ApplicationWithRelations`, `"__typename"` | `"whitelistDomains"`> & `object` & `object` ## Type declaration [#type-declaration] ### whitelistDomains [#whitelistdomains] > **whitelistDomains**: `string`\[] ## Type declaration [#type-declaration-1] ### whiteLabelDomains [#whitelabeldomains] > **whiteLabelDomains**: `string`\[] ## Defined in [#defined-in-6] [src/clients/applications.ts:8](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/applications.ts#L8) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/applications](../README.md) / ApplicationsClientOptions # Type Alias: ApplicationsClientOptions [#type-alias-applicationsclientoptions] > **ApplicationsClientOptions**: `object` ## Type declaration [#type-declaration-2] ### graphqlClient [#graphqlclient] > **graphqlClient**: [`Client`](../../../index/interfaces/Client.md) ## Defined in [#defined-in-7] [src/clients/applications.ts:17](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/applications.ts#L17) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/applications](../README.md) / CreateApplicationArgs # Type Alias: CreateApplicationArgs [#type-alias-createapplicationargs] > **CreateApplicationArgs**: `Pick`\<[`Application`](Application.md), `"name"` | `"whitelistDomains"`> ## Defined in [#defined-in-8] [src/clients/applications.ts:24](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/applications.ts#L24) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/applications](../README.md) / DeleteApplicationArgs # Type Alias: DeleteApplicationArgs [#type-alias-deleteapplicationargs] > **DeleteApplicationArgs**: `Pick`\<[`Application`](Application.md), `"id"`> ## Defined in [#defined-in-9] [src/clients/applications.ts:33](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/applications.ts#L33) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/applications](../README.md) / GetApplicationArgs # Type Alias: GetApplicationArgs [#type-alias-getapplicationargs] > **GetApplicationArgs**: `Pick`\<[`Application`](Application.md), `"id"`> ## Defined in [#defined-in-10] [src/clients/applications.ts:21](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/applications.ts#L21) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/applications](../README.md) / UpdateApplicationArgs # Type Alias: UpdateApplicationArgs [#type-alias-updateapplicationargs] > **UpdateApplicationArgs**: `Pick`\<[`Application`](Application.md), `"id"`> & `Partial`\<`Pick`\<[`Application`](Application.md), `"name"` | `"whitelistDomains"`>> ## Defined in [#defined-in-11] [src/clients/applications.ts:30](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/applications.ts#L30) *** [**@alternatefutures/sdk**](../../README.md) • **Docs** *** [@alternatefutures/sdk](../../README.md) / clients/billing # clients/billing [#clientsbilling] ## Index [#index-1] ### Classes [#classes-1] * [BillingClient](classes/BillingClient.md) ### Type Aliases [#type-aliases-1] * [BillingClientOptions](type-aliases/BillingClientOptions.md) * [ConnectedAccount](type-aliases/ConnectedAccount.md) * [CryptoPaymentRequest](type-aliases/CryptoPaymentRequest.md) * [CurrentUsage](type-aliases/CurrentUsage.md) * [Customer](type-aliases/Customer.md) * [Invoice](type-aliases/Invoice.md) * [InvoiceLineItem](type-aliases/InvoiceLineItem.md) * [Payment](type-aliases/Payment.md) * [PaymentMethod](type-aliases/PaymentMethod.md) * [Subscription](type-aliases/Subscription.md) * [SubscriptionPlan](type-aliases/SubscriptionPlan.md) * [Transfer](type-aliases/Transfer.md) * [UsageMetric](type-aliases/UsageMetric.md) * [UsageRecord](type-aliases/UsageRecord.md) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/billing](../README.md) / BillingClient # Class: BillingClient [#class-billingclient] ## Constructors [#constructors-1] ### new BillingClient() [#new-billingclient] > **new BillingClient**(`options`): [`BillingClient`](BillingClient.md) #### Parameters [#parameters-5] • **options**: [`BillingClientOptions`](../type-aliases/BillingClientOptions.md) #### Returns [#returns-6] [`BillingClient`](BillingClient.md) #### Defined in [#defined-in-12] [src/clients/billing.ts:163](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L163) ## Methods [#methods-1] ### addPaymentMethod() [#addpaymentmethod] > **addPaymentMethod**(`input`): `Promise`\<[`PaymentMethod`](../type-aliases/PaymentMethod.md)> #### Parameters [#parameters-6] • **input** • **input.blockchain?**: `string` • **input.paymentMethodId?**: `string` • **input.provider?**: `"stripe"` | `"stax"` • **input.setDefault?**: `boolean` • **input.walletAddress?**: `string` #### Returns [#returns-7] `Promise`\<[`PaymentMethod`](../type-aliases/PaymentMethod.md)> #### Defined in [#defined-in-13] [src/clients/billing.ts:214](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L214) *** ### cancelSubscription() [#cancelsubscription] > **cancelSubscription**(`__namedParameters`): `Promise`\<[`Subscription`](../type-aliases/Subscription.md)> #### Parameters [#parameters-7] • **\_\_namedParameters** • **\_\_namedParameters.id**: `string` • **\_\_namedParameters.immediately?**: `boolean` = `false` #### Returns [#returns-8] `Promise`\<[`Subscription`](../type-aliases/Subscription.md)> #### Defined in [#defined-in-14] [src/clients/billing.ts:291](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L291) *** ### createConnectedAccount() [#createconnectedaccount] > **createConnectedAccount**(`input`): `Promise`\<[`ConnectedAccount`](../type-aliases/ConnectedAccount.md)> #### Parameters [#parameters-8] • **input** • **input.accountType?**: `"standard"` | `"express"` | `"custom"` • **input.businessName?**: `string` • **input.country?**: `string` • **input.email**: `string` • **input.provider?**: `"stripe"` | `"stax"` #### Returns [#returns-9] `Promise`\<[`ConnectedAccount`](../type-aliases/ConnectedAccount.md)> #### Defined in [#defined-in-15] [src/clients/billing.ts:444](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L444) *** ### createCryptoPayment() [#createcryptopayment] > **createCryptoPayment**(`__namedParameters`): `Promise`\<[`CryptoPaymentRequest`](../type-aliases/CryptoPaymentRequest.md)> #### Parameters [#parameters-9] • **\_\_namedParameters** • **\_\_namedParameters.chainId?**: `number` = `1` • **\_\_namedParameters.invoiceId**: `string` • **\_\_namedParameters.tokenSymbol?**: `string` = `'usdc'` #### Returns [#returns-10] `Promise`\<[`CryptoPaymentRequest`](../type-aliases/CryptoPaymentRequest.md)> #### Defined in [#defined-in-16] [src/clients/billing.ts:405](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L405) *** ### createDashboardLink() [#createdashboardlink] > **createDashboardLink**(`accountId`): `Promise`\<`object`> #### Parameters [#parameters-10] • **accountId**: `string` #### Returns [#returns-11] `Promise`\<`object`> ##### url [#url] > **url**: `string` #### Defined in [#defined-in-17] [src/clients/billing.ts:482](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L482) *** ### createOnboardingLink() [#createonboardinglink] > **createOnboardingLink**(`__namedParameters`): `Promise`\<`object`> #### Parameters [#parameters-11] • **\_\_namedParameters** • **\_\_namedParameters.accountId**: `string` • **\_\_namedParameters.refreshUrl**: `string` • **\_\_namedParameters.returnUrl**: `string` #### Returns [#returns-12] `Promise`\<`object`> ##### expiresAt [#expiresat] > **expiresAt**: `number` ##### url [#url-1] > **url**: `string` #### Defined in [#defined-in-18] [src/clients/billing.ts:463](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L463) *** ### createSubscription() [#createsubscription] > **createSubscription**(`input`): `Promise`\<[`Subscription`](../type-aliases/Subscription.md)> #### Parameters [#parameters-12] • **input** • **input.paymentMethodId?**: `string` • **input.planId**: `string` • **input.seats?**: `number` #### Returns [#returns-13] `Promise`\<[`Subscription`](../type-aliases/Subscription.md)> #### Defined in [#defined-in-19] [src/clients/billing.ts:279](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L279) *** ### createTransfer() [#createtransfer] > **createTransfer**(`input`): `Promise`\<[`Transfer`](../type-aliases/Transfer.md)> #### Parameters [#parameters-13] • **input** • **input.amount**: `number` • **input.connectedAccountId**: `string` • **input.currency?**: `string` • **input.description?**: `string` • **input.sourcePaymentId?**: `string` #### Returns [#returns-14] `Promise`\<[`Transfer`](../type-aliases/Transfer.md)> #### Defined in [#defined-in-20] [src/clients/billing.ts:505](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L505) *** ### deleteConnectedAccount() [#deleteconnectedaccount] > **deleteConnectedAccount**(`id`): `Promise`\<`boolean`> #### Parameters [#parameters-14] • **id**: `string` #### Returns [#returns-15] `Promise`\<`boolean`> #### Defined in [#defined-in-21] [src/clients/billing.ts:489](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L489) *** ### generateInvoice() [#generateinvoice] > **generateInvoice**(): `Promise`\<[`Invoice`](../type-aliases/Invoice.md)> #### Returns [#returns-16] `Promise`\<[`Invoice`](../type-aliases/Invoice.md)> #### Defined in [#defined-in-22] [src/clients/billing.ts:343](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L343) *** ### getActiveSubscription() [#getactivesubscription] > **getActiveSubscription**(): `Promise`\<`null` | [`Subscription`](../type-aliases/Subscription.md)> #### Returns [#returns-17] `Promise`\<`null` | [`Subscription`](../type-aliases/Subscription.md)> #### Defined in [#defined-in-23] [src/clients/billing.ts:269](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L269) *** ### getConnectedAccount() [#getconnectedaccount] > **getConnectedAccount**(`id`): `Promise`\<`null` | [`ConnectedAccount`](../type-aliases/ConnectedAccount.md)> #### Parameters [#parameters-15] • **id**: `string` #### Returns [#returns-18] `Promise`\<`null` | [`ConnectedAccount`](../type-aliases/ConnectedAccount.md)> #### Defined in [#defined-in-24] [src/clients/billing.ts:458](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L458) *** ### getCurrentUsage() [#getcurrentusage] > **getCurrentUsage**(): `Promise`\<`null` | [`CurrentUsage`](../type-aliases/CurrentUsage.md)> #### Returns [#returns-19] `Promise`\<`null` | [`CurrentUsage`](../type-aliases/CurrentUsage.md)> #### Defined in [#defined-in-25] [src/clients/billing.ts:354](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L354) *** ### getCustomer() [#getcustomer] > **getCustomer**(): `Promise`\<`null` | [`Customer`](../type-aliases/Customer.md)> #### Returns [#returns-20] `Promise`\<`null` | [`Customer`](../type-aliases/Customer.md)> #### Defined in [#defined-in-26] [src/clients/billing.ts:192](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L192) *** ### getInvoice() [#getinvoice] > **getInvoice**(`__namedParameters`): `Promise`\<`null` | [`Invoice`](../type-aliases/Invoice.md)> #### Parameters [#parameters-16] • **\_\_namedParameters** • **\_\_namedParameters.id**: `string` #### Returns [#returns-21] `Promise`\<`null` | [`Invoice`](../type-aliases/Invoice.md)> #### Defined in [#defined-in-27] [src/clients/billing.ts:338](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L338) *** ### getPlatformBalance() [#getplatformbalance] > **getPlatformBalance**(): `Promise`\<`object`\[]> #### Returns [#returns-22] `Promise`\<`object`\[]> #### Defined in [#defined-in-28] [src/clients/billing.ts:519](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L519) *** ### getSubscriptionPlans() [#getsubscriptionplans] > **getSubscriptionPlans**(): `Promise`\<[`SubscriptionPlan`](../type-aliases/SubscriptionPlan.md)\[]> #### Returns [#returns-23] `Promise`\<[`SubscriptionPlan`](../type-aliases/SubscriptionPlan.md)\[]> #### Defined in [#defined-in-29] [src/clients/billing.ts:274](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L274) *** ### getUsageHistory() [#getusagehistory] > **getUsageHistory**(`limit`): `Promise`\<[`UsageRecord`](../type-aliases/UsageRecord.md)\[]> #### Parameters [#parameters-17] • **limit**: `number` = `100` #### Returns [#returns-24] `Promise`\<[`UsageRecord`](../type-aliases/UsageRecord.md)\[]> #### Defined in [#defined-in-30] [src/clients/billing.ts:359](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L359) *** ### listConnectedAccounts() [#listconnectedaccounts] > **listConnectedAccounts**(): `Promise`\<[`ConnectedAccount`](../type-aliases/ConnectedAccount.md)\[]> #### Returns [#returns-25] `Promise`\<[`ConnectedAccount`](../type-aliases/ConnectedAccount.md)\[]> #### Defined in [#defined-in-31] [src/clients/billing.ts:439](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L439) *** ### listInvoices() [#listinvoices] > **listInvoices**(`__namedParameters`): `Promise`\<[`Invoice`](../type-aliases/Invoice.md)\[]> #### Parameters [#parameters-18] • **\_\_namedParameters** = `{}` • **\_\_namedParameters.limit?**: `number` = `50` • **\_\_namedParameters.status?**: `string` #### Returns [#returns-26] `Promise`\<[`Invoice`](../type-aliases/Invoice.md)\[]> #### Defined in [#defined-in-32] [src/clients/billing.ts:323](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L323) *** ### listPaymentMethods() [#listpaymentmethods] > **listPaymentMethods**(): `Promise`\<[`PaymentMethod`](../type-aliases/PaymentMethod.md)\[]> #### Returns [#returns-27] `Promise`\<[`PaymentMethod`](../type-aliases/PaymentMethod.md)\[]> #### Defined in [#defined-in-33] [src/clients/billing.ts:209](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L209) *** ### listPayments() [#listpayments] > **listPayments**(`limit`): `Promise`\<[`Payment`](../type-aliases/Payment.md)\[]> #### Parameters [#parameters-19] • **limit**: `number` = `50` #### Returns [#returns-28] `Promise`\<[`Payment`](../type-aliases/Payment.md)\[]> #### Defined in [#defined-in-34] [src/clients/billing.ts:380](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L380) *** ### listSubscriptions() [#listsubscriptions] > **listSubscriptions**(): `Promise`\<[`Subscription`](../type-aliases/Subscription.md)\[]> #### Returns [#returns-29] `Promise`\<[`Subscription`](../type-aliases/Subscription.md)\[]> #### Defined in [#defined-in-35] [src/clients/billing.ts:264](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L264) *** ### listTransfers() [#listtransfers] > **listTransfers**(`connectedAccountId`?, `limit`?): `Promise`\<[`Transfer`](../type-aliases/Transfer.md)\[]> #### Parameters [#parameters-20] • **connectedAccountId?**: `string` • **limit?**: `number` = `50` #### Returns [#returns-30] `Promise`\<[`Transfer`](../type-aliases/Transfer.md)\[]> #### Defined in [#defined-in-36] [src/clients/billing.ts:496](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L496) *** ### processPayment() [#processpayment] > **processPayment**(`__namedParameters`): `Promise`\<[`Payment`](../type-aliases/Payment.md) & `object`> #### Parameters [#parameters-21] • **\_\_namedParameters** • **\_\_namedParameters.amount?**: `number` • **\_\_namedParameters.invoiceId**: `string` • **\_\_namedParameters.paymentMethodId?**: `string` #### Returns [#returns-31] `Promise`\<[`Payment`](../type-aliases/Payment.md) & `object`> #### Defined in [#defined-in-37] [src/clients/billing.ts:385](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L385) *** ### recordCryptoPayment() [#recordcryptopayment] > **recordCryptoPayment**(`input`): `Promise`\<[`Payment`](../type-aliases/Payment.md)> #### Parameters [#parameters-22] • **input** • **input.amount**: `number` • **input.blockchain**: `string` • **input.fromAddress**: `string` • **input.invoiceId**: `string` • **input.txHash**: `string` #### Returns [#returns-32] `Promise`\<[`Payment`](../type-aliases/Payment.md)> #### Defined in [#defined-in-38] [src/clients/billing.ts:421](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L421) *** ### recordUsage() [#recordusage] > **recordUsage**(`input`): `Promise`\<[`UsageRecord`](../type-aliases/UsageRecord.md)> #### Parameters [#parameters-23] • **input** • **input.metricType**: `"storage"` | `"bandwidth"` | `"compute"` | `"requests"` • **input.quantity**: `number` • **input.timestamp?**: `number` #### Returns [#returns-33] `Promise`\<[`UsageRecord`](../type-aliases/UsageRecord.md)> #### Defined in [#defined-in-39] [src/clients/billing.ts:364](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L364) *** ### removePaymentMethod() [#removepaymentmethod] > **removePaymentMethod**(`__namedParameters`): `Promise`\<`boolean`> #### Parameters [#parameters-24] • **\_\_namedParameters** • **\_\_namedParameters.id**: `string` #### Returns [#returns-34] `Promise`\<`boolean`> #### Defined in [#defined-in-40] [src/clients/billing.ts:246](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L246) *** ### setDefaultPaymentMethod() [#setdefaultpaymentmethod] > **setDefaultPaymentMethod**(`__namedParameters`): `Promise`\<`boolean`> #### Parameters [#parameters-25] • **\_\_namedParameters** • **\_\_namedParameters.id**: `string` #### Returns [#returns-35] `Promise`\<`boolean`> #### Defined in [#defined-in-41] [src/clients/billing.ts:253](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L253) *** ### updateCustomer() [#updatecustomer] > **updateCustomer**(`data`): `Promise`\<[`Customer`](../type-aliases/Customer.md)> #### Parameters [#parameters-26] • **data** • **data.email?**: `string` • **data.name?**: `string` #### Returns [#returns-36] `Promise`\<[`Customer`](../type-aliases/Customer.md)> #### Defined in [#defined-in-42] [src/clients/billing.ts:197](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L197) *** ### updateSubscriptionSeats() [#updatesubscriptionseats] > **updateSubscriptionSeats**(`__namedParameters`): `Promise`\<[`Subscription`](../type-aliases/Subscription.md)> #### Parameters [#parameters-27] • **\_\_namedParameters** • **\_\_namedParameters.id**: `string` • **\_\_namedParameters.seats**: `number` #### Returns [#returns-37] `Promise`\<[`Subscription`](../type-aliases/Subscription.md)> #### Defined in [#defined-in-43] [src/clients/billing.ts:305](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L305) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/billing](../README.md) / BillingClientOptions # Type Alias: BillingClientOptions [#type-alias-billingclientoptions] > **BillingClientOptions**: `object` ## Type declaration [#type-declaration-3] ### accessTokenService [#accesstokenservice] > **accessTokenService**: `AccessTokenService` ### authServiceUrl [#authserviceurl] > **authServiceUrl**: `string` ## Defined in [#defined-in-44] [src/clients/billing.ts:154](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L154) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/billing](../README.md) / ConnectedAccount # Type Alias: ConnectedAccount [#type-alias-connectedaccount] > **ConnectedAccount**: `object` ## Type declaration [#type-declaration-4] ### accountType [#accounttype] > **accountType**: `"standard"` | `"express"` | `"custom"` ### businessName? [#businessname] > `optional` **businessName**: `string` ### chargesEnabled [#chargesenabled] > **chargesEnabled**: `boolean` ### country? [#country] > `optional` **country**: `string` ### createdAt [#createdat] > **createdAt**: `number` ### detailsSubmitted [#detailssubmitted] > **detailsSubmitted**: `boolean` ### email? [#email] > `optional` **email**: `string` ### id [#id] > **id**: `string` ### payoutsEnabled [#payoutsenabled] > **payoutsEnabled**: `boolean` ### provider [#provider] > **provider**: `"stripe"` | `"stax"` ## Defined in [#defined-in-45] [src/clients/billing.ts:119](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L119) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/billing](../README.md) / CryptoPaymentRequest # Type Alias: CryptoPaymentRequest [#type-alias-cryptopaymentrequest] > **CryptoPaymentRequest**: `object` ## Type declaration [#type-declaration-5] ### amount [#amount] > **amount**: `number` ### chainId [#chainid] > **chainId**: `number` ### currency [#currency] > **currency**: `string` ### depositAddress [#depositaddress] > **depositAddress**: `string` ### expiresAt [#expiresat-1] > **expiresAt**: `number` ### id [#id-1] > **id**: `string` ### status [#status] > **status**: `"PENDING"` ### tokenAddress? [#tokenaddress] > `optional` **tokenAddress**: `string` ### tokenSymbol [#tokensymbol] > **tokenSymbol**: `string` ## Defined in [#defined-in-46] [src/clients/billing.ts:142](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L142) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/billing](../README.md) / CurrentUsage # Type Alias: CurrentUsage [#type-alias-currentusage] > **CurrentUsage**: `object` ## Type declaration [#type-declaration-6] ### bandwidth [#bandwidth] > **bandwidth**: [`UsageMetric`](UsageMetric.md) ### compute [#compute] > **compute**: [`UsageMetric`](UsageMetric.md) ### periodEnd? [#periodend] > `optional` **periodEnd**: `number` ### periodStart? [#periodstart] > `optional` **periodStart**: `number` ### requests [#requests] > **requests**: [`UsageMetric`](UsageMetric.md) ### storage [#storage] > **storage**: [`UsageMetric`](UsageMetric.md) ### total [#total] > **total**: `number` ## Defined in [#defined-in-47] [src/clients/billing.ts:96](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L96) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/billing](../README.md) / Customer # Type Alias: Customer [#type-alias-customer] > **Customer**: `object` ## Type declaration [#type-declaration-7] ### createdAt [#createdat-1] > **createdAt**: `number` ### email? [#email-1] > `optional` **email**: `string` ### id [#id-2] > **id**: `string` ### name? [#name] > `optional` **name**: `string` ## Defined in [#defined-in-48] [src/clients/billing.ts:9](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L9) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/billing](../README.md) / Invoice # Type Alias: Invoice [#type-alias-invoice] > **Invoice**: `object` ## Type declaration [#type-declaration-8] ### amountDue [#amountdue] > **amountDue**: `number` ### amountPaid [#amountpaid] > **amountPaid**: `number` ### createdAt [#createdat-2] > **createdAt**: `number` ### currency [#currency-1] > **currency**: `string` ### dueDate? [#duedate] > `optional` **dueDate**: `number` ### id [#id-3] > **id**: `string` ### invoiceNumber [#invoicenumber] > **invoiceNumber**: `string` ### lineItems? [#lineitems] > `optional` **lineItems**: [`InvoiceLineItem`](InvoiceLineItem.md)\[] ### paidAt? [#paidat] > `optional` **paidAt**: `number` ### pdfUrl? [#pdfurl] > `optional` **pdfUrl**: `string` ### periodEnd? [#periodend-1] > `optional` **periodEnd**: `number` ### periodStart? [#periodstart-1] > `optional` **periodStart**: `number` ### status [#status-1] > **status**: `"DRAFT"` | `"OPEN"` | `"PAID"` | `"VOID"` | `"UNCOLLECTIBLE"` ### subtotal [#subtotal] > **subtotal**: `number` ### tax [#tax] > **tax**: `number` ### total [#total-1] > **total**: `number` ## Defined in [#defined-in-49] [src/clients/billing.ts:60](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L60) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/billing](../README.md) / InvoiceLineItem # Type Alias: InvoiceLineItem [#type-alias-invoicelineitem] > **InvoiceLineItem**: `object` ## Type declaration [#type-declaration-9] ### amount [#amount-1] > **amount**: `number` ### description [#description] > **description**: `string` ### id [#id-4] > **id**: `string` ### quantity [#quantity] > **quantity**: `number` ### unitPrice [#unitprice] > **unitPrice**: `number` ## Defined in [#defined-in-50] [src/clients/billing.ts:52](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L52) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/billing](../README.md) / Payment # Type Alias: Payment [#type-alias-payment] > **Payment**: `object` ## Type declaration [#type-declaration-10] ### amount [#amount-2] > **amount**: `number` ### blockchain? [#blockchain] > `optional` **blockchain**: `string` ### createdAt [#createdat-3] > **createdAt**: `number` ### currency [#currency-2] > **currency**: `string` ### id [#id-5] > **id**: `string` ### invoiceId? [#invoiceid] > `optional` **invoiceId**: `string` ### provider? [#provider-1] > `optional` **provider**: `string` ### status [#status-2] > **status**: `"PENDING"` | `"SUCCEEDED"` | `"FAILED"` ### txHash? [#txhash] > `optional` **txHash**: `string` ## Defined in [#defined-in-51] [src/clients/billing.ts:79](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L79) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/billing](../README.md) / PaymentMethod # Type Alias: PaymentMethod [#type-alias-paymentmethod] > **PaymentMethod**: `object` ## Type declaration [#type-declaration-11] ### blockchain? [#blockchain-1] > `optional` **blockchain**: `string` ### cardBrand? [#cardbrand] > `optional` **cardBrand**: `string` ### cardExpMonth? [#cardexpmonth] > `optional` **cardExpMonth**: `number` ### cardExpYear? [#cardexpyear] > `optional` **cardExpYear**: `number` ### cardLast4? [#cardlast4] > `optional` **cardLast4**: `string` ### createdAt [#createdat-4] > **createdAt**: `number` ### id [#id-6] > **id**: `string` ### isDefault [#isdefault] > **isDefault**: `boolean` ### provider? [#provider-2] > `optional` **provider**: `string` ### type [#type] > **type**: `"CARD"` | `"CRYPTO"` ### walletAddress? [#walletaddress] > `optional` **walletAddress**: `string` ## Defined in [#defined-in-52] [src/clients/billing.ts:16](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L16) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/billing](../README.md) / Subscription # Type Alias: Subscription [#type-alias-subscription] > **Subscription**: `object` ## Type declaration [#type-declaration-12] ### basePricePerSeat [#basepriceperseat] > **basePricePerSeat**: `number` ### cancelAt? [#cancelat] > `optional` **cancelAt**: `number` ### createdAt [#createdat-5] > **createdAt**: `number` ### currentPeriodEnd [#currentperiodend] > **currentPeriodEnd**: `number` ### currentPeriodStart [#currentperiodstart] > **currentPeriodStart**: `number` ### id [#id-7] > **id**: `string` ### plan [#plan] > **plan**: `"FREE"` | `"STARTER"` | `"PRO"` | `"ENTERPRISE"` ### seats [#seats] > **seats**: `number` ### status [#status-3] > **status**: `"ACTIVE"` | `"CANCELED"` | `"PAST_DUE"` | `"UNPAID"` | `"TRIALING"` ### trialEnd? [#trialend] > `optional` **trialEnd**: `number` ### usageMarkup [#usagemarkup] > **usageMarkup**: `number` ## Defined in [#defined-in-53] [src/clients/billing.ts:38](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L38) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/billing](../README.md) / SubscriptionPlan # Type Alias: SubscriptionPlan [#type-alias-subscriptionplan] > **SubscriptionPlan**: `object` ## Type declaration [#type-declaration-13] ### basePricePerSeat [#basepriceperseat-1] > **basePricePerSeat**: `number` ### features? [#features] > `optional` **features**: `Record`\<`string`, `unknown`> ### id [#id-8] > **id**: `string` ### name [#name-1] > **name**: `"FREE"` | `"STARTER"` | `"PRO"` | `"ENTERPRISE"` ### usageMarkup [#usagemarkup-1] > **usageMarkup**: `number` ## Defined in [#defined-in-54] [src/clients/billing.ts:30](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L30) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/billing](../README.md) / Transfer # Type Alias: Transfer [#type-alias-transfer] > **Transfer**: `object` ## Type declaration [#type-declaration-14] ### amount [#amount-3] > **amount**: `number` ### connectedAccountId [#connectedaccountid] > **connectedAccountId**: `string` ### createdAt [#createdat-6] > **createdAt**: `number` ### currency [#currency-3] > **currency**: `string` ### description? [#description-1] > `optional` **description**: `string` ### id [#id-9] > **id**: `string` ### status [#status-4] > **status**: `"pending"` | `"paid"` | `"failed"` | `"canceled"` ## Defined in [#defined-in-55] [src/clients/billing.ts:132](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L132) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/billing](../README.md) / UsageMetric # Type Alias: UsageMetric [#type-alias-usagemetric] > **UsageMetric**: `object` ## Type declaration [#type-declaration-15] ### amount [#amount-4] > **amount**: `number` ### quantity [#quantity-1] > **quantity**: `number` ## Defined in [#defined-in-56] [src/clients/billing.ts:91](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L91) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/billing](../README.md) / UsageRecord # Type Alias: UsageRecord [#type-alias-usagerecord] > **UsageRecord**: `object` ## Type declaration [#type-declaration-16] ### amount [#amount-5] > **amount**: `number` ### createdAt [#createdat-7] > **createdAt**: `number` ### id [#id-10] > **id**: `string` ### metricType [#metrictype] > **metricType**: `"storage"` | `"bandwidth"` | `"compute"` | `"requests"` ### periodEnd [#periodend-2] > **periodEnd**: `number` ### periodStart [#periodstart-2] > **periodStart**: `number` ### quantity [#quantity-2] > **quantity**: `number` ### recordedAt [#recordedat] > **recordedAt**: `number` ### unitPrice [#unitprice-1] > **unitPrice**: `number` ## Defined in [#defined-in-57] [src/clients/billing.ts:106](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/billing.ts#L106) *** [**@alternatefutures/sdk**](../../README.md) • **Docs** *** [@alternatefutures/sdk](../../README.md) / clients/domains # clients/domains [#clientsdomains] ## Index [#index-2] ### Classes [#classes-2] * [DomainsClient](classes/DomainsClient.md) ### Type Aliases [#type-aliases-2] * [Domain](type-aliases/Domain.md) * [DomainsClientOptions](type-aliases/DomainsClientOptions.md) * [Zone](type-aliases/Zone.md) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/domains](../README.md) / DomainsClient # Class: DomainsClient [#class-domainsclient] ## Constructors [#constructors-2] ### new DomainsClient() [#new-domainsclient] > **new DomainsClient**(`options`): [`DomainsClient`](DomainsClient.md) #### Parameters [#parameters-28] • **options**: [`DomainsClientOptions`](../type-aliases/DomainsClientOptions.md) #### Returns [#returns-38] [`DomainsClient`](DomainsClient.md) #### Defined in [#defined-in-58] [src/clients/domains.ts:110](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/domains.ts#L110) ## Methods [#methods-2] ### createCustomDomain() [#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 [#parameters-29] • **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 [#returns-39] `Promise`\<`Pick`\<`object`, `"__typename"` | `"createdAt"` | `"id"` | `"updatedAt"` | `"hostname"` | `"status"` | `"dnslinkStatus"` | `"errorMessage"` | `"isVerified"`>> Promise\ Domain object with verification instructions #### Examples [#examples] ```typescript // 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' ``` ```typescript // Create an ENS domain const ensDomain = await sdk.domains().createCustomDomain({ siteId: 'site-123', hostname: 'mysite.eth', domainType: 'ENS' }); ``` ```typescript // Create domain with CNAME verification const domain = await sdk.domains().createCustomDomain({ siteId: 'site-123', hostname: 'www.example.com', verificationMethod: 'CNAME' }); ``` #### Defined in [#defined-in-59] [src/clients/domains.ts:383](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/domains.ts#L383) *** ### ~~createDomain()~~ [#createdomain] > **createDomain**(`__namedParameters`): `Promise`\<`any`> #### Parameters [#parameters-30] • **\_\_namedParameters** • **\_\_namedParameters.hostname**: `string` • **\_\_namedParameters.zoneId**: `string` #### Returns [#returns-40] `Promise`\<`any`> #### Deprecated [#deprecated] Use createCustomDomain instead for new domain creation with SSL support #### Defined in [#defined-in-60] [src/clients/domains.ts:209](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/domains.ts#L209) *** ### createZoneForPrivateGateway() [#createzoneforprivategateway] > **createZoneForPrivateGateway**(): `Promise`\<[`Zone`](../type-aliases/Zone.md)> #### Returns [#returns-41] `Promise`\<[`Zone`](../type-aliases/Zone.md)> #### Defined in [#defined-in-61] [src/clients/domains.ts:308](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/domains.ts#L308) *** ### createZoneForSite() [#createzoneforsite] > **createZoneForSite**(`__namedParameters`): `Promise`\<[`Zone`](../type-aliases/Zone.md)> #### Parameters [#parameters-31] • **\_\_namedParameters** • **\_\_namedParameters.siteId**: `string` #### Returns [#returns-42] `Promise`\<[`Zone`](../type-aliases/Zone.md)> #### Defined in [#defined-in-62] [src/clients/domains.ts:287](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/domains.ts#L287) *** ### deleteDomain() [#deletedomain] > **deleteDomain**(`__namedParameters`): `Promise`\<`Pick`\<`object`, `"__typename"` | `"createdAt"` | `"id"` | `"updatedAt"` | `"hostname"` | `"status"` | `"dnslinkStatus"` | `"errorMessage"` | `"isVerified"`>> #### Parameters [#parameters-32] • **\_\_namedParameters** • **\_\_namedParameters.domainId**: `string` #### Returns [#returns-43] `Promise`\<`Pick`\<`object`, `"__typename"` | `"createdAt"` | `"id"` | `"updatedAt"` | `"hostname"` | `"status"` | `"dnslinkStatus"` | `"errorMessage"` | `"isVerified"`>> #### Defined in [#defined-in-63] [src/clients/domains.ts:234](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/domains.ts#L234) *** ### deleteZone() [#deletezone] > **deleteZone**(`__namedParameters`): `Promise`\<[`Zone`](../type-aliases/Zone.md)> #### Parameters [#parameters-33] • **\_\_namedParameters** • **\_\_namedParameters.id**: `string` #### Returns [#returns-44] `Promise`\<[`Zone`](../type-aliases/Zone.md)> #### Defined in [#defined-in-64] [src/clients/domains.ts:317](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/domains.ts#L317) *** ### get() [#get-1] > **get**(`__namedParameters`): `Promise`\<`Domain`> #### Parameters [#parameters-34] • **\_\_namedParameters** • **\_\_namedParameters.domainId**: `string` #### Returns [#returns-45] `Promise`\<`Domain`> #### Defined in [#defined-in-65] [src/clients/domains.ts:141](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/domains.ts#L141) *** ### getByHostname() [#getbyhostname] > **getByHostname**(`__namedParameters`): `Promise`\<`Domain`> #### Parameters [#parameters-35] • **\_\_namedParameters** • **\_\_namedParameters.hostname**: `string` #### Returns [#returns-46] `Promise`\<`Domain`> #### Defined in [#defined-in-66] [src/clients/domains.ts:161](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/domains.ts#L161) *** ### getVerificationInstructions() [#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 [#parameters-36] • **options** Instruction retrieval options • **options.domainId**: `string` The ID of the domain #### Returns [#returns-47] `Promise`\<`any`> Promise\ Object containing DNS record instructions #### Example [#example] ```typescript // 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 [#defined-in-67] [src/clients/domains.ts:628](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/domains.ts#L628) *** ### getZone() [#getzone] > **getZone**(`__namedParameters`): `Promise`\<[`Zone`](../type-aliases/Zone.md)> #### Parameters [#parameters-37] • **\_\_namedParameters** • **\_\_namedParameters.id**: `string` #### Returns [#returns-48] `Promise`\<[`Zone`](../type-aliases/Zone.md)> #### Defined in [#defined-in-68] [src/clients/domains.ts:271](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/domains.ts#L271) *** ### list() [#list-1] > **list**(): `Promise`\<`Domain`\[]> #### Returns [#returns-49] `Promise`\<`Domain`\[]> #### Defined in [#defined-in-69] [src/clients/domains.ts:116](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/domains.ts#L116) *** ### listByZoneId() [#listbyzoneid] > **listByZoneId**(`__namedParameters`): `Promise`\<`Domain`\[]> #### Parameters [#parameters-38] • **\_\_namedParameters** • **\_\_namedParameters.zoneId**: `string` #### Returns [#returns-50] `Promise`\<`Domain`\[]> #### Defined in [#defined-in-70] [src/clients/domains.ts:183](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/domains.ts#L183) *** ### listDomainsForSite() [#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 [#parameters-39] • **options** List options • **options.siteId**: `string` The ID of the site #### Returns [#returns-51] `Promise`\<`Pick`\<`object`, `"__typename"` | `"createdAt"` | `"id"` | `"updatedAt"` | `"hostname"` | `"status"` | `"dnslinkStatus"` | `"errorMessage"` | `"isVerified"`>\[]> Promise\ Array of domain objects #### Examples [#examples-1] ```typescript // 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}`); }); ``` ```typescript // 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 [#defined-in-71] [src/clients/domains.ts:682](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/domains.ts#L682) *** ### listZones() [#listzones] > **listZones**(): `Promise`\<[`Zone`](../type-aliases/Zone.md)\[]> #### Returns [#returns-52] `Promise`\<[`Zone`](../type-aliases/Zone.md)\[]> #### Defined in [#defined-in-72] [src/clients/domains.ts:262](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/domains.ts#L262) *** ### provisionSsl() [#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 [#parameters-40] • **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 [#returns-53] `Promise`\<`any`> Promise\ Updated domain object with SSL status #### Example [#example-1] ```typescript // 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 [#defined-in-73] [src/clients/domains.ts:480](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/domains.ts#L480) *** ### removeCustomDomain() [#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 [#parameters-41] • **options** Deletion options • **options.domainId**: `string` The ID of the domain to remove #### Returns [#returns-54] `Promise`\<`Pick`\<`object`, `"__typename"` | `"createdAt"` | `"id"` | `"updatedAt"` | `"hostname"` | `"status"` | `"dnslinkStatus"` | `"errorMessage"` | `"isVerified"`>> Promise\ True if deletion successful #### Examples [#examples-2] ```typescript // Remove a domain await sdk.domains().removeCustomDomain({ domainId: 'domain-123' }); ``` ```typescript // 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 [#defined-in-74] [src/clients/domains.ts:585](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/domains.ts#L585) *** ### setPrimaryDomain() [#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 [#parameters-42] • **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 [#returns-55] `Promise`\<`any`> Promise\ True if successful #### Examples [#examples-3] ```typescript // Set primary domain for a site await sdk.domains().setPrimaryDomain({ siteId: 'site-123', domainId: 'domain-456' }); ``` ```typescript // 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 [#defined-in-75] [src/clients/domains.ts:534](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/domains.ts#L534) *** ### verifyCustomDomain() [#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 [#parameters-43] • **options** Verification options • **options.domainId**: `string` The ID of the domain to verify #### Returns [#returns-56] `Promise`\<`Pick`\<`object`, `"__typename"` | `"createdAt"` | `"id"` | `"updatedAt"` | `"hostname"` | `"status"` | `"dnslinkStatus"` | `"errorMessage"` | `"isVerified"`>> Promise\ True if verification successful, false otherwise #### Example [#example-2] ```typescript // 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 [#defined-in-76] [src/clients/domains.ts:441](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/domains.ts#L441) *** ### verifyDomain() [#verifydomain] > **verifyDomain**(`__namedParameters`): `Promise`\<`Pick`\<`object`, `"__typename"` | `"createdAt"` | `"id"` | `"updatedAt"` | `"hostname"` | `"status"` | `"dnslinkStatus"` | `"errorMessage"` | `"isVerified"`>> #### Parameters [#parameters-44] • **\_\_namedParameters** • **\_\_namedParameters.domainId**: `string` #### Returns [#returns-57] `Promise`\<`Pick`\<`object`, `"__typename"` | `"createdAt"` | `"id"` | `"updatedAt"` | `"hostname"` | `"status"` | `"dnslinkStatus"` | `"errorMessage"` | `"isVerified"`>> #### Defined in [#defined-in-77] [src/clients/domains.ts:248](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/domains.ts#L248) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/domains](../README.md) / Domain # Type Alias: Domain [#type-alias-domain] > **Domain**: `Pick`\<`DomainWithRelations`, `"id"` | `"zone"` | `"hostname"` | `"isVerified"` | `"updatedAt"` | `"createdAt"` | `"dnsConfigs"` | `"status"`> & `object` ## Type declaration [#type-declaration-17] ### arnsName? [#arnsname] > `optional` **arnsName**: `string` ### dnsCheckAttempts? [#dnscheckattempts] > `optional` **dnsCheckAttempts**: `number` ### dnsVerifiedAt? [#dnsverifiedat] > `optional` **dnsVerifiedAt**: `string` ### domainType? [#domaintype] > `optional` **domainType**: `"WEB2"` | `"ARNS"` | `"ENS"` | `"IPNS"` ### ensName? [#ensname] > `optional` **ensName**: `string` ### expectedARecord? [#expectedarecord] > `optional` **expectedARecord**: `string` ### expectedCname? [#expectedcname] > `optional` **expectedCname**: `string` ### ipnsHash? [#ipnshash] > `optional` **ipnsHash**: `string` ### lastDnsCheck? [#lastdnscheck] > `optional` **lastDnsCheck**: `string` ### sslAutoRenew? [#sslautorenew] > `optional` **sslAutoRenew**: `boolean` ### sslExpiresAt? [#sslexpiresat] > `optional` **sslExpiresAt**: `string` ### sslIssuedAt? [#sslissuedat] > `optional` **sslIssuedAt**: `string` ### sslStatus? [#sslstatus] > `optional` **sslStatus**: `"NONE"` | `"PENDING"` | `"ACTIVE"` | `"EXPIRED"` | `"FAILED"` ### txtVerificationStatus? [#txtverificationstatus] > `optional` **txtVerificationStatus**: `"PENDING"` | `"VERIFIED"` | `"FAILED"` ### txtVerificationToken? [#txtverificationtoken] > `optional` **txtVerificationToken**: `string` ### verified? [#verified] > `optional` **verified**: `boolean` ## Defined in [#defined-in-78] [src/clients/domains.ts:23](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/domains.ts#L23) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/domains](../README.md) / DomainsClientOptions # Type Alias: DomainsClientOptions [#type-alias-domainsclientoptions] > **DomainsClientOptions**: `object` ## Type declaration [#type-declaration-18] ### graphqlClient [#graphqlclient-1] > **graphqlClient**: [`Client`](../../../index/interfaces/Client.md) ## Defined in [#defined-in-79] [src/clients/domains.ts:19](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/domains.ts#L19) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/domains](../README.md) / Zone # Type Alias: Zone [#type-alias-zone] > **Zone**: `Pick`\<`ZoneWithRelations`, `"id"` | `"originUrl"` | `"createdAt"` | `"updatedAt"` | `"type"` | `"status"`> ## Defined in [#defined-in-80] [src/clients/domains.ts:53](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/domains.ts#L53) *** [**@alternatefutures/sdk**](../../README.md) • **Docs** *** [@alternatefutures/sdk](../../README.md) / clients/ens # clients/ens [#clientsens] ## Index [#index-3] ### Classes [#classes-3] * [EnsClient](classes/EnsClient.md) ### Type Aliases [#type-aliases-3] * [EnsClientOptions](type-aliases/EnsClientOptions.md) * [EnsRecord](type-aliases/EnsRecord.md) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/ens](../README.md) / EnsClient # Class: EnsClient [#class-ensclient] ## Constructors [#constructors-3] ### new EnsClient() [#new-ensclient] > **new EnsClient**(`options`): [`EnsClient`](EnsClient.md) #### Parameters [#parameters-45] • **options**: [`EnsClientOptions`](../type-aliases/EnsClientOptions.md) #### Returns [#returns-58] [`EnsClient`](EnsClient.md) #### Defined in [#defined-in-81] [src/clients/ens.ts:40](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/ens.ts#L40) ## Methods [#methods-3] ### create() [#create-1] > **create**(`__namedParameters`): `Promise`\<[`EnsRecord`](../type-aliases/EnsRecord.md)> #### Parameters [#parameters-46] • **\_\_namedParameters** • **\_\_namedParameters.ipnsRecordId**: `string` • **\_\_namedParameters.name**: `string` • **\_\_namedParameters.siteId**: `string` #### Returns [#returns-59] `Promise`\<[`EnsRecord`](../type-aliases/EnsRecord.md)> #### Defined in [#defined-in-82] [src/clients/ens.ts:44](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/ens.ts#L44) *** ### delete() [#delete-1] > **delete**(`__namedParameters`): `Promise`\<[`EnsRecord`](../type-aliases/EnsRecord.md)> #### Parameters [#parameters-47] • **\_\_namedParameters** • **\_\_namedParameters.id**: `string` #### Returns [#returns-60] `Promise`\<[`EnsRecord`](../type-aliases/EnsRecord.md)> #### Defined in [#defined-in-83] [src/clients/ens.ts:120](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/ens.ts#L120) *** ### get() [#get-2] > **get**(`__namedParameters`): `Promise`\<[`EnsRecord`](../type-aliases/EnsRecord.md)> #### Parameters [#parameters-48] • **\_\_namedParameters** • **\_\_namedParameters.id**: `string` #### Returns [#returns-61] `Promise`\<[`EnsRecord`](../type-aliases/EnsRecord.md)> #### Defined in [#defined-in-84] [src/clients/ens.ts:72](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/ens.ts#L72) *** ### getByName() [#getbyname] > **getByName**(`__namedParameters`): `Promise`\<[`EnsRecord`](../type-aliases/EnsRecord.md)> #### Parameters [#parameters-49] • **\_\_namedParameters** • **\_\_namedParameters.name**: `string` #### Returns [#returns-62] `Promise`\<[`EnsRecord`](../type-aliases/EnsRecord.md)> #### Defined in [#defined-in-85] [src/clients/ens.ts:88](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/ens.ts#L88) *** ### list() [#list-2] > **list**(): `Promise`\<[`EnsRecord`](../type-aliases/EnsRecord.md)\[]> #### Returns [#returns-63] `Promise`\<[`EnsRecord`](../type-aliases/EnsRecord.md)\[]> #### Defined in [#defined-in-86] [src/clients/ens.ts:136](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/ens.ts#L136) *** ### listByIpnsRecordId() [#listbyipnsrecordid] > **listByIpnsRecordId**(`__namedParameters`): `Promise`\<[`EnsRecord`](../type-aliases/EnsRecord.md)\[]> #### Parameters [#parameters-50] • **\_\_namedParameters** • **\_\_namedParameters.ipnsRecordId**: `string` #### Returns [#returns-64] `Promise`\<[`EnsRecord`](../type-aliases/EnsRecord.md)\[]> #### Defined in [#defined-in-87] [src/clients/ens.ts:149](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/ens.ts#L149) *** ### verify() [#verify] > **verify**(`__namedParameters`): `Promise`\<[`EnsRecord`](../type-aliases/EnsRecord.md)> #### Parameters [#parameters-51] • **\_\_namedParameters** • **\_\_namedParameters.id**: `string` #### Returns [#returns-65] `Promise`\<[`EnsRecord`](../type-aliases/EnsRecord.md)> #### Defined in [#defined-in-88] [src/clients/ens.ts:104](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/ens.ts#L104) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/ens](../README.md) / EnsClientOptions # Type Alias: EnsClientOptions [#type-alias-ensclientoptions] > **EnsClientOptions**: `object` ## Type declaration [#type-declaration-19] ### graphqlClient [#graphqlclient-2] > **graphqlClient**: [`Client`](../../../index/interfaces/Client.md) ## Defined in [#defined-in-89] [src/clients/ens.ts:17](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/ens.ts#L17) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/ens](../README.md) / EnsRecord # Type Alias: EnsRecord [#type-alias-ensrecord] > **EnsRecord**: `Omit`\<`EnsRecordWithRelations`, `"site"` | `"ipnsRecord"`> & `object` ## Type declaration [#type-declaration-20] ### ipnsRecord [#ipnsrecord] > **ipnsRecord**: `Pick`\<`EnsRecordWithRelations`\[`"ipnsRecord"`], `"id"` | `"name"` | `"hash"`> & `object` #### Type declaration [#type-declaration-21] ##### id [#id-11] > **id**: `string` ### site [#site] > **site**: `Pick`\<`EnsRecordWithRelations`\[`"site"`], `"id"`> ## Defined in [#defined-in-90] [src/clients/ens.ts:7](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/ens.ts#L7) *** [**@alternatefutures/sdk**](../../README.md) • **Docs** *** [@alternatefutures/sdk](../../README.md) / clients/functions # clients/functions [#clientsfunctions] ## Index [#index-4] ### Classes [#classes-4] * [FunctionsClient](classes/FunctionsClient.md) ### Type Aliases [#type-aliases-4] * [AFFunction](type-aliases/AFFunction.md) * [CreateAFFunctionArgs](type-aliases/CreateAFFunctionArgs.md) * [DeleteAFFunctionArgs](type-aliases/DeleteAFFunctionArgs.md) * [DeployAFFunctionArgs](type-aliases/DeployAFFunctionArgs.md) * [FunctionsClientOptions](type-aliases/FunctionsClientOptions.md) * [GetAFFunctionArgs](type-aliases/GetAFFunctionArgs.md) * [ListAFFunctionArgs](type-aliases/ListAFFunctionArgs.md) * [UpdateAFFunctionArgs](type-aliases/UpdateAFFunctionArgs.md) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/functions](../README.md) / FunctionsClient # Class: FunctionsClient [#class-functionsclient] ## Constructors [#constructors-4] ### new FunctionsClient() [#new-functionsclient] > **new FunctionsClient**(`options`): [`FunctionsClient`](FunctionsClient.md) #### Parameters [#parameters-52] • **options**: [`FunctionsClientOptions`](../type-aliases/FunctionsClientOptions.md) #### Returns [#returns-66] [`FunctionsClient`](FunctionsClient.md) #### Defined in [#defined-in-91] [src/clients/functions.ts:72](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/functions.ts#L72) ## Methods [#methods-4] ### create() [#create-2] > **create**(`__namedParameters`): `Promise`\<`Pick`\<`object`, `"__typename"` | `"createdAt"` | `"id"` | `"name"` | `"updatedAt"` | `"deployments"` | `"site"` | `"status"` | `"siteId"` | `"currentDeployment"` | `"currentDeploymentId"` | `"invokeUrl"` | `"projectId"` | `"slug"`>> #### Parameters [#parameters-53] • **\_\_namedParameters**: [`CreateAFFunctionArgs`](../type-aliases/CreateAFFunctionArgs.md) #### Returns [#returns-67] `Promise`\<`Pick`\<`object`, `"__typename"` | `"createdAt"` | `"id"` | `"name"` | `"updatedAt"` | `"deployments"` | `"site"` | `"status"` | `"siteId"` | `"currentDeployment"` | `"currentDeploymentId"` | `"invokeUrl"` | `"projectId"` | `"slug"`>> #### Defined in [#defined-in-92] [src/clients/functions.ts:123](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/functions.ts#L123) *** ### delete() [#delete-2] > **delete**(`__namedParameters`): `Promise`\<`Pick`\<`object`, `"__typename"` | `"createdAt"` | `"id"` | `"name"` | `"updatedAt"` | `"deployments"` | `"site"` | `"status"` | `"siteId"` | `"currentDeployment"` | `"currentDeploymentId"` | `"invokeUrl"` | `"projectId"` | `"slug"`>> #### Parameters [#parameters-54] • **\_\_namedParameters**: [`DeleteAFFunctionArgs`](../type-aliases/DeleteAFFunctionArgs.md) #### Returns [#returns-68] `Promise`\<`Pick`\<`object`, `"__typename"` | `"createdAt"` | `"id"` | `"name"` | `"updatedAt"` | `"deployments"` | `"site"` | `"status"` | `"siteId"` | `"currentDeployment"` | `"currentDeploymentId"` | `"invokeUrl"` | `"projectId"` | `"slug"`>> #### Defined in [#defined-in-93] [src/clients/functions.ts:162](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/functions.ts#L162) *** ### deploy() [#deploy] > **deploy**(`__namedParameters`): `Promise`\<`AFFunctionDeployment`> #### Parameters [#parameters-55] • **\_\_namedParameters**: [`DeployAFFunctionArgs`](../type-aliases/DeployAFFunctionArgs.md) #### Returns [#returns-69] `Promise`\<`AFFunctionDeployment`> #### Defined in [#defined-in-94] [src/clients/functions.ts:141](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/functions.ts#L141) *** ### get() [#get-3] > **get**(`__namedParameters`): `Promise`\<[`AFFunction`](../type-aliases/AFFunction.md)> #### Parameters [#parameters-56] • **\_\_namedParameters**: [`GetAFFunctionArgs`](../type-aliases/GetAFFunctionArgs.md) #### Returns [#returns-70] `Promise`\<[`AFFunction`](../type-aliases/AFFunction.md)> #### Defined in [#defined-in-95] [src/clients/functions.ts:76](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/functions.ts#L76) *** ### list() [#list-3] > **list**(): `Promise`\<[`AFFunction`](../type-aliases/AFFunction.md)\[]> #### Returns [#returns-71] `Promise`\<[`AFFunction`](../type-aliases/AFFunction.md)\[]> #### Defined in [#defined-in-96] [src/clients/functions.ts:92](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/functions.ts#L92) *** ### listDeployments() [#listdeployments] > **listDeployments**(`__namedParameters`): `Promise`\<`AFFunctionDeployment`\[]> #### Parameters [#parameters-57] • **\_\_namedParameters**: [`ListAFFunctionArgs`](../type-aliases/ListAFFunctionArgs.md) #### Returns [#returns-72] `Promise`\<`AFFunctionDeployment`\[]> #### Defined in [#defined-in-97] [src/clients/functions.ts:106](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/functions.ts#L106) *** ### update() [#update-1] > **update**(`__namedParameters`): `Promise`\<`Pick`\<`object`, `"__typename"` | `"createdAt"` | `"id"` | `"name"` | `"updatedAt"` | `"deployments"` | `"site"` | `"status"` | `"siteId"` | `"currentDeployment"` | `"currentDeploymentId"` | `"invokeUrl"` | `"projectId"` | `"slug"`>> #### Parameters [#parameters-58] • **\_\_namedParameters**: [`UpdateAFFunctionArgs`](../type-aliases/UpdateAFFunctionArgs.md) #### Returns [#returns-73] `Promise`\<`Pick`\<`object`, `"__typename"` | `"createdAt"` | `"id"` | `"name"` | `"updatedAt"` | `"deployments"` | `"site"` | `"status"` | `"siteId"` | `"currentDeployment"` | `"currentDeploymentId"` | `"invokeUrl"` | `"projectId"` | `"slug"`>> #### Defined in [#defined-in-98] [src/clients/functions.ts:178](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/functions.ts#L178) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/functions](../README.md) / AFFunction # Type Alias: AFFunction [#type-alias-affunction] > **AFFunction**: `Omit`\<`OriginalAFFunction`, `"projectId"` | `"site"`> ## Defined in [#defined-in-99] [src/clients/functions.ts:14](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/functions.ts#L14) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/functions](../README.md) / CreateAFFunctionArgs # Type Alias: CreateAFFunctionArgs [#type-alias-createaffunctionargs] > **CreateAFFunctionArgs**: `object` ## Type declaration [#type-declaration-22] ### name [#name-2] > **name**: `string` ### routes? [#routes] > `optional` **routes**: `Record`\<`string`, `string`> | `null` ### siteId? [#siteid] > `optional` **siteId**: `string` ## Defined in [#defined-in-100] [src/clients/functions.ts:19](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/functions.ts#L19) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/functions](../README.md) / DeleteAFFunctionArgs # Type Alias: DeleteAFFunctionArgs [#type-alias-deleteaffunctionargs] > **DeleteAFFunctionArgs**: `object` ## Type declaration [#type-declaration-23] ### id [#id-12] > **id**: `string` ## Defined in [#defined-in-101] [src/clients/functions.ts:24](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/functions.ts#L24) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/functions](../README.md) / DeployAFFunctionArgs # Type Alias: DeployAFFunctionArgs [#type-alias-deployaffunctionargs] > **DeployAFFunctionArgs**: `object` ## Type declaration [#type-declaration-24] ### assetsCid? [#assetscid] > `optional` **assetsCid**: `string` ### blake3Hash? [#blake3hash] > `optional` **blake3Hash**: `string` ### cid [#cid] > **cid**: `string` ### functionId [#functionid] > **functionId**: `string` ### sgx? [#sgx] > `optional` **sgx**: `boolean` ## Defined in [#defined-in-102] [src/clients/functions.ts:34](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/functions.ts#L34) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/functions](../README.md) / FunctionsClientOptions # Type Alias: FunctionsClientOptions [#type-alias-functionsclientoptions] > **FunctionsClientOptions**: `object` ## Type declaration [#type-declaration-25] ### graphqlClient [#graphqlclient-3] > **graphqlClient**: [`Client`](../../../index/interfaces/Client.md) ## Defined in [#defined-in-103] [src/clients/functions.ts:10](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/functions.ts#L10) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/functions](../README.md) / GetAFFunctionArgs # Type Alias: GetAFFunctionArgs [#type-alias-getaffunctionargs] > **GetAFFunctionArgs**: `object` ## Type declaration [#type-declaration-26] ### name [#name-3] > **name**: `string` ## Defined in [#defined-in-104] [src/clients/functions.ts:16](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/functions.ts#L16) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/functions](../README.md) / ListAFFunctionArgs # Type Alias: ListAFFunctionArgs [#type-alias-listaffunctionargs] > **ListAFFunctionArgs**: `object` ## Type declaration [#type-declaration-27] ### functionId [#functionid-1] > **functionId**: `string` ## Defined in [#defined-in-105] [src/clients/functions.ts:41](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/functions.ts#L41) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/functions](../README.md) / UpdateAFFunctionArgs # Type Alias: UpdateAFFunctionArgs [#type-alias-updateaffunctionargs] > **UpdateAFFunctionArgs**: `object` ## Type declaration [#type-declaration-28] ### id [#id-13] > **id**: `string` ### name? [#name-4] > `optional` **name**: `string` ### routes? [#routes-1] > `optional` **routes**: `Record`\<`string`, `string`> | `null` ### slug? [#slug] > `optional` **slug**: `string` ### status? [#status-5] > `optional` **status**: [`AFFunctionStatus`](../../../index/type-aliases/AFFunctionStatus.md) ## Defined in [#defined-in-106] [src/clients/functions.ts:27](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/functions.ts#L27) *** [**@alternatefutures/sdk**](../../README.md) • **Docs** *** [@alternatefutures/sdk](../../README.md) / clients/ipfs # clients/ipfs [#clientsipfs] ## Index [#index-5] ### Classes [#classes-5] * [IpfsClient](classes/IpfsClient.md) ### Type Aliases [#type-aliases-5] * [AddAllOptions](type-aliases/AddAllOptions.md) * [AddFromPathOptions](type-aliases/AddFromPathOptions.md) * [IpfsClientOptions](type-aliases/IpfsClientOptions.md) * [IpfsFile](type-aliases/IpfsFile.md) * [UploadResult](type-aliases/UploadResult.md) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/ipfs](../README.md) / IpfsClient # Class: IpfsClient [#class-ipfsclient] ## Constructors [#constructors-5] ### new IpfsClient() [#new-ipfsclient] > **new IpfsClient**(`options`): [`IpfsClient`](IpfsClient.md) #### Parameters [#parameters-59] • **options**: [`IpfsClientOptions`](../type-aliases/IpfsClientOptions.md) #### Returns [#returns-74] [`IpfsClient`](IpfsClient.md) #### Defined in [#defined-in-107] [src/clients/ipfs.ts:47](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/ipfs.ts#L47) ## Methods [#methods-5] ### add() [#add] > **add**(`file`): `Promise`\<[`UploadResult`](../type-aliases/UploadResult.md)> #### Parameters [#parameters-60] • **file**: [`IpfsFile`](../type-aliases/IpfsFile.md) #### Returns [#returns-75] `Promise`\<[`UploadResult`](../type-aliases/UploadResult.md)> #### Defined in [#defined-in-108] [src/clients/ipfs.ts:68](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/ipfs.ts#L68) *** ### addAll() [#addall] > **addAll**(`files`, `options`): `Promise`\<[`UploadResult`](../type-aliases/UploadResult.md)\[]> #### Parameters [#parameters-61] • **files**: [`IpfsFile`](../type-aliases/IpfsFile.md)\[] | `AsyncGenerator`\<`GlobSourceResult`, `void`, `unknown`> • **options**: [`AddAllOptions`](../type-aliases/AddAllOptions.md) = `{}` #### Returns [#returns-76] `Promise`\<[`UploadResult`](../type-aliases/UploadResult.md)\[]> #### Defined in [#defined-in-109] [src/clients/ipfs.ts:89](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/ipfs.ts#L89) *** ### addFromPath() [#addfrompath] > **addFromPath**(`path`, `options`): `Promise`\<`object`\[]> #### Parameters [#parameters-62] • **path**: `string` • **options**: [`AddFromPathOptions`](../type-aliases/AddFromPathOptions.md) = `{}` #### Returns [#returns-77] `Promise`\<`object`\[]> #### Defined in [#defined-in-110] [src/clients/ipfs.ts:161](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/ipfs.ts#L161) *** ### addSitesToIpfs() [#addsitestoipfs] > **addSitesToIpfs**(`path`, `options`): `Promise`\<`object`\[]> #### Parameters [#parameters-63] • **path**: `string` • **options**: [`AddFromPathOptions`](../type-aliases/AddFromPathOptions.md) = `{}` #### Returns [#returns-78] `Promise`\<`object`\[]> #### Defined in [#defined-in-111] [src/clients/ipfs.ts:201](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/ipfs.ts#L201) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/ipfs](../README.md) / AddAllOptions # Type Alias: AddAllOptions [#type-alias-addalloptions] > **AddAllOptions**: `object` ## Type declaration [#type-declaration-29] ### basename? [#basename] > `optional` **basename**: `string` ### searchParams? [#searchparams] > `optional` **searchParams**: `URLSearchParams` ### siteId? [#siteid-1] > `optional` **siteId**: `string` ### wrapWithDirectory? [#wrapwithdirectory] > `optional` **wrapWithDirectory**: `boolean` ## Defined in [#defined-in-112] [src/clients/ipfs.ts:26](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/ipfs.ts#L26) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/ipfs](../README.md) / AddFromPathOptions # Type Alias: AddFromPathOptions [#type-alias-addfrompathoptions] > **AddFromPathOptions**: `object` ## Type declaration [#type-declaration-30] ### searchParams? [#searchparams-1] > `optional` **searchParams**: `URLSearchParams` ### siteId? [#siteid-2] > `optional` **siteId**: `string` ### wrapWithDirectory? [#wrapwithdirectory-1] > `optional` **wrapWithDirectory**: `boolean` ## Defined in [#defined-in-113] [src/clients/ipfs.ts:33](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/ipfs.ts#L33) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/ipfs](../README.md) / IpfsClientOptions # Type Alias: IpfsClientOptions [#type-alias-ipfsclientoptions] > **IpfsClientOptions**: `object` ## Type declaration [#type-declaration-31] ### uploadProxyClient [#uploadproxyclient] > **uploadProxyClient**: [`UploadProxyClient`](../../uploadProxy/classes/UploadProxyClient.md) ## Defined in [#defined-in-114] [src/clients/ipfs.ts:22](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/ipfs.ts#L22) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/ipfs](../README.md) / IpfsFile # Type Alias: IpfsFile [#type-alias-ipfsfile] > **IpfsFile**: `object` ## Type declaration [#type-declaration-32] ### content [#content] > **content**: `ArrayBuffer` | `string` ### path? [#path] > `optional` **path**: `string` ## Defined in [#defined-in-115] [src/clients/ipfs.ts:17](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/ipfs.ts#L17) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/ipfs](../README.md) / UploadResult # Type Alias: UploadResult [#type-alias-uploadresult] > **UploadResult**: `object` ## Type declaration [#type-declaration-33] ### cid [#cid-1] > **cid**: `CID` ### path [#path-1] > **path**: `string` ### size [#size] > **size**: `number` ## Defined in [#defined-in-116] [src/clients/ipfs.ts:39](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/ipfs.ts#L39) *** [**@alternatefutures/sdk**](../../README.md) • **Docs** *** [@alternatefutures/sdk](../../README.md) / clients/ipns # clients/ipns [#clientsipns] ## Index [#index-6] ### Classes [#classes-6] * [IpnsClient](classes/IpnsClient.md) ### Type Aliases [#type-aliases-6] * [CreateRecordForSiteArgs](type-aliases/CreateRecordForSiteArgs.md) * [DeleteRecordArgs](type-aliases/DeleteRecordArgs.md) * [GetRecordArgs](type-aliases/GetRecordArgs.md) * [IpnsClientOptions](type-aliases/IpnsClientOptions.md) * [IpnsRecord](type-aliases/IpnsRecord.md) * [PublishRecordArgs](type-aliases/PublishRecordArgs.md) * [PublishSignedNameArgs](type-aliases/PublishSignedNameArgs.md) * [ResolveNameArgs](type-aliases/ResolveNameArgs.md) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/ipns](../README.md) / IpnsClient # Class: IpnsClient [#class-ipnsclient] ## Constructors [#constructors-6] ### new IpnsClient() [#new-ipnsclient] > **new IpnsClient**(`options`): [`IpnsClient`](IpnsClient.md) #### Parameters [#parameters-64] • **options**: [`IpnsClientOptions`](../type-aliases/IpnsClientOptions.md) #### Returns [#returns-79] [`IpnsClient`](IpnsClient.md) #### Defined in [#defined-in-117] [src/clients/ipns.ts:54](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/ipns.ts#L54) ## Methods [#methods-6] ### createRecord() [#createrecord] > **createRecord**(): `Promise`\<[`IpnsRecord`](../type-aliases/IpnsRecord.md)> #### Returns [#returns-80] `Promise`\<[`IpnsRecord`](../type-aliases/IpnsRecord.md)> #### Defined in [#defined-in-118] [src/clients/ipns.ts:110](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/ipns.ts#L110) *** ### createRecordForSite() [#createrecordforsite] > **createRecordForSite**(`__namedParameters`): `Promise`\<[`IpnsRecord`](../type-aliases/IpnsRecord.md)> #### Parameters [#parameters-65] • **\_\_namedParameters**: [`CreateRecordForSiteArgs`](../type-aliases/CreateRecordForSiteArgs.md) #### Returns [#returns-81] `Promise`\<[`IpnsRecord`](../type-aliases/IpnsRecord.md)> #### Defined in [#defined-in-119] [src/clients/ipns.ts:119](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/ipns.ts#L119) *** ### deleteRecord() [#deleterecord] > **deleteRecord**(`__namedParameters`): `Promise`\<[`IpnsRecord`](../type-aliases/IpnsRecord.md)> #### Parameters [#parameters-66] • **\_\_namedParameters**: [`DeleteRecordArgs`](../type-aliases/DeleteRecordArgs.md) #### Returns [#returns-82] `Promise`\<[`IpnsRecord`](../type-aliases/IpnsRecord.md)> #### Defined in [#defined-in-120] [src/clients/ipns.ts:137](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/ipns.ts#L137) *** ### getRecord() [#getrecord] > **getRecord**(`__namedParameters`): `Promise`\<[`IpnsRecord`](../type-aliases/IpnsRecord.md)> #### Parameters [#parameters-67] • **\_\_namedParameters**: [`GetRecordArgs`](../type-aliases/GetRecordArgs.md) #### Returns [#returns-83] `Promise`\<[`IpnsRecord`](../type-aliases/IpnsRecord.md)> #### Defined in [#defined-in-121] [src/clients/ipns.ts:164](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/ipns.ts#L164) *** ### listRecords() [#listrecords] > **listRecords**(): `Promise`\<[`IpnsRecord`](../type-aliases/IpnsRecord.md)\[]> #### Returns [#returns-84] `Promise`\<[`IpnsRecord`](../type-aliases/IpnsRecord.md)\[]> #### Defined in [#defined-in-122] [src/clients/ipns.ts:155](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/ipns.ts#L155) *** ### publishRecord() [#publishrecord] > **publishRecord**(`__namedParameters`): `Promise`\<[`IpnsRecord`](../type-aliases/IpnsRecord.md)> #### Parameters [#parameters-68] • **\_\_namedParameters**: [`PublishRecordArgs`](../type-aliases/PublishRecordArgs.md) #### Returns [#returns-85] `Promise`\<[`IpnsRecord`](../type-aliases/IpnsRecord.md)> #### Defined in [#defined-in-123] [src/clients/ipns.ts:88](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/ipns.ts#L88) *** ### publishSignedName() [#publishsignedname] > **publishSignedName**(`__namedParameters`): `Promise`\<`string`> #### Parameters [#parameters-69] • **\_\_namedParameters**: [`PublishSignedNameArgs`](../type-aliases/PublishSignedNameArgs.md) #### Returns [#returns-86] `Promise`\<`string`> #### Defined in [#defined-in-124] [src/clients/ipns.ts:58](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/ipns.ts#L58) *** ### resolveName() [#resolvename] > **resolveName**(`__namedParameters`): `Promise`\<`string`> #### Parameters [#parameters-70] • **\_\_namedParameters**: [`ResolveNameArgs`](../type-aliases/ResolveNameArgs.md) #### Returns [#returns-87] `Promise`\<`string`> #### Defined in [#defined-in-125] [src/clients/ipns.ts:74](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/ipns.ts#L74) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/ipns](../README.md) / CreateRecordForSiteArgs # Type Alias: CreateRecordForSiteArgs [#type-alias-createrecordforsiteargs] > **CreateRecordForSiteArgs**: `object` ## Type declaration [#type-declaration-34] ### siteId [#siteid-3] > **siteId**: `string` ## Defined in [#defined-in-126] [src/clients/ipns.ts:20](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/ipns.ts#L20) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/ipns](../README.md) / DeleteRecordArgs # Type Alias: DeleteRecordArgs [#type-alias-deleterecordargs] > **DeleteRecordArgs**: `object` ## Type declaration [#type-declaration-35] ### id [#id-14] > **id**: `string` ## Defined in [#defined-in-127] [src/clients/ipns.ts:24](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/ipns.ts#L24) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/ipns](../README.md) / GetRecordArgs # Type Alias: GetRecordArgs [#type-alias-getrecordargs] > **GetRecordArgs**: `object` ## Type declaration [#type-declaration-36] ### name [#name-5] > **name**: `string` ## Defined in [#defined-in-128] [src/clients/ipns.ts:28](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/ipns.ts#L28) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/ipns](../README.md) / IpnsClientOptions # Type Alias: IpnsClientOptions [#type-alias-ipnsclientoptions] > **IpnsClientOptions**: `object` ## Type declaration [#type-declaration-37] ### graphqlClient [#graphqlclient-4] > **graphqlClient**: [`Client`](../../../index/interfaces/Client.md) ## Defined in [#defined-in-129] [src/clients/ipns.ts:7](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/ipns.ts#L7) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/ipns](../README.md) / IpnsRecord # Type Alias: IpnsRecord [#type-alias-ipnsrecord] > **IpnsRecord**: `Pick`\<`IpnsRecordWithRelations`, `"id"` | `"name"` | `"hash"`> & `object` ## Type declaration [#type-declaration-38] ### ensRecords [#ensrecords] > **ensRecords**: `Pick`\<`IpnsRecordWithRelations`\[`"ensRecords"`]\[`number`], `"id"`>\[] ## Defined in [#defined-in-130] [src/clients/ipns.ts:37](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/ipns.ts#L37) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/ipns](../README.md) / PublishRecordArgs # Type Alias: PublishRecordArgs [#type-alias-publishrecordargs] > **PublishRecordArgs**: `object` ## Type declaration [#type-declaration-39] ### hash [#hash] > **hash**: `string` ### id [#id-15] > **id**: `string` ## Defined in [#defined-in-131] [src/clients/ipns.ts:11](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/ipns.ts#L11) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/ipns](../README.md) / PublishSignedNameArgs # Type Alias: PublishSignedNameArgs [#type-alias-publishsignednameargs] > **PublishSignedNameArgs**: `object` ## Type declaration [#type-declaration-40] ### input [#input] > **input**: `string` ### key [#key] > **key**: `string` ## Defined in [#defined-in-132] [src/clients/ipns.ts:32](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/ipns.ts#L32) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/ipns](../README.md) / ResolveNameArgs # Type Alias: ResolveNameArgs [#type-alias-resolvenameargs] > **ResolveNameArgs**: `object` ## Type declaration [#type-declaration-41] ### name [#name-6] > **name**: `string` ## Defined in [#defined-in-133] [src/clients/ipns.ts:16](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/ipns.ts#L16) *** [**@alternatefutures/sdk**](../../README.md) • **Docs** *** [@alternatefutures/sdk](../../README.md) / clients/privateGateway # clients/privateGateway [#clientsprivategateway] ## Index [#index-7] ### Classes [#classes-7] * [PrivateGatewayClient](classes/PrivateGatewayClient.md) ### Type Aliases [#type-aliases-7] * [CreatePrivateGatewayArgs](type-aliases/CreatePrivateGatewayArgs.md) * [DeletePrivateGatewayArgs](type-aliases/DeletePrivateGatewayArgs.md) * [GetPrivateGatewayArgs](type-aliases/GetPrivateGatewayArgs.md) * [GetPrivateGatewayBySlugArgs](type-aliases/GetPrivateGatewayBySlugArgs.md) * [PrivateGateway](type-aliases/PrivateGateway.md) * [PrivateGatewayClientOptions](type-aliases/PrivateGatewayClientOptions.md) * [UpdatePrivateGatewayArgs](type-aliases/UpdatePrivateGatewayArgs.md) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/privateGateway](../README.md) / PrivateGatewayClient # Class: PrivateGatewayClient [#class-privategatewayclient] ## Constructors [#constructors-7] ### new PrivateGatewayClient() [#new-privategatewayclient] > **new PrivateGatewayClient**(`options`): [`PrivateGatewayClient`](PrivateGatewayClient.md) #### Parameters [#parameters-71] • **options**: [`PrivateGatewayClientOptions`](../type-aliases/PrivateGatewayClientOptions.md) #### Returns [#returns-88] [`PrivateGatewayClient`](PrivateGatewayClient.md) #### Defined in [#defined-in-134] [src/clients/privateGateway.ts:49](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/privateGateway.ts#L49) ## Methods [#methods-7] ### create() [#create-3] > **create**(`__namedParameters`): `Promise`\<`Pick`\<`object`, `"__typename"` | `"createdAt"` | `"id"` | `"name"` | `"updatedAt"` | `"domains"` | `"project"` | `"zone"` | `"slug"` | `"domainsPaginated"` | `"primaryDomain"`>> #### Parameters [#parameters-72] • **\_\_namedParameters**: [`CreatePrivateGatewayArgs`](../type-aliases/CreatePrivateGatewayArgs.md) #### Returns [#returns-89] `Promise`\<`Pick`\<`object`, `"__typename"` | `"createdAt"` | `"id"` | `"name"` | `"updatedAt"` | `"domains"` | `"project"` | `"zone"` | `"slug"` | `"domainsPaginated"` | `"primaryDomain"`>> #### Defined in [#defined-in-135] [src/clients/privateGateway.ts:116](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/privateGateway.ts#L116) *** ### delete() [#delete-3] > **delete**(`__namedParameters`): `Promise`\<`Pick`\<`object`, `"__typename"` | `"createdAt"` | `"id"` | `"name"` | `"updatedAt"` | `"domains"` | `"project"` | `"zone"` | `"slug"` | `"domainsPaginated"` | `"primaryDomain"`>> #### Parameters [#parameters-73] • **\_\_namedParameters**: [`DeletePrivateGatewayArgs`](../type-aliases/DeletePrivateGatewayArgs.md) #### Returns [#returns-90] `Promise`\<`Pick`\<`object`, `"__typename"` | `"createdAt"` | `"id"` | `"name"` | `"updatedAt"` | `"domains"` | `"project"` | `"zone"` | `"slug"` | `"domainsPaginated"` | `"primaryDomain"`>> #### Defined in [#defined-in-136] [src/clients/privateGateway.ts:135](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/privateGateway.ts#L135) *** ### get() [#get-4] > **get**(`__namedParameters`): `Promise`\<`PrivateGateway`> #### Parameters [#parameters-74] • **\_\_namedParameters**: [`GetPrivateGatewayArgs`](../type-aliases/GetPrivateGatewayArgs.md) #### Returns [#returns-91] `Promise`\<`PrivateGateway`> #### Defined in [#defined-in-137] [src/clients/privateGateway.ts:53](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/privateGateway.ts#L53) *** ### getBySlug() [#getbyslug] > **getBySlug**(`__namedParameters`): `Promise`\<`PrivateGateway`> #### Parameters [#parameters-75] • **\_\_namedParameters**: [`GetPrivateGatewayBySlugArgs`](../type-aliases/GetPrivateGatewayBySlugArgs.md) #### Returns [#returns-92] `Promise`\<`PrivateGateway`> #### Defined in [#defined-in-138] [src/clients/privateGateway.ts:78](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/privateGateway.ts#L78) *** ### list() [#list-4] > **list**(): `Promise`\<`PrivateGateway`\[]> #### Returns [#returns-93] `Promise`\<`PrivateGateway`\[]> #### Defined in [#defined-in-139] [src/clients/privateGateway.ts:98](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/privateGateway.ts#L98) *** ### update() [#update-2] > **update**(`__namedParameters`): `Promise`\<`Pick`\<`object`, `"__typename"` | `"createdAt"` | `"id"` | `"name"` | `"updatedAt"` | `"domains"` | `"project"` | `"zone"` | `"slug"` | `"domainsPaginated"` | `"primaryDomain"`>> #### Parameters [#parameters-76] • **\_\_namedParameters**: [`UpdatePrivateGatewayArgs`](../type-aliases/UpdatePrivateGatewayArgs.md) #### Returns [#returns-94] `Promise`\<`Pick`\<`object`, `"__typename"` | `"createdAt"` | `"id"` | `"name"` | `"updatedAt"` | `"domains"` | `"project"` | `"zone"` | `"slug"` | `"domainsPaginated"` | `"primaryDomain"`>> #### Defined in [#defined-in-140] [src/clients/privateGateway.ts:151](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/privateGateway.ts#L151) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/privateGateway](../README.md) / CreatePrivateGatewayArgs # Type Alias: CreatePrivateGatewayArgs [#type-alias-createprivategatewayargs] > **CreatePrivateGatewayArgs**: `object` ## Type declaration [#type-declaration-42] ### name [#name-7] > **name**: `string` ### zoneId [#zoneid] > **zoneId**: `string` ## Defined in [#defined-in-141] [src/clients/privateGateway.ts:22](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/privateGateway.ts#L22) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/privateGateway](../README.md) / DeletePrivateGatewayArgs # Type Alias: DeletePrivateGatewayArgs [#type-alias-deleteprivategatewayargs] > **DeletePrivateGatewayArgs**: `object` ## Type declaration [#type-declaration-43] ### id [#id-16] > **id**: `string` ## Defined in [#defined-in-142] [src/clients/privateGateway.ts:23](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/privateGateway.ts#L23) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/privateGateway](../README.md) / GetPrivateGatewayArgs # Type Alias: GetPrivateGatewayArgs [#type-alias-getprivategatewayargs] > **GetPrivateGatewayArgs**: `object` ## Type declaration [#type-declaration-44] ### id [#id-17] > **id**: `string` ## Defined in [#defined-in-143] [src/clients/privateGateway.ts:21](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/privateGateway.ts#L21) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/privateGateway](../README.md) / GetPrivateGatewayBySlugArgs # Type Alias: GetPrivateGatewayBySlugArgs [#type-alias-getprivategatewaybyslugargs] > **GetPrivateGatewayBySlugArgs**: `object` ## Type declaration [#type-declaration-45] ### slug [#slug-1] > **slug**: `string` ## Defined in [#defined-in-144] [src/clients/privateGateway.ts:25](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/privateGateway.ts#L25) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/privateGateway](../README.md) / PrivateGateway # Type Alias: PrivateGateway [#type-alias-privategateway] > **PrivateGateway**: `Omit`\<`PrivateGatewayWithRelations`, `"project"` | `"domains"` | `"domainsPaginated"` | `"primaryDomain"`> & `object` ## Type declaration [#type-declaration-46] ### project [#project] > **project**: `Pick`\<`Project`, `"id"`> ## Defined in [#defined-in-145] [src/clients/privateGateway.ts:26](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/privateGateway.ts#L26) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/privateGateway](../README.md) / PrivateGatewayClientOptions # Type Alias: PrivateGatewayClientOptions [#type-alias-privategatewayclientoptions] > **PrivateGatewayClientOptions**: `object` ## Type declaration [#type-declaration-47] ### graphqlClient [#graphqlclient-5] > **graphqlClient**: [`Client`](../../../index/interfaces/Client.md) ## Defined in [#defined-in-146] [src/clients/privateGateway.ts:17](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/privateGateway.ts#L17) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/privateGateway](../README.md) / UpdatePrivateGatewayArgs # Type Alias: UpdatePrivateGatewayArgs [#type-alias-updateprivategatewayargs] > **UpdatePrivateGatewayArgs**: `object` ## Type declaration [#type-declaration-48] ### id [#id-18] > **id**: `string` ### name [#name-8] > **name**: `string` ## Defined in [#defined-in-147] [src/clients/privateGateway.ts:24](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/privateGateway.ts#L24) *** [**@alternatefutures/sdk**](../../README.md) • **Docs** *** [@alternatefutures/sdk](../../README.md) / clients/projects # clients/projects [#clientsprojects] ## Index [#index-8] ### Classes [#classes-8] * [ProjectsClient](classes/ProjectsClient.md) ### Type Aliases [#type-aliases-8] * [CreateProjectArgs](type-aliases/CreateProjectArgs.md) * [GetProjectArgs](type-aliases/GetProjectArgs.md) * [Project](type-aliases/Project.md) * [ProjectsClientOptions](type-aliases/ProjectsClientOptions.md) * [UpdateProjectArgs](type-aliases/UpdateProjectArgs.md) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/projects](../README.md) / ProjectsClient # Class: ProjectsClient [#class-projectsclient] ## Constructors [#constructors-8] ### new ProjectsClient() [#new-projectsclient] > **new ProjectsClient**(`options`): [`ProjectsClient`](ProjectsClient.md) #### Parameters [#parameters-77] • **options**: [`ProjectsClientOptions`](../type-aliases/ProjectsClientOptions.md) #### Returns [#returns-95] [`ProjectsClient`](ProjectsClient.md) #### Defined in [#defined-in-148] [src/clients/projects.ts:43](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/projects.ts#L43) ## Methods [#methods-8] ### create() [#create-4] > **create**(`__namedParameters`): `Promise`\<[`Project`](../type-aliases/Project.md)> #### Parameters [#parameters-78] • **\_\_namedParameters**: [`CreateProjectArgs`](../type-aliases/CreateProjectArgs.md) #### Returns [#returns-96] `Promise`\<[`Project`](../type-aliases/Project.md)> #### Defined in [#defined-in-149] [src/clients/projects.ts:47](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/projects.ts#L47) *** ### get() [#get-5] > **get**(`__namedParameters`): `Promise`\<[`Project`](../type-aliases/Project.md)> #### Parameters [#parameters-79] • **\_\_namedParameters**: [`GetProjectArgs`](../type-aliases/GetProjectArgs.md) #### Returns [#returns-97] `Promise`\<[`Project`](../type-aliases/Project.md)> #### Defined in [#defined-in-150] [src/clients/projects.ts:80](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/projects.ts#L80) *** ### list() [#list-5] > **list**(): `Promise`\<[`Project`](../type-aliases/Project.md)\[]> #### Returns [#returns-98] `Promise`\<[`Project`](../type-aliases/Project.md)\[]> #### Defined in [#defined-in-151] [src/clients/projects.ts:96](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/projects.ts#L96) *** ### update() [#update-3] > **update**(`__namedParameters`): `Promise`\<[`Project`](../type-aliases/Project.md)> #### Parameters [#parameters-80] • **\_\_namedParameters**: [`UpdateProjectArgs`](../type-aliases/UpdateProjectArgs.md) #### Returns [#returns-99] `Promise`\<[`Project`](../type-aliases/Project.md)> #### Defined in [#defined-in-152] [src/clients/projects.ts:63](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/projects.ts#L63) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/projects](../README.md) / CreateProjectArgs # Type Alias: CreateProjectArgs [#type-alias-createprojectargs] > **CreateProjectArgs**: `object` ## Type declaration [#type-declaration-49] ### name [#name-9] > **name**: `string` ## Defined in [#defined-in-153] [src/clients/projects.ts:12](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/projects.ts#L12) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/projects](../README.md) / GetProjectArgs # Type Alias: GetProjectArgs [#type-alias-getprojectargs] > **GetProjectArgs**: `object` ## Type declaration [#type-declaration-50] ### id [#id-19] > **id**: `string` ## Defined in [#defined-in-154] [src/clients/projects.ts:24](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/projects.ts#L24) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/projects](../README.md) / Project # Type Alias: Project [#type-alias-project] > **Project**: `Omit`\<`ProjectWithRelations`, `"currentUserMembership"` | `"memberships"` | `"membershipsPaginated"`> ## Defined in [#defined-in-155] [src/clients/projects.ts:26](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/projects.ts#L26) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/projects](../README.md) / ProjectsClientOptions # Type Alias: ProjectsClientOptions [#type-alias-projectsclientoptions] > **ProjectsClientOptions**: `object` ## Type declaration [#type-declaration-51] ### graphqlClient [#graphqlclient-6] > **graphqlClient**: [`Client`](../../../index/interfaces/Client.md) ## Defined in [#defined-in-156] [src/clients/projects.ts:8](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/projects.ts#L8) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/projects](../README.md) / UpdateProjectArgs # Type Alias: UpdateProjectArgs [#type-alias-updateprojectargs] > **UpdateProjectArgs**: `object` ## Type declaration [#type-declaration-52] ### data [#data] > **data**: `object` ### data.avatar? [#dataavatar] > `optional` **avatar**: *typeof* `File`\[`"prototype"`] ### data.backupStorageOnArweave? [#databackupstorageonarweave] > `optional` **backupStorageOnArweave**: `boolean` ### data.backupStorageOnFilecoin? [#databackupstorageonfilecoin] > `optional` **backupStorageOnFilecoin**: `boolean` ### data.name? [#dataname] > `optional` **name**: `string` ### where [#where] > **where**: `object` ### where.id [#whereid] > **id**: `string` ## Defined in [#defined-in-157] [src/clients/projects.ts:14](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/projects.ts#L14) *** [**@alternatefutures/sdk**](../../README.md) • **Docs** *** [@alternatefutures/sdk](../../README.md) / clients/sites # clients/sites [#clientssites] ## Index [#index-9] ### Classes [#classes-9] * [SitesClient](classes/SitesClient.md) ### Type Aliases [#type-aliases-9] * [CreateCustomIpfsDeploymentArgs](type-aliases/CreateCustomIpfsDeploymentArgs.md) * [CreateSiteArgs](type-aliases/CreateSiteArgs.md) * [DeleteSiteArgs](type-aliases/DeleteSiteArgs.md) * [Deployment](type-aliases/Deployment.md) * [GetBySlugArgs](type-aliases/GetBySlugArgs.md) * [GetDeploymentArgs](type-aliases/GetDeploymentArgs.md) * [GetSiteArgs](type-aliases/GetSiteArgs.md) * [Site](type-aliases/Site.md) * [SitesClientOptions](type-aliases/SitesClientOptions.md) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/sites](../README.md) / SitesClient # Class: SitesClient [#class-sitesclient] ## Constructors [#constructors-9] ### new SitesClient() [#new-sitesclient] > **new SitesClient**(`options`): [`SitesClient`](SitesClient.md) #### Parameters [#parameters-81] • **options**: [`SitesClientOptions`](../type-aliases/SitesClientOptions.md) #### Returns [#returns-100] [`SitesClient`](SitesClient.md) #### Defined in [#defined-in-158] [src/clients/sites.ts:74](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/sites.ts#L74) ## Methods [#methods-9] ### create() [#create-5] > **create**(`__namedParameters`): `Promise`\<[`Site`](../type-aliases/Site.md)> #### Parameters [#parameters-82] • **\_\_namedParameters**: [`CreateSiteArgs`](../type-aliases/CreateSiteArgs.md) #### Returns [#returns-101] `Promise`\<[`Site`](../type-aliases/Site.md)> #### Defined in [#defined-in-159] [src/clients/sites.ts:139](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/sites.ts#L139) *** ### createCustomIpfsDeployment() [#createcustomipfsdeployment] > **createCustomIpfsDeployment**(`__namedParameters`): `Promise`\<[`Deployment`](../type-aliases/Deployment.md)> #### Parameters [#parameters-83] • **\_\_namedParameters**: `Required`\<`Pick`\<`Deployment`, `"cid"` | `"siteId"`>> #### Returns [#returns-102] `Promise`\<[`Deployment`](../type-aliases/Deployment.md)> #### Defined in [#defined-in-160] [src/clients/sites.ts:179](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/sites.ts#L179) *** ### delete() [#delete-4] > **delete**(`__namedParameters`): `Promise`\<[`Site`](../type-aliases/Site.md)> #### Parameters [#parameters-84] • **\_\_namedParameters**: [`DeleteSiteArgs`](../type-aliases/DeleteSiteArgs.md) #### Returns [#returns-103] `Promise`\<[`Site`](../type-aliases/Site.md)> #### Defined in [#defined-in-161] [src/clients/sites.ts:159](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/sites.ts#L159) *** ### get() [#get-6] > **get**(`__namedParameters`): `Promise`\<[`Site`](../type-aliases/Site.md)> #### Parameters [#parameters-85] • **\_\_namedParameters**: [`GetSiteArgs`](../type-aliases/GetSiteArgs.md) #### Returns [#returns-104] `Promise`\<[`Site`](../type-aliases/Site.md)> #### Defined in [#defined-in-162] [src/clients/sites.ts:78](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/sites.ts#L78) *** ### getBySlug() [#getbyslug-1] > **getBySlug**(`__namedParameters`): `Promise`\<[`Site`](../type-aliases/Site.md)> #### Parameters [#parameters-86] • **\_\_namedParameters**: [`GetBySlugArgs`](../type-aliases/GetBySlugArgs.md) #### Returns [#returns-105] `Promise`\<[`Site`](../type-aliases/Site.md)> #### Defined in [#defined-in-163] [src/clients/sites.ts:98](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/sites.ts#L98) *** ### getDeployment() [#getdeployment] > **getDeployment**(`__namedParameters`): `Promise`\<[`Deployment`](../type-aliases/Deployment.md)> #### Parameters [#parameters-87] • **\_\_namedParameters**: [`GetDeploymentArgs`](../type-aliases/GetDeploymentArgs.md) #### Returns [#returns-106] `Promise`\<[`Deployment`](../type-aliases/Deployment.md)> #### Defined in [#defined-in-164] [src/clients/sites.ts:199](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/sites.ts#L199) *** ### list() [#list-6] > **list**(): `Promise`\<[`Site`](../type-aliases/Site.md)\[]> #### Returns [#returns-107] `Promise`\<[`Site`](../type-aliases/Site.md)\[]> #### Defined in [#defined-in-165] [src/clients/sites.ts:118](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/sites.ts#L118) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/sites](../README.md) / CreateCustomIpfsDeploymentArgs # Type Alias: CreateCustomIpfsDeploymentArgs [#type-alias-createcustomipfsdeploymentargs] > **CreateCustomIpfsDeploymentArgs**: `Required`\<`Pick`\<`DeploymentWithRelations`, `"siteId"` | `"cid"`>> ## Defined in [#defined-in-166] [src/clients/sites.ts:43](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/sites.ts#L43) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/sites](../README.md) / CreateSiteArgs # Type Alias: CreateSiteArgs [#type-alias-createsiteargs] > **CreateSiteArgs**: `Pick`\<[`Site`](Site.md), `"name"`> ## Defined in [#defined-in-167] [src/clients/sites.ts:41](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/sites.ts#L41) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/sites](../README.md) / DeleteSiteArgs # Type Alias: DeleteSiteArgs [#type-alias-deletesiteargs] > **DeleteSiteArgs**: `Pick`\<[`Site`](Site.md), `"id"`> ## Defined in [#defined-in-168] [src/clients/sites.ts:42](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/sites.ts#L42) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/sites](../README.md) / Deployment # Type Alias: Deployment [#type-alias-deployment] > **Deployment**: `Pick`\<`DeploymentWithRelations`, `"id"` | `"status"` | `"storageType"` | `"siteId"` | `"cid"` | `"updatedAt"` | `"createdAt"`> ## Defined in [#defined-in-169] [src/clients/sites.ts:22](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/sites.ts#L22) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/sites](../README.md) / GetBySlugArgs # Type Alias: GetBySlugArgs [#type-alias-getbyslugargs] > **GetBySlugArgs**: `Pick`\<[`Site`](Site.md), `"slug"`> ## Defined in [#defined-in-170] [src/clients/sites.ts:40](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/sites.ts#L40) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/sites](../README.md) / GetDeploymentArgs # Type Alias: GetDeploymentArgs [#type-alias-getdeploymentargs] > **GetDeploymentArgs**: `Pick`\<`DeploymentWithRelations`, `"id"`> ## Defined in [#defined-in-171] [src/clients/sites.ts:46](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/sites.ts#L46) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/sites](../README.md) / GetSiteArgs # Type Alias: GetSiteArgs [#type-alias-getsiteargs] > **GetSiteArgs**: `Pick`\<[`Site`](Site.md), `"id"`> ## Defined in [#defined-in-172] [src/clients/sites.ts:39](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/sites.ts#L39) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/sites](../README.md) / Site # Type Alias: Site [#type-alias-site] > **Site**: `Pick`\<`SiteWithRelations`, `"id"` | `"name"` | `"slug"`> & `object` ## Type declaration [#type-declaration-53] ### deployments [#deployments] > **deployments**: [`Deployment`](Deployment.md)\[] ### domains [#domains] > **domains**: `Pick`\<`SiteWithRelations`\[`"domains"`]\[`number`], `"id"` | `"hostname"`>\[] ### ipnsRecords [#ipnsrecords] > **ipnsRecords**: `Pick`\<`SiteWithRelations`\[`"ipnsRecords"`]\[`number`], `"id"`>\[] ### primaryDomain? [#primarydomain] > `optional` **primaryDomain**: `Pick`\<`DomainWithRelations`, `"id"` | `"hostname"`> ### zones [#zones] > **zones**: `Pick`\<`SiteWithRelations`\[`"zones"`]\[`number`], `"id"` | `"status"`>\[] ## Defined in [#defined-in-173] [src/clients/sites.ts:27](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/sites.ts#L27) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/sites](../README.md) / SitesClientOptions # Type Alias: SitesClientOptions [#type-alias-sitesclientoptions] > **SitesClientOptions**: `object` ## Type declaration [#type-declaration-54] ### graphqlClient [#graphqlclient-7] > **graphqlClient**: [`Client`](../../../index/interfaces/Client.md) ## Defined in [#defined-in-174] [src/clients/sites.ts:35](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/sites.ts#L35) *** [**@alternatefutures/sdk**](../../README.md) • **Docs** *** [@alternatefutures/sdk](../../README.md) / clients/storage # clients/storage [#clientsstorage] ## Index [#index-10] ### Classes [#classes-10] * [StorageClient](classes/StorageClient.md) ### Type Aliases [#type-aliases-10] * [DeletePinArgs](type-aliases/DeletePinArgs.md) * [GetPinArgs](type-aliases/GetPinArgs.md) * [GetPinByFilenameArgs](type-aliases/GetPinByFilenameArgs.md) * [PinByCidArgs](type-aliases/PinByCidArgs.md) * [PinByFilenameArgs](type-aliases/PinByFilenameArgs.md) * [StorageClientOptions](type-aliases/StorageClientOptions.md) * [StoragePin](type-aliases/StoragePin.md) * [UploadDirectoryArgs](type-aliases/UploadDirectoryArgs.md) * [UploadFileArgs](type-aliases/UploadFileArgs.md) * [UploadPrivateFileArgs](type-aliases/UploadPrivateFileArgs.md) * [UploadVirtualDirectoryArgs](type-aliases/UploadVirtualDirectoryArgs.md) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/storage](../README.md) / StorageClient # Class: StorageClient [#class-storageclient] ## Constructors [#constructors-10] ### new StorageClient() [#new-storageclient] > **new StorageClient**(`options`): [`StorageClient`](StorageClient.md) #### Parameters [#parameters-88] • **options**: [`StorageClientOptions`](../type-aliases/StorageClientOptions.md) #### Returns [#returns-108] [`StorageClient`](StorageClient.md) #### Defined in [#defined-in-175] [src/clients/storage.ts:109](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/storage.ts#L109) ## Methods [#methods-10] ### delete() [#delete-5] > **delete**(`__namedParameters`): `Promise`\<`object`> #### Parameters [#parameters-89] • **\_\_namedParameters**: [`PinByCidArgs`](../type-aliases/PinByCidArgs.md) #### Returns [#returns-109] `Promise`\<`object`> ##### body [#body] > **body**: `any` ##### status [#status-6] > **status**: `number` = `response.status` #### Defined in [#defined-in-176] [src/clients/storage.ts:350](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/storage.ts#L350) *** ### get() [#get-7] > **get**(`__namedParameters`): `Promise`\<[`StoragePin`](../type-aliases/StoragePin.md)> #### Parameters [#parameters-90] • **\_\_namedParameters**: [`PinByCidArgs`](../type-aliases/PinByCidArgs.md) #### Returns [#returns-110] `Promise`\<[`StoragePin`](../type-aliases/StoragePin.md)> #### Defined in [#defined-in-177] [src/clients/storage.ts:225](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/storage.ts#L225) *** ### getByFilename() [#getbyfilename] > **getByFilename**(`__namedParameters`): `Promise`\<[`StoragePin`](../type-aliases/StoragePin.md)\[]> #### Parameters [#parameters-91] • **\_\_namedParameters**: [`PinByFilenameArgs`](../type-aliases/PinByFilenameArgs.md) #### Returns [#returns-111] `Promise`\<[`StoragePin`](../type-aliases/StoragePin.md)\[]> #### Defined in [#defined-in-178] [src/clients/storage.ts:263](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/storage.ts#L263) *** ### list() [#list-7] > **list**(): `Promise`\<[`StoragePin`](../type-aliases/StoragePin.md)\[]> #### Returns [#returns-112] `Promise`\<[`StoragePin`](../type-aliases/StoragePin.md)\[]> #### Defined in [#defined-in-179] [src/clients/storage.ts:304](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/storage.ts#L304) *** ### uploadDirectory() [#uploaddirectory] > **uploadDirectory**(`__namedParameters`): `Promise`\<[`UploadPinResponse`](../../uploadProxy/type-aliases/UploadPinResponse.md)> #### Parameters [#parameters-92] • **\_\_namedParameters**: [`UploadDirectoryArgs`](../type-aliases/UploadDirectoryArgs.md) #### Returns [#returns-113] `Promise`\<[`UploadPinResponse`](../../uploadProxy/type-aliases/UploadPinResponse.md)> #### Defined in [#defined-in-180] [src/clients/storage.ts:114](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/storage.ts#L114) *** ### uploadFile() [#uploadfile] > **uploadFile**(`__namedParameters`): `Promise`\<[`UploadPinResponse`](../../uploadProxy/type-aliases/UploadPinResponse.md)> #### Parameters [#parameters-93] • **\_\_namedParameters**: [`UploadFileArgs`](../type-aliases/UploadFileArgs.md) #### Returns [#returns-114] `Promise`\<[`UploadPinResponse`](../../uploadProxy/type-aliases/UploadPinResponse.md)> #### Defined in [#defined-in-181] [src/clients/storage.ts:198](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/storage.ts#L198) *** ### uploadPrivateFile() [#uploadprivatefile] > **uploadPrivateFile**(`__namedParameters`): `Promise`\<[`UploadPinResponse`](../../uploadProxy/type-aliases/UploadPinResponse.md)> #### Parameters [#parameters-94] • **\_\_namedParameters**: [`UploadPrivateFileArgs`](../type-aliases/UploadPrivateFileArgs.md) #### Returns [#returns-115] `Promise`\<[`UploadPinResponse`](../../uploadProxy/type-aliases/UploadPinResponse.md)> #### Defined in [#defined-in-182] [src/clients/storage.ts:171](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/storage.ts#L171) *** ### uploadVirtualDirectory() [#uploadvirtualdirectory] > **uploadVirtualDirectory**(`__namedParameters`): `Promise`\<[`UploadPinResponse`](../../uploadProxy/type-aliases/UploadPinResponse.md)> #### Parameters [#parameters-95] • **\_\_namedParameters**: [`UploadVirtualDirectoryArgs`](../type-aliases/UploadVirtualDirectoryArgs.md) #### Returns [#returns-116] `Promise`\<[`UploadPinResponse`](../../uploadProxy/type-aliases/UploadPinResponse.md)> #### Defined in [#defined-in-183] [src/clients/storage.ts:155](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/storage.ts#L155) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/storage](../README.md) / DeletePinArgs # Type Alias: DeletePinArgs [#type-alias-deletepinargs] > **DeletePinArgs**: [`PinByCidArgs`](PinByCidArgs.md) ## Defined in [#defined-in-184] [src/clients/storage.ts:49](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/storage.ts#L49) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/storage](../README.md) / GetPinArgs # Type Alias: GetPinArgs [#type-alias-getpinargs] > **GetPinArgs**: [`PinByCidArgs`](PinByCidArgs.md) ## Defined in [#defined-in-185] [src/clients/storage.ts:46](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/storage.ts#L46) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/storage](../README.md) / GetPinByFilenameArgs # Type Alias: GetPinByFilenameArgs [#type-alias-getpinbyfilenameargs] > **GetPinByFilenameArgs**: [`PinByFilenameArgs`](PinByFilenameArgs.md) ## Defined in [#defined-in-186] [src/clients/storage.ts:47](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/storage.ts#L47) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/storage](../README.md) / PinByCidArgs # Type Alias: PinByCidArgs [#type-alias-pinbycidargs] > **PinByCidArgs**: `Pick`\<`Pin`, `"cid"`> ## Defined in [#defined-in-187] [src/clients/storage.ts:43](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/storage.ts#L43) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/storage](../README.md) / PinByFilenameArgs # Type Alias: PinByFilenameArgs [#type-alias-pinbyfilenameargs] > **PinByFilenameArgs**: `Pick`\<`Pin`, `"filename"` | `"extension"`> ## Defined in [#defined-in-188] [src/clients/storage.ts:44](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/storage.ts#L44) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/storage](../README.md) / StorageClientOptions # Type Alias: StorageClientOptions [#type-alias-storageclientoptions] > **StorageClientOptions**: `object` ## Type declaration [#type-declaration-55] ### graphqlClient [#graphqlclient-8] > **graphqlClient**: [`Client`](../../../index/interfaces/Client.md) ### uploadProxyClient [#uploadproxyclient-1] > **uploadProxyClient**: [`UploadProxyClient`](../../uploadProxy/classes/UploadProxyClient.md) ## Defined in [#defined-in-189] [src/clients/storage.ts:51](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/storage.ts#L51) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/storage](../README.md) / StoragePin # Type Alias: StoragePin [#type-alias-storagepin] > **StoragePin**: `Pick`\<`Pin`, `"cid"` | `"filename"` | `"extension"` | `"arweavePin"`> & `object` ## Type declaration [#type-declaration-56] ### arweaveId? [#arweaveid] > `optional` **arweaveId**: `string` ### filecoinDealIds? [#filecoindealids] > `optional` **filecoinDealIds**: `string` ## Defined in [#defined-in-190] [src/clients/storage.ts:36](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/storage.ts#L36) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/storage](../README.md) / UploadDirectoryArgs # Type Alias: UploadDirectoryArgs [#type-alias-uploaddirectoryargs] > **UploadDirectoryArgs**: `object` ## Type declaration [#type-declaration-57] ### onUploadProgress()? [#onuploadprogress] > `optional` **onUploadProgress**: (`uploadProgress`) => `void` #### Parameters [#parameters-96] • **uploadProgress**: [`UploadProgress`](../../uploadProxy/type-aliases/UploadProgress.md) #### Returns [#returns-117] `void` ### options? [#options] > `optional` **options**: [`UploadContentOptions`](../../uploadProxy/type-aliases/UploadContentOptions.md) ### parentFolderId? [#parentfolderid] > `optional` **parentFolderId**: `string` ### path [#path-2] > **path**: `string` ## Defined in [#defined-in-191] [src/clients/storage.ts:56](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/storage.ts#L56) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/storage](../README.md) / UploadFileArgs # Type Alias: UploadFileArgs [#type-alias-uploadfileargs] > **UploadFileArgs**: `object` ## Type declaration [#type-declaration-58] ### file [#file] > **file**: `FileLike` ### onUploadProgress()? [#onuploadprogress-1] > `optional` **onUploadProgress**: (`uploadProgress`) => `void` #### Parameters [#parameters-97] • **uploadProgress**: [`UploadProgress`](../../uploadProxy/type-aliases/UploadProgress.md) #### Returns [#returns-118] `void` ### options? [#options-1] > `optional` **options**: [`UploadContentOptions`](../../uploadProxy/type-aliases/UploadContentOptions.md) ### parentFolderId? [#parentfolderid-1] > `optional` **parentFolderId**: `string` ## Defined in [#defined-in-192] [src/clients/storage.ts:68](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/storage.ts#L68) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/storage](../README.md) / UploadPrivateFileArgs # Type Alias: UploadPrivateFileArgs [#type-alias-uploadprivatefileargs] > **UploadPrivateFileArgs**: `object` ## Type declaration [#type-declaration-59] ### filePath [#filepath] > **filePath**: `string` ### hashingAlhorithm? [#hashingalhorithm] > `optional` **hashingAlhorithm**: `"sha256"` | `"sha512"` | `"blake3"` ### onUploadProgress()? [#onuploadprogress-2] > `optional` **onUploadProgress**: (`uploadProgress`) => `void` #### Parameters [#parameters-98] • **uploadProgress**: [`UploadProgress`](../../uploadProxy/type-aliases/UploadProgress.md) #### Returns [#returns-119] `void` ## Defined in [#defined-in-193] [src/clients/storage.ts:63](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/storage.ts#L63) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/storage](../README.md) / UploadVirtualDirectoryArgs # Type Alias: UploadVirtualDirectoryArgs [#type-alias-uploadvirtualdirectoryargs] > **UploadVirtualDirectoryArgs**: `object` ## Type declaration [#type-declaration-60] ### directoryName [#directoryname] > **directoryName**: `string` ### files [#files] > **files**: `FileLike`\[] ### onUploadProgress()? [#onuploadprogress-3] > `optional` **onUploadProgress**: (`uploadProgress`) => `void` #### Parameters [#parameters-99] • **uploadProgress**: [`UploadProgress`](../../uploadProxy/type-aliases/UploadProgress.md) #### Returns [#returns-120] `void` ### parentFolderId? [#parentfolderid-2] > `optional` **parentFolderId**: `string` ## Defined in [#defined-in-194] [src/clients/storage.ts:75](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/storage.ts#L75) *** [**@alternatefutures/sdk**](../../README.md) • **Docs** *** [@alternatefutures/sdk](../../README.md) / clients/uploadProxy # clients/uploadProxy [#clientsuploadproxy] ## Index [#index-11] ### Classes [#classes-11] * [UploadProxyClient](classes/UploadProxyClient.md) ### Type Aliases [#type-aliases-11] * [UploadContentArgs](type-aliases/UploadContentArgs.md) * [UploadContentOptions](type-aliases/UploadContentOptions.md) * [UploadPinResponse](type-aliases/UploadPinResponse.md) * [UploadPrivateContentArgs](type-aliases/UploadPrivateContentArgs.md) * [UploadProgress](type-aliases/UploadProgress.md) * [UploadProxyClientOptions](type-aliases/UploadProxyClientOptions.md) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/uploadProxy](../README.md) / UploadProxyClient # Class: UploadProxyClient [#class-uploadproxyclient] ## Constructors [#constructors-11] ### new UploadProxyClient() [#new-uploadproxyclient] > **new UploadProxyClient**(`options`): [`UploadProxyClient`](UploadProxyClient.md) #### Parameters [#parameters-100] • **options**: [`UploadProxyClientOptions`](../type-aliases/UploadProxyClientOptions.md) #### Returns [#returns-121] [`UploadProxyClient`](UploadProxyClient.md) #### Defined in [#defined-in-195] [src/clients/uploadProxy.ts:112](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/uploadProxy.ts#L112) ## Methods [#methods-11] ### delete() [#delete-6] > **delete**(`cid`): `Promise`\<`Response`> #### Parameters [#parameters-101] • **cid**: `string` #### Returns [#returns-122] `Promise`\<`Response`> #### Defined in [#defined-in-196] [src/clients/uploadProxy.ts:284](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/uploadProxy.ts#L284) *** ### uploadContent() [#uploadcontent] > **uploadContent**(`__namedParameters`): `Promise`\<[`UploadPinResponse`](../type-aliases/UploadPinResponse.md)> #### Parameters [#parameters-102] • **\_\_namedParameters**: [`UploadContentArgs`](../type-aliases/UploadContentArgs.md) #### Returns [#returns-123] `Promise`\<[`UploadPinResponse`](../type-aliases/UploadPinResponse.md)> #### Defined in [#defined-in-197] [src/clients/uploadProxy.ts:161](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/uploadProxy.ts#L161) *** ### uploadPrivateContent() [#uploadprivatecontent] > **uploadPrivateContent**(`__namedParameters`): `Promise`\<`object`> #### Parameters [#parameters-103] • **\_\_namedParameters**: [`UploadPrivateContentArgs`](../type-aliases/UploadPrivateContentArgs.md) #### Returns [#returns-124] `Promise`\<`object`> ##### duplicate [#duplicate] > **duplicate**: `boolean` = `false` ##### pin [#pin] > **pin**: `object` ##### pin.cid [#pincid] > **cid**: `string` = `response.data.cid` ##### pin.size [#pinsize] > **size**: `number` = `file.size` #### Defined in [#defined-in-198] [src/clients/uploadProxy.ts:117](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/uploadProxy.ts#L117) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/uploadProxy](../README.md) / UploadContentArgs # Type Alias: UploadContentArgs [#type-alias-uploadcontentargs] > **UploadContentArgs**: `object` ## Type declaration [#type-declaration-61] ### basename [#basename-1] > **basename**: `string` ### getStream() [#getstream] > **getStream**: () => `ReadableStream`\<`Block`> #### Returns [#returns-125] `ReadableStream`\<`Block`> ### onUploadProgress()? [#onuploadprogress-4] > `optional` **onUploadProgress**: (`uploadProgress`) => `void` #### Parameters [#parameters-104] • **uploadProgress**: [`UploadProgress`](UploadProgress.md) #### Returns [#returns-126] `void` ### options? [#options-2] > `optional` **options**: [`UploadContentOptions`](UploadContentOptions.md) ### parentFolderId? [#parentfolderid-3] > `optional` **parentFolderId**: `string` ## Defined in [#defined-in-199] [src/clients/uploadProxy.ts:46](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/uploadProxy.ts#L46) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/uploadProxy](../README.md) / UploadContentOptions # Type Alias: UploadContentOptions [#type-alias-uploadcontentoptions] > **UploadContentOptions**: `object` ## Type declaration [#type-declaration-62] ### functionName? [#functionname] > `optional` **functionName**: `string` ### siteId? [#siteid-4] > `optional` **siteId**: `string` ## Defined in [#defined-in-200] [src/clients/uploadProxy.ts:60](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/uploadProxy.ts#L60) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/uploadProxy](../README.md) / UploadPinResponse # Type Alias: UploadPinResponse [#type-alias-uploadpinresponse] > **UploadPinResponse**: `object` ## Type declaration [#type-declaration-63] ### duplicate [#duplicate-1] > **duplicate**: `boolean` ### pin [#pin-1] > **pin**: `Pick`\<`Pin`, `"cid"` | `"size"`> ## Defined in [#defined-in-201] [src/clients/uploadProxy.ts:65](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/uploadProxy.ts#L65) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/uploadProxy](../README.md) / UploadPrivateContentArgs # Type Alias: UploadPrivateContentArgs [#type-alias-uploadprivatecontentargs] > **UploadPrivateContentArgs**: `object` ## Type declaration [#type-declaration-64] ### file [#file-1] > **file**: `File` ### fileHash [#filehash] > **fileHash**: `string` ### onUploadProgress()? [#onuploadprogress-5] > `optional` **onUploadProgress**: (`uploadProgress`) => `void` #### Parameters [#parameters-105] • **uploadProgress**: [`UploadProgress`](UploadProgress.md) #### Returns [#returns-127] `void` ## Defined in [#defined-in-202] [src/clients/uploadProxy.ts:54](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/uploadProxy.ts#L54) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/uploadProxy](../README.md) / UploadProgress # Type Alias: UploadProgress [#type-alias-uploadprogress] > **UploadProgress**: `object` ## Type declaration [#type-declaration-65] ### loadedSize [#loadedsize] > **loadedSize**: `number` ### totalSize? [#totalsize] > `optional` **totalSize**: `number` ## Defined in [#defined-in-203] [src/clients/uploadProxy.ts:36](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/uploadProxy.ts#L36) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/uploadProxy](../README.md) / UploadProxyClientOptions # Type Alias: UploadProxyClientOptions [#type-alias-uploadproxyclientoptions] > **UploadProxyClientOptions**: `object` ## Type declaration [#type-declaration-66] ### accessTokenService [#accesstokenservice-1] > **accessTokenService**: `AccessTokenService` ### uploadProxyApiUrl [#uploadproxyapiurl] > **uploadProxyApiUrl**: `string` ## Defined in [#defined-in-204] [src/clients/uploadProxy.ts:41](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/uploadProxy.ts#L41) *** [**@alternatefutures/sdk**](../../README.md) • **Docs** *** [@alternatefutures/sdk](../../README.md) / clients/user # clients/user [#clientsuser] ## Index [#index-12] ### Classes [#classes-12] * [UserClient](classes/UserClient.md) ### Type Aliases [#type-aliases-12] * [UserClientOptions](type-aliases/UserClientOptions.md) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/user](../README.md) / UserClient # Class: UserClient [#class-userclient] ## Constructors [#constructors-12] ### new UserClient() [#new-userclient] > **new UserClient**(`options`): [`UserClient`](UserClient.md) #### Parameters [#parameters-106] • **options**: [`UserClientOptions`](../type-aliases/UserClientOptions.md) #### Returns [#returns-128] [`UserClient`](UserClient.md) #### Defined in [#defined-in-205] [src/clients/user.ts:10](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/user.ts#L10) ## Methods [#methods-12] ### deletePersonalAccessToken() [#deletepersonalaccesstoken] > **deletePersonalAccessToken**(`__namedParameters`): `Promise`\<`Pick`\<`object`, `"__typename"` | `"createdAt"` | `"id"` | `"name"` | `"updatedAt"` | `"maskedToken"`>> #### Parameters [#parameters-107] • **\_\_namedParameters** • **\_\_namedParameters.id**: `string` #### Returns [#returns-129] `Promise`\<`Pick`\<`object`, `"__typename"` | `"createdAt"` | `"id"` | `"name"` | `"updatedAt"` | `"maskedToken"`>> #### Defined in [#defined-in-206] [src/clients/user.ts:30](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/user.ts#L30) *** ### listPersonalAccessTokens() [#listpersonalaccesstokens] > **listPersonalAccessTokens**(): `Promise`\<`Pick`\<`object`, `"createdAt"` | `"id"` | `"name"` | `"maskedToken"`>\[]> #### Returns [#returns-130] `Promise`\<`Pick`\<`object`, `"createdAt"` | `"id"` | `"name"` | `"maskedToken"`>\[]> #### Defined in [#defined-in-207] [src/clients/user.ts:14](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/user.ts#L14) *** [**@alternatefutures/sdk**](../../../README.md) • **Docs** *** [@alternatefutures/sdk](../../../README.md) / [clients/user](../README.md) / UserClientOptions # Type Alias: UserClientOptions [#type-alias-userclientoptions] > **UserClientOptions**: `object` ## Type declaration [#type-declaration-67] ### graphqlClient [#graphqlclient-9] > **graphqlClient**: [`Client`](../../../index/interfaces/Client.md) ## Defined in [#defined-in-208] [src/clients/user.ts:3](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/clients/user.ts#L3) *** [**@alternatefutures/sdk**](../README.md) • **Docs** *** [@alternatefutures/sdk](../README.md) / index # index [#index-13] ## Index [#index-14] ### Classes [#classes-13] * [AlternateFuturesSdk](classes/AlternateFuturesSdk.md) * [ApplicationAccessTokenService](classes/ApplicationAccessTokenService.md) * [PersonalAccessTokenService](classes/PersonalAccessTokenService.md) * [StaticAccessTokenService](classes/StaticAccessTokenService.md) ### Interfaces [#interfaces] * [ApplicationWhiteLabelDomain](interfaces/ApplicationWhiteLabelDomain.md) * [ApplicationWhitelistDomain](interfaces/ApplicationWhitelistDomain.md) * [Client](interfaces/Client.md) ### Type Aliases [#type-aliases-13] * [AFFunctionStatus](type-aliases/AFFunctionStatus.md) * [DomainStatus](type-aliases/DomainStatus.md) ### Functions [#functions] * [createClient](functions/createClient.md) ## References [#references] ### AFFunction [#affunction] Re-exports [AFFunction](../clients/functions/type-aliases/AFFunction.md) *** ### Application [#application] Re-exports [Application](../clients/applications/type-aliases/Application.md) *** ### BillingClient [#billingclient] Re-exports [BillingClient](../clients/billing/classes/BillingClient.md) *** ### CurrentUsage [#currentusage] Re-exports [CurrentUsage](../clients/billing/type-aliases/CurrentUsage.md) *** ### Customer [#customer] Re-exports [Customer](../clients/billing/type-aliases/Customer.md) *** ### Deployment [#deployment] Re-exports [Deployment](../clients/sites/type-aliases/Deployment.md) *** ### Domain [#domain] Re-exports [Domain](../clients/domains/type-aliases/Domain.md) *** ### EnsRecord [#ensrecord] Re-exports [EnsRecord](../clients/ens/type-aliases/EnsRecord.md) *** ### Invoice [#invoice] Re-exports [Invoice](../clients/billing/type-aliases/Invoice.md) *** ### InvoiceLineItem [#invoicelineitem] Re-exports [InvoiceLineItem](../clients/billing/type-aliases/InvoiceLineItem.md) *** ### IpfsFile [#ipfsfile] Re-exports [IpfsFile](../clients/ipfs/type-aliases/IpfsFile.md) *** ### IpnsRecord [#ipnsrecord-1] Re-exports [IpnsRecord](../clients/ipns/type-aliases/IpnsRecord.md) *** ### Payment [#payment] Re-exports [Payment](../clients/billing/type-aliases/Payment.md) *** ### PaymentMethod [#paymentmethod] Re-exports [PaymentMethod](../clients/billing/type-aliases/PaymentMethod.md) *** ### PrivateGateway [#privategateway] Re-exports [PrivateGateway](../clients/privateGateway/type-aliases/PrivateGateway.md) *** ### Project [#project-1] Re-exports [Project](../clients/projects/type-aliases/Project.md) *** ### Site [#site-1] Re-exports [Site](../clients/sites/type-aliases/Site.md) *** ### StoragePin [#storagepin] Re-exports [StoragePin](../clients/storage/type-aliases/StoragePin.md) *** ### Subscription [#subscription] Re-exports [Subscription](../clients/billing/type-aliases/Subscription.md) *** ### UploadContentOptions [#uploadcontentoptions] Re-exports [UploadContentOptions](../clients/uploadProxy/type-aliases/UploadContentOptions.md) *** ### UploadPinResponse [#uploadpinresponse] Re-exports [UploadPinResponse](../clients/uploadProxy/type-aliases/UploadPinResponse.md) *** ### UploadProgress [#uploadprogress] Re-exports [UploadProgress](../clients/uploadProxy/type-aliases/UploadProgress.md) *** ### UsageMetric [#usagemetric] Re-exports [UsageMetric](../clients/billing/type-aliases/UsageMetric.md) *** ### UsageRecord [#usagerecord] Re-exports [UsageRecord](../clients/billing/type-aliases/UsageRecord.md) *** ### Zone [#zone] Re-exports [Zone](../clients/domains/type-aliases/Zone.md) *** [**@alternatefutures/sdk**](../../README.md) • **Docs** *** [@alternatefutures/sdk](../../README.md) / [index](../README.md) / AlternateFuturesSdk # Class: AlternateFuturesSdk [#class-alternatefuturessdk] ## Constructors [#constructors-13] ### new AlternateFuturesSdk() [#new-alternatefuturessdk] > **new AlternateFuturesSdk**(`__namedParameters`): [`AlternateFuturesSdk`](AlternateFuturesSdk.md) #### Parameters [#parameters-108] • **\_\_namedParameters**: `AlternateFuturesSdkOptions` #### Returns [#returns-131] [`AlternateFuturesSdk`](AlternateFuturesSdk.md) #### Defined in [#defined-in-209] [src/AlternateFuturesSdk.ts:69](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/AlternateFuturesSdk.ts#L69) ## Methods [#methods-13] ### applications() [#applications] > **applications**(): [`ApplicationsClient`](../../clients/applications/classes/ApplicationsClient.md) #### Returns [#returns-132] [`ApplicationsClient`](../../clients/applications/classes/ApplicationsClient.md) #### Defined in [#defined-in-210] [src/AlternateFuturesSdk.ts:187](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/AlternateFuturesSdk.ts#L187) *** ### billing() [#billing] > **billing**(): [`BillingClient`](../../clients/billing/classes/BillingClient.md) #### Returns [#returns-133] [`BillingClient`](../../clients/billing/classes/BillingClient.md) #### Defined in [#defined-in-211] [src/AlternateFuturesSdk.ts:236](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/AlternateFuturesSdk.ts#L236) *** ### domains() [#domains-1] > **domains**(): [`DomainsClient`](../../clients/domains/classes/DomainsClient.md) #### Returns [#returns-134] [`DomainsClient`](../../clients/domains/classes/DomainsClient.md) #### Defined in [#defined-in-212] [src/AlternateFuturesSdk.ts:177](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/AlternateFuturesSdk.ts#L177) *** ### ens() [#ens] > **ens**(): [`EnsClient`](../../clients/ens/classes/EnsClient.md) #### Returns [#returns-135] [`EnsClient`](../../clients/ens/classes/EnsClient.md) #### Defined in [#defined-in-213] [src/AlternateFuturesSdk.ts:197](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/AlternateFuturesSdk.ts#L197) *** ### functions() [#functions-1] > **functions**(): [`FunctionsClient`](../../clients/functions/classes/FunctionsClient.md) #### Returns [#returns-136] [`FunctionsClient`](../../clients/functions/classes/FunctionsClient.md) #### Defined in [#defined-in-214] [src/AlternateFuturesSdk.ts:226](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/AlternateFuturesSdk.ts#L226) *** ### getVersion() [#getversion] > **getVersion**(): `Promise`\<`Pick`\<`object`, `"version"`>> #### Returns [#returns-137] `Promise`\<`Pick`\<`object`, `"version"`>> #### Defined in [#defined-in-215] [src/AlternateFuturesSdk.ts:120](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/AlternateFuturesSdk.ts#L120) *** ### ipfs() [#ipfs] > **ipfs**(): [`IpfsClient`](../../clients/ipfs/classes/IpfsClient.md) #### Returns [#returns-138] [`IpfsClient`](../../clients/ipfs/classes/IpfsClient.md) #### Defined in [#defined-in-216] [src/AlternateFuturesSdk.ts:145](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/AlternateFuturesSdk.ts#L145) *** ### ipns() [#ipns] > **ipns**(): [`IpnsClient`](../../clients/ipns/classes/IpnsClient.md) #### Returns [#returns-139] [`IpnsClient`](../../clients/ipns/classes/IpnsClient.md) #### Defined in [#defined-in-217] [src/AlternateFuturesSdk.ts:137](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/AlternateFuturesSdk.ts#L137) *** ### privateGateways() [#privategateways] > **privateGateways**(): [`PrivateGatewayClient`](../../clients/privateGateway/classes/PrivateGatewayClient.md) #### Returns [#returns-140] [`PrivateGatewayClient`](../../clients/privateGateway/classes/PrivateGatewayClient.md) #### Defined in [#defined-in-218] [src/AlternateFuturesSdk.ts:205](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/AlternateFuturesSdk.ts#L205) *** ### projects() [#projects] > **projects**(): [`ProjectsClient`](../../clients/projects/classes/ProjectsClient.md) #### Returns [#returns-141] [`ProjectsClient`](../../clients/projects/classes/ProjectsClient.md) #### Defined in [#defined-in-219] [src/AlternateFuturesSdk.ts:167](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/AlternateFuturesSdk.ts#L167) *** ### sites() [#sites] > **sites**(): [`SitesClient`](../../clients/sites/classes/SitesClient.md) #### Returns [#returns-142] [`SitesClient`](../../clients/sites/classes/SitesClient.md) #### Defined in [#defined-in-220] [src/AlternateFuturesSdk.ts:159](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/AlternateFuturesSdk.ts#L159) *** ### storage() [#storage-1] > **storage**(): [`StorageClient`](../../clients/storage/classes/StorageClient.md) #### Returns [#returns-143] [`StorageClient`](../../clients/storage/classes/StorageClient.md) #### Defined in [#defined-in-221] [src/AlternateFuturesSdk.ts:215](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/AlternateFuturesSdk.ts#L215) *** ### user() [#user] > **user**(): [`UserClient`](../../clients/user/classes/UserClient.md) #### Returns [#returns-144] [`UserClient`](../../clients/user/classes/UserClient.md) #### Defined in [#defined-in-222] [src/AlternateFuturesSdk.ts:129](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/AlternateFuturesSdk.ts#L129) *** [**@alternatefutures/sdk**](../../README.md) • **Docs** *** [@alternatefutures/sdk](../../README.md) / [index](../README.md) / ApplicationAccessTokenService # Class: ApplicationAccessTokenService [#class-applicationaccesstokenservice] ## Extends [#extends] * `AccessTokenService` ## Constructors [#constructors-14] ### new ApplicationAccessTokenService() [#new-applicationaccesstokenservice] > **new ApplicationAccessTokenService**(`__namedParameters`): [`ApplicationAccessTokenService`](ApplicationAccessTokenService.md) #### Parameters [#parameters-109] • **\_\_namedParameters**: `ApplicationAccessTokenServiceOptions` #### Returns [#returns-145] [`ApplicationAccessTokenService`](ApplicationAccessTokenService.md) #### Overrides [#overrides] `AccessTokenService.constructor` #### Defined in [#defined-in-223] [src/libs/AccessTokenService/ApplicationAccessTokenService.ts:21](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/libs/AccessTokenService/ApplicationAccessTokenService.ts#L21) ## Methods [#methods-14] ### getAccessToken() [#getaccesstoken] > **getAccessToken**(): `Promise`\<`string`> #### Returns [#returns-146] `Promise`\<`string`> #### Overrides [#overrides-1] `AccessTokenService.getAccessToken` #### Defined in [#defined-in-224] [src/libs/AccessTokenService/ApplicationAccessTokenService.ts:54](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/libs/AccessTokenService/ApplicationAccessTokenService.ts#L54) *** [**@alternatefutures/sdk**](../../README.md) • **Docs** *** [@alternatefutures/sdk](../../README.md) / [index](../README.md) / PersonalAccessTokenService # Class: PersonalAccessTokenService [#class-personalaccesstokenservice] ## Extends [#extends-1] * `AccessTokenService` ## Constructors [#constructors-15] ### new PersonalAccessTokenService() [#new-personalaccesstokenservice] > **new PersonalAccessTokenService**(`__namedParameters`): [`PersonalAccessTokenService`](PersonalAccessTokenService.md) #### Parameters [#parameters-110] • **\_\_namedParameters**: `PersonalAccessTokenServiceOptions` #### Returns [#returns-147] [`PersonalAccessTokenService`](PersonalAccessTokenService.md) #### Overrides [#overrides-2] `AccessTokenService.constructor` #### Defined in [#defined-in-225] [src/libs/AccessTokenService/PersonalAccessTokenService.ts:22](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/libs/AccessTokenService/PersonalAccessTokenService.ts#L22) ## Methods [#methods-15] ### close() [#close] > **close**(): `void` #### Returns [#returns-148] `void` #### Defined in [#defined-in-226] [src/libs/AccessTokenService/PersonalAccessTokenService.ts:86](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/libs/AccessTokenService/PersonalAccessTokenService.ts#L86) *** ### getAccessToken() [#getaccesstoken-1] > **getAccessToken**(): `Promise`\<`string`> #### Returns [#returns-149] `Promise`\<`string`> #### Overrides [#overrides-3] `AccessTokenService.getAccessToken` #### Defined in [#defined-in-227] [src/libs/AccessTokenService/PersonalAccessTokenService.ts:78](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/libs/AccessTokenService/PersonalAccessTokenService.ts#L78) *** [**@alternatefutures/sdk**](../../README.md) • **Docs** *** [@alternatefutures/sdk](../../README.md) / [index](../README.md) / StaticAccessTokenService # Class: StaticAccessTokenService [#class-staticaccesstokenservice] ## Extends [#extends-2] * `AccessTokenService` ## Constructors [#constructors-16] ### new StaticAccessTokenService() [#new-staticaccesstokenservice] > **new StaticAccessTokenService**(`__namedParameters`): [`StaticAccessTokenService`](StaticAccessTokenService.md) #### Parameters [#parameters-111] • **\_\_namedParameters**: `StaticAccessTokenServiceOptions` #### Returns [#returns-150] [`StaticAccessTokenService`](StaticAccessTokenService.md) #### Overrides [#overrides-4] `AccessTokenService.constructor` #### Defined in [#defined-in-228] [src/libs/AccessTokenService/StaticAccessTokenService.ts:12](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/libs/AccessTokenService/StaticAccessTokenService.ts#L12) ## Methods [#methods-16] ### getAccessToken() [#getaccesstoken-2] > **getAccessToken**(): `Promise`\<`string`> #### Returns [#returns-151] `Promise`\<`string`> #### Overrides [#overrides-5] `AccessTokenService.getAccessToken` #### Defined in [#defined-in-229] [src/libs/AccessTokenService/StaticAccessTokenService.ts:22](https://github.com/alternatefutures/alternate-clouds-sdk/blob/main/src/libs/AccessTokenService/StaticAccessTokenService.ts#L22) *** [**@alternatefutures/sdk**](../../README.md) • **Docs** *** [@alternatefutures/sdk](../../README.md) / [index](../README.md) / createClient # Function: createClient() [#function-createclient] > **createClient**(`options`?): [`Client`](../interfaces/Client.md) ## Parameters [#parameters-112] • **options?**: `ClientOptions` ## Returns [#returns-152] [`Client`](../interfaces/Client.md) ## Defined in [#defined-in-230] node\_modules/.pnpm/@alternatefutures+utils-genql-client\@0.2.0/node\_modules/@alternatefutures/utils-genql-client/dist/index.ts:34 *** [**@alternatefutures/sdk**](../../README.md) • **Docs** *** [@alternatefutures/sdk](../../README.md) / [index](../README.md) / ApplicationWhiteLabelDomain # Interface: ApplicationWhiteLabelDomain [#interface-applicationwhitelabeldomain] ## Properties [#properties] ### \_\_typename [#__typename] > **\_\_typename**: `"ApplicationWhiteLabelDomain"` #### Defined in [#defined-in-231] node\_modules/.pnpm/@alternatefutures+utils-genql-client\@0.2.0/node\_modules/@alternatefutures/utils-genql-client/dist/schema.ts:37 *** ### createdAt [#createdat-8] > **createdAt**: `any` #### Defined in [#defined-in-232] node\_modules/.pnpm/@alternatefutures+utils-genql-client\@0.2.0/node\_modules/@alternatefutures/utils-genql-client/dist/schema.ts:33 *** ### hostname [#hostname] > **hostname**: `string` #### Defined in [#defined-in-233] node\_modules/.pnpm/@alternatefutures+utils-genql-client\@0.2.0/node\_modules/@alternatefutures/utils-genql-client/dist/schema.ts:34 *** ### id [#id-20] > **id**: `string` #### Defined in [#defined-in-234] node\_modules/.pnpm/@alternatefutures+utils-genql-client\@0.2.0/node\_modules/@alternatefutures/utils-genql-client/dist/schema.ts:35 *** ### updatedAt [#updatedat] > **updatedAt**: `any` #### Defined in [#defined-in-235] node\_modules/.pnpm/@alternatefutures+utils-genql-client\@0.2.0/node\_modules/@alternatefutures/utils-genql-client/dist/schema.ts:36 *** [**@alternatefutures/sdk**](../../README.md) • **Docs** *** [@alternatefutures/sdk](../../README.md) / [index](../README.md) / ApplicationWhitelistDomain # Interface: ApplicationWhitelistDomain [#interface-applicationwhitelistdomain] ## Properties [#properties-1] ### \_\_typename [#__typename-1] > **\_\_typename**: `"ApplicationWhitelistDomain"` #### Defined in [#defined-in-236] node\_modules/.pnpm/@alternatefutures+utils-genql-client\@0.2.0/node\_modules/@alternatefutures/utils-genql-client/dist/schema.ts:57 *** ### createdAt [#createdat-9] > **createdAt**: `any` #### Defined in [#defined-in-237] node\_modules/.pnpm/@alternatefutures+utils-genql-client\@0.2.0/node\_modules/@alternatefutures/utils-genql-client/dist/schema.ts:53 *** ### hostname [#hostname-1] > **hostname**: `string` #### Defined in [#defined-in-238] node\_modules/.pnpm/@alternatefutures+utils-genql-client\@0.2.0/node\_modules/@alternatefutures/utils-genql-client/dist/schema.ts:54 *** ### id [#id-21] > **id**: `string` #### Defined in [#defined-in-239] node\_modules/.pnpm/@alternatefutures+utils-genql-client\@0.2.0/node\_modules/@alternatefutures/utils-genql-client/dist/schema.ts:55 *** ### updatedAt [#updatedat-1] > **updatedAt**: `any` #### Defined in [#defined-in-240] node\_modules/.pnpm/@alternatefutures+utils-genql-client\@0.2.0/node\_modules/@alternatefutures/utils-genql-client/dist/schema.ts:56 *** [**@alternatefutures/sdk**](../../README.md) • **Docs** *** [@alternatefutures/sdk](../../README.md) / [index](../README.md) / Client # Interface: Client [#interface-client] ## Methods [#methods-17] ### mutation() [#mutation] > **mutation**\<`R`>(`request`): `Promise`\<`FieldsSelection`\<`Mutation`, `R`>> #### Type Parameters [#type-parameters] • **R** *extends* `MutationGenqlSelection` #### Parameters [#parameters-113] • **request**: `R` & `object` #### Returns [#returns-153] `Promise`\<`FieldsSelection`\<`Mutation`, `R`>> #### Defined in [#defined-in-241] node\_modules/.pnpm/@alternatefutures+utils-genql-client\@0.2.0/node\_modules/@alternatefutures/utils-genql-client/dist/index.ts:29 *** ### query() [#query] > **query**\<`R`>(`request`): `Promise`\<`FieldsSelection`\<`Query`, `R`>> #### Type Parameters [#type-parameters-1] • **R** *extends* `QueryGenqlSelection` #### Parameters [#parameters-114] • **request**: `R` & `object` #### Returns [#returns-154] `Promise`\<`FieldsSelection`\<`Query`, `R`>> #### Defined in [#defined-in-242] node\_modules/.pnpm/@alternatefutures+utils-genql-client\@0.2.0/node\_modules/@alternatefutures/utils-genql-client/dist/index.ts:25 *** [**@alternatefutures/sdk**](../../README.md) • **Docs** *** [@alternatefutures/sdk](../../README.md) / [index](../README.md) / AFFunctionStatus # Type Alias: AFFunctionStatus [#type-alias-affunctionstatus] > **AFFunctionStatus**: `"ACTIVE"` | `"INACTIVE"` ## Defined in [#defined-in-243] node\_modules/.pnpm/@alternatefutures+utils-genql-client\@0.2.0/node\_modules/@alternatefutures/utils-genql-client/dist/schema.ts:506 *** [**@alternatefutures/sdk**](../../README.md) • **Docs** *** [@alternatefutures/sdk](../../README.md) / [index](../README.md) / DomainStatus # Type Alias: DomainStatus [#type-alias-domainstatus] > **DomainStatus**: `"ACTIVE"` | `"CREATED"` | `"CREATING"` | `"CREATING_FAILED"` | `"DELETING"` | `"DELETING_FAILED"` | `"VERIFYING"` | `"VERIFYING_FAILED"` ## Defined in [#defined-in-244] node\_modules/.pnpm/@alternatefutures+utils-genql-client\@0.2.0/node\_modules/@alternatefutures/utils-genql-client/dist/schema.ts:331 ***