@newfold/huapi-js 2.1317.0 → 2.1340.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.1317.0
+ * OpenAPI spec version: 1.1340.0
  */
 export declare type SshKeyListV4200RowsItem = {
     authorize?: boolean;
@@ -55,6 +55,31 @@ export declare type SshKeyImportV3Body = {
     /** The entity that initiated the GAP call */
     source?: string;
 };
+export declare type SiteUsersV2200UsersItemMeta = {
+    maestro_web_pro?: string;
+    maestro_wpp_identifier?: string;
+};
+export declare type SiteUsersV2200UsersItem = {
+    display_name?: string;
+    id: number;
+    meta?: SiteUsersV2200UsersItemMeta;
+    post_count?: number;
+    role: string;
+    user_email: string;
+    user_id: number;
+    user_login: string;
+    user_nicename: string;
+};
+export declare type SiteUsersV2200 = {
+    /** Total number of users that linked to the site */
+    total_users: number;
+    users: SiteUsersV2200UsersItem[];
+};
+export declare type SiteUsersV2Params = {
+    limit?: number;
+    page?: number;
+    search?: string;
+};
 export declare type SitesSshUserListV2200 = {
     users?: SSHUsersV2Response[];
 };
@@ -96,6 +121,28 @@ export declare type SitesSecuritySitelockV2Params = {
      */
     source?: SitesSecuritySitelockV2Source;
 };
+export declare type SiteMalwareStatusV2200 = {
+    /**
+     * addon state
+     * @nullable
+     */
+    addon_state?: string | null;
+    /**
+     * malware status given by jetpack protect addon
+     * @nullable
+     */
+    malware_state?: string | null;
+    /**
+     * plugin state
+     * @nullable
+     */
+    plugin_state?: string | null;
+    /**
+     * scanner state
+     * @nullable
+     */
+    scanner_state?: string | null;
+};
 /**
  * @nullable
  */
@@ -203,17 +250,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
  */
@@ -369,6 +405,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;
@@ -704,7 +751,7 @@ export declare type DbListV2200 = {
 };
 export declare type BackupStatusV2200 = {
     /** @nullable */
-    message?: string | null;
+    backup_download_url?: string | null;
     status?: string;
 };
 export declare type BackupStatusV2Params = {
@@ -1110,6 +1157,9 @@ export declare type SiteQualityMetrics200AspectScores = {
     performance?: number;
     seo?: number;
 };
+export declare type SiteQualityMetrics200AspectDetails = {
+    performance?: SiteQualityMetrics200AspectDetailsPerformance;
+};
 export declare type SiteQualityMetrics200 = {
     aspect_details: SiteQualityMetrics200AspectDetails;
     aspect_scores: SiteQualityMetrics200AspectScores;
@@ -1140,9 +1190,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";
@@ -1918,17 +1965,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;
@@ -1948,6 +1984,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";
@@ -2580,6 +2627,139 @@ export declare type ListFilesParams = {
     path: string;
     showdotfiles?: boolean;
 };
+export declare type HostingEmailSuspend512 = {
+    /** Customer error code */
+    error?: string;
+};
+export declare type HostingEmailSuspend403 = {
+    /** Customer error code */
+    error?: string;
+};
+export declare type HostingEmailSuspend200 = {
+    /** The address that was (un)suspended */
+    address?: string;
+};
+/**
+ * The function to suspend
+ */
+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";
+};
+/**
+ * Suspension action. Can be 'suspend' or 'unsuspend'.
+ */
+export declare type HostingEmailSuspendBodyAction = typeof HostingEmailSuspendBodyAction[keyof typeof HostingEmailSuspendBodyAction];
+export declare const HostingEmailSuspendBodyAction: {
+    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;
+};
+export declare type HostingEmailForwarderDelete400 = {
+    /** Customer error code */
+    error?: string;
+};
+export declare type HostingEmailForwarderDelete200 = {
+    [key: string]: unknown;
+};
+export declare type HostingEmailForwarderDeleteParams = {
+    /**
+     * The source address or domain of the forwarder to be deleted
+     */
+    source: string;
+    /**
+     * The destination of the forwarder to be deleted
+     */
+    destination: string;
+};
+export declare type HostingEmailForwarderAdd512 = {
+    /** Customer error code */
+    error?: string;
+};
+export declare type HostingEmailForwarderAdd409 = {
+    /** Customer error code */
+    error?: string;
+};
+export declare type HostingEmailForwarderAdd403 = {
+    /** Customer error code */
+    error?: string;
+};
+export declare type HostingEmailForwarderAdd400 = {
+    /** Customer error code */
+    error?: string;
+};
+export declare type HostingEmailForwarderAdd200 = {
+    [key: string]: unknown;
+};
+/**
+ * The type of forwarder to add (defaults to 'account')
+ */
+export declare type HostingEmailForwarderAddBodyType = typeof HostingEmailForwarderAddBodyType[keyof typeof HostingEmailForwarderAddBodyType];
+export declare const HostingEmailForwarderAddBodyType: {
+    readonly account: "account";
+    readonly domain: "domain";
+};
+/**
+ * The type of forwarder destination (defaults to 'email')
+ */
+export declare type HostingEmailForwarderAddBodyDestinationType = typeof HostingEmailForwarderAddBodyDestinationType[keyof typeof HostingEmailForwarderAddBodyDestinationType];
+export declare const HostingEmailForwarderAddBodyDestinationType: {
+    readonly domain: "domain";
+    readonly discard: "discard";
+    readonly discard_with_error: "discard_with_error";
+    readonly email: "email";
+    readonly pipe: "pipe";
+    readonly system: "system";
+};
+export declare type HostingEmailForwarderAddBody = {
+    /** The forwarding destination - can be an email address, system username, script path, or error message string */
+    destination?: string;
+    /** The type of forwarder destination (defaults to 'email') */
+    destination_type: HostingEmailForwarderAddBodyDestinationType;
+    /** The source (email address or domain) of the forwarder being added */
+    source: string;
+    /** The type of forwarder to add (defaults to 'account') */
+    type: HostingEmailForwarderAddBodyType;
+};
+export declare type HostingEmailForwardersList200ForwardersItem = {
+    /** Where the email will be forwarded to */
+    destination?: string;
+    /** Where the email to be forwarded is coming from */
+    source?: string;
+    /**
+     * The type of forwarder
+     * @nullable
+     */
+    type?: string | null;
+};
+export declare type HostingEmailForwardersList200 = {
+    /** List of forwarders */
+    forwarders?: HostingEmailForwardersList200ForwardersItem[];
+};
+export declare type HostingEmailForwardersListType = typeof HostingEmailForwardersListType[keyof typeof HostingEmailForwardersListType];
+export declare const HostingEmailForwardersListType: {
+    readonly account: "account";
+    readonly domain: "domain";
+};
+export declare type HostingEmailForwardersListParams = {
+    /**
+     * The type of forwarder list to query (default: account)
+     */
+    type: HostingEmailForwardersListType;
+    /**
+     * The domain to query forwarders by
+     */
+    domain?: string;
+};
 export declare type HostingEmailUpdate512 = {
     /** Customer error code */
     error?: string;
@@ -3096,7 +3276,8 @@ export declare type DbAddBody = {
     type?: DbAddBodyType;
 };
 export declare type CronLastRun200 = {
-    last_run?: string;
+    /** @nullable */
+    last_run?: string | null;
 };
 export declare type CronLastRunParams = {
     command: string;
@@ -3265,7 +3446,10 @@ export declare type HostingAdvancedDomainServicesBody = {
     domain: string;
 };
 export declare type HostingAdvancedDomainServicesCheck200 = {
+    /** 1 if domain services need to be configured, 0 if not */
     configure_domain_services?: number;
+    /** Whether a user exists that HAL doesn't know about; should disable some functionality if 0 and configure_domain_services is 1 */
+    managed_cpanel_user_exists?: number;
 };
 export declare type HostingAdvancedDnsUpdate200 = {
     [key: string]: unknown;
@@ -3412,6 +3596,38 @@ export declare type DomainZoneeditorUrl200 = {
 export declare type DomainUnassign200 = {
     [key: string]: unknown;
 };
+export declare type AccessLogs200LogsItem = {
+    /** @nullable */
+    date?: string | null;
+    /** @nullable */
+    device?: string | null;
+    /** @nullable */
+    host?: string | null;
+    /** @nullable */
+    ip?: string | null;
+    /** @nullable */
+    request?: string | null;
+    /** @nullable */
+    response_code?: number | null;
+    /** @nullable */
+    response_size?: number | null;
+    /** @nullable */
+    server_ip?: string | null;
+};
+export declare type AccessLogs200 = {
+    logs?: AccessLogs200LogsItem[];
+};
+export declare type AccessLogsType = typeof AccessLogsType[keyof typeof AccessLogsType];
+export declare const AccessLogsType: {
+    readonly error: "error";
+    readonly all: "all";
+};
+export declare type AccessLogsParams = {
+    /**
+     * Access logs type
+     */
+    type?: AccessLogsType;
+};
 export declare type DomainDnszoneReset200 = {
     [key: string]: unknown;
 };
@@ -3421,14 +3637,10 @@ export declare type DomainDnseditorEdit200 = {
 export declare type DomainDnseditorEditBody = {
     /** It describes dns point value for each type of record */
     content?: string;
-    /** mail server that domain  of  DNS record points to */
-    exchange?: string;
     /** Flag of each DNS record it has */
     flag?: string;
     /** name type of dns record */
     name?: string;
-    /** mail server that domain  of  DNS record points to */
-    nsdname?: string;
     /** actual cotent on which the records points to */
     orig_content?: string;
     /** actual name that records holds */
@@ -3436,6 +3648,8 @@ export declare type DomainDnseditorEditBody = {
     /** Port of SRV DNS record */
     port?: string;
     /** Priority of each DNS record, Default priority would be set to one */
+    preference?: string;
+    /** Priority of each DNS record, Default priority would be set to one */
     priority?: string;
     /** protocal of  DNS record */
     protocol?: string;
@@ -3447,8 +3661,6 @@ export declare type DomainDnseditorEditBody = {
     ttl?: string;
     /** Add host records for your domain name, such as A Records, MX Records, or IPV6 (AAAA). Choose MANAGE to see the full list of supported records */
     type?: string;
-    /** mail server that domain  of  DNS record points to */
-    value?: string;
     /** Weight of each DNS record it holds */
     weight?: string;
 };
@@ -3488,11 +3700,61 @@ export declare type DomainDnseditorAddBodyRecordsItem = {
 export declare type DomainDnseditorAddBody = {
     records?: DomainDnseditorAddBodyRecordsItem[];
 };
-export declare type DomainDnseditorList200Item = {
-    content?: string;
+export declare type DomainDnseditorList200DnsRecordsItem = {
+    /**
+     * It describes dns point value for each type of record
+     * @nullable
+     */
+    content?: string | null;
+    /**
+     * Flag of each DNS record it has
+     * @nullable
+     */
+    flag?: string | null;
+    /** name type of dns record with domain name */
     name?: string;
+    /**
+     * Port of SRV DNS record
+     * @nullable
+     */
+    port?: string | null;
+    /**
+     * Priority of each DNS record, Default priority would be set to one
+     * @nullable
+     */
+    preference?: string | null;
+    /**
+     * Priority of each DNS record, Default priority would be set to one
+     * @nullable
+     */
+    priority?: string | null;
+    /**
+     * Tag of each DNS record
+     * @nullable
+     */
+    tag?: string | null;
+    /**
+     * Target of SRV DNS record example.domain.com
+     * @nullable
+     */
+    target?: string | null;
+    /** How long the DNS record is valid for */
     ttl?: number;
+    /** manage domain DNS records (A, MX, CNAME, TXT and SRV Records) for individual services */
     type?: string;
+    /**
+     * Tag value for CAA Record
+     * @nullable
+     */
+    value?: string | null;
+    /**
+     * Weight of each DNS record it holds
+     * @nullable
+     */
+    weight?: string | null;
+};
+export declare type DomainDnseditorList200 = {
+    dns_records?: DomainDnseditorList200DnsRecordsItem[];
 };
 export declare type DomainDnseditor200 = {
     success?: number;
@@ -3829,12 +4091,6 @@ export declare type CodeguardDatabaseBackupListParams = {
     database_id?: number;
     website_id?: number;
 };
-export declare type CodeguardDatabaseList200DatabasesItemDatabaseBackup = {
-    account?: string;
-    commit_id?: string;
-    id?: number;
-    website_id?: number;
-};
 export declare type CodeguardDatabaseList200DatabasesItem = {
     database_backup?: CodeguardDatabaseList200DatabasesItemDatabaseBackup;
 };
@@ -3842,6 +4098,12 @@ export declare type CodeguardDatabaseList200 = {
     databases?: CodeguardDatabaseList200DatabasesItem[];
     status?: number;
 };
+export declare type CodeguardDatabaseList200DatabasesItemDatabaseBackup = {
+    account?: string;
+    commit_id?: string;
+    id?: number;
+    website_id?: number;
+};
 export declare type CodeguardBackupRestore200 = {
     database_success?: boolean;
     website_success?: boolean;

package/src/index.schemas.js

@@ -168,6 +168,36 @@ 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',
+};
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const HostingEmailSuspendBodyAction = {
+    suspend: 'suspend',
+    unsuspend: 'unsuspend',
+};
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const HostingEmailForwarderAddBodyType = {
+    account: 'account',
+    domain: 'domain',
+};
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const HostingEmailForwarderAddBodyDestinationType = {
+    domain: 'domain',
+    discard: 'discard',
+    discard_with_error: 'discard_with_error',
+    email: 'email',
+    pipe: 'pipe',
+    system: 'system',
+};
+// eslint-disable-next-line @typescript-eslint/no-redeclare
+export const HostingEmailForwardersListType = {
+    account: 'account',
+    domain: 'domain',
+};
+// eslint-disable-next-line @typescript-eslint/no-redeclare
 export const HostingEmailAddBodyType = {
     box: 'box',
     domainalias: 'domainalias',
@@ -229,6 +259,11 @@ export const DbAddBodyType = {
     postgres: 'postgres',
 };
 // eslint-disable-next-line @typescript-eslint/no-redeclare
+export const AccessLogsType = {
+    error: 'error',
+    all: 'all',
+};
+// eslint-disable-next-line @typescript-eslint/no-redeclare
 export const BackupListBackupType = {
     full: 'full',
     home: 'home',