@newfold/huapi-js 2.1952.0 → 2.1978.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.1952.0
+ * OpenAPI spec version: 1.1978.0
  */
 export declare type SshKeyListV4200RowsItem = {
     authorize?: boolean;
@@ -206,13 +206,6 @@ export declare type BackupStatusV3Params = {
      */
     client_tracking_id: string;
 };
-export declare type BackupListV3200 = {
-    has_more?: boolean;
-    items?: BackupListV3200ItemsItem[];
-    limit?: number;
-    offset?: number;
-    total?: number;
-};
 /**
  * @nullable
  */
@@ -247,6 +240,13 @@ export declare type BackupListV3200ItemsItem = {
     timezone?: string;
     type?: string;
 };
+export declare type BackupListV3200 = {
+    has_more?: boolean;
+    items?: BackupListV3200ItemsItem[];
+    limit?: number;
+    offset?: number;
+    total?: number;
+};
 export declare type BackupListV3Params = {
     page?: number;
     limit?: number;
@@ -429,6 +429,12 @@ export declare type SiteMalwareStatusV2200 = {
      */
     scanner_state?: string | null;
 };
+export declare type SitesDomainsV2200 = {
+    domains: SitesDomainsV2200DomainsItem[];
+    limit?: number;
+    page?: number;
+    total?: number;
+};
 /**
  * Most recent errors logged during domain ssl validation. Remains set if validation tries run out. Gets reset by new validation job.
  * @nullable
@@ -565,26 +571,9 @@ export declare type SitesDomainsV2200DomainsItem = {
      */
     used_entri?: number | null;
 };
-export declare type SitesDomainsV2200 = {
-    domains: SitesDomainsV2200DomainsItem[];
-    limit?: number;
-    page?: number;
-    total?: number;
-};
 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
  */
@@ -612,63 +601,6 @@ 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;
@@ -747,6 +679,74 @@ 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,6 +1477,50 @@ export declare type WaldaiSso200 = {
     /** SSO redirect URL for WaldAI dashboard */
     redirect_url: string;
 };
+export declare type UserProservices200ProductsItemProductProfileOptionsItem = {
+    /** @nullable */
+    profile_option?: number | null;
+    /** @nullable */
+    profile_value?: string | null;
+};
+export declare type UserProservices200ProductsItem = {
+    /** @nullable */
+    auto_renew_flag?: boolean | null;
+    /**
+     * FG billing account id
+     * @nullable
+     */
+    billing_account_id?: string | null;
+    /** @nullable */
+    created_date?: string | null;
+    /** @nullable */
+    expiration_date?: string | null;
+    /** @nullable */
+    generic_prod_type?: string | null;
+    /** @nullable */
+    life_cycle_state?: string | null;
+    /**
+     * prod_code of the parent product referenced by parent_prod_inst_id
+     * @nullable
+     */
+    parent_prod_code?: string | null;
+    /** @nullable */
+    parent_prod_inst_id?: string | null;
+    /** @nullable */
+    prod_code?: string | null;
+    /** @nullable */
+    prod_inst_id?: string | null;
+    /** @nullable */
+    prod_name?: string | null;
+    /** FG product profile options */
+    product_profile_options?: UserProservices200ProductsItemProductProfileOptionsItem[];
+};
+export declare type UserProservices200 = {
+    /** Pro-services products from FG */
+    products?: UserProservices200ProductsItem[];
+    /** Number of pro-services products returned */
+    total?: number;
+};
 export declare type AllUserMonarxDetails200RowsItem = {
     /** HAL Account back_reference, used to link to the product instance */
     account_back_ref?: string;
@@ -2652,13 +2696,6 @@ export declare type SitesMetricDimensions200DimensionsPageIsCachedItem = {
     dimension?: SitesMetricDimensions200DimensionsPageIsCachedItemDimension;
     timestamp?: number;
 };
-export declare type SitesMetricDimensions200DimensionsHttpVersionItemDimension = {
-    [key: string]: number;
-};
-export declare type SitesMetricDimensions200DimensionsHttpVersionItem = {
-    dimension?: SitesMetricDimensions200DimensionsHttpVersionItemDimension;
-    timestamp?: number;
-};
 export declare type SitesMetricDimensions200Dimensions = {
     http_host?: SitesMetricDimensions200DimensionsHttpHostItem[];
     http_status?: SitesMetricDimensions200DimensionsHttpStatusItem[];
@@ -2671,6 +2708,13 @@ export declare type SitesMetricDimensions200Dimensions = {
     visitor_is_crawler?: SitesMetricDimensions200DimensionsVisitorIsCrawlerItem[];
     wp_admin_ajax_action?: SitesMetricDimensions200DimensionsWpAdminAjaxActionItem[];
 };
+export declare type SitesMetricDimensions200DimensionsHttpVersionItemDimension = {
+    [key: string]: number;
+};
+export declare type SitesMetricDimensions200DimensionsHttpVersionItem = {
+    dimension?: SitesMetricDimensions200DimensionsHttpVersionItemDimension;
+    timestamp?: number;
+};
 export declare type SitesMetricDimensions200DimensionsHttpVerbItemDimension = {
     [key: string]: number;
 };
@@ -3241,20 +3285,6 @@ 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
  */
@@ -3404,6 +3434,20 @@ 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;
+};
 export declare type PublicRegions200RowsItem = {
     /**
      * Whether dedicated configurator is active for this region
@@ -3612,6 +3656,12 @@ export declare type PublicImages200 = {
     /** List of images */
     rows?: PublicImages200RowsItem[];
 };
+export declare type PublicImagesParams = {
+    /**
+     * Brand identifier for HAL admin calls.
+     */
+    brand?: string;
+};
 export declare type HostingVisitors200VisitorsItem = {
     bandwidth?: number;
     hits?: number;
@@ -4921,6 +4971,12 @@ export declare type HostingEmailFiltersAddBody = {
     /** list of rules to be applied to the filter */
     rules?: HostingEmailFiltersAddBodyRulesItem[];
 };
+export declare type HostingEmailFiltersList200 = {
+    /** The number of filters */
+    count?: number;
+    /** List of filters */
+    filters?: HostingEmailFiltersList200FiltersItem[];
+};
 export declare type HostingEmailFiltersList200FiltersItemRulesItem = {
     match?: FilterRuleMatch;
     opt?: FilterRuleOpt;
@@ -4951,12 +5007,6 @@ export declare type HostingEmailFiltersList200FiltersItem = {
     /** Whether the filter is unescaped */
     unescaped?: boolean;
 };
-export declare type HostingEmailFiltersList200 = {
-    /** The number of filters */
-    count?: number;
-    /** List of filters */
-    filters?: HostingEmailFiltersList200FiltersItem[];
-};
 export declare type HostingEmailFiltersListParams = {
     /**
      * The email account address to query filters by
@@ -5802,6 +5852,25 @@ export declare type HostingAdvancedPasswordBody = {
      */
     password: string;
 };
+export declare type HostingAdvancedServerHealthcheck200 = {
+    /**
+     * 1 if the panel responded (Windows servers)
+     * @nullable
+     */
+    panel_version?: number | null;
+    /**
+     * Dotted reason code when the server is not healthy
+     * @nullable
+     */
+    reason?: string | null;
+    /**
+     * 1 if the server responded to a hello probe (Linux servers)
+     * @nullable
+     */
+    server_hello?: number | null;
+    /** Current server status */
+    server_status: string;
+};
 export declare type HostingAdvancedServerStatus200Actions = {
     [key: string]: unknown;
 };
@@ -5854,6 +5923,27 @@ export declare type HostingAdvancedServer200 = {
     uptime?: string;
     uptime_seconds?: number;
 };
+/**
+ * Links
+ * @nullable
+ */
+export declare type HostingAdvancedImages200ImagesItemLinks = {
+    /**
+     * Community URL
+     * @nullable
+     */
+    community?: string | null;
+    /**
+     * Documentation URL
+     * @nullable
+     */
+    doc?: string | null;
+    /**
+     * Forums URL
+     * @nullable
+     */
+    forums?: string | null;
+} | null;
 export declare type HostingAdvancedImages200ImagesItem = {
     /**
      * The application software included on the image
@@ -5945,27 +6035,6 @@ export declare type HostingAdvancedImages200ImagesItem = {
 export declare type HostingAdvancedImages200 = {
     images: HostingAdvancedImages200ImagesItem[];
 };
-/**
- * Links
- * @nullable
- */
-export declare type HostingAdvancedImages200ImagesItemLinks = {
-    /**
-     * Community URL
-     * @nullable
-     */
-    community?: string | null;
-    /**
-     * Documentation URL
-     * @nullable
-     */
-    doc?: string | null;
-    /**
-     * Forums URL
-     * @nullable
-     */
-    forums?: string | null;
-} | null;
 export declare type HostingAdvancedImagesParams = {
     /**
      * Starting page for pagination
@@ -6024,6 +6093,16 @@ export declare type HostingAdvancedDnsParams = {
     domain: string;
     dns_with_us?: number;
 };
+export declare type HostingAdvancedConsole200 = {
+    url?: string;
+};
+export declare type HostingAdvancedConsoleProtocol = typeof HostingAdvancedConsoleProtocol[keyof typeof HostingAdvancedConsoleProtocol];
+export declare const HostingAdvancedConsoleProtocol: {
+    readonly ssh: "ssh";
+};
+export declare type HostingAdvancedConsoleParams = {
+    protocol?: HostingAdvancedConsoleProtocol;
+};
 export declare type HostingAddons200RowsItemMeta = {
     [key: string]: string | number | boolean;
 };
@@ -6067,31 +6146,6 @@ export declare type ActivityLog200 = {
 export declare type ActivityLogParams = {
     days?: number;
 };
-export declare type HostingAccount200ResourcesWorkers = {
-    /** @nullable */
-    available?: number | null;
-    /** @nullable */
-    total?: number | null;
-    /** @nullable */
-    used?: number | null;
-};
-export declare type HostingAccount200ResourcesStorage = {
-    /** @nullable */
-    available?: number | null;
-    /** @nullable */
-    total?: number | null;
-    unit?: string;
-    /** @nullable */
-    used?: number | null;
-};
-/**
- * @nullable
- */
-export declare type HostingAccount200Resources = {
-    staging?: HostingAccount200ResourcesStaging;
-    storage?: HostingAccount200ResourcesStorage;
-    workers?: HostingAccount200ResourcesWorkers;
-} | null;
 export declare type HostingAccount200 = {
     account_id?: string;
     account_limits?: HostingAccount200AccountLimits;
@@ -6114,6 +6168,34 @@ export declare type HostingAccount200 = {
     type?: string;
     username?: string;
 };
+export declare type HostingAccount200ResourcesWorkers = {
+    /** @nullable */
+    available?: number | null;
+    /** @nullable */
+    total?: number | null;
+    /** @nullable */
+    used?: number | null;
+};
+/**
+ * Usage statistics for non-staging sites
+ * @nullable
+ */
+export declare type HostingAccount200ResourcesUsed = {
+    /**
+     * Total number of domains used by this account
+     * @nullable
+     */
+    domain?: number | null;
+} | null;
+export declare type HostingAccount200ResourcesStorage = {
+    /** @nullable */
+    available?: number | null;
+    /** @nullable */
+    total?: number | null;
+    unit?: string;
+    /** @nullable */
+    used?: number | null;
+};
 export declare type HostingAccount200ResourcesStagingWorkers = {
     /** @nullable */
     available?: number | null;
@@ -6135,6 +6217,19 @@ export declare type HostingAccount200ResourcesStaging = {
     storage?: HostingAccount200ResourcesStagingStorage;
     workers?: HostingAccount200ResourcesStagingWorkers;
 };
+/**
+ * @nullable
+ */
+export declare type HostingAccount200Resources = {
+    staging?: HostingAccount200ResourcesStaging;
+    storage?: HostingAccount200ResourcesStorage;
+    /**
+     * Usage statistics for non-staging sites
+     * @nullable
+     */
+    used?: HostingAccount200ResourcesUsed;
+    workers?: HostingAccount200ResourcesWorkers;
+} | null;
 export declare type HostingAccount200Billing = {
     prod_code?: string;
     product_name?: string;
@@ -6146,6 +6241,11 @@ export declare type HostingAccount200AccountLimits = {
      * @nullable
      */
     email_accounts?: number | null;
+    /**
+     * Maxmimum number of domains that can be added to this account
+     * @nullable
+     */
+    max_domain?: number | null;
     /**
      * Number of max sites allowed for the hosting account
      * @nullable
@@ -6445,6 +6545,70 @@ export declare type DomainCerts200CertsItem = {
 export declare type DomainCerts200 = {
     certs?: DomainCerts200CertsItem[];
 };
+/**
+ * Most recent errors logged during domain ssl validation. Remains set if validation tries run out. Gets reset by new validation job.
+ * @nullable
+ */
+export declare type DomainInfo200SetupProgressValidateSslErrorTable = {
+    [key: string]: unknown;
+} | null;
+/**
+ * @nullable
+ */
+export declare type DomainInfo200SetupProgress = {
+    /**
+     * Result of domain cdn validation (null=not started,0=started,1=succeeded,2=skipped)
+     * @nullable
+     */
+    validate_cdn?: number | null;
+    /**
+     * Most recent error logged during domain cdn validation. Remains set if validation tries run out. Gets reset by new validation job.
+     * @nullable
+     */
+    validate_cdn_error?: string | null;
+    /**
+     * Result of domain dns validation (null=not started,0=started,1=succeeded,2=skipped)
+     * @nullable
+     */
+    validate_dns?: number | null;
+    /**
+     * Whether dns_auto_repair was run on this domain (1=true)
+     * @nullable
+     */
+    validate_dns_auto_repair?: number | null;
+    /**
+     * Most recent error logged during domain dns validation. Remains set if validation tries run out. Gets reset by new validation job.
+     * @nullable
+     */
+    validate_dns_error?: string | null;
+    /**
+     * Most recent error logged during domain validation. Remains set if validation tries run out. Gets reset by new validation job.
+     * @nullable
+     */
+    validate_error?: string | null;
+    /**
+     * Result of domain ssl validation (null=not started,0=started,1=succeeded,2=skipped)
+     * @nullable
+     */
+    validate_ssl?: number | null;
+    /**
+     * Most recent error logged during domain ssl validation. Remains set if validation tries run out. Gets reset by new validation job.
+     * @nullable
+     */
+    validate_ssl_error?: string | null;
+    /**
+     * Most recent errors logged during domain ssl validation. Remains set if validation tries run out. Gets reset by new validation job.
+     * @nullable
+     */
+    validate_ssl_error_table?: DomainInfo200SetupProgressValidateSslErrorTable;
+} | null;
+/**
+ * Job ids and names currently running on the domain
+ * @nullable
+ */
+export declare type DomainInfo200Jobs = {
+    [key: string]: unknown;
+} | null;
 export declare type DomainInfo200 = {
     /** @nullable */
     account_back_ref?: string | null;
@@ -6517,70 +6681,10 @@ export declare type DomainInfo200 = {
      */
     used_entri?: number | null;
 };
-/**
- * Most recent errors logged during domain ssl validation. Remains set if validation tries run out. Gets reset by new validation job.
- * @nullable
- */
-export declare type DomainInfo200SetupProgressValidateSslErrorTable = {
-    [key: string]: unknown;
-} | null;
-/**
- * @nullable
- */
-export declare type DomainInfo200SetupProgress = {
-    /**
-     * Result of domain cdn validation (null=not started,0=started,1=succeeded,2=skipped)
-     * @nullable
-     */
-    validate_cdn?: number | null;
-    /**
-     * Most recent error logged during domain cdn validation. Remains set if validation tries run out. Gets reset by new validation job.
-     * @nullable
-     */
-    validate_cdn_error?: string | null;
-    /**
-     * Result of domain dns validation (null=not started,0=started,1=succeeded,2=skipped)
-     * @nullable
-     */
-    validate_dns?: number | null;
-    /**
-     * Whether dns_auto_repair was run on this domain (1=true)
-     * @nullable
-     */
-    validate_dns_auto_repair?: number | null;
-    /**
-     * Most recent error logged during domain dns validation. Remains set if validation tries run out. Gets reset by new validation job.
-     * @nullable
-     */
-    validate_dns_error?: string | null;
-    /**
-     * Most recent error logged during domain validation. Remains set if validation tries run out. Gets reset by new validation job.
-     * @nullable
-     */
-    validate_error?: string | null;
-    /**
-     * Result of domain ssl validation (null=not started,0=started,1=succeeded,2=skipped)
-     * @nullable
-     */
-    validate_ssl?: number | null;
-    /**
-     * Most recent error logged during domain ssl validation. Remains set if validation tries run out. Gets reset by new validation job.
-     * @nullable
-     */
-    validate_ssl_error?: string | null;
-    /**
-     * Most recent errors logged during domain ssl validation. Remains set if validation tries run out. Gets reset by new validation job.
-     * @nullable
-     */
-    validate_ssl_error_table?: DomainInfo200SetupProgressValidateSslErrorTable;
-} | null;
-/**
- * Job ids and names currently running on the domain
- * @nullable
- */
-export declare type DomainInfo200Jobs = {
-    [key: string]: unknown;
-} | null;
+export declare type BullhornAnnouncements200 = {
+    /** Bullhorn announcement banners for Account Manager. Empty when the feature is disabled or no announcements are configured. */
+    bullhornAnnouncements: BullhornAnnouncement[];
+};
 export declare type Announcements200 = {
     /** Global announcement banners for Account Manager. Empty when the feature is disabled or no announcements are configured. */
     announcements: Announcement[];
@@ -7978,6 +8082,19 @@ export interface Announcement {
      */
     'sub-heading'?: string | null;
 }
+/**
+ * A single bullhorn announcement loaded from object storage.
+ */
+export interface BullhornAnnouncement {
+    /** Supporting bullhorn announcement text. */
+    body: string;
+    /** Feature area where the bullhorn announcement should appear. */
+    featureKey: string;
+    /** Primary bullhorn announcement title. */
+    header: string;
+    /** Destination URL opened when the bullhorn announcement is clicked. */
+    url: string;
+}
 /**
  * Which character set to use for the autorespond email content
  */