@newfold/huapi-js 2.1792.0 → 2.1799.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.1792.0
+ * OpenAPI spec version: 1.1799.0
  */
 export declare type SshKeyListV4200RowsItem = {
     authorize?: boolean;
@@ -413,17 +413,6 @@ 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
  */
@@ -586,6 +575,17 @@ 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 SshKeyV2200 = {
     deleted?: number;
     key_name?: string;
@@ -633,6 +633,12 @@ export declare type HostingSiteAddV2200 = {
     status?: string;
     url?: string;
 };
+export declare type HostingSiteAddV2BodyWpMultiSite = {
+    /** Set canonicalize_aliases as site_meta */
+    canonicalize_aliases?: boolean;
+    /** Allow create multiple websites under one WP network */
+    enable?: boolean;
+};
 /**
  * Datacenter to host site in.
  */
@@ -676,6 +682,7 @@ export declare type HostingSiteAddV2Body = {
     title?: string;
     /** Number of PHP workers */
     workers?: number;
+    wp_multi_site?: HostingSiteAddV2BodyWpMultiSite;
 };
 export declare type HostingSitesV2200UsedSitesDetails = {
     /** Includes all active sites count */
@@ -689,6 +696,30 @@ export declare type HostingSitesV2200UsedSitesDetails = {
     /** Count of staging sites on specified hosting account */
     staging_sites?: number;
 };
+export declare type HostingSitesV2200 = {
+    /**
+     * Remaining number of sites the customer can create. Max sites - used sites. Null means 'unlimited'.
+     * @nullable
+     */
+    available_sites?: number | null;
+    items?: HostingSitesV2200ItemsItem[];
+    /** page size */
+    limit?: number;
+    /**
+     * Maximum number of sites the customer can have. Null means 'unlimited'.
+     * @nullable
+     */
+    max_sites?: number | null;
+    /** current page number */
+    page?: number;
+    /** total number of pages */
+    pages?: number;
+    /** total number of sites returned */
+    total?: number;
+    /** Current number of sites in use by the customer. its normal for this value to be different than the total number of sites in the list. */
+    used_sites?: number;
+    used_sites_details?: HostingSitesV2200UsedSitesDetails;
+};
 /**
  * @nullable
  */
@@ -851,30 +882,6 @@ export declare type HostingSitesV2200ItemsItem = {
      */
     version_ptr?: string | null;
 };
-export declare type HostingSitesV2200 = {
-    /**
-     * Remaining number of sites the customer can create. Max sites - used sites. Null means 'unlimited'.
-     * @nullable
-     */
-    available_sites?: number | null;
-    items?: HostingSitesV2200ItemsItem[];
-    /** page size */
-    limit?: number;
-    /**
-     * Maximum number of sites the customer can have. Null means 'unlimited'.
-     * @nullable
-     */
-    max_sites?: number | null;
-    /** current page number */
-    page?: number;
-    /** total number of pages */
-    pages?: number;
-    /** total number of sites returned */
-    total?: number;
-    /** Current number of sites in use by the customer. its normal for this value to be different than the total number of sites in the list. */
-    used_sites?: number;
-    used_sites_details?: HostingSitesV2200UsedSitesDetails;
-};
 export declare type HostingSitesV2Params = {
     limit?: number;
     page?: number;
@@ -1237,10 +1244,6 @@ export declare type UserHostingOverviewParams = {
      */
     limit?: number;
 };
-export declare type UserHosting200 = {
-    /** Information for the paginated hosting accounts */
-    rows?: UserHosting200RowsItem[];
-};
 /**
  * Usage statistics for staging sites
  * @nullable
@@ -1262,6 +1265,70 @@ export declare type UserHosting200RowsItemUsedStage = {
      */
     workers?: number | null;
 } | null;
+export declare type UserHosting200RowsItem = {
+    /** Additional information about the account */
+    account_info?: UserHosting200RowsItemAccountInfo;
+    /** HAL Account back_reference, used to link to the product instance */
+    back_reference?: string;
+    /**
+     * Information from the billing system about this hosting account
+     * @nullable
+     */
+    billing?: UserHosting200RowsItemBilling;
+    /**
+     * Capability sites associated with the account
+     * @nullable
+     */
+    capability_sites?: string | null;
+    /**
+     * Feature set name ex: hosting_40s
+     * @nullable
+     */
+    feature_set?: string | null;
+    /** Whether the product associated with this hosting account has panel mail (True) or not (False) */
+    has_panel_mail?: boolean;
+    /** Whether the product associated with this hosting account can be upgraded (True) or not (False) */
+    is_upgradeable?: boolean;
+    /**
+     * Account limits
+     * @nullable
+     */
+    limit?: UserHosting200RowsItemLimit;
+    /**
+     * Remote limits for the account
+     * @nullable
+     */
+    limit_remote?: UserHosting200RowsItemLimitRemote;
+    /**
+     * Package name
+     * @nullable
+     */
+    package?: string | null;
+    /**
+     * Control panel type
+     * @nullable
+     */
+    panel?: string | null;
+    /**
+     * Number of sites
+     * @nullable
+     */
+    sites?: number | null;
+    /**
+     * Usage statistics for non-staging sites
+     * @nullable
+     */
+    used?: UserHosting200RowsItemUsed;
+    /**
+     * Usage statistics for staging sites
+     * @nullable
+     */
+    used_stage?: UserHosting200RowsItemUsedStage;
+};
+export declare type UserHosting200 = {
+    /** Information for the paginated hosting accounts */
+    rows?: UserHosting200RowsItem[];
+};
 /**
  * Usage statistics for non-staging sites
  * @nullable
@@ -1376,66 +1443,6 @@ export declare type UserHosting200RowsItemBilling = {
      */
     prod_name?: string | null;
 } | null;
-export declare type UserHosting200RowsItem = {
-    /** Additional information about the account */
-    account_info?: UserHosting200RowsItemAccountInfo;
-    /** HAL Account back_reference, used to link to the product instance */
-    back_reference?: string;
-    /**
-     * Information from the billing system about this hosting account
-     * @nullable
-     */
-    billing?: UserHosting200RowsItemBilling;
-    /**
-     * Capability sites associated with the account
-     * @nullable
-     */
-    capability_sites?: string | null;
-    /**
-     * Feature set name ex: hosting_40s
-     * @nullable
-     */
-    feature_set?: string | null;
-    /** Whether the product associated with this hosting account has panel mail (True) or not (False) */
-    has_panel_mail?: boolean;
-    /** Whether the product associated with this hosting account can be upgraded (True) or not (False) */
-    is_upgradeable?: boolean;
-    /**
-     * Account limits
-     * @nullable
-     */
-    limit?: UserHosting200RowsItemLimit;
-    /**
-     * Remote limits for the account
-     * @nullable
-     */
-    limit_remote?: UserHosting200RowsItemLimitRemote;
-    /**
-     * Package name
-     * @nullable
-     */
-    package?: string | null;
-    /**
-     * Control panel type
-     * @nullable
-     */
-    panel?: string | null;
-    /**
-     * Number of sites
-     * @nullable
-     */
-    sites?: number | null;
-    /**
-     * Usage statistics for non-staging sites
-     * @nullable
-     */
-    used?: UserHosting200RowsItemUsed;
-    /**
-     * Usage statistics for staging sites
-     * @nullable
-     */
-    used_stage?: UserHosting200RowsItemUsedStage;
-};
 /**
  * Region information for the account
  * @nullable
@@ -2150,6 +2157,28 @@ export declare type CreatePhpInfo200 = {
     /** html file content */
     html?: string;
 };
+export declare type SitesPerformanceScansAdd200 = {
+    [key: string]: unknown;
+};
+export declare type SitesPerformanceScansAddBody = {
+    scan_now?: boolean;
+};
+export declare type SitesPerformanceScans200 = {
+    [key: string]: unknown;
+};
+export declare type SitesPerformanceScansList200Meta = {
+    page?: number;
+    per_page?: number;
+    total?: number;
+};
+export declare type SitesPerformanceScansList200 = {
+    data?: PerformanceScanResultItemModel[];
+    meta?: SitesPerformanceScansList200Meta;
+};
+export declare type SitesPerformanceScansListParams = {
+    page?: number;
+    per_page?: number;
+};
 export declare type SitesPerformanceRedisPurge200 = {
     [key: string]: unknown;
 };
@@ -2211,12 +2240,8 @@ export declare type SitesPerformanceCachepurgeBody = {
 export declare type SitePendingDomainDelete200 = {
     [key: string]: unknown;
 };
-export declare type SitesMetricDimensions200 = {
-    date_end?: string;
-    date_start?: string;
-    dimensions?: SitesMetricDimensions200Dimensions;
-    elapsed?: number;
-    metric?: string;
+export declare type SitesOnboardingSteps200 = {
+    steps?: SiteOnboardingStepModel[];
 };
 export declare type SitesMetricDimensions200DimensionsWpAdminAjaxActionItemDimension = {
     [key: string]: number;
@@ -2225,6 +2250,25 @@ export declare type SitesMetricDimensions200DimensionsWpAdminAjaxActionItem = {
     dimension?: SitesMetricDimensions200DimensionsWpAdminAjaxActionItemDimension;
     timestamp?: number;
 };
+export declare type SitesMetricDimensions200Dimensions = {
+    http_host?: SitesMetricDimensions200DimensionsHttpHostItem[];
+    http_status?: SitesMetricDimensions200DimensionsHttpStatusItem[];
+    http_verb?: SitesMetricDimensions200DimensionsHttpVerbItem[];
+    http_version?: SitesMetricDimensions200DimensionsHttpVersionItem[];
+    page_is_cached?: SitesMetricDimensions200DimensionsPageIsCachedItem[];
+    page_renderer?: SitesMetricDimensions200DimensionsPageRendererItem[];
+    visitor_asn?: SitesMetricDimensions200DimensionsVisitorAsnItem[];
+    visitor_country_code?: SitesMetricDimensions200DimensionsVisitorCountryCodeItem[];
+    visitor_is_crawler?: SitesMetricDimensions200DimensionsVisitorIsCrawlerItem[];
+    wp_admin_ajax_action?: SitesMetricDimensions200DimensionsWpAdminAjaxActionItem[];
+};
+export declare type SitesMetricDimensions200 = {
+    date_end?: string;
+    date_start?: string;
+    dimensions?: SitesMetricDimensions200Dimensions;
+    elapsed?: number;
+    metric?: string;
+};
 export declare type SitesMetricDimensions200DimensionsVisitorIsCrawlerItemDimension = {
     [key: string]: number;
 };
@@ -2246,18 +2290,6 @@ export declare type SitesMetricDimensions200DimensionsVisitorAsnItem = {
     dimension?: SitesMetricDimensions200DimensionsVisitorAsnItemDimension;
     timestamp?: number;
 };
-export declare type SitesMetricDimensions200Dimensions = {
-    http_host?: SitesMetricDimensions200DimensionsHttpHostItem[];
-    http_status?: SitesMetricDimensions200DimensionsHttpStatusItem[];
-    http_verb?: SitesMetricDimensions200DimensionsHttpVerbItem[];
-    http_version?: SitesMetricDimensions200DimensionsHttpVersionItem[];
-    page_is_cached?: SitesMetricDimensions200DimensionsPageIsCachedItem[];
-    page_renderer?: SitesMetricDimensions200DimensionsPageRendererItem[];
-    visitor_asn?: SitesMetricDimensions200DimensionsVisitorAsnItem[];
-    visitor_country_code?: SitesMetricDimensions200DimensionsVisitorCountryCodeItem[];
-    visitor_is_crawler?: SitesMetricDimensions200DimensionsVisitorIsCrawlerItem[];
-    wp_admin_ajax_action?: SitesMetricDimensions200DimensionsWpAdminAjaxActionItem[];
-};
 export declare type SitesMetricDimensions200DimensionsPageRendererItemDimension = {
     [key: string]: number;
 };
@@ -2763,6 +2795,8 @@ export declare const SiteUpdateBodyVersionPtr: {
     readonly beta: "beta";
 };
 export declare type SiteUpdateBody = {
+    /** Whether the user has clicked on the brand protection offer in the UI, used for onboarding purposes */
+    brand_protection_clicked?: boolean;
     /** Disk space in GiB */
     disk_limit_gib?: number;
     /** domain for the site to be added */
@@ -2771,8 +2805,12 @@ export declare type SiteUpdateBody = {
     handler_404?: boolean;
     /** Status of the site's onboarding */
     onboarding?: number;
+    /** Whether the user has clicked on the onboarding call offer in the UI, used for onboarding purposes */
+    onboarding_call_clicked?: boolean;
     /** filesystem path that follows the domain in the url */
     path?: string;
+    /** Whether the user has clicked on the pro services offer in the UI, used for onboarding purposes */
+    pro_services_clicked?: boolean;
     /** Skip FG domain checks for HAL domain */
     skip_fg_checks?: boolean;
     /** title of the site to be updated */
@@ -2782,6 +2820,13 @@ export declare type SiteUpdateBody = {
     /** Number of PHP workers */
     workers?: number;
 };
+/**
+ * @nullable
+ */
+export declare type SitesInfo200WpMultiSite = {
+    canonicalize_aliases?: boolean;
+    enable?: boolean;
+} | null;
 /**
  * @nullable
  */
@@ -2809,6 +2854,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;
@@ -2889,72 +2999,9 @@ export declare type SitesInfo200 = {
      * @nullable
      */
     version_ptr?: string | 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;
+    wp_multi_site?: SitesInfo200WpMultiSite;
 };
-/**
- * @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 HostingVisitors200VisitorsItem = {
     bandwidth?: number;
     hits?: number;
@@ -3293,9 +3340,6 @@ export declare type HostingRedirects200Item = {
     url?: string;
     wildcard?: boolean;
 };
-export declare type ProductLicenseDetails200 = {
-    wpsolution?: ProductLicenseDetails200Wpsolution;
-};
 export declare type ProductLicenseDetails200WpsolutionCreatorItem = {
     expirationDate?: string;
     prodInstId?: string;
@@ -3309,6 +3353,9 @@ export declare type ProductLicenseDetails200Wpsolution = {
     creator?: ProductLicenseDetails200WpsolutionCreatorItem[];
     total?: number;
 };
+export declare type ProductLicenseDetails200 = {
+    wpsolution?: ProductLicenseDetails200Wpsolution;
+};
 export declare type ProductLicenseDetailsProductName = typeof ProductLicenseDetailsProductName[keyof typeof ProductLicenseDetailsProductName];
 export declare const ProductLicenseDetailsProductName: {
     readonly wpsolution: "wpsolution";
@@ -5118,6 +5165,8 @@ export declare type HostingAdvancedServerStatusBody = {
     action?: string;
     /** Admin email for the site user */
     admin_email?: string;
+    /** The hostname to be set for the server - only applicable for the 'sethostname' action */
+    hostname?: string;
     /** ID of the image to rebuild with - only applicable for the 'rebuild' action */
     image_id?: string;
     /** To skip site installation - DEPRECATED do not use */
@@ -8789,6 +8838,11 @@ export interface SiteInfoResponseModelV2 {
     account_status?: string | null;
     /** @nullable */
     base_domain?: string | null;
+    /**
+     * Whether the user has clicked on the brand protection link in onboarding
+     * @nullable
+     */
+    brand_protection_clicked?: boolean | null;
     /**
      * False if site was added by site scanner
      * @nullable
@@ -8834,6 +8888,11 @@ export interface SiteInfoResponseModelV2 {
      * @nullable
      */
     onboarding?: number | null;
+    /**
+     * Whether the user has clicked on the onboarding call link in onboarding
+     * @nullable
+     */
+    onboarding_call_clicked?: boolean | null;
     /** @nullable */
     pagespeed?: SiteInfoResponseModelV2Pagespeed;
     /**
@@ -8852,6 +8911,11 @@ export interface SiteInfoResponseModelV2 {
      * @nullable
      */
     php_version?: string | null;
+    /**
+     * Whether the user has clicked on the pro services link in onboarding
+     * @nullable
+     */
+    pro_services_clicked?: boolean | null;
     /** @nullable */
     resources?: SiteInfoResponseModelV2Resources;
     /** @nullable */
@@ -8880,6 +8944,68 @@ export interface SitesAutoupdatesResponse {
     /** @nullable */
     themes?: boolean | null;
 }
+export declare type SiteOnboardingStepModelAction = {
+    /**
+     * The CTB to load for this step
+     * @nullable
+     */
+    ctb?: string | null;
+    /**
+     * The redirect URL for this step
+     * @nullable
+     */
+    redirect?: string | null;
+    /**
+     * Which app or type of SSO should be used for this step, if type=sso
+     * @nullable
+     */
+    sso_app?: string | null;
+    /** The text to show on the action control for this step */
+    text?: string;
+    /** The type of response action being returned */
+    type?: string;
+};
+export interface SiteOnboardingStepModel {
+    action?: SiteOnboardingStepModelAction;
+    /** Whether this step should be marked completed */
+    completed?: boolean;
+    /** Order in which this step should be displayed relative to the rest of the list (ascending) */
+    order?: number;
+    /** Text to show for this step */
+    text?: string;
+}
+export interface PerformanceScanResultItemModel {
+    /** @nullable */
+    accessibility_score?: number | null;
+    /** @nullable */
+    best_practices_score?: number | null;
+    /** @nullable */
+    created_at?: string | null;
+    /** @nullable */
+    cumulative_layout_shift?: number | null;
+    /** @nullable */
+    first_contentful_paint?: number | null;
+    /** @nullable */
+    id?: number | null;
+    /** @nullable */
+    is_active?: boolean | null;
+    /** @nullable */
+    job_id?: string | null;
+    /** @nullable */
+    largest_contentful_paint?: number | null;
+    /** @nullable */
+    last_scan_time?: string | null;
+    /** @nullable */
+    overall_score?: number | null;
+    /** @nullable */
+    performance_score?: number | null;
+    /** @nullable */
+    seo_score?: number | null;
+    /** @nullable */
+    speed_index?: number | null;
+    /** @nullable */
+    updated_at?: string | null;
+}
 export interface SSHUsersV2Response {
     installed?: boolean;
     is_active?: boolean;