@newfold/huapi-js 2.1365.0 → 2.1398.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.1365.0
+ * OpenAPI spec version: 1.1398.0
  */
 export declare type SshKeyListV4200RowsItem = {
     authorize?: boolean;
@@ -55,6 +55,23 @@ export declare type SshKeyImportV3Body = {
     /** The entity that initiated the GAP call */
     source?: string;
 };
+export declare type BackupCreateV3200 = {
+    message?: string;
+    tracking_id?: number;
+};
+/**
+ * The type of the backup
+ */
+export declare type BackupCreateV3BodyBackupType = typeof BackupCreateV3BodyBackupType[keyof typeof BackupCreateV3BodyBackupType];
+export declare const BackupCreateV3BodyBackupType: {
+    readonly home: "home";
+    readonly db: "db";
+    readonly home_db: "home_db";
+};
+export declare type BackupCreateV3Body = {
+    /** The type of the backup */
+    backup_type?: BackupCreateV3BodyBackupType;
+};
 export declare type SiteUsersV2200UsersItemMeta = {
     maestro_web_pro?: string;
     maestro_wpp_identifier?: string;
@@ -277,63 +294,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;
@@ -351,6 +311,8 @@ export declare type SitesListV2200ItemsItem = {
     date_modified?: string;
     detected_type?: string;
     /** @nullable */
+    docpath?: string | null;
+    /** @nullable */
     docroot?: string | null;
     /** @nullable */
     domain?: string | null;
@@ -416,6 +378,63 @@ export declare type SitesListV2200 = {
     /** 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;
@@ -631,6 +650,8 @@ export declare type HostingSitesV2200ItemsItem = {
     date_modified?: string;
     detected_type?: string;
     /** @nullable */
+    docpath?: string | null;
+    /** @nullable */
     docroot?: string | null;
     /** @nullable */
     domain?: string | null;
@@ -1158,9 +1179,6 @@ export declare type SiteQualityMetrics200AspectScores = {
     performance?: number;
     seo?: number;
 };
-export declare type SiteQualityMetrics200AspectDetails = {
-    performance?: SiteQualityMetrics200AspectDetailsPerformance;
-};
 export declare type SiteQualityMetrics200 = {
     aspect_details: SiteQualityMetrics200AspectDetails;
     aspect_scores: SiteQualityMetrics200AspectScores;
@@ -1191,6 +1209,9 @@ 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";
@@ -1966,6 +1987,8 @@ export declare type SitesInfo200 = {
     date_modified?: string;
     detected_type?: string;
     /** @nullable */
+    docpath?: string | null;
+    /** @nullable */
     docroot?: string | null;
     /** @nullable */
     domain?: string | null;
@@ -2033,17 +2056,6 @@ export declare type HostingVisitors200VisitorsItem = {
     unique_visitors?: number;
     visitors?: number;
 };
-export declare type HostingVisitors200 = {
-    daily?: HostingVisitors200Daily;
-    is_linked_domain?: boolean;
-    linked_domain?: string;
-    total_bandwidth?: number;
-    total_hits?: number;
-    total_pages?: number;
-    total_unique_visitors?: number;
-    total_visitors?: number;
-    visitors?: HostingVisitors200VisitorsItem[];
-};
 export declare type HostingVisitors200DailyTotal = {
     total_bandwidth?: number;
     total_hits?: number;
@@ -2063,6 +2075,17 @@ export declare type HostingVisitors200Daily = {
     data?: HostingVisitors200DailyDataItem[];
     total?: HostingVisitors200DailyTotal;
 };
+export declare type HostingVisitors200 = {
+    daily?: HostingVisitors200Daily;
+    is_linked_domain?: boolean;
+    linked_domain?: string;
+    total_bandwidth?: number;
+    total_hits?: number;
+    total_pages?: number;
+    total_unique_visitors?: number;
+    total_visitors?: number;
+    visitors?: HostingVisitors200VisitorsItem[];
+};
 export declare type HostingVisitorsSource = typeof HostingVisitorsSource[keyof typeof HostingVisitorsSource];
 export declare const HostingVisitorsSource: {
     readonly http: "http";
@@ -2452,16 +2475,6 @@ export declare type HostingMigrationsEventBody = {
     /** The migration id that corresponds to CWM */
     migration_id: string;
 };
-export declare type HostingMigrationsCheck200 = {
-    description?: string;
-    transferable?: boolean;
-};
-export declare type HostingMigrationsCheckParams = {
-    /**
-     * Migration ID to be checked if already used to migrate site on the hosting account
-     */
-    migration_id: string;
-};
 export declare type HostingMigrations200 = {
     success?: boolean;
 };
@@ -2601,6 +2614,57 @@ export declare type HotlinkconfigDetails200 = {
 export declare type HotlinkconfigDetailsParams = {
     docpath: string;
 };
+export declare type HostingRepoLog200 = {
+    /** The output or logs from Git operations such as clone, pull, or deploy */
+    log?: string;
+    /** The file path where the Git repository is cloned */
+    path?: string;
+};
+export declare type HostingRepoLogParams = {
+    path: string;
+};
+export declare type HostingRepo200 = {
+    /** Directory path where the repository was cloned and should now be deleted */
+    path?: string;
+    /** The URL of the remote Git repository to be deleted */
+    repo_url?: string;
+    success?: boolean;
+};
+export declare type HostingRepoBody = {
+    /** Directory path where the repository was cloned and should now be deleted */
+    path?: string;
+};
+export declare type HostingRepoSync200 = {
+    /** The type of action taken */
+    action?: string;
+    /** Branch to checkout to */
+    branch?: string;
+    /** Deploy log */
+    log?: string;
+    /** Path to clone repo into */
+    path?: string;
+    /** The Clone URL */
+    repo_url?: string;
+    success?: boolean;
+};
+export declare type HostingRepoSyncBody = {
+    /** Branch to checkout to */
+    branch?: string;
+    /** Flag to check if it is to not_deploy(clone) or deploy */
+    clone?: boolean;
+    /** Path to clone repo into */
+    path?: string;
+    /** The Clone URL */
+    repo_url: string;
+};
+export declare type HostingRepoList200Item = {
+    /** The checked-out Git branch for the repository */
+    branch?: string;
+    /** The file path where the repository is cloned */
+    path?: string;
+    /** The remote Git repository URL from which the repository was cloned */
+    repo_url?: string;
+};
 export declare type HostingFtp200 = {
     status?: number;
     /** Username */
@@ -2682,23 +2746,30 @@ export declare type HostingFtpList200 = {
 export declare type HostingFixownership200 = {
     success?: boolean;
 };
-export declare type ListFiles200FilesItem = {
-    file?: string;
-    path?: string;
-    size?: number;
-    type?: string;
+export declare type HostingEmailFolderList404 = {
+    /** Error message */
+    error?: string;
 };
-export declare type ListFiles200 = {
-    files?: ListFiles200FilesItem[];
+export declare type HostingEmailFolderList200FoldersItem = {
+    /** Child folders of the parent folder */
+    children?: FolderNode[];
+    /** The name of the parent folder */
+    name?: string;
 };
-export declare type ListFilesParams = {
-    path: string;
-    showdotfiles?: boolean;
+export declare type HostingEmailFolderList200 = {
+    /** The number of email folders returned */
+    count?: number;
+    /** List of email address folders */
+    folders?: HostingEmailFolderList200FoldersItem[];
 };
 export declare type HostingEmailSuspend512 = {
     /** Customer error code */
     error?: string;
 };
+export declare type HostingEmailSuspend404 = {
+    /** Error message */
+    error?: string;
+};
 export declare type HostingEmailSuspend403 = {
     /** Customer error code */
     error?: string;
@@ -2732,6 +2803,20 @@ export declare type HostingEmailSuspendBody = {
     /** The function to suspend */
     type: HostingEmailSuspendBodyType;
 };
+export declare type EmailSso512 = {
+    /** Customer error code */
+    error?: string;
+};
+export declare type EmailSso400 = {
+    /** Customer error code */
+    error?: string;
+};
+export declare type EmailSso200 = {
+    url: string;
+};
+export declare type EmailSsoParams = {
+    email: string;
+};
 export declare type HostingEmailForwarderDelete400 = {
     /** Customer error code */
     error?: string;
@@ -2851,19 +2936,82 @@ export declare type HostingEmailUpdateBody = {
     /** The quota for the email (optional) (default: 0 = unlimited) */
     quota?: number;
 };
+/**
+ * List of suspensions that affect the entire user account
+ * @nullable
+ */
+export declare type HostingEmailList200RowsItemSystemSuspensions = {
+    /** @nullable */
+    receive?: boolean | null;
+    /** @nullable */
+    relay?: boolean | null;
+    /** @nullable */
+    sendmail?: boolean | null;
+} | null;
+/**
+ * State of email box suspensions
+ * @nullable
+ */
+export declare type HostingEmailList200RowsItemBoxSuspensions = {
+    /**
+     * Incoming email is rejected
+     * @nullable
+     */
+    incoming?: boolean | null;
+    /**
+     * Email authentication is disabled
+     * @nullable
+     */
+    login?: boolean | null;
+    /**
+     * Outgoing email is rejected
+     * @nullable
+     */
+    outgoing?: boolean | null;
+    /**
+     * Outgoing email is held in queue
+     * @nullable
+     */
+    outgoing_hold?: boolean | null;
+} | null;
 export declare type HostingEmailList200RowsItem = {
     /** The email address */
     address?: string;
     /**
-     * The amount of disk space used by the email
+     * State of email box suspensions
+     * @nullable
+     */
+    box_suspensions?: HostingEmailList200RowsItemBoxSuspensions;
+    /**
+     * The amount of disk space used by the email box
      * @nullable
      */
     disk_used_kib?: number | null;
+    /**
+     * The percentage of disk space used by the email box
+     * @nullable
+     */
+    disk_used_percent?: number | null;
+    /**
+     * The email domain
+     * @nullable
+     */
+    domain?: string | null;
     /**
      * The number of files in the email
      * @nullable
      */
     files?: number | null;
+    /**
+     * The maximum amount of disk space that may be used by the email
+     * @nullable
+     */
+    quota?: number | null;
+    /**
+     * List of suspensions that affect the entire user account
+     * @nullable
+     */
+    system_suspensions?: HostingEmailList200RowsItemSystemSuspensions;
     /** The type of email */
     type?: string;
 };
@@ -3286,22 +3434,6 @@ export declare type HostingDbAuthorizedHosts200RemoteIpsItem = {
 export declare type HostingDbAuthorizedHosts200 = {
     remote_ips?: HostingDbAuthorizedHosts200RemoteIpsItem[];
 };
-export declare type DbList200DatabasesItemUserlistItem = {
-    db?: string;
-    user?: string;
-};
-export declare type DbList200DatabasesItem = {
-    db?: string;
-    sitename?: string;
-    size?: string;
-    sizemeg?: string;
-    usercount?: number;
-    userlist?: DbList200DatabasesItemUserlistItem[];
-};
-export declare type DbList200 = {
-    databases?: DbList200DatabasesItem[];
-    status?: boolean;
-};
 export declare type Db200 = {
     dbname?: string;
     status?: number;
@@ -3417,14 +3549,6 @@ export declare type ListCrons200RowsItem = {
 export declare type ListCrons200 = {
     rows?: ListCrons200RowsItem[];
 };
-export declare type AddonCloudflare200 = {
-    addon_id?: number;
-    status?: string;
-};
-export declare type AddonCloudflareBody = {
-    /** The domain. */
-    domain: string;
-};
 export declare type HostingCapabilities200 = {
     advanced_hosting?: boolean;
     cbs_backups?: boolean;
@@ -3548,9 +3672,6 @@ export declare type HostingAdvancedDnsParams = {
     domain: string;
     dns_with_us?: number;
 };
-export declare type HostingAddons200 = {
-    rows?: HostingAddons200RowsItem[];
-};
 export declare type HostingAddons200RowsItemMeta = {
     [key: string]: string | number | boolean;
 };
@@ -3566,6 +3687,9 @@ export declare type HostingAddons200RowsItem = {
     subtype?: string;
     type?: string;
 };
+export declare type HostingAddons200 = {
+    rows?: HostingAddons200RowsItem[];
+};
 export declare type HostingAddonsParams = {
     status?: string;
     subtype?: string;
@@ -3591,6 +3715,23 @@ export declare type ActivityLog200 = {
 export declare type ActivityLogParams = {
     days?: number;
 };
+export declare type HostingAccount200 = {
+    account_id?: string;
+    advanced?: boolean;
+    billing?: HostingAccount200Billing;
+    brand?: string;
+    id?: string;
+    panel?: string;
+    plan_key?: string;
+    platform?: string;
+    /** @nullable */
+    resources?: HostingAccount200Resources;
+    /** @nullable */
+    ssh_hostname?: string | null;
+    status?: string;
+    type?: string;
+    username?: string;
+};
 export declare type HostingAccount200ResourcesWorkers = {
     /** @nullable */
     available?: number | null;
@@ -3616,23 +3757,6 @@ export declare type HostingAccount200Resources = {
     storage?: HostingAccount200ResourcesStorage;
     workers?: HostingAccount200ResourcesWorkers;
 } | null;
-export declare type HostingAccount200 = {
-    account_id?: string;
-    advanced?: boolean;
-    billing?: HostingAccount200Billing;
-    brand?: string;
-    id?: string;
-    panel?: string;
-    plan_key?: string;
-    platform?: string;
-    /** @nullable */
-    resources?: HostingAccount200Resources;
-    /** @nullable */
-    ssh_hostname?: string | null;
-    status?: string;
-    type?: string;
-    username?: string;
-};
 export declare type HostingAccount200ResourcesStagingWorkers = {
     /** @nullable */
     available?: number | null;
@@ -4376,6 +4500,12 @@ export declare type AccountEventListParams = {
      */
     date_last?: string;
 };
+export interface FolderNode {
+    /** Child folders of the child folder */
+    children?: FolderNode[];
+    /** The name of the child folder */
+    name?: string;
+}
 /**
  * @nullable
  */
@@ -4491,6 +4621,8 @@ export interface SiteInfoResponseModelV2 {
     date_modified?: string;
     detected_type?: string;
     /** @nullable */
+    docpath?: string | null;
+    /** @nullable */
     docroot?: string | null;
     /** @nullable */
     domain?: string | null;

package/src/index.schemas.js

@@ -1,4 +1,10 @@
 // eslint-disable-next-line @typescript-eslint/no-redeclare
+export const BackupCreateV3BodyBackupType = {
+    home: 'home',
+    db: 'db',
+    home_db: 'home_db',
+};
+// eslint-disable-next-line @typescript-eslint/no-redeclare
 export const SitesSecuritySitelockV2Source = {
     hal: 'hal',
     fg: 'fg',