@newfold/huapi-js 2.1898.0 → 2.1902.0

package/src/index.schemas.d.ts

@@ -3,7 +3,7 @@
  * Do not edit manually.
  * Hosting UAPI
  * Hosting UAPI is an API to expose Hosting, Addons, and Site functionality to a customer-facing Front End such as (Account Manager).
- * OpenAPI spec version: 1.1898.0
+ * OpenAPI spec version: 1.1902.0
  */
 export declare type SshKeyListV4200RowsItem = {
     authorize?: boolean;
@@ -453,84 +453,6 @@ export declare type SitesDomainsV2200 = {
 export declare type SitesDomainsV2Params = {
     scan?: boolean;
 };
-export declare type SitesListV2200ItemsItem = {
-    /** @nullable */
-    account_back_ref?: string | null;
-    account_id?: string;
-    /**
-     * the current status of the account this site belongs to
-     * @nullable
-     */
-    account_status?: string | null;
-    /** @nullable */
-    base_domain?: string | null;
-    /**
-     * False if site was added by site scanner
-     * @nullable
-     */
-    confirmed?: boolean | null;
-    /** @nullable */
-    datacenter?: string | null;
-    date_added?: string;
-    date_modified?: string;
-    detected_type?: string;
-    /** @nullable */
-    docpath?: string | null;
-    /** @nullable */
-    docroot?: string | null;
-    /** @nullable */
-    domain?: string | null;
-    edge_cache?: boolean;
-    handler_404?: string;
-    id?: number;
-    /** @nullable */
-    installed_id?: string | null;
-    /** True if docpath is public_html, otherwise False */
-    is_primary?: boolean;
-    /**
-     * Job ids for the site
-     * @nullable
-     */
-    jobs?: SitesListV2200ItemsItemJobs;
-    /** @nullable */
-    last_error?: string | null;
-    /** @nullable */
-    migration_id?: string | null;
-    /** @nullable */
-    name?: string | null;
-    /**
-     * Status of the site's onboarding
-     * @nullable
-     */
-    onboarding?: number | null;
-    path?: string;
-    /** @nullable */
-    pending_url?: string | null;
-    /** @nullable */
-    pending_url_data?: SitesListV2200ItemsItemPendingUrlData;
-    /**
-     * The Php Version. If unable to determine, it will be NULL
-     * @nullable
-     */
-    php_version?: string | null;
-    resources?: SitesListV2200ItemsItemResources;
-    /** @nullable */
-    staging?: SitesListV2200ItemsItemStaging;
-    status?: string;
-    subtype?: string;
-    type?: string;
-    /** @nullable */
-    url?: string | null;
-    /** @nullable */
-    url_is_provisional?: boolean | null;
-    /** @nullable */
-    version?: string | null;
-    /**
-     * The WP Version
-     * @nullable
-     */
-    version_ptr?: string | null;
-};
 export declare type SitesListV2200 = {
     items?: SitesListV2200ItemsItem[];
     /** page size */
@@ -626,6 +548,84 @@ export declare type SitesListV2200ItemsItemPendingUrlData = {
 export declare type SitesListV2200ItemsItemJobs = {
     [key: string]: unknown;
 } | null;
+export declare type SitesListV2200ItemsItem = {
+    /** @nullable */
+    account_back_ref?: string | null;
+    account_id?: string;
+    /**
+     * the current status of the account this site belongs to
+     * @nullable
+     */
+    account_status?: string | null;
+    /** @nullable */
+    base_domain?: string | null;
+    /**
+     * False if site was added by site scanner
+     * @nullable
+     */
+    confirmed?: boolean | null;
+    /** @nullable */
+    datacenter?: string | null;
+    date_added?: string;
+    date_modified?: string;
+    detected_type?: string;
+    /** @nullable */
+    docpath?: string | null;
+    /** @nullable */
+    docroot?: string | null;
+    /** @nullable */
+    domain?: string | null;
+    edge_cache?: boolean;
+    handler_404?: string;
+    id?: number;
+    /** @nullable */
+    installed_id?: string | null;
+    /** True if docpath is public_html, otherwise False */
+    is_primary?: boolean;
+    /**
+     * Job ids for the site
+     * @nullable
+     */
+    jobs?: SitesListV2200ItemsItemJobs;
+    /** @nullable */
+    last_error?: string | null;
+    /** @nullable */
+    migration_id?: string | null;
+    /** @nullable */
+    name?: string | null;
+    /**
+     * Status of the site's onboarding
+     * @nullable
+     */
+    onboarding?: number | null;
+    path?: string;
+    /** @nullable */
+    pending_url?: string | null;
+    /** @nullable */
+    pending_url_data?: SitesListV2200ItemsItemPendingUrlData;
+    /**
+     * The Php Version. If unable to determine, it will be NULL
+     * @nullable
+     */
+    php_version?: string | null;
+    resources?: SitesListV2200ItemsItemResources;
+    /** @nullable */
+    staging?: SitesListV2200ItemsItemStaging;
+    status?: string;
+    subtype?: string;
+    type?: string;
+    /** @nullable */
+    url?: string | null;
+    /** @nullable */
+    url_is_provisional?: boolean | null;
+    /** @nullable */
+    version?: string | null;
+    /**
+     * The WP Version
+     * @nullable
+     */
+    version_ptr?: string | null;
+};
 export declare type SshKeyV2200 = {
     deleted?: number;
     key_name?: string;
@@ -2784,6 +2784,28 @@ export declare type JetpackBackupStatus200 = {
     /** @nullable */
     status?: string | null;
 };
+export declare type SitesBackupsDetails200Xcitium = {
+    activated?: boolean;
+    /** @nullable */
+    addon_back_reference?: string | null;
+    addon_id?: string;
+    can_upgrade?: boolean;
+    /** @nullable */
+    database_id?: string | null;
+    /** @nullable */
+    disabled?: boolean | null;
+    /** @nullable */
+    over_quota?: boolean | null;
+    /** @nullable */
+    plan_name?: string | null;
+    seats_available?: number;
+    seats_count?: number;
+    status?: boolean;
+    /** @nullable */
+    url?: string | null;
+    /** @nullable */
+    website_id?: string | null;
+};
 export declare type SitesBackupsDetails200Jetpack = {
     /** @nullable */
     addon_back_reference?: string | null;
@@ -2832,6 +2854,7 @@ export declare type SitesBackupsDetails200Codeguard = {
 export declare type SitesBackupsDetails200 = {
     codeguard?: SitesBackupsDetails200Codeguard;
     jetpack?: SitesBackupsDetails200Jetpack;
+    xcitium?: SitesBackupsDetails200Xcitium;
 };
 export declare type SitesBackupsCodeguard200 = {
     database_id?: number;
@@ -2980,6 +3003,71 @@ export declare type SitesInfo200Staging = {
     /** A list of staging sites of the current site */
     sites?: number[];
 } | null;
+export declare type SitesInfo200ResourcesStorage = {
+    /** @nullable */
+    available?: number | null;
+    /** @nullable */
+    total?: number | null;
+    unit?: string;
+    /** @nullable */
+    used?: number | null;
+};
+export declare type SitesInfo200Resources = {
+    storage?: SitesInfo200ResourcesStorage;
+    /** @nullable */
+    workers?: number | null;
+};
+/**
+ * @nullable
+ */
+export declare type SitesInfo200PendingUrlData = {
+    /**
+     * The root domain name
+     * @nullable
+     */
+    base_domain?: string | null;
+    /**
+     * The Fully Qualified Domain Name (FQDN)
+     * @nullable
+     */
+    domain?: string | null;
+    /**
+     * The current pending_url's HAL Domain ID
+     * @nullable
+     */
+    domain_id?: number | null;
+    /** @nullable */
+    error?: string | null;
+    /** Flag indicating whether the pending_url is temporary or not */
+    is_temp?: boolean;
+    /**
+     * Flag indicating whether the url_sync job has run out of attempts
+     * @nullable
+     */
+    job_failed?: boolean | null;
+    /** @nullable */
+    stage?: string | null;
+    /**
+     * Timestamp for when we will update the WP url, regardless of active sessions
+     * @nullable
+     */
+    wp_session?: string | null;
+} | null;
+/**
+ * @nullable
+ */
+export declare type SitesInfo200Pagespeed = {
+    lastrun?: string;
+    performance?: string;
+    strategy?: string;
+} | null;
+/**
+ * Job ids for the site
+ * @nullable
+ */
+export declare type SitesInfo200Jobs = {
+    [key: string]: unknown;
+} | null;
 export declare type SitesInfo200 = {
     /** @nullable */
     account_back_ref?: string | null;
@@ -3063,71 +3151,6 @@ export declare type SitesInfo200 = {
     /** @nullable */
     wp_multi_site?: SitesInfo200WpMultiSite;
 };
-export declare type SitesInfo200ResourcesStorage = {
-    /** @nullable */
-    available?: number | null;
-    /** @nullable */
-    total?: number | null;
-    unit?: string;
-    /** @nullable */
-    used?: number | null;
-};
-export declare type SitesInfo200Resources = {
-    storage?: SitesInfo200ResourcesStorage;
-    /** @nullable */
-    workers?: number | null;
-};
-/**
- * @nullable
- */
-export declare type SitesInfo200PendingUrlData = {
-    /**
-     * The root domain name
-     * @nullable
-     */
-    base_domain?: string | null;
-    /**
-     * The Fully Qualified Domain Name (FQDN)
-     * @nullable
-     */
-    domain?: string | null;
-    /**
-     * The current pending_url's HAL Domain ID
-     * @nullable
-     */
-    domain_id?: number | null;
-    /** @nullable */
-    error?: string | null;
-    /** Flag indicating whether the pending_url is temporary or not */
-    is_temp?: boolean;
-    /**
-     * Flag indicating whether the url_sync job has run out of attempts
-     * @nullable
-     */
-    job_failed?: boolean | null;
-    /** @nullable */
-    stage?: string | null;
-    /**
-     * Timestamp for when we will update the WP url, regardless of active sessions
-     * @nullable
-     */
-    wp_session?: string | null;
-} | null;
-/**
- * @nullable
- */
-export declare type SitesInfo200Pagespeed = {
-    lastrun?: string;
-    performance?: string;
-    strategy?: string;
-} | null;
-/**
- * Job ids for the site
- * @nullable
- */
-export declare type SitesInfo200Jobs = {
-    [key: string]: unknown;
-} | null;
 /**
  * Links
  * @nullable
@@ -5738,28 +5761,6 @@ export declare type ActivityLog200 = {
 export declare type ActivityLogParams = {
     days?: number;
 };
-export declare type HostingAccount200 = {
-    account_id?: string;
-    account_limits?: HostingAccount200AccountLimits;
-    /** The timestamp that the hosting addon was created */
-    addon_date_added?: string;
-    advanced?: boolean;
-    billing?: HostingAccount200Billing;
-    brand?: string;
-    id?: string;
-    panel?: string;
-    plan_key?: string;
-    platform?: string;
-    /** @nullable */
-    resources?: HostingAccount200Resources;
-    /** @nullable */
-    server_status?: string | null;
-    /** @nullable */
-    ssh_hostname?: string | null;
-    status?: string;
-    type?: string;
-    username?: string;
-};
 export declare type HostingAccount200ResourcesWorkers = {
     /** @nullable */
     available?: number | null;
@@ -5777,6 +5778,14 @@ export declare type HostingAccount200ResourcesStorage = {
     /** @nullable */
     used?: number | null;
 };
+/**
+ * @nullable
+ */
+export declare type HostingAccount200Resources = {
+    staging?: HostingAccount200ResourcesStaging;
+    storage?: HostingAccount200ResourcesStorage;
+    workers?: HostingAccount200ResourcesWorkers;
+} | null;
 export declare type HostingAccount200ResourcesStagingWorkers = {
     /** @nullable */
     available?: number | null;
@@ -5798,14 +5807,6 @@ export declare type HostingAccount200ResourcesStaging = {
     storage?: HostingAccount200ResourcesStagingStorage;
     workers?: HostingAccount200ResourcesStagingWorkers;
 };
-/**
- * @nullable
- */
-export declare type HostingAccount200Resources = {
-    staging?: HostingAccount200ResourcesStaging;
-    storage?: HostingAccount200ResourcesStorage;
-    workers?: HostingAccount200ResourcesWorkers;
-} | null;
 export declare type HostingAccount200Billing = {
     prod_code?: string;
     product_name?: string;
@@ -5823,6 +5824,28 @@ export declare type HostingAccount200AccountLimits = {
      */
     sites?: number | null;
 };
+export declare type HostingAccount200 = {
+    account_id?: string;
+    account_limits?: HostingAccount200AccountLimits;
+    /** The timestamp that the hosting addon was created */
+    addon_date_added?: string;
+    advanced?: boolean;
+    billing?: HostingAccount200Billing;
+    brand?: string;
+    id?: string;
+    panel?: string;
+    plan_key?: string;
+    platform?: string;
+    /** @nullable */
+    resources?: HostingAccount200Resources;
+    /** @nullable */
+    server_status?: string | null;
+    /** @nullable */
+    ssh_hostname?: string | null;
+    status?: string;
+    type?: string;
+    username?: string;
+};
 export declare type DomainZoneeditorUrl200 = {
     url: string;
 };
@@ -6510,10 +6533,6 @@ export declare type BackupCreateOndemandV1Body = {
     /** Whether to include a link to the backup tarball */
     include_backup_tar_link?: BackupCreateOndemandV1BodyIncludeBackupTarLink;
 };
-export declare type BackupMeta200 = {
-    account?: BackupMeta200Account;
-    site?: BackupMeta200Site;
-};
 /**
  * @nullable
  */
@@ -6547,6 +6566,10 @@ export declare type BackupMeta200Site = {
     /** @nullable */
     cbs_restore_consent_info?: BackupMeta200SiteCbsRestoreConsentInfo;
 };
+export declare type BackupMeta200 = {
+    account?: BackupMeta200Account;
+    site?: BackupMeta200Site;
+};
 /**
  * @nullable
  */
@@ -6587,6 +6610,9 @@ export declare type BackupMeta200Account = {
 export declare type BackupMetaParams = {
     site_id?: number;
 };
+export declare type BackupList200 = {
+    home?: BackupList200HomeItem[];
+};
 export declare type BackupList200HomeItemBackupStatus = {
     /** @nullable */
     download_url?: string | null;
@@ -6598,9 +6624,6 @@ export declare type BackupList200HomeItem = {
     backup_status?: BackupList200HomeItemBackupStatus;
     time_created?: string;
 };
-export declare type BackupList200 = {
-    home?: BackupList200HomeItem[];
-};
 export declare type BackupListBackupType = typeof BackupListBackupType[keyof typeof BackupListBackupType];
 export declare const BackupListBackupType: {
     readonly full: "full";
@@ -6639,6 +6662,105 @@ export declare type BackupInitiateBody = {
     /** Backup Volume store ID to get the backup */
     backup_volume_store_id: string;
 };
+export declare type XcitiumSso200 = {
+    /** URL that allows SSOing in to manage the Xcitium backup account */
+    url?: string;
+};
+export declare type XcitiumPlanInfo200SeatsItem = {
+    /** Whether this site can create or can download xcitium backups */
+    activated?: boolean;
+    /**
+     * Site url for this xcitium backup
+     * @nullable
+     */
+    url?: string | null;
+    /**
+     * The xcitium identifier for this backup
+     * @nullable
+     */
+    website_id?: string | null;
+};
+export declare type XcitiumPlanInfo200 = {
+    /** Whether backups can be created or downloaded from xcitium */
+    activated?: boolean;
+    /**
+     * Back reference of the xcitium addon
+     * @nullable
+     */
+    back_reference?: string | null;
+    /** Whether the xcitium addon is upgradable to a higher tier */
+    can_upgrade?: boolean;
+    /** Whether the xcitium addon has been disabled */
+    disabled?: boolean;
+    /** Whether backup size has gone over the storage limit for the xcitium plan */
+    over_quota?: boolean;
+    /** Displayable plan name that the xcitium addon is on */
+    plan_name?: string;
+    /** Current number of sites added to the xcitium plan */
+    seat_count?: string;
+    /** Max number of sites that can be added to the xcitium plan */
+    seat_limit?: string;
+    seats?: XcitiumPlanInfo200SeatsItem[];
+    /** Current size (in gib) of backups under the xcitium plan */
+    size?: string;
+    /** Max size (in gib) that can be backed up under the xcitium plan */
+    size_limit?: string;
+    /** Status of the xcitium addon */
+    status?: string;
+};
+export declare type XcitiumBackupRestore200 = {
+    database_success?: boolean;
+    website_success?: boolean;
+};
+export declare type XcitiumBackupRestoreBody = {
+    /** The commit id to restore the database from. */
+    database_commit_id?: string;
+    /** The id of the database the given database is associated with. */
+    database_id?: number;
+    /** The commit id to restore the website from. */
+    website_commit_id?: string;
+    /** The id of the website the given database is associated with. */
+    website_id?: number;
+};
+export declare type XcitiumBackupDownload200 = {
+    database_success?: number;
+    website_success?: number;
+};
+export declare type XcitiumBackupDownloadBody = {
+    /** The commit id to restore the database from. */
+    database_commit_id?: string;
+    /** The commit id to restore the website from. */
+    website_commit_id?: string;
+    /** The id of the website the given database is associated with. */
+    website_id?: number;
+};
+export declare type XcitiumBackupCreate200 = {
+    database_success?: number;
+    website_success?: number;
+};
+export declare type XcitiumBackupCreateBody = {
+    /** The id of the database the given database is associated with. */
+    database_id?: number;
+    /** The id of the website the given database is associated with. */
+    website_id?: number;
+};
+export declare type XcitiumBackupList200BackupsItemDatabaseBackupsItem = {
+    commit_id?: string;
+    event_time?: string;
+    id?: number;
+    recommended?: boolean;
+};
+export declare type XcitiumBackupList200BackupsItem = {
+    database_backups?: XcitiumBackupList200BackupsItemDatabaseBackupsItem[];
+    event_time?: string;
+    website_commit_id?: string;
+};
+export declare type XcitiumBackupList200 = {
+    backups?: XcitiumBackupList200BackupsItem[];
+};
+export declare type XcitiumBackupListParams = {
+    website_id: number;
+};
 export declare type AddonsSitelockSso200 = {
     site_url?: string;
     sitelock_id?: string;