@newfold/huapi-js 2.1795.0 → 2.1805.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.1795.0
+ * OpenAPI spec version: 1.1805.0
  */
 export declare type SshKeyListV4200RowsItem = {
     authorize?: boolean;
@@ -268,12 +268,6 @@ 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
@@ -410,6 +404,12 @@ 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;
 };
@@ -933,12 +933,6 @@ export declare type HostingDomainsUnassignV2Body = {
     /** The site id to be unassigned */
     site_id: number;
 };
-export declare type HostingDomainsV2200 = {
-    domains: HostingDomainsV2200DomainsItem[];
-    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
@@ -1075,6 +1069,12 @@ export declare type HostingDomainsV2200DomainsItem = {
      */
     used_entri?: number | null;
 };
+export declare type HostingDomainsV2200 = {
+    domains: HostingDomainsV2200DomainsItem[];
+    limit?: number;
+    page?: number;
+    total?: number;
+};
 export declare type HostingDomainsV2TypesItem = typeof HostingDomainsV2TypesItem[keyof typeof HostingDomainsV2TypesItem];
 export declare const HostingDomainsV2TypesItem: {
     readonly addon: "addon";
@@ -1230,6 +1230,43 @@ export declare type AddonsSitelockSsoV2Params = {
      */
     source?: string;
 };
+export declare type AllUserMonarxDetails200RowsItem = {
+    /** Addon ID of the Monarx addon */
+    addon_id: number;
+    /**
+     * Domain ID registered with Monarx
+     * @nullable
+     */
+    domain_id?: number | null;
+    /** Domain name registered with Monarx */
+    domain_name: string;
+    /**
+     * Malware signal health status
+     * @nullable
+     */
+    health_status?: string | null;
+    /** Hosting ID of the account */
+    hosting_id: string;
+    /**
+     * Timestamp of last completed scan
+     * @nullable
+     */
+    last_scan_completed_at?: string | null;
+    /**
+     * Monarx plan purchased
+     * @nullable
+     */
+    plan?: string | null;
+    /**
+     * Hosting product name
+     * @nullable
+     */
+    prod_name?: string | null;
+};
+export declare type AllUserMonarxDetails200 = {
+    /** Flattened list of Monarx addon records per domain */
+    rows: AllUserMonarxDetails200RowsItem[];
+};
 export declare type UserHostingOverview200 = {
     /** Whether one (or more) of the hosting accounts manageable by this user allows unlimited sites */
     has_unlimited_sites?: boolean;
@@ -1244,6 +1281,10 @@ export declare type UserHostingOverviewParams = {
      */
     limit?: number;
 };
+export declare type UserHosting200 = {
+    /** Information for the paginated hosting accounts */
+    rows?: UserHosting200RowsItem[];
+};
 /**
  * Usage statistics for staging sites
  * @nullable
@@ -1439,10 +1480,6 @@ export declare type UserHosting200RowsItem = {
      */
     used_stage?: UserHosting200RowsItemUsedStage;
 };
-export declare type UserHosting200 = {
-    /** Information for the paginated hosting accounts */
-    rows?: UserHosting200RowsItem[];
-};
 /**
  * Region information for the account
  * @nullable
@@ -2035,6 +2072,9 @@ export declare type SiteQualityMetrics200Audits = {
 export declare type SiteQualityMetrics200AspectScores = {
     performance?: number;
 };
+export declare type SiteQualityMetrics200AspectDetails = {
+    performance?: SiteQualityMetrics200AspectDetailsPerformance;
+};
 export declare type SiteQualityMetrics200 = {
     aspect_details: SiteQualityMetrics200AspectDetails;
     aspect_scores: SiteQualityMetrics200AspectScores;
@@ -2065,9 +2105,6 @@ export declare type SiteQualityMetrics200AspectDetailsPerformance = {
     'speed-index'?: SiteQualityMetrics200AspectDetailsPerformanceSpeedIndex;
     'total-blocking-time'?: SiteQualityMetrics200AspectDetailsPerformanceTotalBlockingTime;
 };
-export declare type SiteQualityMetrics200AspectDetails = {
-    performance?: SiteQualityMetrics200AspectDetailsPerformance;
-};
 export declare type SiteQualityMetricsStrategy = typeof SiteQualityMetricsStrategy[keyof typeof SiteQualityMetricsStrategy];
 export declare const SiteQualityMetricsStrategy: {
     readonly MOBILE: "MOBILE";
@@ -2157,6 +2194,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;
 };
@@ -2221,13 +2280,6 @@ export declare type SitePendingDomainDelete200 = {
 export declare type SitesOnboardingSteps200 = {
     steps?: SiteOnboardingStepModel[];
 };
-export declare type SitesMetricDimensions200 = {
-    date_end?: string;
-    date_start?: string;
-    dimensions?: SitesMetricDimensions200Dimensions;
-    elapsed?: number;
-    metric?: string;
-};
 export declare type SitesMetricDimensions200DimensionsWpAdminAjaxActionItemDimension = {
     [key: string]: number;
 };
@@ -2235,6 +2287,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;
 };
@@ -2298,18 +2369,6 @@ export declare type SitesMetricDimensions200DimensionsHttpHostItem = {
     dimension?: SitesMetricDimensions200DimensionsHttpHostItemDimension;
     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 SitesMetricDimensionsParams = {
     start?: string;
     end?: string;
@@ -2798,6 +2857,13 @@ export declare type SiteUpdateBody = {
     /** Number of PHP workers */
     workers?: number;
 };
+/**
+ * @nullable
+ */
+export declare type SitesInfo200WpMultiSite = {
+    canonicalize_aliases?: boolean;
+    enable?: boolean;
+} | null;
 /**
  * @nullable
  */
@@ -2970,6 +3036,8 @@ export declare type SitesInfo200 = {
      * @nullable
      */
     version_ptr?: string | null;
+    /** @nullable */
+    wp_multi_site?: SitesInfo200WpMultiSite;
 };
 export declare type HostingVisitors200VisitorsItem = {
     bandwidth?: number;
@@ -3309,6 +3377,9 @@ export declare type HostingRedirects200Item = {
     url?: string;
     wildcard?: boolean;
 };
+export declare type ProductLicenseDetails200 = {
+    wpsolution?: ProductLicenseDetails200Wpsolution;
+};
 export declare type ProductLicenseDetails200WpsolutionCreatorItem = {
     expirationDate?: string;
     prodInstId?: string;
@@ -3322,9 +3393,6 @@ 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";
@@ -3373,6 +3441,41 @@ export declare type HostingOnboardingData200 = {
 export declare type HostingNameservers200 = {
     nameservers: string[];
 };
+export declare type HostingMonarxAddonsList200RowsItem = {
+    /** Addon ID of the Monarx addon */
+    addon_id: number;
+    /** Domain registered with Monarx */
+    domain_name: string;
+    /**
+     * Malware signal health status
+     * @nullable
+     */
+    health_status?: string | null;
+    /** Hosting ID of the account */
+    hosting_id: string;
+    /**
+     * Monarx plan purchased for the domain
+     * @nullable
+     */
+    plan?: string | null;
+};
+export declare type HostingMonarxAddonsList200 = {
+    rows: HostingMonarxAddonsList200RowsItem[];
+};
+export declare type HostingMonarxAddonsListParams = {
+    /**
+     * HAL site id. At most one of site_id, domain_id, domain_name may be provided.
+     */
+    site_id?: number;
+    /**
+     * HAL domain id. At most one of site_id, domain_id, domain_name may be provided.
+     */
+    domain_id?: number;
+    /**
+     * Domain name associated with the account. At most one of site_id, domain_id, domain_name may be provided.
+     */
+    domain_name?: string;
+};
 export declare type HostingMigrationSiteScanStatus200 = {
     callback_url?: string;
     transferable?: boolean;
@@ -3429,6 +3532,12 @@ export declare type HostingMigrationStatus200RowsItem = {
 export declare type HostingMigrationStatus200 = {
     rows?: HostingMigrationStatus200RowsItem[];
 };
+export declare type HostingLicenseInfo200 = {
+    licenses?: HostingLicenseModel[];
+};
+export declare type HostingLicenseInfoParams = {
+    subtype?: string[];
+};
 export declare type HostingLead400 = {
     [key: string]: unknown;
 };
@@ -4451,6 +4560,10 @@ export declare type HostingEmailUpdateBody = {
     /** The password for the email */
     password?: string;
 };
+export declare type HostingEmailList200 = {
+    /** List of email resources */
+    rows?: HostingEmailList200RowsItem[];
+};
 /**
  * List of suspensions that affect the entire user account
  * @nullable
@@ -4540,10 +4653,6 @@ export declare type HostingEmailList200RowsItem = {
      */
     utf8_folders?: boolean | null;
 };
-export declare type HostingEmailList200 = {
-    /** List of email resources */
-    rows?: HostingEmailList200RowsItem[];
-};
 export declare type HostingEmailDelete200 = {
     [key: string]: unknown;
 };
@@ -5134,6 +5243,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 */
@@ -5828,6 +5939,44 @@ export declare type AddonsSync200 = {
 export declare type AddonsSpamexpertsSso200 = {
     url?: string;
 };
+export declare type MonarxAddonReportUrl200 = {
+    /** Tokenized Monarx iframe URL */
+    report_url: string;
+};
+export declare type MonarxAddonReportUrlParams = {
+    /**
+     * HAL site id. Exactly one of site_id, domain_id, domain_name must be provided.
+     */
+    site_id?: number;
+    /**
+     * HAL domain id. Exactly one of site_id, domain_id, domain_name must be provided.
+     */
+    domain_id?: number;
+    /**
+     * Domain name associated with the account. Exactly one of site_id, domain_id, domain_name must be provided.
+     */
+    domain_name?: string;
+};
+export declare type MonarxAddonSealGeneration200 = {
+    /** HTML snippet for displaying the Monarx verification seal */
+    monarx_seal: string;
+    /** Monarx site registration identifier */
+    site_registration_id: string;
+};
+export declare type MonarxAddonSealGenerationParams = {
+    /**
+     * HAL site id. Exactly one of site_id, domain_id, domain_name must be provided.
+     */
+    site_id?: number;
+    /**
+     * HAL domain id. Exactly one of site_id, domain_id, domain_name must be provided.
+     */
+    domain_id?: number;
+    /**
+     * Domain name associated with the account. Exactly one of site_id, domain_id, domain_name must be provided.
+     */
+    domain_name?: string;
+};
 export declare type AddonsJetpackValidate200 = {
     is_connected?: boolean;
 };
@@ -5870,6 +6019,10 @@ export declare type AddonsCloudflareExternalNsCheckParams = {
 export declare type AddonsCloudflare200 = {
     status?: string;
 };
+export declare type BackupMeta200 = {
+    account?: BackupMeta200Account;
+    site?: BackupMeta200Site;
+};
 /**
  * @nullable
  */
@@ -5940,10 +6093,6 @@ export declare type BackupMeta200Account = {
     /** @nullable */
     cbs_last_restore_timestamp?: string | null;
 };
-export declare type BackupMeta200 = {
-    account?: BackupMeta200Account;
-    site?: BackupMeta200Site;
-};
 export declare type BackupMetaParams = {
     site_id?: number;
 };
@@ -6146,6 +6295,9 @@ export declare type CodeguardBackupCreateBody = {
     /** The id of the website the given database is associated with. */
     website_id?: number;
 };
+export declare type CodeguardBackupList200 = {
+    backups?: CodeguardBackupList200BackupsItem[];
+};
 export declare type CodeguardBackupList200BackupsItemDatabaseBackupsItem = {
     commit_id?: string;
     event_time?: string;
@@ -6157,9 +6309,6 @@ export declare type CodeguardBackupList200BackupsItem = {
     event_time?: string;
     website_commit_id?: string;
 };
-export declare type CodeguardBackupList200 = {
-    backups?: CodeguardBackupList200BackupsItem[];
-};
 export declare type CodeguardBackupListParams = {
     website_id: number;
 };
@@ -6261,6 +6410,8 @@ export declare type AccountHostingList200AccountsItem = {
     region_desc?: string;
     /** Returns type of accounts where the hosting plan's data center is located */
     region_type?: string;
+    /** Returns type of server the hosting account is installed on */
+    server_type?: string;
     status?: string;
 };
 export declare type AccountHostingList200 = {
@@ -6271,6 +6422,24 @@ export declare type AccountHostingListParams = {
      * Flag to exclude atomic site accounts from the response
      */
     exclude_atomic_sites?: boolean;
+    /**
+     * Whether to prevent the site_list call which populates the current_sites value per account - pass true to prevent it
+     */
+    bypass_sites?: boolean;
+    /**
+     * A list of statuses to query for - e.g. active, disabled
+     */
+    status?: string[];
+    /**
+     * A list of server types to query for - e.g. shared_cpanel, shared
+     */
+    server_type?: string[];
+};
+export declare type AccountFeatures200 = {
+    /** Feature information for the paginated product instances */
+    rows?: AccountFeatures200RowsItem[];
+    /** Total number of product instance IDs available to that account */
+    total_count?: number;
 };
 /**
  * Usage statistics
@@ -6335,73 +6504,6 @@ export declare type AccountFeatures200RowsItemLimit = {
      */
     workers?: number | null;
 } | null;
-/**
- * Feature details from HAL account_feature_info_list
- */
-export declare type AccountFeatures200RowsItem = {
-    /**
-     * Product auto-renew flag
-     * @nullable
-     */
-    autoRenewFlag?: boolean | null;
-    /** HAL Account back_reference, used to link to the product instance */
-    back_reference?: string;
-    /**
-     * Product expiration date
-     * @nullable
-     */
-    expirationDate?: string | null;
-    /** Feature set name ex: hosting_40s */
-    feature_set?: string;
-    /** Additional information about the account */
-    info?: AccountFeatures200RowsItemInfo;
-    /**
-     * Account limits
-     * @nullable
-     */
-    limit?: AccountFeatures200RowsItemLimit;
-    /**
-     * Remote limits for the account
-     * @nullable
-     */
-    limit_remote?: AccountFeatures200RowsItemLimitRemote;
-    /**
-     * Package name
-     * @nullable
-     */
-    package?: string | null;
-    /**
-     * Control panel type
-     * @nullable
-     */
-    panel?: string | null;
-    /**
-     * Product code
-     * @nullable
-     */
-    prodCode?: string | null;
-    /**
-     * Product name
-     * @nullable
-     */
-    prodName?: string | null;
-    /**
-     * Number of sites
-     * @nullable
-     */
-    sites?: number | null;
-    /**
-     * Usage statistics
-     * @nullable
-     */
-    used?: AccountFeatures200RowsItemUsed;
-};
-export declare type AccountFeatures200 = {
-    /** Feature information for the paginated product instances */
-    rows?: AccountFeatures200RowsItem[];
-    /** Total number of product instance IDs available to that account */
-    total_count?: number;
-};
 /**
  * Region information for the account
  * @nullable
@@ -6538,6 +6640,67 @@ export declare type AccountFeatures200RowsItemInfo = {
      */
     username?: string | null;
 };
+/**
+ * Feature details from HAL account_feature_info_list
+ */
+export declare type AccountFeatures200RowsItem = {
+    /**
+     * Product auto-renew flag
+     * @nullable
+     */
+    autoRenewFlag?: boolean | null;
+    /** HAL Account back_reference, used to link to the product instance */
+    back_reference?: string;
+    /**
+     * Product expiration date
+     * @nullable
+     */
+    expirationDate?: string | null;
+    /** Feature set name ex: hosting_40s */
+    feature_set?: string;
+    /** Additional information about the account */
+    info?: AccountFeatures200RowsItemInfo;
+    /**
+     * Account limits
+     * @nullable
+     */
+    limit?: AccountFeatures200RowsItemLimit;
+    /**
+     * Remote limits for the account
+     * @nullable
+     */
+    limit_remote?: AccountFeatures200RowsItemLimitRemote;
+    /**
+     * Package name
+     * @nullable
+     */
+    package?: string | null;
+    /**
+     * Control panel type
+     * @nullable
+     */
+    panel?: string | null;
+    /**
+     * Product code
+     * @nullable
+     */
+    prodCode?: string | null;
+    /**
+     * Product name
+     * @nullable
+     */
+    prodName?: string | null;
+    /**
+     * Number of sites
+     * @nullable
+     */
+    sites?: number | null;
+    /**
+     * Usage statistics
+     * @nullable
+     */
+    used?: AccountFeatures200RowsItemUsed;
+};
 export declare type AccountFeaturesParams = {
     /**
      * Starting index for pagination (default: 0)
@@ -8696,6 +8859,28 @@ export interface SpamCustomScore {
     /** The value for the corresponding score subtype */
     value?: number;
 }
+/**
+ * @nullable
+ */
+export declare type HostingLicenseModelDetails = {
+    /**
+     * The number of seats provided by this license
+     * @nullable
+     */
+    seats?: number | null;
+} | null;
+export interface HostingLicenseModel {
+    /** @nullable */
+    details?: HostingLicenseModelDetails;
+    /** Whether the license is eligible be upgraded */
+    is_upgradeable?: boolean;
+    /** The name of the level of license */
+    name?: string;
+    /** The status of the license addon */
+    status?: string;
+    /** The subtype of the license */
+    subtype?: string;
+}
 /**
  * @nullable
  */
@@ -8922,6 +9107,11 @@ export declare type SiteOnboardingStepModelAction = {
      * @nullable
      */
     redirect?: string | null;
+    /**
+     * Which meta value to set after this step's action has been taken
+     * @nullable
+     */
+    set_meta?: string | null;
     /**
      * Which app or type of SSO should be used for this step, if type=sso
      * @nullable
@@ -8934,13 +9124,45 @@ export declare type SiteOnboardingStepModelAction = {
 };
 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;
+    /** The status of this step - not_started, in_progress, completed */
+    status?: string;
     /** 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;