@newfold/huapi-js 2.1799.0 → 2.1820.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.1799.0
+ * OpenAPI spec version: 1.1820.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,9 +404,26 @@ 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
  */
@@ -575,17 +586,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 SshKeyV2200 = {
     deleted?: number;
     key_name?: string;
@@ -1230,6 +1230,43 @@ export declare type AddonsSitelockSsoV2Params = {
      */
     source?: string;
 };
+export declare type AllUserMonarxDetails200RowsItem = {
+    /** HAL Account back_reference, used to link to the product instance */
+    account_back_ref?: string;
+    /** 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;
+    /**
+     * 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
@@ -1265,70 +1306,6 @@ 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
@@ -1443,6 +1420,66 @@ 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
@@ -1484,6 +1521,11 @@ export declare type UserHosting200RowsItemAccountInfo = {
      * @nullable
      */
     addon_back_ref?: string | null;
+    /**
+     * Timestamp of when the hosting addon was created
+     * @nullable
+     */
+    addon_date_added?: string | null;
     /**
      * The ID of the addon associated with the account
      * @nullable
@@ -3340,6 +3382,9 @@ export declare type HostingRedirects200Item = {
     url?: string;
     wildcard?: boolean;
 };
+export declare type ProductLicenseDetails200 = {
+    wpsolution?: ProductLicenseDetails200Wpsolution;
+};
 export declare type ProductLicenseDetails200WpsolutionCreatorItem = {
     expirationDate?: string;
     prodInstId?: string;
@@ -3353,9 +3398,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";
@@ -3404,6 +3446,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;
@@ -3460,6 +3537,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;
 };
@@ -5364,6 +5447,8 @@ export declare type HostingAccount200Resources = {
 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;
@@ -5861,11 +5946,49 @@ 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;
 };
 export declare type AddonsInfo200 = {
-    id?: string;
+    id?: number;
 };
 export declare type AddonsCloudflareExternalNsCheck200Www = {
     /** @nullable */
@@ -5903,6 +6026,10 @@ export declare type AddonsCloudflareExternalNsCheckParams = {
 export declare type AddonsCloudflare200 = {
     status?: string;
 };
+export declare type BackupMeta200 = {
+    account?: BackupMeta200Account;
+    site?: BackupMeta200Site;
+};
 /**
  * @nullable
  */
@@ -5973,10 +6100,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;
 };
@@ -6179,6 +6302,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;
@@ -6190,9 +6316,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;
 };
@@ -6294,6 +6417,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 = {
@@ -6304,6 +6429,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
@@ -6368,73 +6511,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
@@ -6571,6 +6647,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)
@@ -8729,6 +8866,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
  */
@@ -8955,6 +9114,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
@@ -8967,10 +9131,10 @@ 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;
 }