@newfold/huapi-js 2.1234.0 → 2.1240.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -10,7 +10,7 @@
10
10
  "tslib": "2.7.0"
11
11
  },
12
12
  "module": "dist/index.ts",
13
- "version": "2.1234.0",
13
+ "version": "2.1240.0",
14
14
  "sideEffects": false,
15
15
  "main": "./src/index.js",
16
16
  "types": "./src/index.d.ts",
package/src/index.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  import type { DefinedInitialDataOptions, DefinedUseInfiniteQueryResult, DefinedUseQueryResult, InfiniteData, QueryKey, UndefinedInitialDataOptions, UseInfiniteQueryOptions, UseInfiniteQueryResult, UseMutationOptions, UseMutationResult, UseQueryOptions, UseQueryResult } from '@tanstack/react-query';
2
2
  import axios from 'axios';
3
3
  import type { AxiosError, AxiosRequestConfig, AxiosResponse } from 'axios';
4
- import type { AccountEventList200, AccountEventListParams, AccountHostingList200, AccountPublicKey200, AccountPublicKey404, AccountPublicKeyCreate200, AccountPublicKeyCreate409, AccountPublicKeyCreateBody, AccountPublicKeyDelete200, AccountPublicKeyDelete404, AccountPublicKeyToggle200, AccountPublicKeyToggle409, AccountPublicKeyToggleBody, AccountPublicKeys200, ActivityLog200, ActivityLogParams, AddCron200, AddCron400, AddCronBody, AddHostingRedirects200, AddHostingRedirectsBody, AddIndex200, AddIndexBody, AddPrivacy200, AddPrivacyBody, AddSiteIpaddress200, AddSiteIpaddressBody, AddonCloudflare200, AddonCloudflareBody, AddonsCloudflare200, AddonsInfo200, AddonsJetpackValidate200, AddonsSitelockSso200, AddonsSitelockSsoV2200, AddonsSitelockSsoV2Params, AddonsSpamexpertsSso200, BackupCreateV2200, BackupCreateV2Body, BackupDownloadV2200, BackupDownloadV2Body, BackupInitiate200, BackupInitiateBody, BackupList200, BackupListParams, BackupListV2200, BackupRestoreV2200, BackupRestoreV2Body, BackupStatus200, BackupStatusParams, BackupStatusV2200, BackupStatusV2Params, BackupsJetpackBackup200, CodeguardBackupCreate200, CodeguardBackupCreateBody, CodeguardBackupDownload200, CodeguardBackupDownloadBody, CodeguardBackupList200, CodeguardBackupListParams, CodeguardBackupRestore200, CodeguardBackupRestoreBody, CodeguardDatabaseBackupCreate200, CodeguardDatabaseBackupCreateBody, CodeguardDatabaseBackupList200, CodeguardDatabaseBackupListParams, CodeguardDatabaseBackupRestore200, CodeguardDatabaseBackupRestoreBody, CodeguardDatabaseList200, CodeguardLoginLink200, CodeguardPlanInfo200, CodeguardWebsiteBackupCreate200, CodeguardWebsiteBackupCreateBody, CodeguardWebsiteBackupList200, CodeguardWebsiteBackupListParams, CodeguardWebsiteBackupRestore200, CodeguardWebsiteBackupRestoreBody, CodeguardWebsiteList200, CreatePhpInfo200, Cron200, CronBody, Db200, DbAdd200, DbAddBody, DbBody, DbCheckDatabase200, DbCheckDatabaseBody, DbList200, DbListV2200, DbMultipleUserDatabase200, DbMultipleUserDatabaseBody, DbUsage200, DbUserAdd200, DbUserAddBody, DbUserDelete200, DbUserDeleteBody, DbUserList200, DbUserPasswordSet200, DbUserPasswordSetBody, DbUserPrivsGet200, DbUserPrivsGetParams, DbUserPrivsSet200, DbUserPrivsSetBody, DbUserRename200, DbUserRenameBody, DirectoryPrivacy200, DirectoryPrivacyParams, DomainCertInstall200, DomainCertInstallBody, DomainCertUninstall200, DomainCertUpdate200, DomainCertUpdateBody, DomainCerts200, DomainDnsExport200, DomainDnsExportParams, DomainDnseditor200, DomainDnseditorAdd200, DomainDnseditorAddBody, DomainDnseditorBody, DomainDnseditorEdit200, DomainDnseditorEditBody, DomainDnseditorList200Item, DomainDnszoneReset200, DomainInfo200, DomainUnassign200, DomainZoneeditorUrl200, Domains200, DomainsParams, EditPrivacy200, EditPrivacyBody, HostingAccount200, HostingAddons200, HostingAddonsParams, HostingAdvancedDomainServices200, HostingAdvancedDomainServicesBody, HostingAdvancedDomainServicesCheck200, HostingAdvancedPassword200, HostingAdvancedPasswordBody, HostingAdvancedServer200, HostingAdvancedServerStatus200, HostingAdvancedServerStatusBody, HostingAdvancedSsoWhm200, HostingAdvancedSystemConsole200, HostingCapabilities200, HostingDbAuthorizedHosts200, HostingDbAuthorizedHostsAdd200, HostingDbAuthorizedHostsAddBody, HostingDbAuthorizedHostsDelete200, HostingDbAuthorizedHostsDeleteBody, HostingDbAuthorizedHostsUpdate200, HostingDbAuthorizedHostsUpdateBody, HostingDomainAssign200, HostingDomainAssignBody, HostingDomainAvailability200, HostingDomainAvailabilityParams, HostingDomainsUnassign200, HostingDomainsUnassignBody, HostingDomainsUnassignV2200, HostingDomainsUnassignV2Body, HostingEcommerceInfo200, HostingFixownership200, HostingFtp200, HostingFtpAdd200, HostingFtpAddBody, HostingFtpBody, HostingFtpList200, HostingFtpUpdate200, HostingFtpUpdateBody, HostingInfo200, HostingInfoDiskUsage200, HostingLead200, HostingLead400, HostingLeadParams, HostingMigrationInfo200, HostingMigrationInfoParams, HostingMigrationSiteScanStatus200, HostingMigrationSiteScanStatusParams, HostingMigrationStatus200, HostingMigrations200, HostingMigrationsBody, HostingMigrationsCheck200, HostingMigrationsCheckParams, HostingMigrationsEvent200, HostingMigrationsEventBody, HostingNameservers200, HostingNameserversV2200, HostingOnboardingData200, HostingOnboardingDataUpdate200, HostingOnboardingDataUpdateBody, HostingRedirect200, HostingRedirectBody, HostingRedirects200Item, HostingRedirectsV2200Item, HostingResellerSsoWhm200, HostingShellInfo200, HostingShellToggle200, HostingShellToggleBody, HostingSiteAdd200, HostingSiteAddBody, HostingSiteAddV2200, HostingSiteAddV2Body, HostingSitesV2200, HostingSitesV2Params, HostingSshInfo200, HostingVisitors200, HostingVisitorsParams, Index200, IndexBody, JetpackBackupStatus200, ListCrons200, ListFiles200, ListFilesParams, ListFilesV2200, ListFilesV2Params, ListIndex200, ListIndexParams, Privacy200, PrivacyBody, PrivacyUser200, PrivacyUserBody, RepairDatabase200, RepairDatabaseBody, ResetSite200, ResetSiteBody, Site200, SiteAddonCloudflare200, SiteAddonCloudflare400, SiteBody, SiteInfoResponseModelV2, SiteIpaddress200, SiteIpaddressBody, SiteIpaddressList200Item, SiteMalwareStatus200, SitePendingDomainDelete200, SitePluginUpdate200, SitePluginUpdateBody, SitePlugins200, SitePluginsAutoupdate200, SitePluginsAutoupdateBody, SitePluginsParams, SitePluginsToggle200, SitePluginsToggleBody, SitePluginsUpdate200, SitePluginsUpdateBody, SiteStatus200, SiteUpdate200, SiteUpdate400, SiteUpdateBody, SiteUsers200, SitesAccessLogs200, SitesAccessLogsDownloadParams, SitesAccessLogsParams, SitesAutoupdatesResponse, SitesAutoupdatesUpdateBody, SitesBackups200, SitesBackupsCodeguard200, SitesBackupsDetails200, SitesBatch200, SitesBatchBody, SitesDatabaseInfo200, SitesDatabasePasswordsync200, SitesDns200, SitesDnsParams, SitesDomain200, SitesDomainParams, SitesDomainUrl200, SitesDomainUrlBody, SitesDomainsCreate200, SitesDomainsCreateBody, SitesDomainsV2200, SitesDomainsV2Params, SitesErrorLogs200, SitesErrorLogsDownloadParams, SitesErrorLogsParams, SitesHasBackups200, SitesInfo200, SitesListV2200, SitesListV3200, SitesListV3Params, SitesMetricDimensions200, SitesMetricDimensionsParams, SitesMetricsDimensionAveraged200, SitesMetricsDimensionAveragedParams, SitesPerformanceCachepurge200, SitesPerformanceCachepurgeBody, SitesPerformanceEdgecache200, SitesPerformanceEdgecacheBody, SitesPerformanceEnduranceCacheLevel200, SitesPerformanceEnduranceCacheLevelBody, SitesPerformanceEnduranceCacheLevelStatus200, SitesPerformanceEndurancePageCache200, SitesSecurityBundle200, SitesSecurityCheckCore200, SitesSecurityHttpsEnableDisableSsl200, SitesSecurityHttpsEnableDisableSslBody, SitesSecurityHttpsRedirectionStatus200, SitesSecurityResetCoreFiles200, SitesSecuritySitelock200, SitesSecuritySitelockParams, SitesSecuritySitelockV2200, SitesSecuritySitelockV2Params, SitesSecuritySslAcme200, SitesSecuritySslStatus200, SitesSecuritySslStatusParams, SitesSettingsComingSoon200, SitesSettingsComingSoonToggle200, SitesSettingsComingSoonToggleBody, SitesSettingsDebug200, SitesSettingsDebugToggle200, SitesSettingsDebugToggleBody, SitesSettingsPhpVersionUpdate200, SitesSettingsPhpVersionUpdateBody, SitesSettingsPhpVersions200, SitesSshUserCreate200, SitesSshUserCreateBody, SitesSshUserDelete200, SitesSshUserDeleteBody, SitesSshUserList200, SitesSshUserListV2200, SitesSshUserUpdate200, SitesSshUserUpdateBody, SitesSsl200, SitesSso200, SitesSsoParams, SitesVersion200, SshKey200, SshKeyBody, SshKeyFetch200, SshKeyFetchParams, SshKeyGenerate200, SshKeyGenerateBody, SshKeyImport200, SshKeyImportBody, SshKeyImportV2200, SshKeyImportV2Body, SshKeyImportV3200, SshKeyImportV3Body, SshKeyList200, SshKeyListV2200, SshKeyListV3200, SshKeyListV4200, SshKeyV2200, SshKeyV2Body, Sso200, SsoParams, StagingSitePromote200, StagingSitePromoteBody, UpdateCron200, UpdateCronBody, WebzaiSso200, WeeblySso200 } from './index.schemas';
4
+ import type { AccountEventList200, AccountEventListParams, AccountHostingList200, AccountPublicKey200, AccountPublicKey404, AccountPublicKeyCreate200, AccountPublicKeyCreate409, AccountPublicKeyCreateBody, AccountPublicKeyDelete200, AccountPublicKeyDelete404, AccountPublicKeyToggle200, AccountPublicKeyToggle409, AccountPublicKeyToggleBody, AccountPublicKeys200, ActivityLog200, ActivityLogParams, AddCron200, AddCron400, AddCronBody, AddHostingRedirects200, AddHostingRedirectsBody, AddIndex200, AddIndexBody, AddPrivacy200, AddPrivacyBody, AddSiteIpaddress200, AddSiteIpaddressBody, AddonCloudflare200, AddonCloudflareBody, AddonsCloudflare200, AddonsInfo200, AddonsJetpackValidate200, AddonsSitelockSso200, AddonsSitelockSsoV2200, AddonsSitelockSsoV2Params, AddonsSpamexpertsSso200, BackupCreateV2200, BackupCreateV2Body, BackupDownloadV2200, BackupDownloadV2Body, BackupInitiate200, BackupInitiateBody, BackupList200, BackupListParams, BackupListV2200, BackupRestoreV2200, BackupRestoreV2Body, BackupStatus200, BackupStatusParams, BackupStatusV2200, BackupStatusV2Params, BackupsJetpackBackup200, CodeguardBackupCreate200, CodeguardBackupCreateBody, CodeguardBackupDownload200, CodeguardBackupDownloadBody, CodeguardBackupList200, CodeguardBackupListParams, CodeguardBackupRestore200, CodeguardBackupRestoreBody, CodeguardDatabaseBackupCreate200, CodeguardDatabaseBackupCreateBody, CodeguardDatabaseBackupList200, CodeguardDatabaseBackupListParams, CodeguardDatabaseBackupRestore200, CodeguardDatabaseBackupRestoreBody, CodeguardDatabaseList200, CodeguardLoginLink200, CodeguardPlanInfo200, CodeguardWebsiteBackupCreate200, CodeguardWebsiteBackupCreateBody, CodeguardWebsiteBackupList200, CodeguardWebsiteBackupListParams, CodeguardWebsiteBackupRestore200, CodeguardWebsiteBackupRestoreBody, CodeguardWebsiteList200, CreatePhpInfo200, Cron200, CronBody, Db200, DbAdd200, DbAddBody, DbBody, DbCheckDatabase200, DbCheckDatabaseBody, DbList200, DbListV2200, DbMultipleUserDatabase200, DbMultipleUserDatabaseBody, DbUsage200, DbUserAdd200, DbUserAddBody, DbUserDelete200, DbUserDeleteBody, DbUserList200, DbUserPasswordSet200, DbUserPasswordSetBody, DbUserPrivsGet200, DbUserPrivsGetParams, DbUserPrivsSet200, DbUserPrivsSetBody, DbUserRename200, DbUserRenameBody, DirectoryPrivacy200, DirectoryPrivacyParams, DomainCertInstall200, DomainCertInstallBody, DomainCertUninstall200, DomainCertUpdate200, DomainCertUpdateBody, DomainCerts200, DomainDnsExport200, DomainDnsExportParams, DomainDnseditor200, DomainDnseditorAdd200, DomainDnseditorAddBody, DomainDnseditorBody, DomainDnseditorEdit200, DomainDnseditorEditBody, DomainDnseditorList200Item, DomainDnszoneReset200, DomainInfo200, DomainUnassign200, DomainZoneeditorUrl200, Domains200, DomainsParams, EditPrivacy200, EditPrivacyBody, HostingAccount200, HostingAddons200, HostingAddonsParams, HostingAdvancedDomainServices200, HostingAdvancedDomainServicesBody, HostingAdvancedDomainServicesCheck200, HostingAdvancedPassword200, HostingAdvancedPasswordBody, HostingAdvancedServer200, HostingAdvancedServerStatus200, HostingAdvancedServerStatusBody, HostingAdvancedSsoWhm200, HostingAdvancedSystemConsole200, HostingCapabilities200, HostingDbAuthorizedHosts200, HostingDbAuthorizedHostsAdd200, HostingDbAuthorizedHostsAddBody, HostingDbAuthorizedHostsDelete200, HostingDbAuthorizedHostsDeleteBody, HostingDbAuthorizedHostsUpdate200, HostingDbAuthorizedHostsUpdateBody, HostingDomainAssign200, HostingDomainAssignBody, HostingDomainAvailability200, HostingDomainAvailabilityParams, HostingDomainsUnassign200, HostingDomainsUnassignBody, HostingDomainsUnassignV2200, HostingDomainsUnassignV2Body, HostingEcommerceInfo200, HostingFixownership200, HostingFtp200, HostingFtpAdd200, HostingFtpAddBody, HostingFtpBody, HostingFtpList200, HostingFtpUpdate200, HostingFtpUpdateBody, HostingInfo200, HostingInfoDiskUsage200, HostingLead200, HostingLead400, HostingLeadParams, HostingMigrationInfo200, HostingMigrationInfoParams, HostingMigrationSiteScanStatus200, HostingMigrationSiteScanStatusParams, HostingMigrationStatus200, HostingMigrations200, HostingMigrationsBody, HostingMigrationsCheck200, HostingMigrationsCheckParams, HostingMigrationsEvent200, HostingMigrationsEventBody, HostingNameservers200, HostingNameserversV2200, HostingOnboardingData200, HostingOnboardingDataUpdate200, HostingOnboardingDataUpdateBody, HostingRedirect200, HostingRedirectBody, HostingRedirects200Item, HostingRedirectsV2200Item, HostingResellerSsoWhm200, HostingShellInfo200, HostingShellToggle200, HostingShellToggleBody, HostingSiteAdd200, HostingSiteAddBody, HostingSiteAddV2200, HostingSiteAddV2Body, HostingSitesV2200, HostingSitesV2Params, HostingSshInfo200, HostingVisitors200, HostingVisitorsParams, Index200, IndexBody, JetpackBackupStatus200, ListCrons200, ListFiles200, ListFilesParams, ListFilesV2200, ListFilesV2Params, ListIndex200, ListIndexParams, Privacy200, PrivacyBody, PrivacyUser200, PrivacyUserBody, RepairDatabase200, RepairDatabaseBody, ResetSite200, ResetSiteBody, Site200, SiteAddonCloudflare200, SiteAddonCloudflare400, SiteBody, SiteInfoResponseModelV2, SiteIpaddress200, SiteIpaddressBody, SiteIpaddressList200Item, SiteMalwareStatus200, SitePendingDomainDelete200, SitePluginUpdate200, SitePluginUpdateBody, SitePlugins200, SitePluginsAutoupdate200, SitePluginsAutoupdateBody, SitePluginsParams, SitePluginsToggle200, SitePluginsToggleBody, SitePluginsUpdate200, SitePluginsUpdateBody, SiteQualityMetrics200, SiteQualityMetricsParams, SiteStatus200, SiteUpdate200, SiteUpdate400, SiteUpdateBody, SiteUsers200, SitesAccessLogs200, SitesAccessLogsDownloadParams, SitesAccessLogsParams, SitesAutoupdatesResponse, SitesAutoupdatesUpdateBody, SitesBackups200, SitesBackupsCodeguard200, SitesBackupsDetails200, SitesBatch200, SitesBatchBody, SitesDatabaseInfo200, SitesDatabasePasswordsync200, SitesDns200, SitesDnsParams, SitesDomain200, SitesDomainParams, SitesDomainUrl200, SitesDomainUrlBody, SitesDomainsCreate200, SitesDomainsCreateBody, SitesDomainsV2200, SitesDomainsV2Params, SitesErrorLogs200, SitesErrorLogsDownloadParams, SitesErrorLogsParams, SitesHasBackups200, SitesInfo200, SitesListV2200, SitesListV3200, SitesListV3Params, SitesMetricDimensions200, SitesMetricDimensionsParams, SitesMetricsDimensionAveraged200, SitesMetricsDimensionAveragedParams, SitesPerformanceCachepurge200, SitesPerformanceCachepurgeBody, SitesPerformanceEdgecache200, SitesPerformanceEdgecacheBody, SitesPerformanceEnduranceCacheLevel200, SitesPerformanceEnduranceCacheLevelBody, SitesPerformanceEnduranceCacheLevelStatus200, SitesPerformanceEndurancePageCache200, SitesSecurityBundle200, SitesSecurityCheckCore200, SitesSecurityHttpsEnableDisableSsl200, SitesSecurityHttpsEnableDisableSslBody, SitesSecurityHttpsRedirectionStatus200, SitesSecurityResetCoreFiles200, SitesSecuritySitelock200, SitesSecuritySitelockParams, SitesSecuritySitelockV2200, SitesSecuritySitelockV2Params, SitesSecuritySslAcme200, SitesSecuritySslStatus200, SitesSecuritySslStatusParams, SitesSettingsComingSoon200, SitesSettingsComingSoonToggle200, SitesSettingsComingSoonToggleBody, SitesSettingsDebug200, SitesSettingsDebugToggle200, SitesSettingsDebugToggleBody, SitesSettingsPhpVersionUpdate200, SitesSettingsPhpVersionUpdateBody, SitesSettingsPhpVersions200, SitesSshUserCreate200, SitesSshUserCreateBody, SitesSshUserDelete200, SitesSshUserDeleteBody, SitesSshUserList200, SitesSshUserListV2200, SitesSshUserUpdate200, SitesSshUserUpdateBody, SitesSsl200, SitesSso200, SitesSsoParams, SitesVersion200, SshKey200, SshKeyBody, SshKeyFetch200, SshKeyFetchParams, SshKeyGenerate200, SshKeyGenerateBody, SshKeyImport200, SshKeyImportBody, SshKeyImportV2200, SshKeyImportV2Body, SshKeyImportV3200, SshKeyImportV3Body, SshKeyList200, SshKeyListV2200, SshKeyListV3200, SshKeyListV4200, SshKeyV2200, SshKeyV2Body, Sso200, SsoParams, StagingSitePromote200, StagingSitePromoteBody, UpdateCron200, UpdateCronBody, WebzaiSso200, WeeblySso200 } from './index.schemas';
5
5
  declare type AwaitedInput<T> = PromiseLike<T> | T;
6
6
  declare type Awaited<O> = O extends AwaitedInput<infer T> ? T : never;
7
7
  /**
@@ -5199,6 +5199,38 @@ export declare const useSitePluginsUpdate: <TError = AxiosError<unknown, any>, T
5199
5199
  siteId: string;
5200
5200
  data: SitePluginsUpdateBody;
5201
5201
  }, TContext>;
5202
+ /**
5203
+ * Returns metric for a site url from pagespeed
5204
+ * @summary get pagespeed index api data for a site
5205
+ */
5206
+ export declare const siteQualityMetrics: (siteId: string, params: SiteQualityMetricsParams, options?: AxiosRequestConfig) => Promise<AxiosResponse<SiteQualityMetrics200>>;
5207
+ export declare const getSiteQualityMetricsQueryKey: (siteId: string, params: SiteQualityMetricsParams) => readonly [`/v1/sites/${string}/quality-metrics`, ...SiteQualityMetricsParams[]];
5208
+ export declare const getSiteQualityMetricsQueryOptions: <TData = AxiosResponse<SiteQualityMetrics200, any>, TError = AxiosError<unknown, any>>(siteId: string, params: SiteQualityMetricsParams, options?: {
5209
+ query?: Partial<UseQueryOptions<AxiosResponse<SiteQualityMetrics200, any>, TError, TData, QueryKey>> | undefined;
5210
+ axios?: AxiosRequestConfig<any> | undefined;
5211
+ } | undefined) => UseQueryOptions<AxiosResponse<SiteQualityMetrics200, any>, TError, TData, QueryKey> & {
5212
+ queryKey: QueryKey;
5213
+ };
5214
+ export declare type SiteQualityMetricsQueryResult = NonNullable<Awaited<ReturnType<typeof siteQualityMetrics>>>;
5215
+ export declare type SiteQualityMetricsQueryError = AxiosError<unknown>;
5216
+ export declare function useSiteQualityMetrics<TData = Awaited<ReturnType<typeof siteQualityMetrics>>, TError = AxiosError<unknown>>(siteId: string, params: SiteQualityMetricsParams, options: {
5217
+ query: Partial<UseQueryOptions<Awaited<ReturnType<typeof siteQualityMetrics>>, TError, TData>> & Pick<DefinedInitialDataOptions<Awaited<ReturnType<typeof siteQualityMetrics>>, TError, TData>, 'initialData'>;
5218
+ axios?: AxiosRequestConfig;
5219
+ }): DefinedUseQueryResult<TData, TError> & {
5220
+ queryKey: QueryKey;
5221
+ };
5222
+ export declare function useSiteQualityMetrics<TData = Awaited<ReturnType<typeof siteQualityMetrics>>, TError = AxiosError<unknown>>(siteId: string, params: SiteQualityMetricsParams, options?: {
5223
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof siteQualityMetrics>>, TError, TData>> & Pick<UndefinedInitialDataOptions<Awaited<ReturnType<typeof siteQualityMetrics>>, TError, TData>, 'initialData'>;
5224
+ axios?: AxiosRequestConfig;
5225
+ }): UseQueryResult<TData, TError> & {
5226
+ queryKey: QueryKey;
5227
+ };
5228
+ export declare function useSiteQualityMetrics<TData = Awaited<ReturnType<typeof siteQualityMetrics>>, TError = AxiosError<unknown>>(siteId: string, params: SiteQualityMetricsParams, options?: {
5229
+ query?: Partial<UseQueryOptions<Awaited<ReturnType<typeof siteQualityMetrics>>, TError, TData>>;
5230
+ axios?: AxiosRequestConfig;
5231
+ }): UseQueryResult<TData, TError> & {
5232
+ queryKey: QueryKey;
5233
+ };
5202
5234
  /**
5203
5235
  * Resets a site - deletes/reinstalls the site.
5204
5236
  * @summary reset site
package/src/index.js CHANGED
@@ -3,7 +3,7 @@
3
3
  * Do not edit manually.
4
4
  * Hosting UAPI
5
5
  * Hosting UAPI is an API to expose Hosting, Addons, and Site functionality to a customer-facing Front End such as (Account Manager).
6
- * OpenAPI spec version: 1.1234.0
6
+ * OpenAPI spec version: 1.1240.0
7
7
  */
8
8
  import { useInfiniteQuery, useMutation, useQuery } from '@tanstack/react-query';
9
9
  import axios from 'axios';
@@ -4014,6 +4014,32 @@ export const useSitePluginsUpdate = (options) => {
4014
4014
  const mutationOptions = getSitePluginsUpdateMutationOptions(options);
4015
4015
  return useMutation(mutationOptions);
4016
4016
  };
4017
+ /**
4018
+ * Returns metric for a site url from pagespeed
4019
+ * @summary get pagespeed index api data for a site
4020
+ */
4021
+ export const siteQualityMetrics = (siteId, params, options) => {
4022
+ return axios.get(`/v1/sites/${siteId}/quality-metrics`, Object.assign(Object.assign({}, options), { params: Object.assign(Object.assign({}, params), options === null || options === void 0 ? void 0 : options.params) }));
4023
+ };
4024
+ export const getSiteQualityMetricsQueryKey = (siteId, params) => {
4025
+ return [`/v1/sites/${siteId}/quality-metrics`, ...(params ? [params] : [])];
4026
+ };
4027
+ export const getSiteQualityMetricsQueryOptions = (siteId, params, options) => {
4028
+ var _a;
4029
+ const { query: queryOptions, axios: axiosOptions } = options !== null && options !== void 0 ? options : {};
4030
+ const queryKey = (_a = queryOptions === null || queryOptions === void 0 ? void 0 : queryOptions.queryKey) !== null && _a !== void 0 ? _a : getSiteQualityMetricsQueryKey(siteId, params);
4031
+ const queryFn = ({ signal }) => siteQualityMetrics(siteId, params, Object.assign({ signal }, axiosOptions));
4032
+ return Object.assign({ queryKey, queryFn, enabled: !!(siteId) }, queryOptions);
4033
+ };
4034
+ /**
4035
+ * @summary get pagespeed index api data for a site
4036
+ */
4037
+ export function useSiteQualityMetrics(siteId, params, options) {
4038
+ const queryOptions = getSiteQualityMetricsQueryOptions(siteId, params, options);
4039
+ const query = useQuery(queryOptions);
4040
+ query.queryKey = queryOptions.queryKey;
4041
+ return query;
4042
+ }
4017
4043
  /**
4018
4044
  * Resets a site - deletes/reinstalls the site.
4019
4045
  * @summary reset site
@@ -1,5 +1,5 @@
1
1
  import { http } from 'msw';
2
- import type { AccountEventList200, AccountHostingList200, AccountPublicKey200, AccountPublicKeyCreate200, AccountPublicKeyDelete200, AccountPublicKeyToggle200, AccountPublicKeys200, ActivityLog200, AddCron200, AddHostingRedirects200, AddIndex200, AddPrivacy200, AddSiteIpaddress200, AddonCloudflare200, AddonsCloudflare200, AddonsInfo200, AddonsJetpackValidate200, AddonsSitelockSso200, AddonsSitelockSsoV2200, AddonsSpamexpertsSso200, BackupCreateV2200, BackupDownloadV2200, BackupInitiate200, BackupList200, BackupListV2200, BackupRestoreV2200, BackupStatus200, BackupStatusV2200, BackupsJetpackBackup200, CodeguardBackupCreate200, CodeguardBackupDownload200, CodeguardBackupList200, CodeguardBackupRestore200, CodeguardDatabaseBackupCreate200, CodeguardDatabaseBackupList200, CodeguardDatabaseBackupRestore200, CodeguardDatabaseList200, CodeguardLoginLink200, CodeguardPlanInfo200, CodeguardWebsiteBackupCreate200, CodeguardWebsiteBackupList200, CodeguardWebsiteBackupRestore200, CodeguardWebsiteList200, CreatePhpInfo200, Cron200, Db200, DbAdd200, DbCheckDatabase200, DbList200, DbListV2200, DbMultipleUserDatabase200, DbUsage200, DbUserAdd200, DbUserDelete200, DbUserList200, DbUserPasswordSet200, DbUserPrivsGet200, DbUserPrivsSet200, DbUserRename200, DirectoryPrivacy200, DomainCertInstall200, DomainCertUninstall200, DomainCertUpdate200, DomainCerts200, DomainDnsExport200, DomainDnseditor200, DomainDnseditorAdd200, DomainDnseditorEdit200, DomainDnseditorList200Item, DomainDnszoneReset200, DomainInfo200, DomainUnassign200, DomainZoneeditorUrl200, Domains200, EditPrivacy200, HostingAccount200, HostingAddons200, HostingAdvancedDomainServices200, HostingAdvancedDomainServicesCheck200, HostingAdvancedPassword200, HostingAdvancedServer200, HostingAdvancedServerStatus200, HostingAdvancedSsoWhm200, HostingAdvancedSystemConsole200, HostingCapabilities200, HostingDbAuthorizedHosts200, HostingDbAuthorizedHostsAdd200, HostingDbAuthorizedHostsDelete200, HostingDbAuthorizedHostsUpdate200, HostingDomainAssign200, HostingDomainAvailability200, HostingDomainsUnassign200, HostingDomainsUnassignV2200, HostingEcommerceInfo200, HostingFixownership200, HostingFtp200, HostingFtpAdd200, HostingFtpList200, HostingFtpUpdate200, HostingInfo200, HostingInfoDiskUsage200, HostingLead200, HostingMigrationInfo200, HostingMigrationSiteScanStatus200, HostingMigrationStatus200, HostingMigrations200, HostingMigrationsCheck200, HostingMigrationsEvent200, HostingNameservers200, HostingNameserversV2200, HostingOnboardingData200, HostingOnboardingDataUpdate200, HostingRedirect200, HostingRedirects200Item, HostingRedirectsV2200Item, HostingResellerSsoWhm200, HostingShellInfo200, HostingShellToggle200, HostingSiteAdd200, HostingSiteAddV2200, HostingSitesV2200, HostingSshInfo200, HostingVisitors200, Index200, JetpackBackupStatus200, ListCrons200, ListFiles200, ListFilesV2200, ListIndex200, Privacy200, PrivacyUser200, RepairDatabase200, ResetSite200, Site200, SiteAddonCloudflare200, SiteInfoResponseModelV2, SiteIpaddress200, SiteIpaddressList200Item, SiteMalwareStatus200, SitePendingDomainDelete200, SitePluginUpdate200, SitePlugins200, SitePluginsAutoupdate200, SitePluginsToggle200, SitePluginsUpdate200, SiteStatus200, SiteUpdate200, SiteUsers200, SitesAccessLogs200, SitesAutoupdatesResponse, SitesBackups200, SitesBackupsCodeguard200, SitesBackupsDetails200, SitesBatch200, SitesDatabaseInfo200, SitesDatabasePasswordsync200, SitesDns200, SitesDomain200, SitesDomainUrl200, SitesDomainsCreate200, SitesDomainsV2200, SitesErrorLogs200, SitesHasBackups200, SitesInfo200, SitesListV2200, SitesListV3200, SitesMetricDimensions200, SitesMetricsDimensionAveraged200, SitesPerformanceCachepurge200, SitesPerformanceEdgecache200, SitesPerformanceEnduranceCacheLevel200, SitesPerformanceEnduranceCacheLevelStatus200, SitesPerformanceEndurancePageCache200, SitesSecurityBundle200, SitesSecurityCheckCore200, SitesSecurityHttpsEnableDisableSsl200, SitesSecurityHttpsRedirectionStatus200, SitesSecurityResetCoreFiles200, SitesSecuritySitelock200, SitesSecuritySitelockV2200, SitesSecuritySslAcme200, SitesSecuritySslStatus200, SitesSettingsComingSoon200, SitesSettingsComingSoonToggle200, SitesSettingsDebug200, SitesSettingsDebugToggle200, SitesSettingsPhpVersionUpdate200, SitesSettingsPhpVersions200, SitesSshUserCreate200, SitesSshUserDelete200, SitesSshUserList200, SitesSshUserListV2200, SitesSshUserUpdate200, SitesSsl200, SitesSso200, SitesVersion200, SshKey200, SshKeyFetch200, SshKeyGenerate200, SshKeyImport200, SshKeyImportV2200, SshKeyImportV3200, SshKeyList200, SshKeyListV2200, SshKeyListV3200, SshKeyListV4200, SshKeyV2200, Sso200, StagingSitePromote200, UpdateCron200, WebzaiSso200, WeeblySso200 } from './index.schemas';
2
+ import type { AccountEventList200, AccountHostingList200, AccountPublicKey200, AccountPublicKeyCreate200, AccountPublicKeyDelete200, AccountPublicKeyToggle200, AccountPublicKeys200, ActivityLog200, AddCron200, AddHostingRedirects200, AddIndex200, AddPrivacy200, AddSiteIpaddress200, AddonCloudflare200, AddonsCloudflare200, AddonsInfo200, AddonsJetpackValidate200, AddonsSitelockSso200, AddonsSitelockSsoV2200, AddonsSpamexpertsSso200, BackupCreateV2200, BackupDownloadV2200, BackupInitiate200, BackupList200, BackupListV2200, BackupRestoreV2200, BackupStatus200, BackupStatusV2200, BackupsJetpackBackup200, CodeguardBackupCreate200, CodeguardBackupDownload200, CodeguardBackupList200, CodeguardBackupRestore200, CodeguardDatabaseBackupCreate200, CodeguardDatabaseBackupList200, CodeguardDatabaseBackupRestore200, CodeguardDatabaseList200, CodeguardLoginLink200, CodeguardPlanInfo200, CodeguardWebsiteBackupCreate200, CodeguardWebsiteBackupList200, CodeguardWebsiteBackupRestore200, CodeguardWebsiteList200, CreatePhpInfo200, Cron200, Db200, DbAdd200, DbCheckDatabase200, DbList200, DbListV2200, DbMultipleUserDatabase200, DbUsage200, DbUserAdd200, DbUserDelete200, DbUserList200, DbUserPasswordSet200, DbUserPrivsGet200, DbUserPrivsSet200, DbUserRename200, DirectoryPrivacy200, DomainCertInstall200, DomainCertUninstall200, DomainCertUpdate200, DomainCerts200, DomainDnsExport200, DomainDnseditor200, DomainDnseditorAdd200, DomainDnseditorEdit200, DomainDnseditorList200Item, DomainDnszoneReset200, DomainInfo200, DomainUnassign200, DomainZoneeditorUrl200, Domains200, EditPrivacy200, HostingAccount200, HostingAddons200, HostingAdvancedDomainServices200, HostingAdvancedDomainServicesCheck200, HostingAdvancedPassword200, HostingAdvancedServer200, HostingAdvancedServerStatus200, HostingAdvancedSsoWhm200, HostingAdvancedSystemConsole200, HostingCapabilities200, HostingDbAuthorizedHosts200, HostingDbAuthorizedHostsAdd200, HostingDbAuthorizedHostsDelete200, HostingDbAuthorizedHostsUpdate200, HostingDomainAssign200, HostingDomainAvailability200, HostingDomainsUnassign200, HostingDomainsUnassignV2200, HostingEcommerceInfo200, HostingFixownership200, HostingFtp200, HostingFtpAdd200, HostingFtpList200, HostingFtpUpdate200, HostingInfo200, HostingInfoDiskUsage200, HostingLead200, HostingMigrationInfo200, HostingMigrationSiteScanStatus200, HostingMigrationStatus200, HostingMigrations200, HostingMigrationsCheck200, HostingMigrationsEvent200, HostingNameservers200, HostingNameserversV2200, HostingOnboardingData200, HostingOnboardingDataUpdate200, HostingRedirect200, HostingRedirects200Item, HostingRedirectsV2200Item, HostingResellerSsoWhm200, HostingShellInfo200, HostingShellToggle200, HostingSiteAdd200, HostingSiteAddV2200, HostingSitesV2200, HostingSshInfo200, HostingVisitors200, Index200, JetpackBackupStatus200, ListCrons200, ListFiles200, ListFilesV2200, ListIndex200, Privacy200, PrivacyUser200, RepairDatabase200, ResetSite200, Site200, SiteAddonCloudflare200, SiteInfoResponseModelV2, SiteIpaddress200, SiteIpaddressList200Item, SiteMalwareStatus200, SitePendingDomainDelete200, SitePluginUpdate200, SitePlugins200, SitePluginsAutoupdate200, SitePluginsToggle200, SitePluginsUpdate200, SiteQualityMetrics200, SiteStatus200, SiteUpdate200, SiteUsers200, SitesAccessLogs200, SitesAutoupdatesResponse, SitesBackups200, SitesBackupsCodeguard200, SitesBackupsDetails200, SitesBatch200, SitesDatabaseInfo200, SitesDatabasePasswordsync200, SitesDns200, SitesDomain200, SitesDomainUrl200, SitesDomainsCreate200, SitesDomainsV2200, SitesErrorLogs200, SitesHasBackups200, SitesInfo200, SitesListV2200, SitesListV3200, SitesMetricDimensions200, SitesMetricsDimensionAveraged200, SitesPerformanceCachepurge200, SitesPerformanceEdgecache200, SitesPerformanceEnduranceCacheLevel200, SitesPerformanceEnduranceCacheLevelStatus200, SitesPerformanceEndurancePageCache200, SitesSecurityBundle200, SitesSecurityCheckCore200, SitesSecurityHttpsEnableDisableSsl200, SitesSecurityHttpsRedirectionStatus200, SitesSecurityResetCoreFiles200, SitesSecuritySitelock200, SitesSecuritySitelockV2200, SitesSecuritySslAcme200, SitesSecuritySslStatus200, SitesSettingsComingSoon200, SitesSettingsComingSoonToggle200, SitesSettingsDebug200, SitesSettingsDebugToggle200, SitesSettingsPhpVersionUpdate200, SitesSettingsPhpVersions200, SitesSshUserCreate200, SitesSshUserDelete200, SitesSshUserList200, SitesSshUserListV2200, SitesSshUserUpdate200, SitesSsl200, SitesSso200, SitesVersion200, SshKey200, SshKeyFetch200, SshKeyGenerate200, SshKeyImport200, SshKeyImportV2200, SshKeyImportV3200, SshKeyList200, SshKeyListV2200, SshKeyListV3200, SshKeyListV4200, SshKeyV2200, Sso200, StagingSitePromote200, UpdateCron200, WebzaiSso200, WeeblySso200 } from './index.schemas';
3
3
  export declare const getAccountEventListResponseMock: (overrideResponse?: Partial<AccountEventList200>) => AccountEventList200;
4
4
  export declare const getAccountHostingListResponseMock: (overrideResponse?: Partial<AccountHostingList200>) => AccountHostingList200;
5
5
  export declare const getAccountPublicKeysResponseMock: (overrideResponse?: Partial<AccountPublicKeys200>) => AccountPublicKeys200;
@@ -163,6 +163,7 @@ export declare const getSitePluginUpdateResponseMock: (overrideResponse?: Partia
163
163
  export declare const getSitePluginsAutoupdateResponseMock: (overrideResponse?: Partial<SitePluginsAutoupdate200>) => SitePluginsAutoupdate200;
164
164
  export declare const getSitePluginsToggleResponseMock: (overrideResponse?: Partial<SitePluginsToggle200>) => SitePluginsToggle200;
165
165
  export declare const getSitePluginsUpdateResponseMock: (overrideResponse?: Partial<SitePluginsUpdate200>) => SitePluginsUpdate200;
166
+ export declare const getSiteQualityMetricsResponseMock: (overrideResponse?: Partial<SiteQualityMetrics200>) => SiteQualityMetrics200;
166
167
  export declare const getResetSiteResponseMock: (overrideResponse?: Partial<ResetSite200>) => ResetSite200;
167
168
  export declare const getSitesSecurityBundleResponseMock: (overrideResponse?: Partial<SitesSecurityBundle200>) => SitesSecurityBundle200;
168
169
  export declare const getSitesSecurityCheckCoreResponseMock: (overrideResponse?: Partial<SitesSecurityCheckCore200>) => SitesSecurityCheckCore200;
@@ -378,6 +379,7 @@ export declare const getSitePluginUpdateMockHandler: (overrideResponse?: SitePlu
378
379
  export declare const getSitePluginsAutoupdateMockHandler: (overrideResponse?: SitePluginsAutoupdate200 | ((info: Parameters<Parameters<typeof http.post>[1]>[0]) => Promise<SitePluginsAutoupdate200> | SitePluginsAutoupdate200) | undefined) => import("msw/lib/core/handlers/HttpHandler").HttpHandler;
379
380
  export declare const getSitePluginsToggleMockHandler: (overrideResponse?: SitePluginsToggle200 | ((info: Parameters<Parameters<typeof http.post>[1]>[0]) => Promise<SitePluginsToggle200> | SitePluginsToggle200) | undefined) => import("msw/lib/core/handlers/HttpHandler").HttpHandler;
380
381
  export declare const getSitePluginsUpdateMockHandler: (overrideResponse?: SitePluginsUpdate200 | ((info: Parameters<Parameters<typeof http.post>[1]>[0]) => Promise<SitePluginsUpdate200> | SitePluginsUpdate200) | undefined) => import("msw/lib/core/handlers/HttpHandler").HttpHandler;
382
+ export declare const getSiteQualityMetricsMockHandler: (overrideResponse?: SiteQualityMetrics200 | ((info: Parameters<Parameters<typeof http.get>[1]>[0]) => Promise<SiteQualityMetrics200> | SiteQualityMetrics200) | undefined) => import("msw/lib/core/handlers/HttpHandler").HttpHandler;
381
383
  export declare const getResetSiteMockHandler: (overrideResponse?: ResetSite200 | ((info: Parameters<Parameters<typeof http.post>[1]>[0]) => Promise<ResetSite200> | ResetSite200) | undefined) => import("msw/lib/core/handlers/HttpHandler").HttpHandler;
382
384
  export declare const getSitesSecurityBundleMockHandler: (overrideResponse?: SitesSecurityBundle200 | ((info: Parameters<Parameters<typeof http.get>[1]>[0]) => Promise<SitesSecurityBundle200> | SitesSecurityBundle200) | undefined) => import("msw/lib/core/handlers/HttpHandler").HttpHandler;
383
385
  export declare const getSitesSecurityCheckCoreMockHandler: (overrideResponse?: SitesSecurityCheckCore200 | ((info: Parameters<Parameters<typeof http.get>[1]>[0]) => Promise<SitesSecurityCheckCore200> | SitesSecurityCheckCore200) | undefined) => import("msw/lib/core/handlers/HttpHandler").HttpHandler;
package/src/index.msw.js CHANGED
@@ -4,7 +4,7 @@ import { __awaiter } from "tslib";
4
4
  * Do not edit manually.
5
5
  * Hosting UAPI
6
6
  * Hosting UAPI is an API to expose Hosting, Addons, and Site functionality to a customer-facing Front End such as (Account Manager).
7
- * OpenAPI spec version: 1.1234.0
7
+ * OpenAPI spec version: 1.1240.0
8
8
  */
9
9
  import { faker } from '@faker-js/faker';
10
10
  import { HttpResponse, delay, http } from 'msw';
@@ -193,6 +193,7 @@ export const getSitePluginUpdateResponseMock = (overrideResponse = {}) => (Objec
193
193
  export const getSitePluginsAutoupdateResponseMock = (overrideResponse = {}) => (Object.assign({ success: faker.datatype.boolean() }, overrideResponse));
194
194
  export const getSitePluginsToggleResponseMock = (overrideResponse = {}) => (Object.assign({ success: faker.datatype.boolean() }, overrideResponse));
195
195
  export const getSitePluginsUpdateResponseMock = (overrideResponse = {}) => (Object.assign({ success: faker.datatype.boolean() }, overrideResponse));
196
+ export const getSiteQualityMetricsResponseMock = (overrideResponse = {}) => (Object.assign({ aspect_details: { performance: faker.helpers.arrayElement([{ 'cumulative-layout-shift': faker.helpers.arrayElement([{}, undefined]), 'first-contentful-paint': faker.helpers.arrayElement([{}, undefined]), 'largest-contentful-paint': faker.helpers.arrayElement([{}, undefined]), 'speed-index': faker.helpers.arrayElement([{}, undefined]), 'total-blocking-time': faker.helpers.arrayElement([{}, undefined]) }, undefined]) }, aspect_scores: { accessibility: faker.helpers.arrayElement([faker.number.int({ min: undefined, max: undefined }), undefined]), 'best-practices': faker.helpers.arrayElement([faker.number.int({ min: undefined, max: undefined }), undefined]), performance: faker.helpers.arrayElement([faker.number.int({ min: undefined, max: undefined }), undefined]), seo: faker.helpers.arrayElement([faker.number.int({ min: undefined, max: undefined }), undefined]) }, audits: {}, loading_experience: faker.helpers.arrayElement([{}, undefined]), origin_loading_experience: faker.helpers.arrayElement([{}, undefined]), strategy: faker.helpers.arrayElement([faker.word.sample(), undefined]) }, overrideResponse));
196
197
  export const getResetSiteResponseMock = (overrideResponse = {}) => (Object.assign({ previous_status: faker.word.sample(), status: faker.word.sample() }, overrideResponse));
197
198
  export const getSitesSecurityBundleResponseMock = (overrideResponse = {}) => (Object.assign({ eligible: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]) }, overrideResponse));
198
199
  export const getSitesSecurityCheckCoreResponseMock = (overrideResponse = {}) => (Object.assign({ results: faker.helpers.arrayElement([faker.word.sample(), undefined]), success: faker.helpers.arrayElement([faker.number.int({ min: undefined, max: undefined }), undefined]) }, overrideResponse));
@@ -221,7 +222,7 @@ export const getSitesVersionResponseMock = (overrideResponse = {}) => (Object.as
221
222
  export const getAddonsSitelockSsoV2ResponseMock = (overrideResponse = {}) => (Object.assign({ site_url: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), sitelock_id: faker.helpers.arrayElement([faker.word.sample(), undefined]), url: faker.helpers.arrayElement([faker.word.sample(), undefined]) }, overrideResponse));
222
223
  export const getBackupCreateV2ResponseMock = (overrideResponse = {}) => (Object.assign({ message: faker.helpers.arrayElement([faker.word.sample(), undefined]), tracking_id: faker.helpers.arrayElement([faker.number.int({ min: undefined, max: undefined }), undefined]) }, overrideResponse));
223
224
  export const getBackupDownloadV2ResponseMock = (overrideResponse = {}) => (Object.assign({ message: faker.helpers.arrayElement([faker.word.sample(), undefined]), tracking_id: faker.helpers.arrayElement([faker.number.int({ min: undefined, max: undefined }), undefined]) }, overrideResponse));
224
- export const getBackupListV2ResponseMock = (overrideResponse = {}) => (Object.assign({ backups: faker.helpers.arrayElement([Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ backup_creation_time: faker.helpers.arrayElement([faker.word.sample(), undefined]), backup_id: faker.helpers.arrayElement([faker.number.int({ min: undefined, max: undefined }), undefined]), databases: faker.helpers.arrayElement([Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => (faker.word.sample())), undefined]), type: faker.helpers.arrayElement([faker.word.sample(), undefined]) })), undefined]) }, overrideResponse));
225
+ export const getBackupListV2ResponseMock = (overrideResponse = {}) => (Object.assign({ backups: faker.helpers.arrayElement([Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ backup_creation_time: faker.helpers.arrayElement([faker.word.sample(), undefined]), backup_id: faker.helpers.arrayElement([faker.word.sample(), undefined]), databases: faker.helpers.arrayElement([Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => (faker.word.sample())), undefined]), type: faker.helpers.arrayElement([faker.word.sample(), undefined]) })), undefined]) }, overrideResponse));
225
226
  export const getBackupRestoreV2ResponseMock = (overrideResponse = {}) => (Object.assign({ message: faker.helpers.arrayElement([faker.word.sample(), undefined]), tracking_id: faker.helpers.arrayElement([faker.number.int({ min: undefined, max: undefined }), undefined]) }, overrideResponse));
226
227
  export const getBackupStatusV2ResponseMock = (overrideResponse = {}) => (Object.assign({ message: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), status: faker.helpers.arrayElement([faker.word.sample(), undefined]) }, overrideResponse));
227
228
  export const getDbListV2ResponseMock = (overrideResponse = {}) => (Object.assign({ databases: faker.helpers.arrayElement([Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ db: faker.helpers.arrayElement([faker.word.sample(), undefined]), sitename: faker.helpers.arrayElement([faker.word.sample(), undefined]), sizemib: faker.helpers.arrayElement([faker.word.sample(), undefined]), usercount: faker.helpers.arrayElement([faker.number.int({ min: undefined, max: undefined }), undefined]), userlist: faker.helpers.arrayElement([Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ db: faker.helpers.arrayElement([faker.word.sample(), undefined]), user: faker.helpers.arrayElement([faker.word.sample(), undefined]) })), undefined]) })), undefined]) }, overrideResponse));
@@ -1893,6 +1894,16 @@ export const getSitePluginsUpdateMockHandler = (overrideResponse) => {
1893
1894
  });
1894
1895
  }));
1895
1896
  };
1897
+ export const getSiteQualityMetricsMockHandler = (overrideResponse) => {
1898
+ return http.get('*/v1/sites/:siteId/quality-metrics', (info) => __awaiter(void 0, void 0, void 0, function* () {
1899
+ yield delay(1000);
1900
+ return new HttpResponse(JSON.stringify(overrideResponse !== undefined
1901
+ ? (typeof overrideResponse === "function" ? yield overrideResponse(info) : overrideResponse)
1902
+ : getSiteQualityMetricsResponseMock()), { status: 200,
1903
+ headers: { 'Content-Type': 'application/json' }
1904
+ });
1905
+ }));
1906
+ };
1896
1907
  export const getResetSiteMockHandler = (overrideResponse) => {
1897
1908
  return http.post('*/v1/sites/:siteId/reset', (info) => __awaiter(void 0, void 0, void 0, function* () {
1898
1909
  yield delay(1000);
@@ -2559,6 +2570,7 @@ export const getHostingUAPIMock = () => [
2559
2570
  getSitePluginsAutoupdateMockHandler(),
2560
2571
  getSitePluginsToggleMockHandler(),
2561
2572
  getSitePluginsUpdateMockHandler(),
2573
+ getSiteQualityMetricsMockHandler(),
2562
2574
  getResetSiteMockHandler(),
2563
2575
  getSitesSecurityBundleMockHandler(),
2564
2576
  getSitesSecurityCheckCoreMockHandler(),
@@ -3,7 +3,7 @@
3
3
  * Do not edit manually.
4
4
  * Hosting UAPI
5
5
  * Hosting UAPI is an API to expose Hosting, Addons, and Site functionality to a customer-facing Front End such as (Account Manager).
6
- * OpenAPI spec version: 1.1234.0
6
+ * OpenAPI spec version: 1.1240.0
7
7
  */
8
8
  export declare type SshKeyListV4200RowsItem = {
9
9
  authorize?: boolean;
@@ -203,6 +203,17 @@ export declare type SitesDomainsV2200 = {
203
203
  export declare type SitesDomainsV2Params = {
204
204
  scan?: boolean;
205
205
  };
206
+ export declare type SitesListV2200 = {
207
+ items?: SitesListV2200ItemsItem[];
208
+ /** page size */
209
+ limit?: number;
210
+ /** current page number */
211
+ page?: number;
212
+ /** total number of pages */
213
+ pages?: number;
214
+ /** total number of sites returned */
215
+ total?: number;
216
+ };
206
217
  /**
207
218
  * @nullable
208
219
  */
@@ -358,17 +369,6 @@ export declare type SitesListV2200ItemsItem = {
358
369
  */
359
370
  version_ptr?: string | null;
360
371
  };
361
- export declare type SitesListV2200 = {
362
- items?: SitesListV2200ItemsItem[];
363
- /** page size */
364
- limit?: number;
365
- /** current page number */
366
- page?: number;
367
- /** total number of pages */
368
- pages?: number;
369
- /** total number of sites returned */
370
- total?: number;
371
- };
372
372
  export declare type SshKeyV2200 = {
373
373
  deleted?: number;
374
374
  key_name?: string;
@@ -459,29 +459,6 @@ export declare type HostingSiteAddV2Body = {
459
459
  /** Number of PHP workers */
460
460
  workers?: number;
461
461
  };
462
- export declare type HostingSitesV2200 = {
463
- /**
464
- * Remaining number of sites the customer can create. Max sites - used sites. Null means 'unlimited'.
465
- * @nullable
466
- */
467
- available_sites?: number | null;
468
- items?: HostingSitesV2200ItemsItem[];
469
- /** page size */
470
- limit?: number;
471
- /**
472
- * Maximum number of sites the customer can have. Null means 'unlimited'.
473
- * @nullable
474
- */
475
- max_sites?: number | null;
476
- /** current page number */
477
- page?: number;
478
- /** total number of pages */
479
- pages?: number;
480
- /** total number of sites returned */
481
- total?: number;
482
- /** Current number of sites in use by the customer. its normal for this value to be different than the total number of sites in the list. */
483
- used_sites?: number;
484
- };
485
462
  /**
486
463
  * @nullable
487
464
  */
@@ -637,6 +614,29 @@ export declare type HostingSitesV2200ItemsItem = {
637
614
  */
638
615
  version_ptr?: string | null;
639
616
  };
617
+ export declare type HostingSitesV2200 = {
618
+ /**
619
+ * Remaining number of sites the customer can create. Max sites - used sites. Null means 'unlimited'.
620
+ * @nullable
621
+ */
622
+ available_sites?: number | null;
623
+ items?: HostingSitesV2200ItemsItem[];
624
+ /** page size */
625
+ limit?: number;
626
+ /**
627
+ * Maximum number of sites the customer can have. Null means 'unlimited'.
628
+ * @nullable
629
+ */
630
+ max_sites?: number | null;
631
+ /** current page number */
632
+ page?: number;
633
+ /** total number of pages */
634
+ pages?: number;
635
+ /** total number of sites returned */
636
+ total?: number;
637
+ /** Current number of sites in use by the customer. its normal for this value to be different than the total number of sites in the list. */
638
+ used_sites?: number;
639
+ };
640
640
  export declare type HostingSitesV2Params = {
641
641
  limit?: number;
642
642
  page?: number;
@@ -716,7 +716,7 @@ export declare type BackupRestoreV2200 = {
716
716
  };
717
717
  export declare type BackupRestoreV2Body = {
718
718
  /** Backup Volume store ID to get the backup */
719
- backup_id: number;
719
+ backup_id: string;
720
720
  /** Restore type */
721
721
  restore_type?: string;
722
722
  /** Site id */
@@ -724,7 +724,7 @@ export declare type BackupRestoreV2Body = {
724
724
  };
725
725
  export declare type BackupListV2200BackupsItem = {
726
726
  backup_creation_time?: string;
727
- backup_id?: number;
727
+ backup_id?: string;
728
728
  /** @nullable */
729
729
  databases?: string[] | null;
730
730
  type?: string;
@@ -738,7 +738,7 @@ export declare type BackupDownloadV2200 = {
738
738
  };
739
739
  export declare type BackupDownloadV2Body = {
740
740
  /** Backup Volume store ID to get the backup */
741
- backup_id: number;
741
+ backup_id: string;
742
742
  /** Type of the backup */
743
743
  backup_type?: string;
744
744
  dbs?: string[];
@@ -1035,6 +1035,63 @@ export declare type ResetSiteBody = {
1035
1035
  /** Site type to morph to */
1036
1036
  type?: string;
1037
1037
  };
1038
+ export declare type SiteQualityMetrics200OriginLoadingExperience = {
1039
+ [key: string]: unknown;
1040
+ };
1041
+ export declare type SiteQualityMetrics200LoadingExperience = {
1042
+ [key: string]: unknown;
1043
+ };
1044
+ export declare type SiteQualityMetrics200Audits = {
1045
+ [key: string]: unknown;
1046
+ };
1047
+ export declare type SiteQualityMetrics200AspectScores = {
1048
+ accessibility?: number;
1049
+ 'best-practices'?: number;
1050
+ performance?: number;
1051
+ seo?: number;
1052
+ };
1053
+ export declare type SiteQualityMetrics200AspectDetails = {
1054
+ performance?: SiteQualityMetrics200AspectDetailsPerformance;
1055
+ };
1056
+ export declare type SiteQualityMetrics200 = {
1057
+ aspect_details: SiteQualityMetrics200AspectDetails;
1058
+ aspect_scores: SiteQualityMetrics200AspectScores;
1059
+ audits: SiteQualityMetrics200Audits;
1060
+ loading_experience?: SiteQualityMetrics200LoadingExperience;
1061
+ origin_loading_experience?: SiteQualityMetrics200OriginLoadingExperience;
1062
+ strategy?: string;
1063
+ };
1064
+ export declare type SiteQualityMetrics200AspectDetailsPerformanceTotalBlockingTime = {
1065
+ [key: string]: unknown;
1066
+ };
1067
+ export declare type SiteQualityMetrics200AspectDetailsPerformanceSpeedIndex = {
1068
+ [key: string]: unknown;
1069
+ };
1070
+ export declare type SiteQualityMetrics200AspectDetailsPerformanceLargestContentfulPaint = {
1071
+ [key: string]: unknown;
1072
+ };
1073
+ export declare type SiteQualityMetrics200AspectDetailsPerformanceFirstContentfulPaint = {
1074
+ [key: string]: unknown;
1075
+ };
1076
+ export declare type SiteQualityMetrics200AspectDetailsPerformanceCumulativeLayoutShift = {
1077
+ [key: string]: unknown;
1078
+ };
1079
+ export declare type SiteQualityMetrics200AspectDetailsPerformance = {
1080
+ 'cumulative-layout-shift'?: SiteQualityMetrics200AspectDetailsPerformanceCumulativeLayoutShift;
1081
+ 'first-contentful-paint'?: SiteQualityMetrics200AspectDetailsPerformanceFirstContentfulPaint;
1082
+ 'largest-contentful-paint'?: SiteQualityMetrics200AspectDetailsPerformanceLargestContentfulPaint;
1083
+ 'speed-index'?: SiteQualityMetrics200AspectDetailsPerformanceSpeedIndex;
1084
+ 'total-blocking-time'?: SiteQualityMetrics200AspectDetailsPerformanceTotalBlockingTime;
1085
+ };
1086
+ export declare type SiteQualityMetricsStrategy = typeof SiteQualityMetricsStrategy[keyof typeof SiteQualityMetricsStrategy];
1087
+ export declare const SiteQualityMetricsStrategy: {
1088
+ readonly MOBILE: "MOBILE";
1089
+ readonly DESKTOP: "DESKTOP";
1090
+ readonly STRATEGY_UNSPECIFIED: "STRATEGY_UNSPECIFIED";
1091
+ };
1092
+ export declare type SiteQualityMetricsParams = {
1093
+ strategy: SiteQualityMetricsStrategy;
1094
+ };
1038
1095
  export declare type SitePluginsUpdate200 = {
1039
1096
  success: boolean;
1040
1097
  };
@@ -1133,6 +1190,25 @@ export declare type SitesMetricDimensions200DimensionsWpAdminAjaxActionItem = {
1133
1190
  dimension?: SitesMetricDimensions200DimensionsWpAdminAjaxActionItemDimension;
1134
1191
  timestamp?: number;
1135
1192
  };
1193
+ export declare type SitesMetricDimensions200Dimensions = {
1194
+ http_host?: SitesMetricDimensions200DimensionsHttpHostItem[];
1195
+ http_status?: SitesMetricDimensions200DimensionsHttpStatusItem[];
1196
+ http_verb?: SitesMetricDimensions200DimensionsHttpVerbItem[];
1197
+ http_version?: SitesMetricDimensions200DimensionsHttpVersionItem[];
1198
+ page_is_cached?: SitesMetricDimensions200DimensionsPageIsCachedItem[];
1199
+ page_renderer?: SitesMetricDimensions200DimensionsPageRendererItem[];
1200
+ visitor_asn?: SitesMetricDimensions200DimensionsVisitorAsnItem[];
1201
+ visitor_country_code?: SitesMetricDimensions200DimensionsVisitorCountryCodeItem[];
1202
+ visitor_is_crawler?: SitesMetricDimensions200DimensionsVisitorIsCrawlerItem[];
1203
+ wp_admin_ajax_action?: SitesMetricDimensions200DimensionsWpAdminAjaxActionItem[];
1204
+ };
1205
+ export declare type SitesMetricDimensions200 = {
1206
+ date_end?: string;
1207
+ date_start?: string;
1208
+ dimensions?: SitesMetricDimensions200Dimensions;
1209
+ elapsed?: number;
1210
+ metric?: string;
1211
+ };
1136
1212
  export declare type SitesMetricDimensions200DimensionsVisitorIsCrawlerItemDimension = {
1137
1213
  [key: string]: number;
1138
1214
  };
@@ -1175,25 +1251,6 @@ export declare type SitesMetricDimensions200DimensionsHttpVersionItem = {
1175
1251
  dimension?: SitesMetricDimensions200DimensionsHttpVersionItemDimension;
1176
1252
  timestamp?: number;
1177
1253
  };
1178
- export declare type SitesMetricDimensions200Dimensions = {
1179
- http_host?: SitesMetricDimensions200DimensionsHttpHostItem[];
1180
- http_status?: SitesMetricDimensions200DimensionsHttpStatusItem[];
1181
- http_verb?: SitesMetricDimensions200DimensionsHttpVerbItem[];
1182
- http_version?: SitesMetricDimensions200DimensionsHttpVersionItem[];
1183
- page_is_cached?: SitesMetricDimensions200DimensionsPageIsCachedItem[];
1184
- page_renderer?: SitesMetricDimensions200DimensionsPageRendererItem[];
1185
- visitor_asn?: SitesMetricDimensions200DimensionsVisitorAsnItem[];
1186
- visitor_country_code?: SitesMetricDimensions200DimensionsVisitorCountryCodeItem[];
1187
- visitor_is_crawler?: SitesMetricDimensions200DimensionsVisitorIsCrawlerItem[];
1188
- wp_admin_ajax_action?: SitesMetricDimensions200DimensionsWpAdminAjaxActionItem[];
1189
- };
1190
- export declare type SitesMetricDimensions200 = {
1191
- date_end?: string;
1192
- date_start?: string;
1193
- dimensions?: SitesMetricDimensions200Dimensions;
1194
- elapsed?: number;
1195
- metric?: string;
1196
- };
1197
1254
  export declare type SitesMetricDimensions200DimensionsHttpVerbItemDimension = {
1198
1255
  [key: string]: number;
1199
1256
  };
@@ -1652,63 +1709,6 @@ export declare type SitesInfo200Staging = {
1652
1709
  /** A list of staging sites of the current site */
1653
1710
  sites?: number[];
1654
1711
  } | null;
1655
- export declare type SitesInfo200ResourcesStorage = {
1656
- /** @nullable */
1657
- available?: number | null;
1658
- /** @nullable */
1659
- total?: number | null;
1660
- unit?: string;
1661
- /** @nullable */
1662
- used?: number | null;
1663
- };
1664
- export declare type SitesInfo200Resources = {
1665
- storage?: SitesInfo200ResourcesStorage;
1666
- /** @nullable */
1667
- workers?: number | null;
1668
- };
1669
- /**
1670
- * @nullable
1671
- */
1672
- export declare type SitesInfo200PendingUrlData = {
1673
- /**
1674
- * The root domain name
1675
- * @nullable
1676
- */
1677
- base_domain?: string | null;
1678
- /**
1679
- * The Fully Qualified Domain Name (FQDN)
1680
- * @nullable
1681
- */
1682
- domain?: string | null;
1683
- /**
1684
- * The current pending_url's HAL Domain ID
1685
- * @nullable
1686
- */
1687
- domain_id?: number | null;
1688
- /** @nullable */
1689
- error?: string | null;
1690
- /** Flag indicating whether the pending_url is temporary or not */
1691
- is_temp?: boolean;
1692
- /**
1693
- * Flag indicating whether the url_sync job has run out of attempts
1694
- * @nullable
1695
- */
1696
- job_failed?: boolean | null;
1697
- /** @nullable */
1698
- stage?: string | null;
1699
- /**
1700
- * Timestamp for when we will update the WP url, regardless of active sessions
1701
- * @nullable
1702
- */
1703
- wp_session?: string | null;
1704
- } | null;
1705
- /**
1706
- * Job ids for the site
1707
- * @nullable
1708
- */
1709
- export declare type SitesInfo200Jobs = {
1710
- [key: string]: unknown;
1711
- } | null;
1712
1712
  export declare type SitesInfo200 = {
1713
1713
  /** @nullable */
1714
1714
  account_back_ref?: string | null;
@@ -1781,6 +1781,63 @@ export declare type SitesInfo200 = {
1781
1781
  */
1782
1782
  version_ptr?: string | null;
1783
1783
  };
1784
+ export declare type SitesInfo200ResourcesStorage = {
1785
+ /** @nullable */
1786
+ available?: number | null;
1787
+ /** @nullable */
1788
+ total?: number | null;
1789
+ unit?: string;
1790
+ /** @nullable */
1791
+ used?: number | null;
1792
+ };
1793
+ export declare type SitesInfo200Resources = {
1794
+ storage?: SitesInfo200ResourcesStorage;
1795
+ /** @nullable */
1796
+ workers?: number | null;
1797
+ };
1798
+ /**
1799
+ * @nullable
1800
+ */
1801
+ export declare type SitesInfo200PendingUrlData = {
1802
+ /**
1803
+ * The root domain name
1804
+ * @nullable
1805
+ */
1806
+ base_domain?: string | null;
1807
+ /**
1808
+ * The Fully Qualified Domain Name (FQDN)
1809
+ * @nullable
1810
+ */
1811
+ domain?: string | null;
1812
+ /**
1813
+ * The current pending_url's HAL Domain ID
1814
+ * @nullable
1815
+ */
1816
+ domain_id?: number | null;
1817
+ /** @nullable */
1818
+ error?: string | null;
1819
+ /** Flag indicating whether the pending_url is temporary or not */
1820
+ is_temp?: boolean;
1821
+ /**
1822
+ * Flag indicating whether the url_sync job has run out of attempts
1823
+ * @nullable
1824
+ */
1825
+ job_failed?: boolean | null;
1826
+ /** @nullable */
1827
+ stage?: string | null;
1828
+ /**
1829
+ * Timestamp for when we will update the WP url, regardless of active sessions
1830
+ * @nullable
1831
+ */
1832
+ wp_session?: string | null;
1833
+ } | null;
1834
+ /**
1835
+ * Job ids for the site
1836
+ * @nullable
1837
+ */
1838
+ export declare type SitesInfo200Jobs = {
1839
+ [key: string]: unknown;
1840
+ } | null;
1784
1841
  export declare type HostingVisitors200VisitorsItem = {
1785
1842
  bandwidth?: number;
1786
1843
  hits?: number;
@@ -1791,15 +1848,6 @@ export declare type HostingVisitors200VisitorsItem = {
1791
1848
  unique_visitors?: number;
1792
1849
  visitors?: number;
1793
1850
  };
1794
- export declare type HostingVisitors200 = {
1795
- daily?: HostingVisitors200Daily;
1796
- total_bandwidth?: number;
1797
- total_hits?: number;
1798
- total_pages?: number;
1799
- total_unique_visitors?: number;
1800
- total_visitors?: number;
1801
- visitors?: HostingVisitors200VisitorsItem[];
1802
- };
1803
1851
  export declare type HostingVisitors200DailyTotal = {
1804
1852
  total_bandwidth?: number;
1805
1853
  total_hits?: number;
@@ -1819,6 +1867,15 @@ export declare type HostingVisitors200Daily = {
1819
1867
  data?: HostingVisitors200DailyDataItem[];
1820
1868
  total?: HostingVisitors200DailyTotal;
1821
1869
  };
1870
+ export declare type HostingVisitors200 = {
1871
+ daily?: HostingVisitors200Daily;
1872
+ total_bandwidth?: number;
1873
+ total_hits?: number;
1874
+ total_pages?: number;
1875
+ total_unique_visitors?: number;
1876
+ total_visitors?: number;
1877
+ visitors?: HostingVisitors200VisitorsItem[];
1878
+ };
1822
1879
  export declare type HostingVisitorsSource = typeof HostingVisitorsSource[keyof typeof HostingVisitorsSource];
1823
1880
  export declare const HostingVisitorsSource: {
1824
1881
  readonly http: "http";
@@ -2965,6 +3022,23 @@ export declare type ActivityLog200 = {
2965
3022
  export declare type ActivityLogParams = {
2966
3023
  days?: number;
2967
3024
  };
3025
+ export declare type HostingAccount200 = {
3026
+ account_id?: string;
3027
+ advanced?: boolean;
3028
+ billing?: HostingAccount200Billing;
3029
+ brand?: string;
3030
+ id?: string;
3031
+ panel?: string;
3032
+ plan_key?: string;
3033
+ platform?: string;
3034
+ /** @nullable */
3035
+ resources?: HostingAccount200Resources;
3036
+ /** @nullable */
3037
+ ssh_hostname?: string | null;
3038
+ status?: string;
3039
+ type?: string;
3040
+ username?: string;
3041
+ };
2968
3042
  export declare type HostingAccount200ResourcesWorkers = {
2969
3043
  /** @nullable */
2970
3044
  available?: number | null;
@@ -2990,23 +3064,6 @@ export declare type HostingAccount200Resources = {
2990
3064
  storage?: HostingAccount200ResourcesStorage;
2991
3065
  workers?: HostingAccount200ResourcesWorkers;
2992
3066
  } | null;
2993
- export declare type HostingAccount200 = {
2994
- account_id?: string;
2995
- advanced?: boolean;
2996
- billing?: HostingAccount200Billing;
2997
- brand?: string;
2998
- id?: string;
2999
- panel?: string;
3000
- plan_key?: string;
3001
- platform?: string;
3002
- /** @nullable */
3003
- resources?: HostingAccount200Resources;
3004
- /** @nullable */
3005
- ssh_hostname?: string | null;
3006
- status?: string;
3007
- type?: string;
3008
- username?: string;
3009
- };
3010
3067
  export declare type HostingAccount200ResourcesStagingWorkers = {
3011
3068
  /** @nullable */
3012
3069
  available?: number | null;
@@ -34,6 +34,12 @@ export const SitesSecuritySitelockSource = {
34
34
  halfg: 'halfg',
35
35
  };
36
36
  // eslint-disable-next-line @typescript-eslint/no-redeclare
37
+ export const SiteQualityMetricsStrategy = {
38
+ MOBILE: 'MOBILE',
39
+ DESKTOP: 'DESKTOP',
40
+ STRATEGY_UNSPECIFIED: 'STRATEGY_UNSPECIFIED',
41
+ };
42
+ // eslint-disable-next-line @typescript-eslint/no-redeclare
37
43
  export const SitesErrorLogsDownloadSort = {
38
44
  asc: 'asc',
39
45
  desc: 'desc',