@newfold/huapi-js 2.1375.0 → 2.1412.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.1375.0
+ * OpenAPI spec version: 1.1412.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;
@@ -250,17 +267,6 @@ export declare type SitesDomainsV2200 = {
 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
  */
@@ -418,6 +424,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;
@@ -770,6 +787,8 @@ export declare type BackupRestoreV2Body = {
     /** Backup Volume store ID to get the backup */
     backup_id: string;
     dbs?: string[];
+    /** Restore date */
+    restore_date: string;
     /** Restore type */
     restore_type?: string;
     /** Site id */
@@ -1344,18 +1363,6 @@ export declare type SitesMetricDimensions200DimensionsPageIsCachedItem = {
     dimension?: SitesMetricDimensions200DimensionsPageIsCachedItemDimension;
     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 SitesMetricDimensions200DimensionsHttpVersionItemDimension = {
     [key: string]: number;
 };
@@ -1384,6 +1391,18 @@ 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;
@@ -2365,9 +2384,6 @@ export declare type HostingRedirects200Item = {
     url?: string;
     wildcard?: boolean;
 };
-export declare type ProductLicenseDetails200 = {
-    wpsolution?: ProductLicenseDetails200Wpsolution;
-};
 export declare type ProductLicenseDetails200WpsolutionCreatorItem = {
     expirationDate?: string;
     prodInstId?: string;
@@ -2380,6 +2396,9 @@ export declare type ProductLicenseDetails200Wpsolution = {
     commerce?: ProductLicenseDetails200WpsolutionCommerceItem[];
     creator?: ProductLicenseDetails200WpsolutionCreatorItem[];
 };
+export declare type ProductLicenseDetails200 = {
+    wpsolution?: ProductLicenseDetails200Wpsolution;
+};
 export declare type ProductLicenseDetailsProductName = typeof ProductLicenseDetailsProductName[keyof typeof ProductLicenseDetailsProductName];
 export declare const ProductLicenseDetailsProductName: {
     readonly wpsolution: "wpsolution";
@@ -2458,16 +2477,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;
 };
@@ -2607,6 +2616,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 */
@@ -2688,55 +2748,141 @@ 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 EmailSso512 = {
+    /** Customer error code */
+    error?: string;
 };
-export declare type HostingEmailSuspend512 = {
+export declare type EmailSso400 = {
     /** Customer error code */
     error?: string;
 };
-export declare type HostingEmailSuspend403 = {
+export declare type EmailSso200 = {
+    url: string;
+};
+export declare type EmailSsoParams = {
+    email: string;
+};
+export declare type HostingEmailSettings512 = {
     /** Customer error code */
     error?: string;
 };
-export declare type HostingEmailSuspend200 = {
-    /** The address that was (un)suspended */
+export declare type HostingEmailSettings404 = {
+    /** Customer error code */
+    error?: string;
+};
+export declare type HostingEmailSettings403 = {
+    /** Customer error code */
+    error?: string;
+};
+export declare type HostingEmailSettings200 = {
+    /**
+     * New status of account_incoming - ADDRESS ONLY
+     * @nullable
+     */
+    account_incoming?: string | null;
+    /**
+     * New status of account_login - ADDRESS ONLY
+     * @nullable
+     */
+    account_login?: string | null;
+    /**
+     * New status of account_outgoing - ADDRESS ONLY
+     * @nullable
+     */
+    account_outgoing?: string | null;
+    /** The address that was updated */
     address?: string;
+    /**
+     * New status of automatic plus-addressed folder creation - ADDRESS or SYSTEM
+     * @nullable
+     */
+    autofolders?: string | null;
+    /**
+     * New status of utf8 folder usage - SYSTEM ONLY
+     * @nullable
+     */
+    utf8_folders?: string | null;
 };
 /**
- * The function to suspend
+ * Whether to toggle utf8 folder usage on or off - SYSTEM ONLY
  */
-export declare type HostingEmailSuspendBodyType = typeof HostingEmailSuspendBodyType[keyof typeof HostingEmailSuspendBodyType];
-export declare const HostingEmailSuspendBodyType: {
-    readonly account_login: "account_login";
-    readonly account_outgoing: "account_outgoing";
-    readonly account_incoming: "account_incoming";
+export declare type HostingEmailSettingsBodyUtf8Folders = typeof HostingEmailSettingsBodyUtf8Folders[keyof typeof HostingEmailSettingsBodyUtf8Folders];
+export declare const HostingEmailSettingsBodyUtf8Folders: {
+    readonly enable: "enable";
+    readonly disable: "disable";
+};
+/**
+ * the type of account
+ */
+export declare type HostingEmailSettingsBodyType = typeof HostingEmailSettingsBodyType[keyof typeof HostingEmailSettingsBodyType];
+export declare const HostingEmailSettingsBodyType: {
+    readonly address: "address";
+    readonly system: "system";
+};
+/**
+ * Whether to toggle automatic plus-addressed folder creation on or off - ADDRESS or SYSTEM
+ */
+export declare type HostingEmailSettingsBodyAutofolders = typeof HostingEmailSettingsBodyAutofolders[keyof typeof HostingEmailSettingsBodyAutofolders];
+export declare const HostingEmailSettingsBodyAutofolders: {
+    readonly enable: "enable";
+    readonly disable: "disable";
 };
 /**
- * Suspension action. Can be 'suspend' or 'unsuspend'.
+ * Whether to suspend or unsuspend account_outgoing - ADDRESS ONLY
  */
-export declare type HostingEmailSuspendBodyAction = typeof HostingEmailSuspendBodyAction[keyof typeof HostingEmailSuspendBodyAction];
-export declare const HostingEmailSuspendBodyAction: {
+export declare type HostingEmailSettingsBodyAccountOutgoing = typeof HostingEmailSettingsBodyAccountOutgoing[keyof typeof HostingEmailSettingsBodyAccountOutgoing];
+export declare const HostingEmailSettingsBodyAccountOutgoing: {
+    readonly hold: "hold";
     readonly suspend: "suspend";
     readonly unsuspend: "unsuspend";
 };
-export declare type HostingEmailSuspendBody = {
-    /** Suspension action. Can be 'suspend' or 'unsuspend'. */
-    action?: HostingEmailSuspendBodyAction;
-    /** The email address to (un)suspend */
-    address: string;
-    /** The function to suspend */
-    type: HostingEmailSuspendBodyType;
+/**
+ * Whether to suspend or unsuspend account_login - ADDRESS ONLY
+ */
+export declare type HostingEmailSettingsBodyAccountLogin = typeof HostingEmailSettingsBodyAccountLogin[keyof typeof HostingEmailSettingsBodyAccountLogin];
+export declare const HostingEmailSettingsBodyAccountLogin: {
+    readonly suspend: "suspend";
+    readonly unsuspend: "unsuspend";
+};
+/**
+ * Whether to suspend or unsuspend account_incoming - ADDRESS ONLY
+ */
+export declare type HostingEmailSettingsBodyAccountIncoming = typeof HostingEmailSettingsBodyAccountIncoming[keyof typeof HostingEmailSettingsBodyAccountIncoming];
+export declare const HostingEmailSettingsBodyAccountIncoming: {
+    readonly suspend: "suspend";
+    readonly unsuspend: "unsuspend";
+};
+export declare type HostingEmailSettingsBody = {
+    /** Whether to suspend or unsuspend account_incoming - ADDRESS ONLY */
+    account_incoming?: HostingEmailSettingsBodyAccountIncoming;
+    /** Whether to suspend or unsuspend account_login - ADDRESS ONLY */
+    account_login?: HostingEmailSettingsBodyAccountLogin;
+    /** Whether to suspend or unsuspend account_outgoing - ADDRESS ONLY */
+    account_outgoing?: HostingEmailSettingsBodyAccountOutgoing;
+    /** The email address to update settings on - ADDRESS ONLY */
+    address?: string;
+    /** Whether to toggle automatic plus-addressed folder creation on or off - ADDRESS or SYSTEM */
+    autofolders?: HostingEmailSettingsBodyAutofolders;
+    /** the type of account */
+    type: HostingEmailSettingsBodyType;
+    /** Whether to toggle utf8 folder usage on or off - SYSTEM ONLY */
+    utf8_folders?: HostingEmailSettingsBodyUtf8Folders;
 };
 export declare type HostingEmailForwarderDelete400 = {
     /** Customer error code */
@@ -2898,16 +3044,26 @@ export declare type HostingEmailList200RowsItemBoxSuspensions = {
 export declare type HostingEmailList200RowsItem = {
     /** The email address */
     address?: string;
+    /**
+     * Autocreate folders with plus addressing status
+     * @nullable
+     */
+    autofolders?: boolean | null;
     /**
      * State of email box suspensions
      * @nullable
      */
     box_suspensions?: HostingEmailList200RowsItemBoxSuspensions;
     /**
-     * The amount of disk space used by the email
+     * 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
@@ -2930,6 +3086,11 @@ export declare type HostingEmailList200RowsItem = {
     system_suspensions?: HostingEmailList200RowsItemSystemSuspensions;
     /** The type of email */
     type?: string;
+    /**
+     * If mail folders support utf8 encoding
+     * @nullable
+     */
+    utf8_folders?: boolean | null;
 };
 export declare type HostingEmailList200 = {
     /** List of email resources */
@@ -3350,22 +3511,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;
@@ -3481,14 +3626,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;
@@ -3612,9 +3749,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;
 };
@@ -3630,6 +3764,9 @@ export declare type HostingAddons200RowsItem = {
     subtype?: string;
     type?: string;
 };
+export declare type HostingAddons200 = {
+    rows?: HostingAddons200RowsItem[];
+};
 export declare type HostingAddonsParams = {
     status?: string;
     subtype?: string;
@@ -3655,31 +3792,6 @@ 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;
     advanced?: boolean;
@@ -3697,6 +3809,23 @@ 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;
@@ -3718,6 +3847,14 @@ 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;
@@ -4074,6 +4211,33 @@ export declare type AddonsInfo200 = {
 export declare type AddonsCloudflare200 = {
     status?: string;
 };
+/**
+ * @nullable
+ */
+export declare type BackupMeta200CbsEventIsProcessing = {
+    action?: string;
+    type?: string;
+} | null;
+export declare type BackupMeta200CbsDownloadablesItem = {
+    /** @nullable */
+    id?: string | null;
+    /** @nullable */
+    time_req_completed?: string | null;
+    /** @nullable */
+    type?: string | null;
+    /** @nullable */
+    url?: string | null;
+};
+export declare type BackupMeta200 = {
+    /** @nullable */
+    cbs_downloadables?: BackupMeta200CbsDownloadablesItem[] | null;
+    /** @nullable */
+    cbs_event_is_processing?: BackupMeta200CbsEventIsProcessing;
+    /** @nullable */
+    cbs_last_restore_timestamp?: string | null;
+    /** @nullable */
+    client_tracking_id?: string | null;
+};
 export declare type BackupList200HomeItemBackupStatus = {
     /** @nullable */
     download_url?: string | null;
@@ -4440,6 +4604,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
  */

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',
@@ -168,13 +174,33 @@ export const HostingFtpUpdateBodyUserTypeSet = {
     quota: 'quota',
 };
 // eslint-disable-next-line @typescript-eslint/no-redeclare
-export const HostingEmailSuspendBodyType = {
-    account_login: 'account_login',
-    account_outgoing: 'account_outgoing',
-    account_incoming: 'account_incoming',
+export const HostingEmailSettingsBodyUtf8Folders = {
+    enable: 'enable',
+    disable: 'disable',
+};
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const HostingEmailSettingsBodyType = {
+    address: 'address',
+    system: 'system',
+};
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const HostingEmailSettingsBodyAutofolders = {
+    enable: 'enable',
+    disable: 'disable',
+};
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const HostingEmailSettingsBodyAccountOutgoing = {
+    hold: 'hold',
+    suspend: 'suspend',
+    unsuspend: 'unsuspend',
+};
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const HostingEmailSettingsBodyAccountLogin = {
+    suspend: 'suspend',
+    unsuspend: 'unsuspend',
 };
 // eslint-disable-next-line @typescript-eslint/no-redeclare
-export const HostingEmailSuspendBodyAction = {
+export const HostingEmailSettingsBodyAccountIncoming = {
     suspend: 'suspend',
     unsuspend: 'unsuspend',
 };