@newfold/huapi-js 2.1750.0 → 2.1772.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.1750.0
+ * OpenAPI spec version: 1.1772.0
  */
 export declare type SshKeyListV4200RowsItem = {
     authorize?: boolean;
@@ -410,6 +410,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
  */
@@ -572,17 +583,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;
@@ -923,6 +923,12 @@ 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
@@ -1059,12 +1065,6 @@ 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";
@@ -1234,70 +1234,6 @@ export declare type UserHostingOverviewParams = {
      */
     limit?: number;
 };
-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 staging sites
  * @nullable
@@ -1334,6 +1270,16 @@ export declare type UserHosting200RowsItemUsed = {
      * @nullable
      */
     disk_usage?: number | null;
+    /**
+     * Total number of domain
+     * @nullable
+     */
+    domain?: number | null;
+    /**
+     * Number of files (inodes) used on the hosting account - if 0, unable to retrieve data or unlimited
+     * @nullable
+     */
+    inodes?: number | null;
     /**
      * Total number of sites
      * @nullable
@@ -1360,6 +1306,11 @@ export declare type UserHosting200RowsItemUsed = {
  * @nullable
  */
 export declare type UserHosting200RowsItemLimitRemote = {
+    /**
+     * Total Number of files (inodes) on the hosting account
+     * @nullable
+     */
+    inodes?: number | null;
     /**
      * Quota in KB associated with the account
      * @nullable
@@ -1418,6 +1369,70 @@ 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;
+};
+export declare type UserHosting200 = {
+    /** Information for the paginated hosting accounts */
+    rows?: UserHosting200RowsItem[];
+};
 /**
  * Region information for the account
  * @nullable
@@ -1469,6 +1484,11 @@ export declare type UserHosting200RowsItemAccountInfo = {
      * @nullable
      */
     addon_status?: string | null;
+    /**
+     * The app being used on the server, if applicable
+     * @nullable
+     */
+    application?: string | null;
     /**
      * Brand name associated with the account
      * @nullable
@@ -1515,10 +1535,15 @@ export declare type UserHosting200RowsItemAccountInfo = {
      */
     ns?: string[] | null;
     /**
-     * Operating system name
+     * Operating system name, if applicable
      * @nullable
      */
     os_name?: string | null;
+    /**
+     * Operating system version, if applicable
+     * @nullable
+     */
+    os_version?: string | null;
     /**
      * Platform type
      * @nullable
@@ -1549,6 +1574,11 @@ export declare type UserHosting200RowsItemAccountInfo = {
      * @nullable
      */
     server_type?: string | null;
+    /**
+     * The software installed on the server, if applicable
+     * @nullable
+     */
+    software?: string | null;
     /**
      * SSH hostname
      * @nullable
@@ -2066,6 +2096,27 @@ export declare type CreatePhpInfo200 = {
     /** html file content */
     html?: string;
 };
+export declare type SitesPerformanceRedisPurge200 = {
+    [key: string]: unknown;
+};
+export declare type SitesPerformanceRedisPurgeBody = {
+    [key: string]: unknown;
+};
+export declare type SitesPerformanceRedisUninstall200 = {
+    [key: string]: unknown;
+};
+export declare type SitesPerformanceRedisStatus200 = {
+    obj_cache_enabled?: boolean;
+    obj_cache_installed?: boolean;
+    redis_service_active?: boolean;
+};
+export declare type SitesPerformanceRedisToggle200 = {
+    [key: string]: unknown;
+};
+export declare type SitesPerformanceRedisToggleBody = {
+    /** Pass either 0 or 1 */
+    state: number;
+};
 export declare type SitesPerformanceEndurancePageCache200 = {
     result?: string;
     status?: string;
@@ -2134,6 +2185,13 @@ export declare type SitesMetricDimensions200DimensionsVisitorCountryCodeItem = {
     dimension?: SitesMetricDimensions200DimensionsVisitorCountryCodeItemDimension;
     timestamp?: number;
 };
+export declare type SitesMetricDimensions200DimensionsVisitorAsnItemDimension = {
+    [key: string]: number;
+};
+export declare type SitesMetricDimensions200DimensionsVisitorAsnItem = {
+    dimension?: SitesMetricDimensions200DimensionsVisitorAsnItemDimension;
+    timestamp?: number;
+};
 export declare type SitesMetricDimensions200Dimensions = {
     http_host?: SitesMetricDimensions200DimensionsHttpHostItem[];
     http_status?: SitesMetricDimensions200DimensionsHttpStatusItem[];
@@ -2146,13 +2204,6 @@ export declare type SitesMetricDimensions200Dimensions = {
     visitor_is_crawler?: SitesMetricDimensions200DimensionsVisitorIsCrawlerItem[];
     wp_admin_ajax_action?: SitesMetricDimensions200DimensionsWpAdminAjaxActionItem[];
 };
-export declare type SitesMetricDimensions200DimensionsVisitorAsnItemDimension = {
-    [key: string]: number;
-};
-export declare type SitesMetricDimensions200DimensionsVisitorAsnItem = {
-    dimension?: SitesMetricDimensions200DimensionsVisitorAsnItemDimension;
-    timestamp?: number;
-};
 export declare type SitesMetricDimensions200DimensionsPageRendererItemDimension = {
     [key: string]: number;
 };
@@ -2704,71 +2755,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
- */
-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;
@@ -2850,6 +2836,71 @@ export declare type SitesInfo200 = {
      */
     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;
+};
+/**
+ * @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;
@@ -3229,6 +3280,16 @@ export declare type PasswordScoreParams = {
 export declare type PasswordGenerate200 = {
     password?: string;
 };
+export declare type HostingPasswordUpdate200 = {
+    /** Indicates whether the password was successfully updated (1 = updated, 0 = not updated). */
+    updated?: number;
+};
+export declare type HostingPasswordUpdateBody = {
+    /** Whether to also change the database password to match the new hosting account password. */
+    change_db_user_pw?: boolean;
+    /** The new password for the hosting account. */
+    new_pw: string;
+};
 export declare type HostingOnboardingDataUpdate200 = {
     completed?: boolean;
 };
@@ -3516,7 +3577,6 @@ export declare type HostingFtpUpdateBody = {
     user_type_set?: HostingFtpUpdateBodyUserTypeSet;
 };
 export declare type HostingFtpAdd200 = {
-    pass?: string;
     user?: string;
 };
 export declare type HostingFtpAddBody = {
@@ -4109,6 +4169,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;
@@ -4139,12 +4205,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
@@ -5037,6 +5097,11 @@ export declare type HostingAdvancedServer200 = {
 export declare type HostingAdvancedImages200ImagesItem = {
     /** The image architecture type */
     arch_name?: string;
+    /**
+     * Whether this image is the default for cpanel app installations; If this = 1, it is an image that can be used when installing cPanel
+     * @nullable
+     */
+    cpanel_default?: string | null;
     /**
      * Whether this is the image currently in use by the hosting addon
      * @nullable
@@ -5045,7 +5110,7 @@ export declare type HostingAdvancedImages200ImagesItem = {
     /** The date and time the image was added */
     date_added?: string;
     /**
-     * Whether this image is the default for docker site installations; If this = 1, it is the image that will be used when installing a Docker app
+     * Whether this image is the default for docker site installations; If this = 1, it is an image that can be used when installing a Docker app
      * @nullable
      */
     docker_default?: string | null;
@@ -5168,6 +5233,31 @@ 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;
@@ -5188,23 +5278,6 @@ export declare type HostingAccount200 = {
     type?: string;
     username?: string;
 };
-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;
-};
 export declare type HostingAccount200ResourcesStagingWorkers = {
     /** @nullable */
     available?: number | null;
@@ -5226,14 +5299,6 @@ export declare type HostingAccount200ResourcesStaging = {
     storage?: HostingAccount200ResourcesStagingStorage;
     workers?: HostingAccount200ResourcesStagingWorkers;
 };
-/**
- * @nullable
- */
-export declare type HostingAccount200Resources = {
-    staging?: HostingAccount200ResourcesStaging;
-    storage?: HostingAccount200ResourcesStorage;
-    workers?: HostingAccount200ResourcesWorkers;
-} | null;
 export declare type HostingAccount200Billing = {
     prod_code?: string;
     product_name?: string;
@@ -6114,6 +6179,11 @@ export declare type AccountHostingList200AccountsItem = {
     /** HAL Account ID */
     hosting_id?: string;
     max_sites?: string;
+    /**
+     * HAL parent_id for atomic accounts, account id for non-atomic accounts
+     * @nullable
+     */
+    parent_id?: string | null;
     platform?: string;
     /** HAL Account back_reference */
     prod_inst_id?: string;
@@ -6126,6 +6196,12 @@ export declare type AccountHostingList200AccountsItem = {
 export declare type AccountHostingList200 = {
     accounts?: AccountHostingList200AccountsItem[];
 };
+export declare type AccountHostingListParams = {
+    /**
+     * Flag to exclude atomic site accounts from the response
+     */
+    exclude_atomic_sites?: boolean;
+};
 /**
  * Usage statistics
  * @nullable