@newfold/huapi-js 2.1978.0 → 2.2000.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.1978.0
+ * OpenAPI spec version: 1.2000.0
  */
 export declare type SshKeyListV4200RowsItem = {
     authorize?: boolean;
@@ -574,6 +574,17 @@ export declare type SitesDomainsV2200DomainsItem = {
 export declare type SitesDomainsV2Params = {
     scan?: boolean;
 };
+export declare type SitesListV2200 = {
+    items?: SitesListV2200ItemsItem[];
+    /** page size */
+    limit?: number;
+    /** current page number */
+    page?: number;
+    /** total number of pages */
+    pages?: number;
+    /** total number of sites returned */
+    total?: number;
+};
 /**
  * @nullable
  */
@@ -601,6 +612,63 @@ export declare type SitesListV2200ItemsItemStaging = {
     /** A list of staging sites of the current site */
     sites?: number[];
 } | null;
+export declare type SitesListV2200ItemsItemResourcesStorage = {
+    /** @nullable */
+    available?: number | null;
+    /** @nullable */
+    total?: number | null;
+    unit?: string;
+    /** @nullable */
+    used?: number | null;
+};
+export declare type SitesListV2200ItemsItemResources = {
+    storage?: SitesListV2200ItemsItemResourcesStorage;
+    /** @nullable */
+    workers?: number | null;
+};
+/**
+ * @nullable
+ */
+export declare type SitesListV2200ItemsItemPendingUrlData = {
+    /**
+     * 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;
+/**
+ * Job ids for the site
+ * @nullable
+ */
+export declare type SitesListV2200ItemsItemJobs = {
+    [key: string]: unknown;
+} | null;
 export declare type SitesListV2200ItemsItem = {
     /** @nullable */
     account_back_ref?: string | null;
@@ -679,74 +747,6 @@ export declare type SitesListV2200ItemsItem = {
      */
     version_ptr?: string | null;
 };
-export declare type SitesListV2200 = {
-    items?: SitesListV2200ItemsItem[];
-    /** page size */
-    limit?: number;
-    /** current page number */
-    page?: number;
-    /** total number of pages */
-    pages?: number;
-    /** total number of sites returned */
-    total?: number;
-};
-export declare type SitesListV2200ItemsItemResourcesStorage = {
-    /** @nullable */
-    available?: number | null;
-    /** @nullable */
-    total?: number | null;
-    unit?: string;
-    /** @nullable */
-    used?: number | null;
-};
-export declare type SitesListV2200ItemsItemResources = {
-    storage?: SitesListV2200ItemsItemResourcesStorage;
-    /** @nullable */
-    workers?: number | null;
-};
-/**
- * @nullable
- */
-export declare type SitesListV2200ItemsItemPendingUrlData = {
-    /**
-     * 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;
-/**
- * Job ids for the site
- * @nullable
- */
-export declare type SitesListV2200ItemsItemJobs = {
-    [key: string]: unknown;
-} | null;
 export declare type SshKeyV2200 = {
     deleted?: number;
     key_name?: string;
@@ -1477,12 +1477,51 @@ export declare type WaldaiSso200 = {
     /** SSO redirect URL for WaldAI dashboard */
     redirect_url: string;
 };
+export declare type UserSpamexperts200RowsItemMeta = {
+    /** @nullable */
+    domain?: string | null;
+    /** @nullable */
+    email?: string | null;
+};
+export declare type UserSpamexperts200RowsItem = {
+    addon_id: number;
+    /**
+     * Back reference of the SpamExperts addon
+     * @nullable
+     */
+    back_reference?: string | null;
+    /**
+     * Hosting back reference for grouping rows by package
+     * @nullable
+     */
+    hosting_back_reference?: string | null;
+    meta: UserSpamexperts200RowsItemMeta;
+    status: string;
+};
+export declare type UserSpamexperts200 = {
+    rows: UserSpamexperts200RowsItem[];
+};
+export declare type UserProservices200 = {
+    /** Pro-services products from FG */
+    products?: UserProservices200ProductsItem[];
+    /** Number of pro-services products returned */
+    total?: number;
+};
 export declare type UserProservices200ProductsItemProductProfileOptionsItem = {
     /** @nullable */
     profile_option?: number | null;
     /** @nullable */
     profile_value?: string | null;
 };
+/**
+ * @nullable
+ */
+export declare type UserProservices200ProductsItemIdentifier = {
+    /** Identifier type: domain, ticket_id, or account_id */
+    key?: string;
+    /** Resolved identifier value from Pega or FG */
+    value?: string;
+} | null;
 export declare type UserProservices200ProductsItem = {
     /** @nullable */
     auto_renew_flag?: boolean | null;
@@ -1498,6 +1537,8 @@ export declare type UserProservices200ProductsItem = {
     /** @nullable */
     generic_prod_type?: string | null;
     /** @nullable */
+    identifier?: UserProservices200ProductsItemIdentifier;
+    /** @nullable */
     life_cycle_state?: string | null;
     /**
      * prod_code of the parent product referenced by parent_prod_inst_id
@@ -1510,16 +1551,123 @@ export declare type UserProservices200ProductsItem = {
     prod_code?: string | null;
     /** @nullable */
     prod_inst_id?: string | null;
+    /**
+     * FG product instance display name
+     * @nullable
+     */
+    prod_inst_name?: string | null;
     /** @nullable */
     prod_name?: string | null;
     /** FG product profile options */
     product_profile_options?: UserProservices200ProductsItemProductProfileOptionsItem[];
+    /** Remaining revision days, Expired when the window has ended, or empty when not applicable */
+    revision_window_days?: string;
+    /** Pro-services status: Active or Completed */
+    status?: string;
 };
-export declare type UserProservices200 = {
-    /** Pro-services products from FG */
-    products?: UserProservices200ProductsItem[];
-    /** Number of pro-services products returned */
-    total?: number;
+export declare type UserProducts502 = {
+    /** Error code */
+    error?: string;
+};
+export declare type UserProducts401 = {
+    /** Error code */
+    error?: string;
+};
+export declare type UserProducts200ProductsItem = {
+    /**
+     * Account identifier
+     * @nullable
+     */
+    account_id?: number | null;
+    /**
+     * Human-readable auto-renew status. Possible values: 'On' (auto-renew enabled) or 'Off' (auto-renew disabled).
+     * @nullable
+     */
+    auto_renew?: string | null;
+    /**
+     * Whether auto-renew is enabled
+     * @nullable
+     */
+    auto_renew_flag?: boolean | null;
+    /**
+     * Date when the product was created
+     * @nullable
+     */
+    created_date?: string | null;
+    /**
+     * Product expiration date
+     * @nullable
+     */
+    expiration_date?: string | null;
+    /**
+     * Generic product type
+     * @nullable
+     */
+    generic_prod_type?: string | null;
+    /**
+     * Whether the product is a WP Cloud product (e.g. WP_CLOUD_1, WP_CLOUD_10, WP_CLOUD_25, WP_CLOUD_50, WP_CLOUD_100, WP_CLOUD_300, WP_CLOUD_600).
+     * @nullable
+     */
+    is_cloud_product?: boolean | null;
+    /**
+     * Whether this product includes free foundation hosting
+     * @nullable
+     */
+    is_free_foundation_hosting?: boolean | null;
+    /**
+     * Whether the Google Workspace product has been configured (i.e. configuredCdId equals 13).
+     * @nullable
+     */
+    is_gw_product_configured?: boolean | null;
+    /**
+     * Parent product instance identifier
+     * @nullable
+     */
+    parent_prod_inst_id?: string | null;
+    /**
+     * Internal product code
+     * @nullable
+     */
+    prod_code?: string | null;
+    /**
+     * Product identifier
+     * @nullable
+     */
+    prod_id?: number | null;
+    /**
+     * Product instance identifier
+     * @nullable
+     */
+    prod_inst_id?: string | null;
+    /**
+     * Product instance name
+     * @nullable
+     */
+    prod_inst_name?: string | null;
+    /**
+     * Product display name
+     * @nullable
+     */
+    prod_name?: string | null;
+    /**
+     * Product type
+     * @nullable
+     */
+    prod_type?: string | null;
+    /**
+     * Numeric duration of the subscription. The unit of this value is defined by subscription_unit (e.g. a value of 1 with subscription_unit 'Y' means 1 year, a value of 6 with subscription_unit 'M' means 6 months).
+     * @nullable
+     */
+    subscription_term?: number | null;
+    /**
+     * Unit of the subscription term. Common values: 'Y' (year), 'M' (month). Use in conjunction with subscription_term to determine the full subscription length (e.g. subscription_term: 1, subscription_unit: 'Y' = 1 year).
+     * @nullable
+     */
+    subscription_unit?: string | null;
+};
+export declare type UserProducts200 = {
+    /** List of products associated with the account */
+    products?: UserProducts200ProductsItem[];
 };
 export declare type AllUserMonarxDetails200RowsItem = {
     /** HAL Account back_reference, used to link to the product instance */
@@ -3855,6 +4003,21 @@ export declare type HostingSshInfo200 = {
     success?: boolean;
     username?: string;
 };
+export declare type HostingSpamexpertsEligibleDomains200RowsItem = {
+    /** Domain name */
+    domain?: string;
+    /** HAL domain id */
+    id?: number;
+    /** Domain status on the hosting account */
+    status?: string;
+    /** Domain type */
+    type?: string;
+};
+export declare type HostingSpamexpertsEligibleDomains200 = {
+    /** Number of eligible domains returned */
+    n_rows?: number;
+    rows?: HostingSpamexpertsEligibleDomains200RowsItem[];
+};
 export declare type SitesBatch200 = {
     success?: boolean;
 };
@@ -5815,6 +5978,79 @@ export declare type HostingCapabilities200 = {
     sites?: boolean;
     whm?: boolean;
 };
+/**
+ * @nullable
+ */
+export declare type HostingBackups200Xcitium = {
+    /**
+     * back reference of the HAL addon
+     * @nullable
+     */
+    addon_back_reference?: string | null;
+    /** id of the HAL addon */
+    addon_id?: number;
+    /** whether the product for this addon can be upgraded */
+    can_upgrade?: boolean;
+    /**
+     * displayable product tier or plan name
+     * @nullable
+     */
+    plan_name?: string | null;
+    /** status of the HAL addon */
+    status?: string;
+} | null;
+export declare type HostingBackups200JetpackItem = {
+    /**
+     * back reference of the HAL addon
+     * @nullable
+     */
+    addon_back_reference?: string | null;
+    /** id of the HAL addon */
+    addon_id?: number;
+    /** whether the product for this addon can be upgraded */
+    can_upgrade?: boolean;
+    /**
+     * displayable product tier or plan name
+     * @nullable
+     */
+    plan_name?: string | null;
+    /**
+     * site id from the HAL addon meta
+     * @nullable
+     */
+    site_id?: string | null;
+    /** status of the HAL addon */
+    status?: string;
+};
+/**
+ * @nullable
+ */
+export declare type HostingBackups200Codeguard = {
+    /**
+     * back reference of the HAL addon
+     * @nullable
+     */
+    addon_back_reference?: string | null;
+    /** id of the HAL addon */
+    addon_id?: number;
+    /** whether the product for this addon can be upgraded */
+    can_upgrade?: boolean;
+    /**
+     * displayable product tier or plan name
+     * @nullable
+     */
+    plan_name?: string | null;
+    /** status of the HAL addon */
+    status?: string;
+} | null;
+export declare type HostingBackups200 = {
+    /** @nullable */
+    codeguard?: HostingBackups200Codeguard;
+    /** @nullable */
+    jetpack?: HostingBackups200JetpackItem[] | null;
+    /** @nullable */
+    xcitium?: HostingBackups200Xcitium;
+};
 export declare type HostingAdvancedSystemConsole200 = {
     url?: string;
 };
@@ -5852,7 +6088,48 @@ export declare type HostingAdvancedPasswordBody = {
      */
     password: string;
 };
+/**
+ * Server sync q_job state when server_reason is not_ready
+ * @nullable
+ */
+export declare type HostingAdvancedServerHealthcheck200ServerQJob = {
+    /**
+     * Remaining sync q_job retries (0 means exhausted)
+     * @nullable
+     */
+    remaining?: number | null;
+    /**
+     * Sync q_job tries made so far
+     * @nullable
+     */
+    tries?: number | null;
+} | null;
+/**
+ * Hosting addon sync q_job state when addon_reason is not_ready
+ * @nullable
+ */
+export declare type HostingAdvancedServerHealthcheck200AddonQJob = {
+    /**
+     * Remaining sync q_job retries (0 means exhausted)
+     * @nullable
+     */
+    remaining?: number | null;
+    /**
+     * Sync q_job tries made so far
+     * @nullable
+     */
+    tries?: number | null;
+} | null;
 export declare type HostingAdvancedServerHealthcheck200 = {
+    /**
+     * Hosting addon sync q_job state when addon_reason is not_ready
+     * @nullable
+     */
+    addon_q_job?: HostingAdvancedServerHealthcheck200AddonQJob;
+    /** Resolved hosting addon health category (ok, not_ready, not_active) */
+    addon_reason: string;
+    /** Current hosting addon status */
+    addon_status: string;
     /**
      * 1 if the panel responded (Windows servers)
      * @nullable
@@ -5868,7 +6145,14 @@ export declare type HostingAdvancedServerHealthcheck200 = {
      * @nullable
      */
     server_hello?: number | null;
-    /** Current server status */
+    /**
+     * Server sync q_job state when server_reason is not_ready
+     * @nullable
+     */
+    server_q_job?: HostingAdvancedServerHealthcheck200ServerQJob;
+    /** Resolved server health category (ok, stopped, not_ready, not_active) */
+    server_reason: string;
+    /** Current HAL server VM status */
     server_status: string;
 };
 export declare type HostingAdvancedServerStatus200Actions = {
@@ -6711,6 +6995,15 @@ export declare type AddonsSync200 = {
 export declare type AddonsSpamexpertsSso200 = {
     url?: string;
 };
+export declare type AddonsSpamexpertsDomainAssign200 = {
+    [key: string]: unknown;
+};
+export declare type AddonsSpamexpertsDomainAssignBody = {
+    /** The domain to assign to SpamExperts */
+    domain: string;
+    /** The email address to use for the SpamExperts account */
+    email: string;
+};
 export declare type MonarxAddonReportUrl200 = {
     /** Tokenized Monarx iframe URL */
     report_url: string;
@@ -7096,6 +7389,14 @@ export declare type BackupMeta200SiteCbsBackupDeleteData = {
      */
     plan_type?: BackupMeta200SiteCbsBackupDeleteDataPlanType;
 } | null;
+export declare type BackupMeta200Account = {
+    /** @nullable */
+    cbs_downloadables?: BackupMeta200AccountCbsDownloadablesItem[] | null;
+    /** @nullable */
+    cbs_event_processing?: BackupMeta200AccountCbsEventProcessing;
+    /** @nullable */
+    cbs_last_restore_timestamp?: string | null;
+};
 /**
  * Backup plan type for the current account event processing context.
  * @nullable
@@ -7139,14 +7440,6 @@ export declare type BackupMeta200AccountCbsDownloadablesItem = {
     /** @nullable */
     url?: string | null;
 };
-export declare type BackupMeta200Account = {
-    /** @nullable */
-    cbs_downloadables?: BackupMeta200AccountCbsDownloadablesItem[] | null;
-    /** @nullable */
-    cbs_event_processing?: BackupMeta200AccountCbsEventProcessing;
-    /** @nullable */
-    cbs_last_restore_timestamp?: string | null;
-};
 export declare type BackupMetaParams = {
     site_id?: number;
 };
@@ -7412,7 +7705,13 @@ export declare type CodeguardWebsiteList200 = {
 };
 export declare type CodeguardPlanInfo200SeatsItem = {
     activated?: boolean;
+    database_activated?: boolean;
+    /** @nullable */
+    database_id?: number | null;
+    /** @nullable */
+    site_id?: number | null;
     url?: string;
+    website_activated?: boolean;
     website_id?: number;
 };
 export declare type CodeguardPlanInfo200 = {