@spacefast/wpcloud-sdk 0.0.2

package/dist/generated/sdk.gen.d.ts

@@ -0,0 +1,840 @@
+import { type Options as ClientOptions, type TDataShape, type Client } from "./client";
+import type { PostCustomCertificatesSiteCustomCertificateIdActivateData, PostCustomCertificatesSiteCustomCertificateIdActivateResponses, PostCustomCertificatesSiteCustomCertificateIdActivateErrors, PostClientMetaClientKeyAddData, PostClientMetaClientKeyAddResponses, PostClientMetaClientKeyAddErrors, PostCrontabSiteAddData, PostCrontabSiteAddResponses, PostCrontabSiteAddErrors, PostFirewallRulesSiteAddData, PostFirewallRulesSiteAddResponses, PostFirewallRulesSiteAddErrors, PostSitePersistDataSiteData, PostSitePersistDataSiteResponses, PostSitePersistDataSiteErrors, PostSshUserServiceIdentifierAddData, PostSshUserServiceIdentifierAddResponses, PostSshUserServiceIdentifierAddErrors, PostSiteAllowSshMigrationSiteData, PostSiteAllowSshMigrationSiteResponses, PostSiteAllowSshMigrationSiteErrors, GetEdgeCacheSiteDdosUntilData, GetEdgeCacheSiteDdosUntilResponses, GetEdgeCacheSiteDdosUntilErrors, PostEdgeCacheSiteDdosUntilData, PostEdgeCacheSiteDdosUntilResponses, PostEdgeCacheSiteDdosUntilErrors, GetEdgeCacheSiteDdosUntilDomainData, GetEdgeCacheSiteDdosUntilDomainResponses, GetEdgeCacheSiteDdosUntilDomainErrors, PostEdgeCacheSiteDdosUntilDomainData, PostEdgeCacheSiteDdosUntilDomainResponses, PostEdgeCacheSiteDdosUntilDomainErrors, GetSiteConvertDbCharsetServiceIdentifierFromToData, GetSiteConvertDbCharsetServiceIdentifierFromToResponses, GetSiteConvertDbCharsetServiceIdentifierFromToErrors, PostAliasPkeySetClientCategoryNameData, PostAliasPkeySetClientCategoryNameResponses, PostAliasPkeySetClientCategoryNameErrors, PostCreateSiteClientData, PostCreateSiteClientResponses, PostCreateSiteClientErrors, PostTaskCreateClientTypeData, PostTaskCreateClientTypeResponses, PostTaskCreateClientTypeErrors, PostCustomCertificatesSiteIdDeactivateData, PostCustomCertificatesSiteIdDeactivateResponses, PostCustomCertificatesSiteIdDeactivateErrors, PostCustomCertificatesSiteIdDeleteData, PostCustomCertificatesSiteIdDeleteResponses, PostCustomCertificatesSiteIdDeleteErrors, PostDeleteSiteServiceIdentifierData, PostDeleteSiteServiceIdentifierResponses, PostDeleteSiteServiceIdentifierErrors, PostSslHstsPreloadDomainFalseData, PostSslHstsPreloadDomainFalseResponses, PostSslHstsPreloadDomainFalseErrors, PostSslInfoDomainData, PostSslInfoDomainResponses, PostSslInfoDomainErrors, GetGetAvailableDatacentersClientData, GetGetAvailableDatacentersClientResponses, GetGetAvailableDatacentersClientErrors, GetGetIpsClientData, GetGetIpsClientResponses, GetGetIpsClientErrors, GetGetIpsClientDomainData, GetGetIpsClientDomainResponses, GetGetIpsClientDomainErrors, GetClientMetaClientKeyGetData, GetClientMetaClientKeyGetResponses, GetClientMetaClientKeyGetErrors, GetCustomCertificatesSiteData, GetCustomCertificatesSiteResponses, GetCustomCertificatesSiteErrors, GetCustomCertificatesSiteIdData, GetCustomCertificatesSiteIdResponses, GetCustomCertificatesSiteIdErrors, GetGetDomainVerificationCodeClientDomainData, GetGetDomainVerificationCodeClientDomainResponses, GetGetDomainVerificationCodeClientDomainErrors, GetEdgeCacheSiteData, GetEdgeCacheSiteResponses, GetEdgeCacheSiteErrors, GetEdgeCacheSiteActionData, GetEdgeCacheSiteActionResponses, GetEdgeCacheSiteActionErrors, PostEdgeCacheSiteActionData, PostEdgeCacheSiteActionResponses, PostEdgeCacheSiteActionErrors, GetEdgeCacheSiteActionDomainData, GetEdgeCacheSiteActionDomainResponses, GetEdgeCacheSiteActionDomainErrors, PostEdgeCacheSiteActionDomainData, PostEdgeCacheSiteActionDomainResponses, PostEdgeCacheSiteActionDomainErrors, GetJobCompletionIdData, GetJobCompletionIdResponses, GetJobCompletionIdErrors, PostJobCompletionIdData, PostJobCompletionIdResponses, PostJobCompletionIdErrors, GetJobStatusData, GetJobStatusResponses, GetJobStatusErrors, PostJobStatusData, PostJobStatusResponses, PostJobStatusErrors, GetJobStatusIdData, GetJobStatusIdResponses, GetJobStatusIdErrors, PostJobStatusIdData, PostJobStatusIdResponses, PostJobStatusIdErrors, PostResponseTicketMultiStatusData, PostResponseTicketMultiStatusResponses, PostResponseTicketMultiStatusErrors, GetGetPhpVersionsClientVerboseData, GetGetPhpVersionsClientVerboseResponses, GetGetPhpVersionsClientVerboseErrors, GetAliasPkeyGetClientCategoryNameData, GetAliasPkeyGetClientCategoryNameResponses, GetAliasPkeyGetClientCategoryNameErrors, PostResponseTicketGetFullData, PostResponseTicketGetFullResponses, PostResponseTicketGetFullErrors, PostResponseTicketGetSummaryData, PostResponseTicketGetSummaryResponses, PostResponseTicketGetSummaryErrors, GetSiteBackupGetServiceIdentifierBackupIdData, GetSiteBackupGetServiceIdentifierBackupIdResponses, GetSiteBackupGetServiceIdentifierBackupIdErrors, GetSiteBackupInfoServiceIdentifierBackupIdData, GetSiteBackupInfoServiceIdentifierBackupIdResponses, GetSiteBackupInfoServiceIdentifierBackupIdErrors, GetGetSiteSiteExtraData, GetGetSiteSiteExtraResponses, GetGetSiteSiteExtraErrors, PostSiteMetricsSiteSummarizeData, PostSiteMetricsSiteSummarizeResponses, PostSiteMetricsSiteSummarizeErrors, PostSiteErrorLogsSiteData, PostSiteErrorLogsSiteResponses, PostSiteErrorLogsSiteErrors, PostSitePhpmyadminSiteData, PostSitePhpmyadminSiteResponses, PostSitePhpmyadminSiteErrors, GetGetSshUserUsernameData, GetGetSshUserUsernameResponses, GetGetSshUserUsernameErrors, PostTaskGetAtomicTaskIdData, PostTaskGetAtomicTaskIdResponses, PostTaskGetAtomicTaskIdErrors, PostMetricsTypeKeySummarizeData, PostMetricsTypeKeySummarizeResponses, PostMetricsTypeKeySummarizeErrors, PostUsageSiteData, PostUsageSiteResponses, PostUsageSiteErrors, PostSiteLogsSiteData, PostSiteLogsSiteResponses, PostSiteLogsSiteErrors, PostLogsSiteSiteData, PostLogsSiteSiteResponses, PostLogsSiteSiteErrors, PostTaskInterruptTaskIdData, PostTaskInterruptTaskIdResponses, PostTaskInterruptTaskIdErrors, GetGetSitesClientData, GetGetSitesClientResponses, GetGetSitesClientErrors, GetGetSitesClientMetaData, GetGetSitesClientMetaResponses, GetGetSitesClientMetaErrors, GetCrontabSiteListData, GetCrontabSiteListResponses, GetCrontabSiteListErrors, GetCustomCertificatesSiteListData, GetCustomCertificatesSiteListResponses, GetCustomCertificatesSiteListErrors, GetWebhookFailuresClientData, GetWebhookFailuresClientResponses, GetWebhookFailuresClientErrors, GetFirewallRulesSiteListData, GetFirewallRulesSiteListResponses, GetFirewallRulesSiteListErrors, GetAliasPkeyCategoriesClientData, GetAliasPkeyCategoriesClientResponses, GetAliasPkeyCategoriesClientErrors, PostAliasPkeyListClientCategoryData, PostAliasPkeyListClientCategoryResponses, PostAliasPkeyListClientCategoryErrors, GetSiteBackupsListServiceIdentifierData, GetSiteBackupsListServiceIdentifierResponses, GetSiteBackupsListServiceIdentifierErrors, GetSiteBackupsListServiceIdentifierBackupTypeData, GetSiteBackupsListServiceIdentifierBackupTypeResponses, GetSiteBackupsListServiceIdentifierBackupTypeErrors, GetSshUserServiceIdentifierListData, GetSshUserServiceIdentifierListResponses, GetSshUserServiceIdentifierListErrors, GetEmailBlockClientActionTypeData, GetEmailBlockClientActionTypeResponses, GetEmailBlockClientActionTypeErrors, GetClientAuthorizedKeysClientActionData, GetClientAuthorizedKeysClientActionResponses, GetClientAuthorizedKeysClientActionErrors, PostClientAuthorizedKeysClientActionData, PostClientAuthorizedKeysClientActionResponses, PostClientAuthorizedKeysClientActionErrors, GetClientAuthorizedKeysClientActionIdData, GetClientAuthorizedKeysClientActionIdResponses, GetClientAuthorizedKeysClientActionIdErrors, PostClientAuthorizedKeysClientActionIdData, PostClientAuthorizedKeysClientActionIdResponses, PostClientAuthorizedKeysClientActionIdErrors, GetSiteAliasServiceIdentifierActionData, GetSiteAliasServiceIdentifierActionResponses, GetSiteAliasServiceIdentifierActionErrors, GetSiteMetaSiteKeyActionData, GetSiteMetaSiteKeyActionResponses, GetSiteMetaSiteKeyActionErrors, PostSiteMetaSiteKeyActionData, PostSiteMetaSiteKeyActionResponses, PostSiteMetaSiteKeyActionErrors, PostSiteManageSoftwareTypeSiteData, PostSiteManageSoftwareTypeSiteResponses, PostSiteManageSoftwareTypeSiteErrors, GetSshDisconnectAllUsersServiceIdentifierData, GetSshDisconnectAllUsersServiceIdentifierResponses, GetSshDisconnectAllUsersServiceIdentifierErrors, GetClientMetaClientKeyRemoveData, GetClientMetaClientKeyRemoveResponses, GetClientMetaClientKeyRemoveErrors, PostCrontabSiteRemoveData, PostCrontabSiteRemoveResponses, PostCrontabSiteRemoveErrors, PostFirewallRulesSiteRemoveData, PostFirewallRulesSiteRemoveResponses, PostFirewallRulesSiteRemoveErrors, PostAliasPkeyRemoveClientCategoryNameData, PostAliasPkeyRemoveClientCategoryNameResponses, PostAliasPkeyRemoveClientCategoryNameErrors, GetSshUserServiceIdentifierRemoveUsernameData, GetSshUserServiceIdentifierRemoveUsernameResponses, GetSshUserServiceIdentifierRemoveUsernameErrors, PostSshUserServiceIdentifierRemoveUsernameData, PostSshUserServiceIdentifierRemoveUsernameResponses, PostSshUserServiceIdentifierRemoveUsernameErrors, PostOnDemandBackupCreateSiteTypeData, PostOnDemandBackupCreateSiteTypeResponses, PostOnDemandBackupCreateSiteTypeErrors, PostOnDemandBackupDeleteSiteBackupIdData, PostOnDemandBackupDeleteSiteBackupIdResponses, PostOnDemandBackupDeleteSiteBackupIdErrors, PostResetDbPasswordTypeSiteData, PostResetDbPasswordTypeSiteResponses, PostResetDbPasswordTypeSiteErrors, PostResetDbPasswordTypeSiteNewData, PostResetDbPasswordTypeSiteNewResponses, PostResetDbPasswordTypeSiteNewErrors, PostRestoreSiteSiteData, PostRestoreSiteSiteResponses, PostRestoreSiteSiteErrors, PostSslRetryDomainData, PostSslRetryDomainResponses, PostSslRetryDomainErrors, PostMalwareScanSiteData, PostMalwareScanSiteResponses, PostMalwareScanSiteErrors, PostCustomCertificatesSiteStageData, PostCustomCertificatesSiteStageResponses, PostCustomCertificatesSiteStageErrors, PostSslAndroidCompatDomainEnableData, PostSslAndroidCompatDomainEnableResponses, PostSslAndroidCompatDomainEnableErrors, PostSslHstsSubdomainDomainEnableData, PostSslHstsSubdomainDomainEnableResponses, PostSslHstsSubdomainDomainEnableErrors, PostSslSocialCrawlerRedirectDomainEnableData, PostSslSocialCrawlerRedirectDomainEnableResponses, PostSslSocialCrawlerRedirectDomainEnableErrors, PostCustomCertificatesSiteIdUpdateData, PostCustomCertificatesSiteIdUpdateResponses, PostCustomCertificatesSiteIdUpdateErrors, PostClientMetaClientKeyUpdateData, PostClientMetaClientKeyUpdateResponses, PostClientMetaClientKeyUpdateErrors, PostCrontabSiteUpdateCronIdData, PostCrontabSiteUpdateCronIdResponses, PostCrontabSiteUpdateCronIdErrors, PostSiteSetChrootSiteDesiredData, PostSiteSetChrootSiteDesiredResponses, PostSiteSetChrootSiteDesiredErrors, PostUpdateSiteDomainServiceIdentifierDomainData, PostUpdateSiteDomainServiceIdentifierDomainResponses, PostUpdateSiteDomainServiceIdentifierDomainErrors, PostUpdateSiteDomainServiceIdentifierDomainKeepData, PostUpdateSiteDomainServiceIdentifierDomainKeepResponses, PostUpdateSiteDomainServiceIdentifierDomainKeepErrors, PostUpdateSiteOptionsTypeSiteData, PostUpdateSiteOptionsTypeSiteResponses, PostUpdateSiteOptionsTypeSiteErrors, PostSshUserServiceIdentifierUpdateUsernameData, PostSshUserServiceIdentifierUpdateUsernameResponses, PostSshUserServiceIdentifierUpdateUsernameErrors, PostSiteWordpressVersionSiteVersionData, PostSiteWordpressVersionSiteVersionResponses, PostSiteWordpressVersionSiteVersionErrors, PostCustomCertificatesSiteValidateData, PostCustomCertificatesSiteValidateResponses, PostCustomCertificatesSiteValidateErrors, GetCheckCanHostDomainClientDomainData, GetCheckCanHostDomainClientDomainResponses, GetCheckCanHostDomainClientDomainErrors, GetSiteAliasServiceIdentifierActionDomainData, GetSiteAliasServiceIdentifierActionDomainResponses, GetSiteAliasServiceIdentifierActionDomainErrors } from "./types.gen";
+export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
+    /**
+     * You can provide a client instance returned by `createClient()` instead of
+     * individual options. This might be also useful if you want to implement a
+     * custom client.
+     */
+    client?: Client;
+    /**
+     * You can pass arbitrary values through the `meta` object. This can be
+     * used to access values that aren't defined as part of the SDK function.
+     */
+    meta?: Record<string, unknown>;
+};
+/**
+ * Activate a Staged Custom Certificate
+ * Activate a previously staged custom SSL certificate for use on one or more domains.
+ */
+export declare const postCustomCertificatesSiteCustomCertificateIdActivate: <ThrowOnError extends boolean = true>(options: Options<PostCustomCertificatesSiteCustomCertificateIdActivateData, ThrowOnError>) => import("./client").RequestResult<PostCustomCertificatesSiteCustomCertificateIdActivateResponses, PostCustomCertificatesSiteCustomCertificateIdActivateErrors, ThrowOnError, "fields">;
+/**
+ * Add Client Meta
+ * Add a new client meta value.
+ *
+ * Note: `max_space_quota` is read-only and cannot be added.
+ */
+export declare const postClientMetaClientKeyAdd: <ThrowOnError extends boolean = true>(options: Options<PostClientMetaClientKeyAddData, ThrowOnError>) => import("./client").RequestResult<PostClientMetaClientKeyAddResponses, PostClientMetaClientKeyAddErrors, ThrowOnError, "fields">;
+/**
+ * Add Cron Entry
+ * Adds a cron entry for a site.
+ *
+ * A cron entry runs a `command` on the site according to a given `schedule`.
+ *
+ * A `schedule` is defined using the literals `hourly`, `daily`, `twicedaily` or `weekly`. Shorthand formats are also supported, such as `2h` (twice per hour), `6d` (six times per day), and `3w` (three times per week).
+ *
+ * If the site or client supports the advanced cron feature, the `schedule` may be specified as a full crontab expression. For example, `*\/2 * * * *` runs every two minutes.
+ *
+ * The `command` is executed in an environment similar to an SSH, with utilities such as WP-CLI available. Shell scripts may be used for more complex logic or multi-step commands.
+ *
+ * There are time and concurrency limits for cron entries:
+ *
+ * - Each cron entry has a maximum runtime of 8 hours.
+ * - A cron entry is skipped if its previous execution has not finished.
+ * - Up to three cron entries can run concurrently per site, additional ones will be postponed.
+ *
+ * A webhook named `site-cron-results` is sent if execution of a cron entry fails, either by exiting with a non-zero status code or by breaching concurrency limits.
+ */
+export declare const postCrontabSiteAdd: <ThrowOnError extends boolean = true>(options: Options<PostCrontabSiteAddData, ThrowOnError>) => import("./client").RequestResult<PostCrontabSiteAddResponses, PostCrontabSiteAddErrors, ThrowOnError, "fields">;
+/**
+ * Add Firewall Rule
+ * Add a new firewall rule for a site.
+ */
+export declare const postFirewallRulesSiteAdd: <ThrowOnError extends boolean = true>(options: Options<PostFirewallRulesSiteAddData, ThrowOnError>) => import("./client").RequestResult<PostFirewallRulesSiteAddResponses, PostFirewallRulesSiteAddErrors, ThrowOnError, "fields">;
+/**
+ * Add Persistent Site Data
+ * Add or remove persistent key-value data for a site. Persistent data is preserved across site resets and clones. Parameters use PHP nested array form encoding: data[key][value]=... to set, data[key][delete]=1 to remove.
+ */
+export declare const postSitePersistDataSite: <ThrowOnError extends boolean = true>(options: Options<PostSitePersistDataSiteData, ThrowOnError>) => import("./client").RequestResult<PostSitePersistDataSiteResponses, PostSitePersistDataSiteErrors, ThrowOnError, "fields">;
+/**
+ * Add Site SSH/SFTP User
+ * Create a new SSH/SFTP user for a site. Username must be 5+ characters and not all numbers. Password behavior: omit for random password, empty string for no password (key-only auth), or provide specific password. Allowed key types: ssh-rsa (2048-16384 bits), ecdsa-sha2-nistp256 (256 bits), ssh-ed25519 (256 bits).
+ */
+export declare const postSshUserServiceIdentifierAdd: <ThrowOnError extends boolean = true>(options: Options<PostSshUserServiceIdentifierAddData, ThrowOnError>) => import("./client").RequestResult<PostSshUserServiceIdentifierAddResponses, PostSshUserServiceIdentifierAddErrors, ThrowOnError, "fields">;
+/**
+ * Configure a site to accept an incoming SSH migration
+ * Configure a site to accept an incoming SSH migration. Because an SSH migration, by default is a destructive operation (destroying existing files and database data) you must first configure a site as a migration target before creating a migration for it. In this way you must explicitly signal to us that you accept responsibility for this site and its data being deleted by a migration should one be configured for it. You cannot currently undo this operation.
+ */
+export declare const postSiteAllowSshMigrationSite: <ThrowOnError extends boolean = true>(options: Options<PostSiteAllowSshMigrationSiteData, ThrowOnError>) => import("./client").RequestResult<PostSiteAllowSshMigrationSiteResponses, PostSiteAllowSshMigrationSiteErrors, ThrowOnError, "fields">;
+/**
+ * Get the current Defensive Mode status.
+ * Fetch the current state of Defensive Mode for a site.
+ */
+export declare const getEdgeCacheSiteDdosUntil: <ThrowOnError extends boolean = true>(options: Options<GetEdgeCacheSiteDdosUntilData, ThrowOnError>) => import("./client").RequestResult<GetEdgeCacheSiteDdosUntilResponses, GetEdgeCacheSiteDdosUntilErrors, ThrowOnError, "fields">;
+/**
+ * Configure Defensive Mode for a site.
+ * Enable or disable Defensive Mode for a site.
+ */
+export declare const postEdgeCacheSiteDdosUntil: <ThrowOnError extends boolean = true>(options: Options<PostEdgeCacheSiteDdosUntilData, ThrowOnError>) => import("./client").RequestResult<PostEdgeCacheSiteDdosUntilResponses, PostEdgeCacheSiteDdosUntilErrors, ThrowOnError, "fields">;
+/**
+ * Get the current Defensive Mode status.
+ * Fetch the current state of Defensive Mode for a site.
+ */
+export declare const getEdgeCacheSiteDdosUntilDomain: <ThrowOnError extends boolean = true>(options: Options<GetEdgeCacheSiteDdosUntilDomainData, ThrowOnError>) => import("./client").RequestResult<GetEdgeCacheSiteDdosUntilDomainResponses, GetEdgeCacheSiteDdosUntilDomainErrors, ThrowOnError, "fields">;
+/**
+ * Configure Defensive Mode for a site.
+ * Enable or disable Defensive Mode for a site.
+ */
+export declare const postEdgeCacheSiteDdosUntilDomain: <ThrowOnError extends boolean = true>(options: Options<PostEdgeCacheSiteDdosUntilDomainData, ThrowOnError>) => import("./client").RequestResult<PostEdgeCacheSiteDdosUntilDomainResponses, PostEdgeCacheSiteDdosUntilDomainErrors, ThrowOnError, "fields">;
+/**
+ * Convert Site Database Character Set
+ * Convert a site's tables from a known character set to a specified one.
+ */
+export declare const getSiteConvertDbCharsetServiceIdentifierFromTo: <ThrowOnError extends boolean = true>(options: Options<GetSiteConvertDbCharsetServiceIdentifierFromToData, ThrowOnError>) => import("./client").RequestResult<GetSiteConvertDbCharsetServiceIdentifierFromToResponses, GetSiteConvertDbCharsetServiceIdentifierFromToErrors, ThrowOnError, "fields">;
+/**
+ * Create or Update Public Key
+ * Create or update, as appropriate, an aliasable public key.
+ *
+ * Assuming your client name is "foo", your category is "bar", and your name is "test-key" this endpoint will create or update the public key at the address 'pub://foo/bar?test-key'
+ *
+ * Once created you can use 'pub://foo/bar?test-key' as the value for pkey in the ssh-user endpoint and also authorized_keys_line in the client-authorized-keys endpoint. If you do then when you update the referenced key (such as changing the public key, or changing the parsed options) those changes will be immediately reflected by all ssh-user and client-authorized-keys referencing this address.
+ *
+ * Categories.  Categories should be used sparingly, and for the purposes of identifying classes of keys. A good use of categories would be to differentiate between end-user, developer, support, and automation keys. A poor use of categories would be grouping by site-id at scale. Category names are arbitrary, and exist, or not, based on there being keys using them.
+ *
+ * Names. Names are arbitrary identifiers. A name does not need to make sense to us, though it is helpful when attempting to support you if they do. It is perfectly acceptable to use something like {userid}, {siteid}-{userid}, {userid}-{keynumber}, or whatever else makes sense for your desired operation. It is suggested that some form of immutable ID number or string be used in the name for your aliases to reduce possible confusion when tracking them later on.
+ *
+ * Scale. It is acceptable to use alias-pkey's for 0% of your public keys, 100% of your public keys, or anywhere in-between. The main draw for using them is updating the referenced key once updates all N references to it at the same time N being 1 is acceptable but, in our opinion, it's usually very likely that that will change at some point.
+ *
+ * Uniqueness. Keys are unique based on [client,category,name]. Therefor all of the following are completely unique: pub://client-a/employees?jennifer pub://client-a/users?jennifer pub://client-b/users?jennifer
+ *
+ * Of interest is that it is entirely valid for an ssh-user or client-authorized-key to reference an address belonging to a different client entirely.  It is assumed that this will not com up often but an example use case would be for allowing atomic staff access to a site for debugging purposes.
+ *
+ * Of note is that alias-pkeys cannot reference other alias-pkeys. This may change in the future given a compelling use case but this is not currently planned and there are no known good reasons to start planning.
+ *
+ * References to an aliasable key are not tracked by atomic. As such removing an aliasable key does not remove references to that address. Likewise removing an aliasable key does not remove objects which reference its address from the system either. If a client should have a use case which requires doing such then the client should plan on tracking where those keys are referenced on their end.
+ */
+export declare const postAliasPkeySetClientCategoryName: <ThrowOnError extends boolean = true>(options: Options<PostAliasPkeySetClientCategoryNameData, ThrowOnError>) => import("./client").RequestResult<PostAliasPkeySetClientCategoryNameResponses, PostAliasPkeySetClientCategoryNameErrors, ThrowOnError, "fields">;
+/**
+ * Create Site
+ * Create a WP Cloud site with the following options.
+ */
+export declare const postCreateSiteClient: <ThrowOnError extends boolean = true>(options?: Options<PostCreateSiteClientData, ThrowOnError>) => import("./client").RequestResult<PostCreateSiteClientResponses, PostCreateSiteClientErrors, ThrowOnError, "fields">;
+/**
+ * Create Task
+ * Create a task that will iterate over all client sites.
+ *
+ * "software" : Perform changes to site software (plugins and themes).
+ *
+ * "site-find-files" : Search for files that match the provided pattern. Note that * and ? characters can be used: * will be expanded to (.*) and ? will be expanded to (.)
+ *
+ * "run-wp-cli-command" : Perform a wp-cli command. Note that the command is limited to a run time of 5 minutes and max memory usage of 1200 MB.
+ *
+ * "wpcloud-scan" : Run WP Cloud Scan checks across sites.
+ */
+export declare const postTaskCreateClientType: <ThrowOnError extends boolean = true>(options: Options<PostTaskCreateClientTypeData, ThrowOnError>) => import("./client").RequestResult<PostTaskCreateClientTypeResponses, PostTaskCreateClientTypeErrors, ThrowOnError, "fields">;
+/**
+ * Deactivate a Custom Certificate
+ * Deactivate an active custom SSL certificate. If id is omitted, the currently active certificate is deactivated.
+ */
+export declare const postCustomCertificatesSiteIdDeactivate: <ThrowOnError extends boolean = true>(options: Options<PostCustomCertificatesSiteIdDeactivateData, ThrowOnError>) => import("./client").RequestResult<PostCustomCertificatesSiteIdDeactivateResponses, PostCustomCertificatesSiteIdDeactivateErrors, ThrowOnError, "fields">;
+/**
+ * Delete a Custom Certificate
+ * Delete a custom certificate by ID. The certificate must not be active.
+ */
+export declare const postCustomCertificatesSiteIdDelete: <ThrowOnError extends boolean = true>(options: Options<PostCustomCertificatesSiteIdDeleteData, ThrowOnError>) => import("./client").RequestResult<PostCustomCertificatesSiteIdDeleteResponses, PostCustomCertificatesSiteIdDeleteErrors, ThrowOnError, "fields">;
+/**
+ * Delete Site
+ * Mark a site for deletion.
+ */
+export declare const postDeleteSiteServiceIdentifier: <ThrowOnError extends boolean = true>(options: Options<PostDeleteSiteServiceIdentifierData, ThrowOnError>) => import("./client").RequestResult<PostDeleteSiteServiceIdentifierResponses, PostDeleteSiteServiceIdentifierErrors, ThrowOnError, "fields">;
+/**
+ * Disable HSTS preload directive
+ * Disable HSTS preload directive.
+ */
+export declare const postSslHstsPreloadDomainFalse: <ThrowOnError extends boolean = true>(options: Options<PostSslHstsPreloadDomainFalseData, ThrowOnError>) => import("./client").RequestResult<PostSslHstsPreloadDomainFalseResponses, PostSslHstsPreloadDomainFalseErrors, ThrowOnError, "fields">;
+/**
+ * Fetch SSL Certificate Information
+ * Fetch SSL certificate information.
+ */
+export declare const postSslInfoDomain: <ThrowOnError extends boolean = true>(options: Options<PostSslInfoDomainData, ThrowOnError>) => import("./client").RequestResult<PostSslInfoDomainResponses, PostSslInfoDomainErrors, ThrowOnError, "fields">;
+/**
+ * Get Available Datacenters
+ * Get a list of datacenters with available (non-full, active) servers.
+ */
+export declare const getGetAvailableDatacentersClient: <ThrowOnError extends boolean = true>(options?: Options<GetGetAvailableDatacentersClientData, ThrowOnError>) => import("./client").RequestResult<GetGetAvailableDatacentersClientResponses, GetGetAvailableDatacentersClientErrors, ThrowOnError, "fields">;
+/**
+ * Get Client IP Addresses
+ * Get the IPs for a client; if a domain is included, get suggested IPs if possible for the client.
+ */
+export declare const getGetIpsClient: <ThrowOnError extends boolean = true>(options: Options<GetGetIpsClientData, ThrowOnError>) => import("./client").RequestResult<GetGetIpsClientResponses, GetGetIpsClientErrors, ThrowOnError, "fields">;
+/**
+ * Get Client IP Addresses
+ * Get the IPs for a client; if a domain is included, get suggested IPs if possible for the client.
+ */
+export declare const getGetIpsClientDomain: <ThrowOnError extends boolean = true>(options: Options<GetGetIpsClientDomainData, ThrowOnError>) => import("./client").RequestResult<GetGetIpsClientDomainResponses, GetGetIpsClientDomainErrors, ThrowOnError, "fields">;
+/**
+ * Get Client Meta
+ * Retrieve a client meta value.
+ *
+ * Note: `webhook_hmac_key` does not support the `get` method.
+ */
+export declare const getClientMetaClientKeyGet: <ThrowOnError extends boolean = true>(options: Options<GetClientMetaClientKeyGetData, ThrowOnError>) => import("./client").RequestResult<GetClientMetaClientKeyGetResponses, GetClientMetaClientKeyGetErrors, ThrowOnError, "fields">;
+/**
+ * Get Custom Certificate details
+ * Retrieve details about a custom certificate for a site. Omit the certificate ID to fetch the currently active custom certificate (if any).
+ */
+export declare const getCustomCertificatesSite: <ThrowOnError extends boolean = true>(options: Options<GetCustomCertificatesSiteData, ThrowOnError>) => import("./client").RequestResult<GetCustomCertificatesSiteResponses, GetCustomCertificatesSiteErrors, ThrowOnError, "fields">;
+/**
+ * Get Custom Certificate details
+ * Retrieve details about a custom certificate for a site. Omit the certificate ID to fetch the currently active custom certificate (if any).
+ */
+export declare const getCustomCertificatesSiteId: <ThrowOnError extends boolean = true>(options: Options<GetCustomCertificatesSiteIdData, ThrowOnError>) => import("./client").RequestResult<GetCustomCertificatesSiteIdResponses, GetCustomCertificatesSiteIdErrors, ThrowOnError, "fields">;
+/**
+ * Get Domain Verification Code
+ * Generates the domain verification code, to be used as a TXT record so that a domain can be "claimed" from another WP Cloud client.
+ */
+export declare const getGetDomainVerificationCodeClientDomain: <ThrowOnError extends boolean = true>(options: Options<GetGetDomainVerificationCodeClientDomainData, ThrowOnError>) => import("./client").RequestResult<GetGetDomainVerificationCodeClientDomainResponses, GetGetDomainVerificationCodeClientDomainErrors, ThrowOnError, "fields">;
+/**
+ * Get Edge Cache Settings
+ * Endpoint for getting a site's edge cache settings.
+ */
+export declare const getEdgeCacheSite: <ThrowOnError extends boolean = true>(options: Options<GetEdgeCacheSiteData, ThrowOnError>) => import("./client").RequestResult<GetEdgeCacheSiteResponses, GetEdgeCacheSiteErrors, ThrowOnError, "fields">;
+/**
+ * Get Edge Cache Settings
+ * Endpoint for getting a site's edge cache settings.
+ */
+export declare const getEdgeCacheSiteAction: <ThrowOnError extends boolean = true>(options: Options<GetEdgeCacheSiteActionData, ThrowOnError>) => import("./client").RequestResult<GetEdgeCacheSiteActionResponses, GetEdgeCacheSiteActionErrors, ThrowOnError, "fields">;
+/**
+ * Update Edge Cache Settings
+ * Endpoint for managing a site's edge cache settings.
+ */
+export declare const postEdgeCacheSiteAction: <ThrowOnError extends boolean = true>(options: Options<PostEdgeCacheSiteActionData, ThrowOnError>) => import("./client").RequestResult<PostEdgeCacheSiteActionResponses, PostEdgeCacheSiteActionErrors, ThrowOnError, "fields">;
+/**
+ * Get Edge Cache Settings
+ * Endpoint for getting a site's edge cache settings.
+ */
+export declare const getEdgeCacheSiteActionDomain: <ThrowOnError extends boolean = true>(options: Options<GetEdgeCacheSiteActionDomainData, ThrowOnError>) => import("./client").RequestResult<GetEdgeCacheSiteActionDomainResponses, GetEdgeCacheSiteActionDomainErrors, ThrowOnError, "fields">;
+/**
+ * Update Edge Cache Settings
+ * Endpoint for managing a site's edge cache settings.
+ */
+export declare const postEdgeCacheSiteActionDomain: <ThrowOnError extends boolean = true>(options: Options<PostEdgeCacheSiteActionDomainData, ThrowOnError>) => import("./client").RequestResult<PostEdgeCacheSiteActionDomainResponses, PostEdgeCacheSiteActionDomainErrors, ThrowOnError, "fields">;
+/**
+ * Get Job Status
+ * Get status of a job by ID. Supports getting a single job via GET with URL parameter, or multiple jobs via POST with body parameter.
+ */
+export declare const getJobCompletionId: <ThrowOnError extends boolean = true>(options: Options<GetJobCompletionIdData, ThrowOnError>) => import("./client").RequestResult<GetJobCompletionIdResponses, GetJobCompletionIdErrors, ThrowOnError, "fields">;
+/**
+ * Get Job Status
+ * Get status of a job by ID. Supports getting a single job via GET with URL parameter, or multiple jobs via POST with body parameter.
+ */
+export declare const postJobCompletionId: <ThrowOnError extends boolean = true>(options: Options<PostJobCompletionIdData, ThrowOnError>) => import("./client").RequestResult<PostJobCompletionIdResponses, PostJobCompletionIdErrors, ThrowOnError, "fields">;
+/**
+ * Get Job Statuses
+ * Get full status details of one or more jobs by ID. Returns complete job object including status, data, and metadata.
+ */
+export declare const getJobStatus: <ThrowOnError extends boolean = true>(options?: Options<GetJobStatusData, ThrowOnError>) => import("./client").RequestResult<GetJobStatusResponses, GetJobStatusErrors, ThrowOnError, "fields">;
+/**
+ * Get Job Statuses
+ * Get full status details of one or more jobs by ID. Returns complete job object including status, data, and metadata.
+ */
+export declare const postJobStatus: <ThrowOnError extends boolean = true>(options?: Options<PostJobStatusData, ThrowOnError>) => import("./client").RequestResult<PostJobStatusResponses, PostJobStatusErrors, ThrowOnError, "fields">;
+/**
+ * Get Job Statuses
+ * Get full status details of one or more jobs by ID. Returns complete job object including status, data, and metadata.
+ */
+export declare const getJobStatusId: <ThrowOnError extends boolean = true>(options: Options<GetJobStatusIdData, ThrowOnError>) => import("./client").RequestResult<GetJobStatusIdResponses, GetJobStatusIdErrors, ThrowOnError, "fields">;
+/**
+ * Get Job Statuses
+ * Get full status details of one or more jobs by ID. Returns complete job object including status, data, and metadata.
+ */
+export declare const postJobStatusId: <ThrowOnError extends boolean = true>(options: Options<PostJobStatusIdData, ThrowOnError>) => import("./client").RequestResult<PostJobStatusIdResponses, PostJobStatusIdErrors, ThrowOnError, "fields">;
+/**
+ * Get Multiple Response Ticket Statuses
+ * Retrieve the current status of multiple response tickets in a single request. Requires the "response-ticket/multi-status" extended endpoint authorization.
+ */
+export declare const postResponseTicketMultiStatus: <ThrowOnError extends boolean = true>(options?: Options<PostResponseTicketMultiStatusData, ThrowOnError>) => import("./client").RequestResult<PostResponseTicketMultiStatusResponses, PostResponseTicketMultiStatusErrors, ThrowOnError, "fields">;
+/**
+ * Get PHP Versions
+ * Get a list of available PHP versions, in either simplified (default) or verbose format.
+ */
+export declare const getGetPhpVersionsClientVerbose: <ThrowOnError extends boolean = true>(options?: Options<GetGetPhpVersionsClientVerboseData, ThrowOnError>) => import("./client").RequestResult<GetGetPhpVersionsClientVerboseResponses, GetGetPhpVersionsClientVerboseErrors, ThrowOnError, "fields">;
+/**
+ * Get Public Key
+ * Retrieve a single aliasable public key.
+ */
+export declare const getAliasPkeyGetClientCategoryName: <ThrowOnError extends boolean = true>(options: Options<GetAliasPkeyGetClientCategoryNameData, ThrowOnError>) => import("./client").RequestResult<GetAliasPkeyGetClientCategoryNameResponses, GetAliasPkeyGetClientCategoryNameErrors, ThrowOnError, "fields">;
+/**
+ * Get Response Ticket Details
+ * Retrieve all data for the response ticket including all messages.
+ */
+export declare const postResponseTicketGetFull: <ThrowOnError extends boolean = true>(options?: Options<PostResponseTicketGetFullData, ThrowOnError>) => import("./client").RequestResult<PostResponseTicketGetFullResponses, PostResponseTicketGetFullErrors, ThrowOnError, "fields">;
+/**
+ * Get Response Ticket Summary
+ * Retrieve metadata about the response ticket.
+ */
+export declare const postResponseTicketGetSummary: <ThrowOnError extends boolean = true>(options?: Options<PostResponseTicketGetSummaryData, ThrowOnError>) => import("./client").RequestResult<PostResponseTicketGetSummaryResponses, PostResponseTicketGetSummaryErrors, ThrowOnError, "fields">;
+/**
+ * Get Site Backup Data
+ * Download a site's filesystem or database backup.
+ *
+ * The response body is the raw backup blob, not a JSON envelope. The exact bytes and headers depend on the backup `type` returned by `site-backup-info` and `site-backups-list`:
+ *
+ * - `fs` and `ondemand-fs`: `Content-Type: application/octet-stream`, no `Content-Encoding`. Body is a bzip2-compressed tar archive. Recommended filename: `<site_id>-<backup_id>-fs.tar.bz2`.
+ * - `db` and `ondemand-db`: `Content-Type: application/sql`, always returned with `Content-Encoding: gzip` regardless of the request's `Accept-Encoding`. Body on the wire is a gzip-compressed MySQL dump. Recommended filename: `<site_id>-<backup_id>-db.sql.gz` for the raw bytes, or `<site_id>-<backup_id>-db.sql` if the client decompresses in transit.
+ * - `ondemand` (legacy): inspect `type` via `site-backup-info` and follow the row above that matches the actual contents.
+ *
+ * Because DB downloads include `Content-Encoding: gzip` unconditionally, clients that honor the header (browsers, `curl --compressed`, most HTTP libraries with default settings) will deliver plain SQL text to disk, while clients that ignore it (default `curl -o file`, `wget` without `--compressed`) will deliver gzip-compressed bytes. The response is identical; only client handling differs. For byte-exact downloads, send `Accept-Encoding: identity` and avoid client-side auto-decompression flags such as `curl --compressed`.
+ *
+ * `Content-Disposition` is not set on either response, so callers must choose the filename and extension. `Accept-Ranges: bytes` is honored, which is useful for resuming the multi-GB filesystem downloads.
+ *
+ * When proxying the response to an end user, stream the body straight through without buffering -- FS backups can exceed several gigabytes. Decide deliberately whether to forward the upstream `Content-Encoding: gzip` to the end user (and serve `.sql.gz`) or decompress server-side first (and serve `.sql`).
+ */
+export declare const getSiteBackupGetServiceIdentifierBackupId: <ThrowOnError extends boolean = true>(options: Options<GetSiteBackupGetServiceIdentifierBackupIdData, ThrowOnError>) => import("./client").RequestResult<GetSiteBackupGetServiceIdentifierBackupIdResponses, GetSiteBackupGetServiceIdentifierBackupIdErrors, ThrowOnError, "fields">;
+/**
+ * Get Site Backup Details
+ * Get the details for a single backup.
+ *
+ * Pass the returned `atomic_backup_id` (with its `type`) to `site-backup-get` to download the backup. The `type` determines the response format and recommended filename -- see `site-backup-get` for the per-type format details.
+ */
+export declare const getSiteBackupInfoServiceIdentifierBackupId: <ThrowOnError extends boolean = true>(options: Options<GetSiteBackupInfoServiceIdentifierBackupIdData, ThrowOnError>) => import("./client").RequestResult<GetSiteBackupInfoServiceIdentifierBackupIdResponses, GetSiteBackupInfoServiceIdentifierBackupIdErrors, ThrowOnError, "fields">;
+/**
+ * Get Site Details
+ * Get site details by site ID or domain name.
+ */
+export declare const getGetSiteSiteExtra: <ThrowOnError extends boolean = true>(options: Options<GetGetSiteSiteExtraData, ThrowOnError>) => import("./client").RequestResult<GetGetSiteSiteExtraResponses, GetGetSiteSiteExtraErrors, ThrowOnError, "fields">;
+/**
+ * Get Site Metrics
+ * Get time series metrics from a site.
+ *
+ * **NOTE:** This endpoint is deprecated in favor of /metrics.
+ */
+export declare const postSiteMetricsSiteSummarize: <ThrowOnError extends boolean = true>(options: Options<PostSiteMetricsSiteSummarizeData, ThrowOnError>) => import("./client").RequestResult<PostSiteMetricsSiteSummarizeResponses, PostSiteMetricsSiteSummarizeErrors, ThrowOnError, "fields">;
+/**
+ * Get Site PHP Error Logs
+ * Get PHP error log data from a site. Logs are only guaranteed for 28 days; a start timestamp before that may return incomplete data.
+ */
+export declare const postSiteErrorLogsSite: <ThrowOnError extends boolean = true>(options: Options<PostSiteErrorLogsSiteData, ThrowOnError>) => import("./client").RequestResult<PostSiteErrorLogsSiteResponses, PostSiteErrorLogsSiteErrors, ThrowOnError, "fields">;
+/**
+ * Get Site phpMyAdmin URL
+ * Get a time-limited URL for accessing a site's database via phpMyAdmin.
+ */
+export declare const postSitePhpmyadminSite: <ThrowOnError extends boolean = true>(options: Options<PostSitePhpmyadminSiteData, ThrowOnError>) => import("./client").RequestResult<PostSitePhpmyadminSiteResponses, PostSitePhpmyadminSiteErrors, ThrowOnError, "fields">;
+/**
+ * Get SSH User Details
+ * Retrieve details for an SSH/SFTP user including site ID and timestamps. Validates that the requesting client has access to the user's site.
+ */
+export declare const getGetSshUserUsername: <ThrowOnError extends boolean = true>(options: Options<GetGetSshUserUsernameData, ThrowOnError>) => import("./client").RequestResult<GetGetSshUserUsernameResponses, GetGetSshUserUsernameErrors, ThrowOnError, "fields">;
+/**
+ * Get Task Details
+ * Get the details of a task.
+ */
+export declare const postTaskGetAtomicTaskId: <ThrowOnError extends boolean = true>(options: Options<PostTaskGetAtomicTaskIdData, ThrowOnError>) => import("./client").RequestResult<PostTaskGetAtomicTaskIdResponses, PostTaskGetAtomicTaskIdErrors, ThrowOnError, "fields">;
+/**
+ * Get Time Series Metrics
+ * Get time series metrics.
+ *
+ * This endpoint queries a time series database and returns metrics that correspond to a site or client. Each metric can be further analyzed by specifying a dimension to segment the metric data on for sub analysis. In the API response an array of time periods are returned with each array item containing a `timestamp` field that specifies the start time of the span of time that the metric is reported for. The number of seconds for the span is given by the `data._meta.resolution` field in the response.
+ *
+ * We support up to a 10 second resolution for recent data and metrics are downsampled into larger and larger minimum resolutions as time passes. Querying for a shorter and more recent time span will yield higher resolution data. Both longer time spans (longer time between the `start` and `end` parameters) as well as queries for older metrics data will result in lower resolution response data.
+ *
+ * This endpoint supports returning multiple metrics per 1 dimension or up to 5 dimensions per 1 metric. By passing an array of metrics or dimensions to the metric and dimension field respectively.
+ *
+ * Metrics can be pulled from multiple sources. Based on the Source different dimensions are available for segmentation. The API will respond with a 400 response if invalid metric, dimensions combinations are requested.
+ *
+ * Supported metrics and dimensions to report are:
+ *
+ * Edge Logs metrics
+ * - `requests` - Number of requests
+ * - `requests_persec` - Number of requests per second.
+ * - `response_bytes` - Bandwidth consumed for all responses in bytes.
+ * - `response_bytes_persec` - Bandwidth consumed for all responses in bytes per second.
+ * - `response_bytes_average` - Average number of bytes of each response.
+ * - `response_time_average` - (Default) Average response time of each response.
+ *
+ * Edge Logs dimensions:
+ * - `server_protocol` - Protocol version used by the client.
+ * - `request_method` - Type of request made. (GET, POST, etc.)
+ * - `http_host` - (Default) Hostname of the request.
+ * - `http_status` - HTTP status code of the response.
+ * - `http_user_agent` - HTTP User Agent of the request
+ * - `referer_domain` - Referer Domain of the request
+ * - `page_renderer` - The backend that handled the request (PHP, static file, etc.)
+ * - `page_is_cached` - If the response page came from cache.
+ * - `wp_admin_ajax_action` - For requests to the WP admin AJAX endpoint, which action was specified.
+ * - `visitor_asn` - The ASN that the request came from.
+ * - `visitor_country_code` - The country the request came from according to GeoIP.
+ * - `visitor_is_crawler` - If the visitor appears to be an automated bot or crawler.
+ * - `visitor_device_type` - The detected device that the request came from.
+ * - `visitor_browser` - The detected browser that the request came from.
+ * - `visitor_os` - The detected os that the request came from.
+ * - `visitor_is_logged_in` - If the visitor appears to be logged in.
+ * - `edge_cache_status` - Request Status from Edge.
+ * - `is_rate_limited` - If the request was rate limited.
+ * - `rate_limit_reason` - Reason for the request to be limited.
+ * - `datacenter` - Datacenter that processed the request
+ * - `path` - Request path/url without query string
+ * - `remote_address` - IP that the request was issued from.
+ * - `atomic_site_id` - WP Cloud Site ID associated with the request
+ * - `proxy_type` - Type of proxy server that the request came from.
+ *
+ * PHP Logs metrics
+ * - `php_cpu_time` - Total CPU time.
+ * - `php_cpu_time_persec` - CPU time per second.
+ * - `php_response_time` - Total response time.
+ * - `php_requests` - Number of requests .
+ * - `php_requests_persec` - Number of requests per second.
+ * - `php_workers_average` - Average number of php workers in use.
+ * - `php_workers_min` - Minimum number of php workers in use.
+ * - `php_workers_max` - Maximum number of php workers in use.
+ * - `php_request_burst_percentage` - Percentage of requests in burst mode
+ * - `php_request_limited_percentage` - Percentage of requests that were limited from burst mode.
+ * - `php_request_normal_percentage` - Percentage of requests that were not in burst mode.
+ *
+ * PHP logs dimensions:
+ * - `http_verb` - Type of request made. (GET, POST, etc.)
+ * - `http_host` - Hostname of the request
+ * - `datacenter` - Datacenter that processed the request
+ * - `atomic_site_id` - WP Cloud Site ID associated with the request
+ * - `burst_status` - Request Burst Status [BURST, LIMITED, -]
+ *
+ * Uniques and Views metrics (aggregated from edge available as daily stat)
+ * - `uniques` - Number of unique visitors
+ * - `views` - Number of page views
+ *
+ * Uniques and Views dimensions:
+ * - `hostname` - Hostname.
+ *
+ * MySQL UserStats metrics
+ * - `mysql_total_connections` - number of connections.
+ * - `mysql_concurrent_connections` - number of concurrent connections.
+ * - `mysql_connected_time` - cumulative number of seconds elapsed while there were connections
+ * - `mysql_busy_time` - cumulative number of seconds there was activity on connections
+ * - `mysql_cpu_time` - cumulative CPU time elapsed, in seconds, while servicing connections
+ * - `mysql_bytes_received` - number of bytes received
+ * - `mysql_bytes_sent` - number of bytes sent
+ * - `mysql_binlog_bytes_written` - number of bytes written to the binary log
+ * - `mysql_rows_read` - number of rows read from tables
+ * - `mysql_rows_sent` - number of rows sent to tables
+ * - `mysql_rows_deleted` - number of rows deleted from tables
+ * - `mysql_rows_inserted` - number of rows inserted to tables
+ * - `mysql_rows_updated` - number of rows updated in tables
+ * - `mysql_select_commands` - number of SELECT commands executed
+ * - `mysql_update_commands` - number of UPDATE commands executed
+ * - `mysql_other_commands` - number of OTHER commands executed
+ * - `mysql_commit_transactions` - number of COMMIT commands issued
+ * - `mysql_rollback_transactions` - number of ROLLBACK commands issued
+ * - `mysql_denied_connections` - number of connections denied
+ * - `mysql_lost_connections` - number of connections that were terminated uncleanly
+ * - `mysql_access_denied` - number of issued commands that were denied.
+ * - `mysql_empty_queries` - number of empty queries.
+ * - `mysql_total_ssl_connections` - number of thread connections that used SSL.
+ * - `mysql_max_statement_time_exceeded` - number of times a query has exceeded the maximum execution time
+ *
+ * All mysql metrics have _persec variants.
+ *
+ * MySQL Userstats dimensions:
+ * - `pool` -  Pool Number
+ * - `server` - Server Name
+ * - `atomic_site_id` - WP Cloud Site ID
+ *
+ * CGroup Userstats metrics:
+ * - `cgroup_cpu_usage` - PHP CPU usage
+ * - `cgroup_cpu_usage_persec` - PHP CPU usage per second
+ *
+ * CGroup Userstats dimensions:
+ * - `pool` -  Pool Number
+ * - `server` - Server Name
+ * - `atomic_site_id` - WP Cloud Site ID
+ */
+export declare const postMetricsTypeKeySummarize: <ThrowOnError extends boolean = true>(options: Options<PostMetricsTypeKeySummarizeData, ThrowOnError>) => import("./client").RequestResult<PostMetricsTypeKeySummarizeResponses, PostMetricsTypeKeySummarizeErrors, ThrowOnError, "fields">;
+/**
+ * Get Time Series Usage Data
+ * Get the usage data of a site.
+ *
+ * This endpoint queries a time series database and returns usage data for a site. Usage data includes: compute, bandwidth, email and storage.
+ *
+ * Note on Supported Resolutions and periods:
+ * - `hour` - Available for periods spanning 3 days up to 7 days ago
+ * - `day` - Available for periods spanning 31 days up to 2 months ago
+ * - `month` - Available for periods up to 2 years ago
+ *
+ * Forecast Usage:
+ *
+ * Day and Month resolution usage forecasts are available up to end of the current month. The forecast is generated from the 7-day rolling average of hourly usage and will not capture spikes in usage from sales, advertising or breaking news.
+ */
+export declare const postUsageSite: <ThrowOnError extends boolean = true>(options: Options<PostUsageSiteData, ThrowOnError>) => import("./client").RequestResult<PostUsageSiteResponses, PostUsageSiteErrors, ThrowOnError, "fields">;
+/**
+ * Get Web Server Logs
+ * Get web server (nginx) log data from a site. Logs are only guaranteed for 28 days; a start timestamp before that may return incomplete data.
+ */
+export declare const postSiteLogsSite: <ThrowOnError extends boolean = true>(options: Options<PostSiteLogsSiteData, ThrowOnError>) => import("./client").RequestResult<PostSiteLogsSiteResponses, PostSiteLogsSiteErrors, ThrowOnError, "fields">;
+/**
+ * Get Web Server Logs for a Site
+ * Get web server (nginx) log data for a site. Logs are only guaranteed for 28 days; a start timestamp before that may return incomplete data.
+ */
+export declare const postLogsSiteSite: <ThrowOnError extends boolean = true>(options: Options<PostLogsSiteSiteData, ThrowOnError>) => import("./client").RequestResult<PostLogsSiteSiteResponses, PostLogsSiteSiteErrors, ThrowOnError, "fields">;
+/**
+ * Interrupt Task
+ * Interrupt an incomplete task.
+ */
+export declare const postTaskInterruptTaskId: <ThrowOnError extends boolean = true>(options: Options<PostTaskInterruptTaskIdData, ThrowOnError>) => import("./client").RequestResult<PostTaskInterruptTaskIdResponses, PostTaskInterruptTaskIdErrors, ThrowOnError, "fields">;
+/**
+ * List Client Sites
+ * List a client's sites, generally for auditing purposes.
+ *
+ * Additional site meta keys can be added to the output by specifying them at the end of the endpoint URI separated by '/'. For example, `/get-sites/:client/php_version` would add each site's `php_version` to the output.
+ *
+ * The following additional site meta keys are supported:
+ * - `wp_version`
+ * - `php_version`
+ * - `space_quota`
+ * - `db_file_size`
+ * - `static_file_404`
+ * - `suspended`
+ * - `suspend_after`
+ * - `burst_php_conns`
+ * - `default_php_conns`
+ * - `php_memory_limit`
+ * - `opcache_memory_limit_mb`
+ * - `chroot_path`
+ * - `chroot_ssh_path`
+ * - `_data`
+ */
+export declare const getGetSitesClient: <ThrowOnError extends boolean = true>(options: Options<GetGetSitesClientData, ThrowOnError>) => import("./client").RequestResult<GetGetSitesClientResponses, GetGetSitesClientErrors, ThrowOnError, "fields">;
+/**
+ * List Client Sites
+ * List a client's sites, generally for auditing purposes.
+ *
+ * Additional site meta keys can be added to the output by specifying them at the end of the endpoint URI separated by '/'. For example, `/get-sites/:client/php_version` would add each site's `php_version` to the output.
+ *
+ * The following additional site meta keys are supported:
+ * - `wp_version`
+ * - `php_version`
+ * - `space_quota`
+ * - `db_file_size`
+ * - `static_file_404`
+ * - `suspended`
+ * - `suspend_after`
+ * - `burst_php_conns`
+ * - `default_php_conns`
+ * - `php_memory_limit`
+ * - `opcache_memory_limit_mb`
+ * - `chroot_path`
+ * - `chroot_ssh_path`
+ * - `_data`
+ */
+export declare const getGetSitesClientMeta: <ThrowOnError extends boolean = true>(options: Options<GetGetSitesClientMetaData, ThrowOnError>) => import("./client").RequestResult<GetGetSitesClientMetaResponses, GetGetSitesClientMetaErrors, ThrowOnError, "fields">;
+/**
+ * List Cron Entries
+ * Returns a list of cron entries for a site.
+ */
+export declare const getCrontabSiteList: <ThrowOnError extends boolean = true>(options: Options<GetCrontabSiteListData, ThrowOnError>) => import("./client").RequestResult<GetCrontabSiteListResponses, GetCrontabSiteListErrors, ThrowOnError, "fields">;
+/**
+ * List Custom Certificates
+ * List custom SSL certificates, with optional filtering and pagination.
+ */
+export declare const getCustomCertificatesSiteList: <ThrowOnError extends boolean = true>(options: Options<GetCustomCertificatesSiteListData, ThrowOnError>) => import("./client").RequestResult<GetCustomCertificatesSiteListResponses, GetCustomCertificatesSiteListErrors, ThrowOnError, "fields">;
+/**
+ * List Failed Webhook Jobs
+ * Lists recent failed webhook jobs for a client.
+ */
+export declare const getWebhookFailuresClient: <ThrowOnError extends boolean = true>(options: Options<GetWebhookFailuresClientData, ThrowOnError>) => import("./client").RequestResult<GetWebhookFailuresClientResponses, GetWebhookFailuresClientErrors, ThrowOnError, "fields">;
+/**
+ * List Firewall Rules
+ * Get a list of firewall rules for a site.
+ */
+export declare const getFirewallRulesSiteList: <ThrowOnError extends boolean = true>(options: Options<GetFirewallRulesSiteListData, ThrowOnError>) => import("./client").RequestResult<GetFirewallRulesSiteListResponses, GetFirewallRulesSiteListErrors, ThrowOnError, "fields">;
+/**
+ * List Public Key Categories
+ * Enumerate your category list.
+ */
+export declare const getAliasPkeyCategoriesClient: <ThrowOnError extends boolean = true>(options: Options<GetAliasPkeyCategoriesClientData, ThrowOnError>) => import("./client").RequestResult<GetAliasPkeyCategoriesClientResponses, GetAliasPkeyCategoriesClientErrors, ThrowOnError, "fields">;
+/**
+ * List Public Keys
+ * Enumerate your aliasable public keys, 1000 records at a time.
+ */
+export declare const postAliasPkeyListClientCategory: <ThrowOnError extends boolean = true>(options: Options<PostAliasPkeyListClientCategoryData, ThrowOnError>) => import("./client").RequestResult<PostAliasPkeyListClientCategoryResponses, PostAliasPkeyListClientCategoryErrors, ThrowOnError, "fields">;
+/**
+ * List Site Backups
+ * Get a list of backups for a site.
+ *
+ * Pass the returned `atomic_backup_id` (with its `type`) to `site-backup-get` to download a backup. The `type` determines the response format and recommended filename -- see `site-backup-get` for the per-type format details.
+ */
+export declare const getSiteBackupsListServiceIdentifier: <ThrowOnError extends boolean = true>(options: Options<GetSiteBackupsListServiceIdentifierData, ThrowOnError>) => import("./client").RequestResult<GetSiteBackupsListServiceIdentifierResponses, GetSiteBackupsListServiceIdentifierErrors, ThrowOnError, "fields">;
+/**
+ * List Site Backups
+ * Get a list of backups for a site.
+ *
+ * Pass the returned `atomic_backup_id` (with its `type`) to `site-backup-get` to download a backup. The `type` determines the response format and recommended filename -- see `site-backup-get` for the per-type format details.
+ */
+export declare const getSiteBackupsListServiceIdentifierBackupType: <ThrowOnError extends boolean = true>(options: Options<GetSiteBackupsListServiceIdentifierBackupTypeData, ThrowOnError>) => import("./client").RequestResult<GetSiteBackupsListServiceIdentifierBackupTypeResponses, GetSiteBackupsListServiceIdentifierBackupTypeErrors, ThrowOnError, "fields">;
+/**
+ * List Site SSH/SFTP Users
+ * List all SSH/SFTP usernames for a site.
+ */
+export declare const getSshUserServiceIdentifierList: <ThrowOnError extends boolean = true>(options: Options<GetSshUserServiceIdentifierListData, ThrowOnError>) => import("./client").RequestResult<GetSshUserServiceIdentifierListResponses, GetSshUserServiceIdentifierListErrors, ThrowOnError, "fields">;
+/**
+ * Manage Blocked Domains
+ * Manage domains that have been blocked from sending email via the platform-provided mail service.
+ *
+ * The following actions are allowed:
+ *
+ * - `list` - List blocked domains for a given client
+ *
+ * The following types are allowed:
+ *
+ * - `sasl_block` - Domains that are blocked as a sender
+ */
+export declare const getEmailBlockClientActionType: <ThrowOnError extends boolean = true>(options: Options<GetEmailBlockClientActionTypeData, ThrowOnError>) => import("./client").RequestResult<GetEmailBlockClientActionTypeResponses, GetEmailBlockClientActionTypeErrors, ThrowOnError, "fields">;
+/**
+ * Manage Client Authorized Keys
+ * Manage client-level SSH authorized keys that grant access to all sites owned by a client via client-ssh.atomicsites.net. Only available to fully onboarded clients with allowlisted IP addresses. Keys are parsed and validated, with specific SSH options honored (from, command) and enforced (restrict, agent-forwarding, pty). Allowed key types: ssh-rsa (2048-16384 bits), ecdsa-sha2-nistp256 (256 bits), ssh-ed25519 (256 bits). See OpenBSD sshd authorized_keys format for details.
+ */
+export declare const getClientAuthorizedKeysClientAction: <ThrowOnError extends boolean = true>(options: Options<GetClientAuthorizedKeysClientActionData, ThrowOnError>) => import("./client").RequestResult<GetClientAuthorizedKeysClientActionResponses, GetClientAuthorizedKeysClientActionErrors, ThrowOnError, "fields">;
+/**
+ * Manage Client Authorized Keys
+ * Manage client-level SSH authorized keys that grant access to all sites owned by a client via client-ssh.atomicsites.net. Only available to fully onboarded clients with allowlisted IP addresses. Keys are parsed and validated, with specific SSH options honored (from, command) and enforced (restrict, agent-forwarding, pty). Allowed key types: ssh-rsa (2048-16384 bits), ecdsa-sha2-nistp256 (256 bits), ssh-ed25519 (256 bits). See OpenBSD sshd authorized_keys format for details.
+ */
+export declare const postClientAuthorizedKeysClientAction: <ThrowOnError extends boolean = true>(options: Options<PostClientAuthorizedKeysClientActionData, ThrowOnError>) => import("./client").RequestResult<PostClientAuthorizedKeysClientActionResponses, PostClientAuthorizedKeysClientActionErrors, ThrowOnError, "fields">;
+/**
+ * Manage Client Authorized Keys
+ * Manage client-level SSH authorized keys that grant access to all sites owned by a client via client-ssh.atomicsites.net. Only available to fully onboarded clients with allowlisted IP addresses. Keys are parsed and validated, with specific SSH options honored (from, command) and enforced (restrict, agent-forwarding, pty). Allowed key types: ssh-rsa (2048-16384 bits), ecdsa-sha2-nistp256 (256 bits), ssh-ed25519 (256 bits). See OpenBSD sshd authorized_keys format for details.
+ */
+export declare const getClientAuthorizedKeysClientActionId: <ThrowOnError extends boolean = true>(options: Options<GetClientAuthorizedKeysClientActionIdData, ThrowOnError>) => import("./client").RequestResult<GetClientAuthorizedKeysClientActionIdResponses, GetClientAuthorizedKeysClientActionIdErrors, ThrowOnError, "fields">;
+/**
+ * Manage Client Authorized Keys
+ * Manage client-level SSH authorized keys that grant access to all sites owned by a client via client-ssh.atomicsites.net. Only available to fully onboarded clients with allowlisted IP addresses. Keys are parsed and validated, with specific SSH options honored (from, command) and enforced (restrict, agent-forwarding, pty). Allowed key types: ssh-rsa (2048-16384 bits), ecdsa-sha2-nistp256 (256 bits), ssh-ed25519 (256 bits). See OpenBSD sshd authorized_keys format for details.
+ */
+export declare const postClientAuthorizedKeysClientActionId: <ThrowOnError extends boolean = true>(options: Options<PostClientAuthorizedKeysClientActionIdData, ThrowOnError>) => import("./client").RequestResult<PostClientAuthorizedKeysClientActionIdResponses, PostClientAuthorizedKeysClientActionIdErrors, ThrowOnError, "fields">;
+/**
+ * Manage Site Aliases
+ * Manage domain aliases for a site.
+ */
+export declare const getSiteAliasServiceIdentifierAction: <ThrowOnError extends boolean = true>(options: Options<GetSiteAliasServiceIdentifierActionData, ThrowOnError>) => import("./client").RequestResult<GetSiteAliasServiceIdentifierActionResponses, GetSiteAliasServiceIdentifierActionErrors, ThrowOnError, "fields">;
+/**
+ * Manage Site Meta
+ * Endpoint for managing site meta.
+ *
+ * The following meta keys are supported:
+ *
+ * - Values for `db_charset` and `db_collate` include "latin1", "latin1_swedish_ci"; "utf8", "utf8_general_ci"; and "utf8mb4", "utf8mb4_general_ci".
+ * - `suspended` suspends a site. The value is the HTTP 4xx status code the site will respond with. The supported statuses are "403", "404", "410", "451", "480", and "503".
+ * - `suspend_after` will suspend a site after a given unixtime timestamp with the status specified in "suspended", default 480.
+ * - `allow_restore` opts a site into self-restore via the "restore-site" endpoint. The value must be a positive Unix timestamp, must not be more than 5 minutes in the future, and must be recent (within MONTH_IN_SECONDS) when "restore-site" is called. It only authorizes the restore window; the restore is started with the "restore-site" endpoint.
+ * - `php_version` sets the site's PHP version. Supported values include "8.2", "8.3", "8.4", and "8.5".
+ * - `wp_version` is a get-only key that can be used to retrieve the site's current managed WordPress version, which can be either "latest", "previous", or "beta" (used to test WordPress releases). Use the "site-wordpress-version" endpoint to set "wp_version".
+ * - `do_not_delete` may be set to a truthy value to prevent a site from begin deleted. This can be useful in some cases. For example, you might wish to preserve a site while it is being reviewed for Terms of Service violations.
+ * - `space_used` is a get-only key that returns an integer in bytes; it is updated every 12 hours with the amount of space used by a site's files.
+ * - `db_file_size` is a get-only key that returns an integer in bytes. It is updated every 12 hours with the amount of space used by a site's database.
+ * - `space_quota` can be used to get and set the space quota for a site. Value must be an integer followed by a size specifier like "200G".
+ * - `max_space_quota` is get-only and may be present if the platform has set a space_quota" maximum for a specific site.
+ * - `photon_subsizes` controls whether WP skips generating intermediate image files when an image is uploaded. The platform is able to satisfy requests for intermediate image files whether or not they exist, so sites can save disk space by not creating them. When the a site's web server receives a request for a non-existent intermediate image file, it proxies the request to Photon which responds with the intermediate image size. Can be set to "0" or "1" or deleted.
+ * - `privacy_model` facilitates protection of site assets. May be set to "wp_uploads" to block logged-out requests for WP uploads. If set, an AT_PRIVACY_MODEL constant will be defined in the PHP environment.
+ * - `geo_affinity` may be used to get and set a site's geo-affinity. Allowed values are those returned by the "get-available-datacenters" endpoint. It is not currently useful to set a site's geo-affinity after creation unless you have access to an endpoint that allows you to subsequently trigger migration of the site to another server pool.
+ * - `static_file_404` may be used to get and set how a site responds to requests for non-existent static files. May be set to "lightweight" for simple, fast web server 404s. May be set to "wordpress" to delegate such requests to WordPress. The current default is "wordpress".
+ * - `php_memory_limit` may be used to set the per-request PHP memory limit to a value between 512MB and 2048MB.  Allowed values are 512, 1024, 1536, 2048. The default if not set is 512.
+ * - `opcache_memory_limit_mb` may be used to set the per-request PHP memory limit to a value up to 300.
+ * - `default_php_conns` may be used to either limit site's allowed concurrent PHP connections or to increase the default number of concurrent connections a site can use if the web server has spare PHP connections capacity. Clients may set any value for a site between 2 and 10; the platform has more leeway if needed.
+ * - `burst_php_conns` may be used to enable burst for sites with fewer than 10 default_php_conns. 0 or absent when default_php_conns < 10 means burst is disabled, 1 means burst is enabled.
+ * - `php_fs_permissions` may be used to cause HTTP requests being handled by PHP for a site to have that sites filesystem mounted specially. Currently supported values are "rw" (readwrite - the default), "ro" (readonly), and "loggedin" (read only unless logged into WordPress). It is possible that other more complicated settings may be added in the future.
+ * - `canonicalize_aliases` may be used to change whether a sites domain aliases redirect (default, "true") to the sites primary domain name or are served directly (when set to "false")
+ * - `_data` is provided for clients to store a JSON-encoded array of site-specific data not to exceed 1M in size; this string is available via the get-sites endpoint, but is not part of the get-site record, nor is it available in the context of the site itself.
+ */
+export declare const getSiteMetaSiteKeyAction: <ThrowOnError extends boolean = true>(options: Options<GetSiteMetaSiteKeyActionData, ThrowOnError>) => import("./client").RequestResult<GetSiteMetaSiteKeyActionResponses, GetSiteMetaSiteKeyActionErrors, ThrowOnError, "fields">;
+/**
+ * Manage Site Meta
+ * Endpoint for managing site meta.
+ *
+ * The following meta keys are supported:
+ *
+ * - Values for `db_charset` and `db_collate` include "latin1", "latin1_swedish_ci"; "utf8", "utf8_general_ci"; and "utf8mb4", "utf8mb4_general_ci".
+ * - `suspended` suspends a site. The value is the HTTP 4xx status code the site will respond with. The supported statuses are "403", "404", "410", "451", "480", and "503".
+ * - `suspend_after` will suspend a site after a given unixtime timestamp with the status specified in "suspended", default 480.
+ * - `allow_restore` opts a site into self-restore via the "restore-site" endpoint. The value must be a positive Unix timestamp, must not be more than 5 minutes in the future, and must be recent (within MONTH_IN_SECONDS) when "restore-site" is called. It only authorizes the restore window; the restore is started with the "restore-site" endpoint.
+ * - `php_version` sets the site's PHP version. Supported values include "8.2", "8.3", "8.4", and "8.5".
+ * - `wp_version` is a get-only key that can be used to retrieve the site's current managed WordPress version, which can be either "latest", "previous", or "beta" (used to test WordPress releases). Use the "site-wordpress-version" endpoint to set "wp_version".
+ * - `do_not_delete` may be set to a truthy value to prevent a site from begin deleted. This can be useful in some cases. For example, you might wish to preserve a site while it is being reviewed for Terms of Service violations.
+ * - `space_used` is a get-only key that returns an integer in bytes; it is updated every 12 hours with the amount of space used by a site's files.
+ * - `db_file_size` is a get-only key that returns an integer in bytes. It is updated every 12 hours with the amount of space used by a site's database.
+ * - `space_quota` can be used to get and set the space quota for a site. Value must be an integer followed by a size specifier like "200G".
+ * - `max_space_quota` is get-only and may be present if the platform has set a space_quota" maximum for a specific site.
+ * - `photon_subsizes` controls whether WP skips generating intermediate image files when an image is uploaded. The platform is able to satisfy requests for intermediate image files whether or not they exist, so sites can save disk space by not creating them. When the a site's web server receives a request for a non-existent intermediate image file, it proxies the request to Photon which responds with the intermediate image size. Can be set to "0" or "1" or deleted.
+ * - `privacy_model` facilitates protection of site assets. May be set to "wp_uploads" to block logged-out requests for WP uploads. If set, an AT_PRIVACY_MODEL constant will be defined in the PHP environment.
+ * - `geo_affinity` may be used to get and set a site's geo-affinity. Allowed values are those returned by the "get-available-datacenters" endpoint. It is not currently useful to set a site's geo-affinity after creation unless you have access to an endpoint that allows you to subsequently trigger migration of the site to another server pool.
+ * - `static_file_404` may be used to get and set how a site responds to requests for non-existent static files. May be set to "lightweight" for simple, fast web server 404s. May be set to "wordpress" to delegate such requests to WordPress. The current default is "wordpress".
+ * - `php_memory_limit` may be used to set the per-request PHP memory limit to a value between 512MB and 2048MB.  Allowed values are 512, 1024, 1536, 2048. The default if not set is 512.
+ * - `opcache_memory_limit_mb` may be used to set the per-request PHP memory limit to a value up to 300.
+ * - `default_php_conns` may be used to either limit site's allowed concurrent PHP connections or to increase the default number of concurrent connections a site can use if the web server has spare PHP connections capacity. Clients may set any value for a site between 2 and 10; the platform has more leeway if needed.
+ * - `burst_php_conns` may be used to enable burst for sites with fewer than 10 default_php_conns. 0 or absent when default_php_conns < 10 means burst is disabled, 1 means burst is enabled.
+ * - `php_fs_permissions` may be used to cause HTTP requests being handled by PHP for a site to have that sites filesystem mounted specially. Currently supported values are "rw" (readwrite - the default), "ro" (readonly), and "loggedin" (read only unless logged into WordPress). It is possible that other more complicated settings may be added in the future.
+ * - `canonicalize_aliases` may be used to change whether a sites domain aliases redirect (default, "true") to the sites primary domain name or are served directly (when set to "false")
+ * - `_data` is provided for clients to store a JSON-encoded array of site-specific data not to exceed 1M in size; this string is available via the get-sites endpoint, but is not part of the get-site record, nor is it available in the context of the site itself.
+ */
+export declare const postSiteMetaSiteKeyAction: <ThrowOnError extends boolean = true>(options: Options<PostSiteMetaSiteKeyActionData, ThrowOnError>) => import("./client").RequestResult<PostSiteMetaSiteKeyActionResponses, PostSiteMetaSiteKeyActionErrors, ThrowOnError, "fields">;
+/**
+ * Manage Site Software
+ * Manage a site's software installation and activation.
+ */
+export declare const postSiteManageSoftwareTypeSite: <ThrowOnError extends boolean = true>(options: Options<PostSiteManageSoftwareTypeSiteData, ThrowOnError>) => import("./client").RequestResult<PostSiteManageSoftwareTypeSiteResponses, PostSiteManageSoftwareTypeSiteErrors, ThrowOnError, "fields">;
+/**
+ * Queue SSH Disconnect All Users Job
+ * Queue a job to terminate all active SSH and SFTP connections for a site. Affects both user-level and client-level connections.
+ */
+export declare const getSshDisconnectAllUsersServiceIdentifier: <ThrowOnError extends boolean = true>(options: Options<GetSshDisconnectAllUsersServiceIdentifierData, ThrowOnError>) => import("./client").RequestResult<GetSshDisconnectAllUsersServiceIdentifierResponses, GetSshDisconnectAllUsersServiceIdentifierErrors, ThrowOnError, "fields">;
+/**
+ * Remove Client Meta
+ * Remove a client meta value.
+ *
+ * Note: `max_space_quota` is read-only and cannot be removed.
+ */
+export declare const getClientMetaClientKeyRemove: <ThrowOnError extends boolean = true>(options: Options<GetClientMetaClientKeyRemoveData, ThrowOnError>) => import("./client").RequestResult<GetClientMetaClientKeyRemoveResponses, GetClientMetaClientKeyRemoveErrors, ThrowOnError, "fields">;
+/**
+ * Remove Cron Entry
+ * Removes a cron entry from a site.
+ *
+ * If the event is already running, removing it will prevent future runs, but will not interrupt any existing runs.
+ */
+export declare const postCrontabSiteRemove: <ThrowOnError extends boolean = true>(options: Options<PostCrontabSiteRemoveData, ThrowOnError>) => import("./client").RequestResult<PostCrontabSiteRemoveResponses, PostCrontabSiteRemoveErrors, ThrowOnError, "fields">;
+/**
+ * Remove Firewall Rule
+ * Remove an existing firewall rule from a site.
+ */
+export declare const postFirewallRulesSiteRemove: <ThrowOnError extends boolean = true>(options: Options<PostFirewallRulesSiteRemoveData, ThrowOnError>) => import("./client").RequestResult<PostFirewallRulesSiteRemoveResponses, PostFirewallRulesSiteRemoveErrors, ThrowOnError, "fields">;
+/**
+ * Remove Public Key
+ * Delete a single aliasable public key.
+ *
+ * Removes an aliasable public key. Any object referencing this address will still be doing so. An object referencing the address of a nonexistent key will, effectively, have no key. If a key is [re]created at an address then all objects referencing that address will then be accessible via the aliasable key.
+ */
+export declare const postAliasPkeyRemoveClientCategoryName: <ThrowOnError extends boolean = true>(options: Options<PostAliasPkeyRemoveClientCategoryNameData, ThrowOnError>) => import("./client").RequestResult<PostAliasPkeyRemoveClientCategoryNameResponses, PostAliasPkeyRemoveClientCategoryNameErrors, ThrowOnError, "fields">;
+/**
+ * Remove Site SSH/SFTP User
+ * Delete an SSH/SFTP user from a site. Also queues a disconnect job to terminate any active SSH sessions for this user.
+ */
+export declare const getSshUserServiceIdentifierRemoveUsername: <ThrowOnError extends boolean = true>(options: Options<GetSshUserServiceIdentifierRemoveUsernameData, ThrowOnError>) => import("./client").RequestResult<GetSshUserServiceIdentifierRemoveUsernameResponses, GetSshUserServiceIdentifierRemoveUsernameErrors, ThrowOnError, "fields">;
+/**
+ * Remove Site SSH/SFTP User
+ * Delete an SSH/SFTP user from a site. Also queues a disconnect job to terminate any active SSH sessions for this user.
+ */
+export declare const postSshUserServiceIdentifierRemoveUsername: <ThrowOnError extends boolean = true>(options: Options<PostSshUserServiceIdentifierRemoveUsernameData, ThrowOnError>) => import("./client").RequestResult<PostSshUserServiceIdentifierRemoveUsernameResponses, PostSshUserServiceIdentifierRemoveUsernameErrors, ThrowOnError, "fields">;
+/**
+ * Request Backup Creation
+ * Request creation of an on-demand backup for a site. The backup will contain either filesystem data, database data, or both depending on the type specified. Backups are subject to quota limits which can be customized via site or client metadata.
+ */
+export declare const postOnDemandBackupCreateSiteType: <ThrowOnError extends boolean = true>(options: Options<PostOnDemandBackupCreateSiteTypeData, ThrowOnError>) => import("./client").RequestResult<PostOnDemandBackupCreateSiteTypeResponses, PostOnDemandBackupCreateSiteTypeErrors, ThrowOnError, "fields">;
+/**
+ * Request Backup Deletion
+ * Request deletion of an existing on-demand backup. Only backups of type "ondemand-fs", "ondemand-db", or legacy "ondemand" can be deleted.
+ */
+export declare const postOnDemandBackupDeleteSiteBackupId: <ThrowOnError extends boolean = true>(options: Options<PostOnDemandBackupDeleteSiteBackupIdData, ThrowOnError>) => import("./client").RequestResult<PostOnDemandBackupDeleteSiteBackupIdResponses, PostOnDemandBackupDeleteSiteBackupIdErrors, ThrowOnError, "fields">;
+/**
+ * Reset Database Password
+ * Reset the database password for a site.
+ */
+export declare const postResetDbPasswordTypeSite: <ThrowOnError extends boolean = true>(options: Options<PostResetDbPasswordTypeSiteData, ThrowOnError>) => import("./client").RequestResult<PostResetDbPasswordTypeSiteResponses, PostResetDbPasswordTypeSiteErrors, ThrowOnError, "fields">;
+/**
+ * Reset Database Password
+ * Reset the database password for a site.
+ */
+export declare const postResetDbPasswordTypeSiteNew: <ThrowOnError extends boolean = true>(options: Options<PostResetDbPasswordTypeSiteNewData, ThrowOnError>) => import("./client").RequestResult<PostResetDbPasswordTypeSiteNewResponses, PostResetDbPasswordTypeSiteNewErrors, ThrowOnError, "fields">;
+/**
+ * Restore Existing Site From Its Own Backups
+ * Restore an existing site from a filesystem + database backup pair belonging to that same site. Requires the customer to have set the `allow_restore` site meta to a recent Unix timestamp (within MONTH_IN_SECONDS), and to have suspended the destination site with status 503 via the `suspended` site meta, using the `site-meta` endpoint.
+ *
+ * Mirrors the work performed by `site-provisioned/:site_id/restore` after a `create-site` with `restore_from`, but writes against an existing site instead of a freshly provisioned one.
+ */
+export declare const postRestoreSiteSite: <ThrowOnError extends boolean = true>(options: Options<PostRestoreSiteSiteData, ThrowOnError>) => import("./client").RequestResult<PostRestoreSiteSiteResponses, PostRestoreSiteSiteErrors, ThrowOnError, "fields">;
+/**
+ * Retry SSL Provisioning
+ * Retry SSL certificate provisioning.
+ */
+export declare const postSslRetryDomain: <ThrowOnError extends boolean = true>(options: Options<PostSslRetryDomainData, ThrowOnError>) => import("./client").RequestResult<PostSslRetryDomainResponses, PostSslRetryDomainErrors, ThrowOnError, "fields">;
+/**
+ * Scan Site for Malware
+ * Scan a site for malware.
+ */
+export declare const postMalwareScanSite: <ThrowOnError extends boolean = true>(options: Options<PostMalwareScanSiteData, ThrowOnError>) => import("./client").RequestResult<PostMalwareScanSiteResponses, PostMalwareScanSiteErrors, ThrowOnError, "fields">;
+/**
+ * Stage a Custom Certificate
+ * Prepare a certificate for use on one or more domains. Does not activate the certificate immediately.
+ */
+export declare const postCustomCertificatesSiteStage: <ThrowOnError extends boolean = true>(options: Options<PostCustomCertificatesSiteStageData, ThrowOnError>) => import("./client").RequestResult<PostCustomCertificatesSiteStageResponses, PostCustomCertificatesSiteStageErrors, ThrowOnError, "fields">;
+/**
+ * Toggle Android Compatibility
+ * Enable/disable certificates compatible with older Android devices. Android compatibility is enabled by default.
+ */
+export declare const postSslAndroidCompatDomainEnable: <ThrowOnError extends boolean = true>(options: Options<PostSslAndroidCompatDomainEnableData, ThrowOnError>) => import("./client").RequestResult<PostSslAndroidCompatDomainEnableResponses, PostSslAndroidCompatDomainEnableErrors, ThrowOnError, "fields">;
+/**
+ * Toggle HSTS includeSubDomains
+ * Enable/disable HSTS includeSubDomains directive. Includes the preload directive for ease of use.
+ */
+export declare const postSslHstsSubdomainDomainEnable: <ThrowOnError extends boolean = true>(options: Options<PostSslHstsSubdomainDomainEnableData, ThrowOnError>) => import("./client").RequestResult<PostSslHstsSubdomainDomainEnableResponses, PostSslHstsSubdomainDomainEnableErrors, ThrowOnError, "fields">;
+/**
+ * Toggle Social Crawler Redirect
+ * Enable/disable redirect from https to http for social crawlers. This is used to retain share counts between http/https for Facebook/Twitter/LinkedIn, if links were originally shared as http. Social crawler redirect is disabled by default for all new domains since 2022-11-04.
+ */
+export declare const postSslSocialCrawlerRedirectDomainEnable: <ThrowOnError extends boolean = true>(options: Options<PostSslSocialCrawlerRedirectDomainEnableData, ThrowOnError>) => import("./client").RequestResult<PostSslSocialCrawlerRedirectDomainEnableResponses, PostSslSocialCrawlerRedirectDomainEnableErrors, ThrowOnError, "fields">;
+/**
+ * Update a Custom Certificate
+ * Update an existing custom SSL certificate for renewal or rekeying. If id is omitted, the currently active certificate is updated.
+ */
+export declare const postCustomCertificatesSiteIdUpdate: <ThrowOnError extends boolean = true>(options: Options<PostCustomCertificatesSiteIdUpdateData, ThrowOnError>) => import("./client").RequestResult<PostCustomCertificatesSiteIdUpdateResponses, PostCustomCertificatesSiteIdUpdateErrors, ThrowOnError, "fields">;
+/**
+ * Update Client Meta
+ * Update an existing client meta value.
+ *
+ * Note: `max_space_quota` is read-only and cannot be updated.
+ */
+export declare const postClientMetaClientKeyUpdate: <ThrowOnError extends boolean = true>(options: Options<PostClientMetaClientKeyUpdateData, ThrowOnError>) => import("./client").RequestResult<PostClientMetaClientKeyUpdateResponses, PostClientMetaClientKeyUpdateErrors, ThrowOnError, "fields">;
+/**
+ * Update Cron Entry
+ * Update an existing cron entry.
+ */
+export declare const postCrontabSiteUpdateCronId: <ThrowOnError extends boolean = true>(options: Options<PostCrontabSiteUpdateCronIdData, ThrowOnError>) => import("./client").RequestResult<PostCrontabSiteUpdateCronIdResponses, PostCrontabSiteUpdateCronIdErrors, ThrowOnError, "fields">;
+/**
+ * Update Site Chroot
+ * Update the chroot environment for a site. The chroot slug must be one of the allowed values for the client. Queues a job to apply the filesystem changes on the pool server; use the returned job_id to track completion.
+ */
+export declare const postSiteSetChrootSiteDesired: <ThrowOnError extends boolean = true>(options: Options<PostSiteSetChrootSiteDesiredData, ThrowOnError>) => import("./client").RequestResult<PostSiteSetChrootSiteDesiredResponses, PostSiteSetChrootSiteDesiredErrors, ThrowOnError, "fields">;
+/**
+ * Update Site Domain
+ * Update a site's primary domain.
+ */
+export declare const postUpdateSiteDomainServiceIdentifierDomain: <ThrowOnError extends boolean = true>(options: Options<PostUpdateSiteDomainServiceIdentifierDomainData, ThrowOnError>) => import("./client").RequestResult<PostUpdateSiteDomainServiceIdentifierDomainResponses, PostUpdateSiteDomainServiceIdentifierDomainErrors, ThrowOnError, "fields">;
+/**
+ * Update Site Domain
+ * Update a site's primary domain.
+ */
+export declare const postUpdateSiteDomainServiceIdentifierDomainKeep: <ThrowOnError extends boolean = true>(options: Options<PostUpdateSiteDomainServiceIdentifierDomainKeepData, ThrowOnError>) => import("./client").RequestResult<PostUpdateSiteDomainServiceIdentifierDomainKeepResponses, PostUpdateSiteDomainServiceIdentifierDomainKeepErrors, ThrowOnError, "fields">;
+/**
+ * Update Site Options
+ * Update a site's WordPress options.
+ */
+export declare const postUpdateSiteOptionsTypeSite: <ThrowOnError extends boolean = true>(options: Options<PostUpdateSiteOptionsTypeSiteData, ThrowOnError>) => import("./client").RequestResult<PostUpdateSiteOptionsTypeSiteResponses, PostUpdateSiteOptionsTypeSiteErrors, ThrowOnError, "fields">;
+/**
+ * Update Site SSH/SFTP User
+ * Update password or SSH key for an existing SSH/SFTP user. Empty password string disables password authentication (key-only). Allowed key types: ssh-rsa (2048-16384 bits), ecdsa-sha2-nistp256 (256 bits), ssh-ed25519 (256 bits).
+ */
+export declare const postSshUserServiceIdentifierUpdateUsername: <ThrowOnError extends boolean = true>(options: Options<PostSshUserServiceIdentifierUpdateUsernameData, ThrowOnError>) => import("./client").RequestResult<PostSshUserServiceIdentifierUpdateUsernameResponses, PostSshUserServiceIdentifierUpdateUsernameErrors, ThrowOnError, "fields">;
+/**
+ * Update Site WordPress Version
+ * Configure a site to use a specific managed version of WordPress.
+ */
+export declare const postSiteWordpressVersionSiteVersion: <ThrowOnError extends boolean = true>(options: Options<PostSiteWordpressVersionSiteVersionData, ThrowOnError>) => import("./client").RequestResult<PostSiteWordpressVersionSiteVersionResponses, PostSiteWordpressVersionSiteVersionErrors, ThrowOnError, "fields">;
+/**
+ * Validate Custom Certificate
+ * Validate a custom SSL certificate for use on one or more domains.
+ */
+export declare const postCustomCertificatesSiteValidate: <ThrowOnError extends boolean = true>(options: Options<PostCustomCertificatesSiteValidateData, ThrowOnError>) => import("./client").RequestResult<PostCustomCertificatesSiteValidateResponses, PostCustomCertificatesSiteValidateErrors, ThrowOnError, "fields">;
+/**
+ * Validate Domain Eligibility
+ * Check whether a domain can be hosted on WP Cloud. Note that this check will return false for valid domains that are already hosted on WordPress.com or WP Cloud infrastructure.
+ */
+export declare const getCheckCanHostDomainClientDomain: <ThrowOnError extends boolean = true>(options: Options<GetCheckCanHostDomainClientDomainData, ThrowOnError>) => import("./client").RequestResult<GetCheckCanHostDomainClientDomainResponses, GetCheckCanHostDomainClientDomainErrors, ThrowOnError, "fields">;
+/**
+ * Manage Site Aliases
+ * Manage domain aliases for a site.
+ */
+export declare const getSiteAliasServiceIdentifierActionDomain: <ThrowOnError extends boolean = true>(options: Options<GetSiteAliasServiceIdentifierActionDomainData, ThrowOnError>) => import("./client").RequestResult<GetSiteAliasServiceIdentifierActionDomainResponses, GetSiteAliasServiceIdentifierActionDomainErrors, ThrowOnError, "fields">;
+//# sourceMappingURL=sdk.gen.d.ts.map