@newfold/huapi-js 1.751.0 → 1.796.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.4.0"
11
11
  },
12
12
  "module": "dist/index.ts",
13
- "version": "1.751.0",
13
+ "version": "1.796.0",
14
14
  "sideEffects": false,
15
15
  "main": "./src/index.js",
16
16
  "types": "./src/index.d.ts",
package/src/index.d.ts CHANGED
@@ -3,12 +3,12 @@
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.751.0
6
+ * OpenAPI spec version: 1.796.0
7
7
  */
8
8
  import axios from 'axios';
9
9
  import type { AxiosRequestConfig, AxiosResponse, AxiosError } from 'axios';
10
10
  import type { UseQueryOptions, UseMutationOptions, UseQueryResult, QueryKey } from '@tanstack/react-query';
11
- import type { AccountHostingList200, CodeguardBackupList200, CodeguardBackupListParams, CodeguardBackupCreate200, CodeguardBackupCreateBody, CodeguardBackupDownload200, CodeguardBackupDownloadBody, CodeguardBackupRestore200, CodeguardBackupRestoreBody, CodeguardDatabaseList200, CodeguardDatabaseBackupList200, CodeguardDatabaseBackupListParams, CodeguardDatabaseBackupCreate200, CodeguardDatabaseBackupCreateBody, CodeguardDatabaseBackupRestore200, CodeguardDatabaseBackupRestoreBody, CodeguardLoginLink200, CodeguardPlanInfo200, CodeguardWebsiteList200, CodeguardWebsiteBackupList200, CodeguardWebsiteBackupListParams, CodeguardWebsiteBackupCreate200, CodeguardWebsiteBackupCreateBody, CodeguardWebsiteBackupRestore200, CodeguardWebsiteBackupRestoreBody, AddonsSitelockSso200, AddonsCloudflare200, AddonsInfo200, AddonsSpamexpertsSso200, WebzaiSso200, WeeblySso200, HostingAccount200, HostingAddons200, HostingAddonsParams, HostingAdvancedServer200, HostingAdvancedServerStatus200, HostingAdvancedServerStatusBody, HostingAdvancedPassword200, HostingAdvancedPasswordBody, HostingAdvancedSsoWhm200, HostingAdvancedSystemConsole200, HostingCapabilities200, AddonCloudflare200, AddonCloudflareBody, ListCrons200, AddCron200, AddCron400, AddCronBody, UpdateCron200, UpdateCronBody, Cron200, CronBody, DbAdd200, DbAddBody, Db200, DbBody, DbList200, DbUsage200, DbUserPrivsGet200, DbUserPrivsGetParams, DbUserAdd200, DbUserAddBody, DbUserDelete200, DbUserDeleteBody, DbUserList200, Domains200, DomainsParams, HostingDomainsUnassign200, HostingDomainsUnassignBody, HostingEcommerceInfo200, HostingFtpList200, HostingFtpAdd200, HostingFtpAddBody, HostingFtpUpdate200, HostingFtpUpdateBody, HostingFtp200, HostingFtpBody, HostingInfo200, HostingInfoDiskUsage200, HostingLead200, HostingLead400, HostingLeadParams, HostingMigrationStatus200, HostingMigrations200, HostingMigrationsBody, HostingMigrationsCheck200, HostingMigrationsCheckParams, HostingMigrationsEvent200, HostingMigrationsEventBody, HostingMigrationInfo200, HostingMigrationInfoParams, HostingMigrationSiteScanStatus200, HostingMigrationSiteScanStatusParams, HostingNameservers200, HostingOnboardingData200, HostingOnboardingDataUpdate200, HostingOnboardingDataUpdateBody, HostingResellerSsoWhm200, HostingShellToggle200, HostingShellToggleBody, HostingShellInfo200, HostingSiteAdd200, HostingSiteAddBody, HostingSshInfo200, SshKeyFetch200, SshKeyFetchParams, SshKeyImport200, SshKeyImportBody, SshKeyList200, SshKey200, SshKeyBody, SshKeyGenerate200, SshKeyGenerateBody, Sso200, SsoParams, SitesList200, SitesInfo200, SiteUpdate200, SiteUpdate400, SiteUpdateBody, Site200, SitesAutoupdatesResponse, SitesAutoupdatesUpdateBody, SitesBackups200, SitesHasBackups200, SitesBackupsCodeguard200, SitesBackupsDetails200, JetpackBackupStatus200, BackupsJetpackBackup200, SiteAddonCloudflare200, SiteAddonCloudflare400, SitesDatabaseInfo200, SitesDatabasePasswordsync200, SitesDns200, SitesDnsParams, SitesDomain200, SitesDomainUrl200, SitesDomainUrlBody, SitesDomains200, SitesDomainsCreate200, SitesDomainsCreateBody, SitePendingDomainDelete200, SitesPerformanceCachepurge200, SitesPerformanceCachepurgeBody, SitesPerformanceEnduranceCacheLevelStatus200, SitesPerformanceEnduranceCacheLevel200, SitesPerformanceEnduranceCacheLevelBody, SitesPerformanceEndurancePageCache200, SitePlugins200, SitePluginsAutoupdate200, SitePluginsAutoupdateBody, SitePluginsToggle200, SitePluginsToggleBody, SitePluginsUpdate200, SitePluginsUpdateBody, ResetSite200, ResetSiteBody, SitesSecurityCheckCore200, SitesSecurityResetCoreFiles200, SitesSecurityHttpsRedirectionStatus200, SitesSecurityHttpsEnableDisableSsl200, SitesSecurityHttpsEnableDisableSslBody, SitesSecuritySitelock200, SitesSecuritySslAcme200, SitesSecuritySslStatus200, SitesSettingsComingSoon200, SitesSettingsComingSoonToggle200, SitesSettingsComingSoonToggleBody, SitesSettingsDebug200, SitesSettingsDebugToggle200, SitesSettingsDebugToggleBody, SitesSettingsPhpVersionUpdate200, SitesSettingsPhpVersionUpdateBody, SitesSettingsPhpVersions200, SitesSshUserList200, SitesSshUserCreate200, SitesSshUserCreateBody, SitesSshUserDelete200, SitesSshUserDeleteBody, SitesSshUserUpdate200, SitesSshUserUpdateBody, SitesSsl200, SitesSso200, SitesSsoParams, SiteStatus200, SiteUsers200, SitesVersion200, HostingNameserversV2200, HostingSitesV2200, SshKeyListV2200, SitesListV2200 } from './index.schemas';
11
+ import type { AccountHostingList200, CodeguardBackupList200, CodeguardBackupListParams, CodeguardBackupCreate200, CodeguardBackupCreateBody, CodeguardBackupDownload200, CodeguardBackupDownloadBody, CodeguardBackupRestore200, CodeguardBackupRestoreBody, CodeguardDatabaseList200, CodeguardDatabaseBackupList200, CodeguardDatabaseBackupListParams, CodeguardDatabaseBackupCreate200, CodeguardDatabaseBackupCreateBody, CodeguardDatabaseBackupRestore200, CodeguardDatabaseBackupRestoreBody, CodeguardLoginLink200, CodeguardPlanInfo200, CodeguardWebsiteList200, CodeguardWebsiteBackupList200, CodeguardWebsiteBackupListParams, CodeguardWebsiteBackupCreate200, CodeguardWebsiteBackupCreateBody, CodeguardWebsiteBackupRestore200, CodeguardWebsiteBackupRestoreBody, AddonsSitelockSso200, AddonsCloudflare200, AddonsInfo200, AddonsSpamexpertsSso200, WebzaiSso200, WeeblySso200, HostingAccount200, HostingAddons200, HostingAddonsParams, HostingAdvancedServer200, HostingAdvancedServerStatus200, HostingAdvancedServerStatusBody, HostingAdvancedPassword200, HostingAdvancedPasswordBody, HostingAdvancedSsoWhm200, HostingAdvancedSystemConsole200, HostingCapabilities200, AddonCloudflare200, AddonCloudflareBody, ListCrons200, AddCron200, AddCron400, AddCronBody, UpdateCron200, UpdateCronBody, Cron200, CronBody, DbAdd200, DbAddBody, Db200, DbBody, DbList200, DbUsage200, DbUserPrivsGet200, DbUserPrivsGetParams, DbUserAdd200, DbUserAddBody, DbUserDelete200, DbUserDeleteBody, DbUserList200, Domains200, DomainsParams, HostingDomainsUnassign200, HostingDomainsUnassignBody, HostingEcommerceInfo200, HostingFtpList200, HostingFtpAdd200, HostingFtpAddBody, HostingFtpUpdate200, HostingFtpUpdateBody, HostingFtp200, HostingFtpBody, HostingInfo200, HostingInfoDiskUsage200, HostingLead200, HostingLead400, HostingLeadParams, HostingMigrationStatus200, HostingMigrations200, HostingMigrationsBody, HostingMigrationsCheck200, HostingMigrationsCheckParams, HostingMigrationsEvent200, HostingMigrationsEventBody, HostingMigrationInfo200, HostingMigrationInfoParams, HostingMigrationSiteScanStatus200, HostingMigrationSiteScanStatusParams, HostingNameservers200, HostingOnboardingData200, HostingOnboardingDataUpdate200, HostingOnboardingDataUpdateBody, HostingResellerSsoWhm200, HostingShellToggle200, HostingShellToggleBody, HostingShellInfo200, HostingSiteAdd200, HostingSiteAddBody, HostingSshInfo200, SshKeyFetch200, SshKeyFetchParams, SshKeyImport200, SshKeyImportBody, SshKeyList200, SshKey200, SshKeyBody, SshKeyGenerate200, SshKeyGenerateBody, Sso200, SsoParams, SitesList200, SitesInfo200, SiteUpdate200, SiteUpdate400, SiteUpdateBody, Site200, SitesAutoupdatesResponse, SitesAutoupdatesUpdateBody, SitesBackups200, SitesHasBackups200, SitesBackupsCodeguard200, SitesBackupsDetails200, JetpackBackupStatus200, BackupsJetpackBackup200, SiteAddonCloudflare200, SiteAddonCloudflare400, SitesDatabaseInfo200, SitesDatabasePasswordsync200, SitesDns200, SitesDnsParams, SitesDomain200, SitesDomainParams, SitesDomainUrl200, SitesDomainUrlBody, SitesDomains200, SitesDomainsCreate200, SitesDomainsCreateBody, SitePendingDomainDelete200, SitesPerformanceCachepurge200, SitesPerformanceCachepurgeBody, SitesPerformanceEdgecache200, SitesPerformanceEdgecacheBody, SitesPerformanceEnduranceCacheLevelStatus200, SitesPerformanceEnduranceCacheLevel200, SitesPerformanceEnduranceCacheLevelBody, SitesPerformanceEndurancePageCache200, SitePlugins200, SitePluginsAutoupdate200, SitePluginsAutoupdateBody, SitePluginsToggle200, SitePluginsToggleBody, SitePluginsUpdate200, SitePluginsUpdateBody, ResetSite200, ResetSiteBody, SitesSecurityCheckCore200, SitesSecurityResetCoreFiles200, SitesSecurityHttpsRedirectionStatus200, SitesSecurityHttpsEnableDisableSsl200, SitesSecurityHttpsEnableDisableSslBody, SitesSecuritySitelock200, SitesSecuritySslAcme200, SitesSecuritySslStatus200, SitesSettingsComingSoon200, SitesSettingsComingSoonToggle200, SitesSettingsComingSoonToggleBody, SitesSettingsDebug200, SitesSettingsDebugToggle200, SitesSettingsDebugToggleBody, SitesSettingsPhpVersionUpdate200, SitesSettingsPhpVersionUpdateBody, SitesSettingsPhpVersions200, SitesSshUserList200, SitesSshUserCreate200, SitesSshUserCreateBody, SitesSshUserDelete200, SitesSshUserDeleteBody, SitesSshUserUpdate200, SitesSshUserUpdateBody, SitesSsl200, SitesSso200, SitesSsoParams, SiteStatus200, SiteUsers200, SitesVersion200, HostingNameserversV2200, HostingSitesV2200, SshKeyListV2200, SitesListV2200 } from './index.schemas';
12
12
  declare type AwaitedInput<T> = PromiseLike<T> | T;
13
13
  declare type Awaited<O> = O extends AwaitedInput<infer T> ? T : never;
14
14
  /**
@@ -1384,11 +1384,11 @@ export declare const useSitesDns: <TData = AxiosResponse<SitesDns200, any>, TErr
1384
1384
  * Determines if the domain has the correct DNS setup for site
1385
1385
  * @summary Domain DNS setup for site
1386
1386
  */
1387
- export declare const sitesDomain: (siteId: number, options?: AxiosRequestConfig) => Promise<AxiosResponse<SitesDomain200>>;
1388
- export declare const getSitesDomainQueryKey: (siteId: number) => string[];
1387
+ export declare const sitesDomain: (siteId: number, params?: SitesDomainParams, options?: AxiosRequestConfig) => Promise<AxiosResponse<SitesDomain200>>;
1388
+ export declare const getSitesDomainQueryKey: (siteId: number, params?: SitesDomainParams) => (string | SitesDomainParams)[];
1389
1389
  export declare type SitesDomainQueryResult = NonNullable<Awaited<ReturnType<typeof sitesDomain>>>;
1390
1390
  export declare type SitesDomainQueryError = AxiosError<unknown>;
1391
- export declare const useSitesDomain: <TData = AxiosResponse<SitesDomain200, any>, TError = AxiosError<unknown, any>>(siteId: number, options?: {
1391
+ export declare const useSitesDomain: <TData = AxiosResponse<SitesDomain200, any>, TError = AxiosError<unknown, any>>(siteId: number, params?: SitesDomainParams, options?: {
1392
1392
  query?: UseQueryOptions<AxiosResponse<SitesDomain200, any>, TError, TData, QueryKey> | undefined;
1393
1393
  axios?: AxiosRequestConfig<any> | undefined;
1394
1394
  } | undefined) => UseQueryResult<TData, TError> & {
@@ -1477,6 +1477,24 @@ export declare const useSitesPerformanceCachepurge: <TError = AxiosError<unknown
1477
1477
  siteId: number;
1478
1478
  data: SitesPerformanceCachepurgeBody;
1479
1479
  }, TContext>;
1480
+ /**
1481
+ * Update the edge cache
1482
+ * @summary edge cache toggle for atomic site
1483
+ */
1484
+ export declare const sitesPerformanceEdgecache: (siteId: number, sitesPerformanceEdgecacheBody: SitesPerformanceEdgecacheBody, options?: AxiosRequestConfig) => Promise<AxiosResponse<SitesPerformanceEdgecache200>>;
1485
+ export declare type SitesPerformanceEdgecacheMutationResult = NonNullable<Awaited<ReturnType<typeof sitesPerformanceEdgecache>>>;
1486
+ export declare type SitesPerformanceEdgecacheMutationBody = SitesPerformanceEdgecacheBody;
1487
+ export declare type SitesPerformanceEdgecacheMutationError = AxiosError<unknown>;
1488
+ export declare const useSitesPerformanceEdgecache: <TError = AxiosError<unknown, any>, TContext = unknown>(options?: {
1489
+ mutation?: UseMutationOptions<AxiosResponse<SitesPerformanceEdgecache200, any>, TError, {
1490
+ siteId: number;
1491
+ data: SitesPerformanceEdgecacheBody;
1492
+ }, TContext> | undefined;
1493
+ axios?: AxiosRequestConfig<any> | undefined;
1494
+ } | undefined) => import("@tanstack/react-query").UseMutationResult<AxiosResponse<SitesPerformanceEdgecache200, any>, TError, {
1495
+ siteId: number;
1496
+ data: SitesPerformanceEdgecacheBody;
1497
+ }, TContext>;
1480
1498
  /**
1481
1499
  * Returns the status of endurance_cache_level
1482
1500
  * @summary Get status of endurance cache level
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.751.0
6
+ * OpenAPI spec version: 1.796.0
7
7
  */
8
8
  import axios from 'axios';
9
9
  import { useQuery, useMutation } from '@tanstack/react-query';
@@ -1435,15 +1435,15 @@ export const useSitesDns = (siteId, params, options) => {
1435
1435
  * Determines if the domain has the correct DNS setup for site
1436
1436
  * @summary Domain DNS setup for site
1437
1437
  */
1438
- export const sitesDomain = (siteId, options) => {
1439
- return axios.get(`/v1/sites/${siteId}/domain`, options);
1438
+ export const sitesDomain = (siteId, params, options) => {
1439
+ return axios.get(`/v1/sites/${siteId}/domain`, Object.assign(Object.assign({}, options), { params: Object.assign(Object.assign({}, params), options === null || options === void 0 ? void 0 : options.params) }));
1440
1440
  };
1441
- export const getSitesDomainQueryKey = (siteId) => [`/v1/sites/${siteId}/domain`];
1442
- export const useSitesDomain = (siteId, options) => {
1441
+ export const getSitesDomainQueryKey = (siteId, params) => [`/v1/sites/${siteId}/domain`, ...(params ? [params] : [])];
1442
+ export const useSitesDomain = (siteId, params, options) => {
1443
1443
  var _a;
1444
1444
  const { query: queryOptions, axios: axiosOptions } = options !== null && options !== void 0 ? options : {};
1445
- const queryKey = (_a = queryOptions === null || queryOptions === void 0 ? void 0 : queryOptions.queryKey) !== null && _a !== void 0 ? _a : getSitesDomainQueryKey(siteId);
1446
- const queryFn = ({ signal }) => sitesDomain(siteId, Object.assign({ signal }, axiosOptions));
1445
+ const queryKey = (_a = queryOptions === null || queryOptions === void 0 ? void 0 : queryOptions.queryKey) !== null && _a !== void 0 ? _a : getSitesDomainQueryKey(siteId, params);
1446
+ const queryFn = ({ signal }) => sitesDomain(siteId, params, Object.assign({ signal }, axiosOptions));
1447
1447
  const query = useQuery(Object.assign({ queryKey, queryFn, enabled: !!(siteId) }, queryOptions));
1448
1448
  query.queryKey = queryKey;
1449
1449
  return query;
@@ -1525,6 +1525,21 @@ export const useSitesPerformanceCachepurge = (options) => {
1525
1525
  };
1526
1526
  return useMutation(mutationFn, mutationOptions);
1527
1527
  };
1528
+ /**
1529
+ * Update the edge cache
1530
+ * @summary edge cache toggle for atomic site
1531
+ */
1532
+ export const sitesPerformanceEdgecache = (siteId, sitesPerformanceEdgecacheBody, options) => {
1533
+ return axios.put(`/v1/sites/${siteId}/performance/edge_cache`, sitesPerformanceEdgecacheBody, options);
1534
+ };
1535
+ export const useSitesPerformanceEdgecache = (options) => {
1536
+ const { mutation: mutationOptions, axios: axiosOptions } = options !== null && options !== void 0 ? options : {};
1537
+ const mutationFn = (props) => {
1538
+ const { siteId, data } = props !== null && props !== void 0 ? props : {};
1539
+ return sitesPerformanceEdgecache(siteId, data, axiosOptions);
1540
+ };
1541
+ return useMutation(mutationFn, mutationOptions);
1542
+ };
1528
1543
  /**
1529
1544
  * Returns the status of endurance_cache_level
1530
1545
  * @summary Get status of endurance cache level
@@ -151,11 +151,18 @@ export declare const getHostingAddonsMock: () => {
151
151
  subtype: string | undefined;
152
152
  status: string | undefined;
153
153
  status_user: string | undefined;
154
- meta: string | undefined;
154
+ meta: {} | undefined;
155
155
  }[] | undefined;
156
156
  };
157
157
  export declare const getHostingAdvancedServerMock: () => {
158
158
  status: string | undefined;
159
+ hostname: string | undefined;
160
+ ips: {
161
+ primary_ip: string | undefined;
162
+ other_ips: string[] | undefined;
163
+ } | undefined;
164
+ os_name: string | undefined;
165
+ os_version: string | undefined;
159
166
  uptime: string | undefined;
160
167
  uptime_seconds: number | undefined;
161
168
  actions: {} | undefined;
@@ -526,8 +533,8 @@ export declare const getSiteAddonCloudflareMock: () => {
526
533
  addon_id: number | undefined;
527
534
  };
528
535
  export declare const getSitesDatabaseInfoMock: () => {
529
- collation: string | undefined;
530
- charset: string | undefined;
536
+ collation: string | null | undefined;
537
+ charset: string | null | undefined;
531
538
  };
532
539
  export declare const getSitesDatabasePasswordsyncMock: () => {};
533
540
  export declare const getSitesDnsMock: () => {
@@ -577,6 +584,7 @@ export declare const getSitePendingDomainDeleteMock: () => {};
577
584
  export declare const getSitesPerformanceCachepurgeMock: () => {
578
585
  success: boolean | undefined;
579
586
  };
587
+ export declare const getSitesPerformanceEdgecacheMock: () => {};
580
588
  export declare const getSitesPerformanceEnduranceCacheLevelStatusMock: () => {
581
589
  endurance_cache_level: number | undefined;
582
590
  };
@@ -670,7 +678,10 @@ export declare const getSitesSettingsPhpVersionsMock: () => {
670
678
  versions: string[] | undefined;
671
679
  };
672
680
  export declare const getSitesSshUserListMock: () => {};
673
- export declare const getSitesSshUserCreateMock: () => {};
681
+ export declare const getSitesSshUserCreateMock: () => {
682
+ public_key: string | null | undefined;
683
+ private_key: string | null | undefined;
684
+ };
674
685
  export declare const getSitesSshUserDeleteMock: () => {};
675
686
  export declare const getSitesSshUserUpdateMock: () => {};
676
687
  export declare const getSitesSslMock: () => {
package/src/index.msw.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.751.0
6
+ * OpenAPI spec version: 1.796.0
7
7
  */
8
8
  import { rest } from 'msw';
9
9
  import { faker } from '@faker-js/faker';
@@ -29,8 +29,8 @@ export const getAddonsSpamexpertsSsoMock = () => ({ url: faker.helpers.arrayElem
29
29
  export const getWebzaiSsoMock = () => ({ sso: faker.helpers.arrayElement([faker.random.word(), undefined]) });
30
30
  export const getWeeblySsoMock = () => ({ sso: faker.helpers.arrayElement([faker.random.word(), undefined]) });
31
31
  export const getHostingAccountMock = () => ({ id: faker.helpers.arrayElement([faker.random.word(), undefined]), account_id: faker.helpers.arrayElement([faker.random.word(), undefined]), brand: faker.helpers.arrayElement([faker.random.word(), undefined]), platform: faker.helpers.arrayElement([faker.random.word(), undefined]), username: faker.helpers.arrayElement([faker.random.word(), undefined]), status: faker.helpers.arrayElement([faker.random.word(), undefined]), type: faker.helpers.arrayElement([faker.random.word(), undefined]), advanced: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), billing: faker.helpers.arrayElement([{ product_name: faker.helpers.arrayElement([faker.random.word(), undefined]) }, undefined]), panel: faker.helpers.arrayElement([faker.random.word(), undefined]), plan_key: faker.helpers.arrayElement([faker.random.word(), undefined]), resources: faker.helpers.arrayElement([{ storage: faker.helpers.arrayElement([{ available: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), null]), undefined]), total: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), null]), undefined]), unit: faker.helpers.arrayElement([faker.random.word(), undefined]), used: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), null]), undefined]) }, undefined]), workers: faker.helpers.arrayElement([{ available: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), null]), undefined]), total: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), null]), undefined]), used: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), null]), undefined]) }, undefined]) }, undefined]) });
32
- export const getHostingAddonsMock = () => ({ rows: faker.helpers.arrayElement([Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ id: faker.helpers.arrayElement([faker.random.word(), undefined]), type: faker.helpers.arrayElement([faker.random.word(), undefined]), subtype: faker.helpers.arrayElement([faker.random.word(), undefined]), status: faker.helpers.arrayElement([faker.random.word(), undefined]), status_user: faker.helpers.arrayElement([faker.random.word(), undefined]), meta: faker.helpers.arrayElement([faker.random.word(), undefined]) })), undefined]) });
33
- export const getHostingAdvancedServerMock = () => ({ status: faker.helpers.arrayElement([faker.random.word(), undefined]), uptime: faker.helpers.arrayElement([faker.random.word(), undefined]), uptime_seconds: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), actions: faker.helpers.arrayElement([{}, undefined]) });
32
+ export const getHostingAddonsMock = () => ({ rows: faker.helpers.arrayElement([Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ id: faker.helpers.arrayElement([faker.random.word(), undefined]), type: faker.helpers.arrayElement([faker.random.word(), undefined]), subtype: faker.helpers.arrayElement([faker.random.word(), undefined]), status: faker.helpers.arrayElement([faker.random.word(), undefined]), status_user: faker.helpers.arrayElement([faker.random.word(), undefined]), meta: faker.helpers.arrayElement([{}, undefined]) })), undefined]) });
33
+ export const getHostingAdvancedServerMock = () => ({ status: faker.helpers.arrayElement([faker.random.word(), undefined]), hostname: faker.helpers.arrayElement([faker.random.word(), undefined]), ips: faker.helpers.arrayElement([{ primary_ip: faker.helpers.arrayElement([faker.random.word(), undefined]), other_ips: faker.helpers.arrayElement([Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => (faker.random.word())), undefined]) }, undefined]), os_name: faker.helpers.arrayElement([faker.random.word(), undefined]), os_version: faker.helpers.arrayElement([faker.random.word(), undefined]), uptime: faker.helpers.arrayElement([faker.random.word(), undefined]), uptime_seconds: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), actions: faker.helpers.arrayElement([{}, undefined]) });
34
34
  export const getHostingAdvancedServerStatusMock = () => ({ status: faker.helpers.arrayElement([faker.random.word(), undefined]), uptime: faker.helpers.arrayElement([faker.random.word(), undefined]), uptime_seconds: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), actions: faker.helpers.arrayElement([{}, undefined]) });
35
35
  export const getHostingAdvancedPasswordMock = () => ({ success: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]) });
36
36
  export const getHostingAdvancedSsoWhmMock = () => ({ url: faker.helpers.arrayElement([faker.random.word(), undefined]) });
@@ -92,7 +92,7 @@ export const getSitesBackupsDetailsMock = () => ({ codeguard: faker.helpers.arra
92
92
  export const getJetpackBackupStatusMock = () => ({ plugin_exists: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), addon_exists: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), addon_id: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]), status: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]), plan_name: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]), can_upgrade: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), has_active_plugin: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), has_active_addon: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), addon_back_reference: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]), pending_upgrade: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]) });
93
93
  export const getBackupsJetpackBackupMock = () => ({});
94
94
  export const getSiteAddonCloudflareMock = () => ({ addon_id: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]) });
95
- export const getSitesDatabaseInfoMock = () => ({ collation: faker.helpers.arrayElement([faker.random.word(), undefined]), charset: faker.helpers.arrayElement([faker.random.word(), undefined]) });
95
+ export const getSitesDatabaseInfoMock = () => ({ collation: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]), charset: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]) });
96
96
  export const getSitesDatabasePasswordsyncMock = () => ({});
97
97
  export const getSitesDnsMock = () => ({ success: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), source: faker.helpers.arrayElement([faker.random.word(), undefined]), records: faker.helpers.arrayElement([Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ name: faker.helpers.arrayElement([faker.random.word(), undefined]), value: faker.helpers.arrayElement([faker.random.word(), undefined]), type: faker.helpers.arrayElement([faker.random.word(), undefined]) })), undefined]) });
98
98
  export const getSitesDomainMock = () => ({ connected: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), a_match: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), nameserver_match: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), detected: faker.helpers.arrayElement([{ a: faker.helpers.arrayElement([Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => (faker.random.word())), undefined]), ns: faker.helpers.arrayElement([Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => (faker.random.word())), undefined]) }, undefined]), wanted: faker.helpers.arrayElement([{ a: faker.helpers.arrayElement([Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => (faker.random.word())), undefined]), ns: faker.helpers.arrayElement([Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => (faker.random.word())), undefined]) }, undefined]) });
@@ -101,6 +101,7 @@ export const getSitesDomainsMock = () => ({ domains: faker.helpers.arrayElement(
101
101
  export const getSitesDomainsCreateMock = () => ({ id: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), status: faker.helpers.arrayElement([faker.random.word(), undefined]) });
102
102
  export const getSitePendingDomainDeleteMock = () => ({});
103
103
  export const getSitesPerformanceCachepurgeMock = () => ({ success: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]) });
104
+ export const getSitesPerformanceEdgecacheMock = () => ({});
104
105
  export const getSitesPerformanceEnduranceCacheLevelStatusMock = () => ({ endurance_cache_level: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]) });
105
106
  export const getSitesPerformanceEnduranceCacheLevelMock = () => ({ options: faker.helpers.arrayElement([{}, undefined]) });
106
107
  export const getSitesPerformanceEndurancePageCacheMock = () => ({ result: faker.helpers.arrayElement([faker.random.word(), undefined]), status: faker.helpers.arrayElement([faker.random.word(), undefined]) });
@@ -123,7 +124,7 @@ export const getSitesSettingsDebugToggleMock = () => ({ success: faker.helpers.a
123
124
  export const getSitesSettingsPhpVersionUpdateMock = () => ({ success: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]) });
124
125
  export const getSitesSettingsPhpVersionsMock = () => ({ versions: faker.helpers.arrayElement([Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => (faker.random.word())), undefined]) });
125
126
  export const getSitesSshUserListMock = () => ({});
126
- export const getSitesSshUserCreateMock = () => ({});
127
+ export const getSitesSshUserCreateMock = () => ({ public_key: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]), private_key: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]) });
127
128
  export const getSitesSshUserDeleteMock = () => ({});
128
129
  export const getSitesSshUserUpdateMock = () => ({});
129
130
  export const getSitesSslMock = () => ({ domain: faker.helpers.arrayElement([faker.random.word(), undefined]), domain_dns_status: faker.helpers.arrayElement([faker.random.word(), undefined]), expiration: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]), issuer: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]), product: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]), provider: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]), status: faker.helpers.arrayElement([faker.random.word(), undefined]), type: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]), upgradeable: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]) });
@@ -324,6 +325,8 @@ export const getHostingUAPIMSW = () => [
324
325
  return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json(getSitePendingDomainDeleteMock()));
325
326
  }), rest.post('*/v1/sites/:siteId/performance/cachepurge', (_req, res, ctx) => {
326
327
  return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json(getSitesPerformanceCachepurgeMock()));
328
+ }), rest.put('*/v1/sites/:siteId/performance/edge_cache', (_req, res, ctx) => {
329
+ return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json(getSitesPerformanceEdgecacheMock()));
327
330
  }), rest.get('*/v1/sites/:siteId/performance/endurance_cache_level', (_req, res, ctx) => {
328
331
  return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json(getSitesPerformanceEnduranceCacheLevelStatusMock()));
329
332
  }), rest.post('*/v1/sites/:siteId/performance/endurance_cache_level', (_req, res, ctx) => {
@@ -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.751.0
6
+ * OpenAPI spec version: 1.796.0
7
7
  */
8
8
  export declare type SitesListV2200ItemsItemResourcesStorage = {
9
9
  available?: number | null;
@@ -194,6 +194,7 @@ export declare const SitesSsoBounceName: {
194
194
  readonly themes: "themes";
195
195
  readonly phpmyadmin: "phpmyadmin";
196
196
  readonly filemanager: "filemanager";
197
+ readonly store: "store";
197
198
  };
198
199
  export declare type SitesSsoParams = {
199
200
  addon_id?: string;
@@ -230,7 +231,10 @@ export declare type SitesSshUserDeleteBody = {
230
231
  ssh_user?: string;
231
232
  };
232
233
  export declare type SitesSshUserCreate200 = {
233
- [key: string]: any;
234
+ /** optional public key */
235
+ public_key?: string | null;
236
+ /** optional private key */
237
+ private_key?: string | null;
234
238
  };
235
239
  export declare type SitesSshUserCreateBody = {
236
240
  /** username of user */
@@ -239,6 +243,8 @@ export declare type SitesSshUserCreateBody = {
239
243
  pass?: string;
240
244
  /** optional public key */
241
245
  pubkey?: string;
246
+ /** optional auto-generate public key flag */
247
+ generate_pubkey?: boolean;
242
248
  };
243
249
  export declare type SitesSshUserList200 = {
244
250
  [key: string]: any;
@@ -377,6 +383,13 @@ export declare type SitesPerformanceEnduranceCacheLevelBody = {
377
383
  export declare type SitesPerformanceEnduranceCacheLevelStatus200 = {
378
384
  endurance_cache_level?: number;
379
385
  };
386
+ export declare type SitesPerformanceEdgecache200 = {
387
+ [key: string]: any;
388
+ };
389
+ export declare type SitesPerformanceEdgecacheBody = {
390
+ /** Pass either 0 or 1 */
391
+ edge_cache: number;
392
+ };
380
393
  export declare type SitesPerformanceCachepurge200 = {
381
394
  success?: boolean;
382
395
  };
@@ -443,6 +456,9 @@ export declare type SitesDomain200 = {
443
456
  detected?: SitesDomain200Detected;
444
457
  wanted?: SitesDomain200Wanted;
445
458
  };
459
+ export declare type SitesDomainParams = {
460
+ domain?: string;
461
+ };
446
462
  export declare type SitesDns200RecordsItem = {
447
463
  name?: string;
448
464
  value?: string;
@@ -460,8 +476,8 @@ export declare type SitesDatabasePasswordsync200 = {
460
476
  [key: string]: any;
461
477
  };
462
478
  export declare type SitesDatabaseInfo200 = {
463
- collation?: string;
464
- charset?: string;
479
+ collation?: string | null;
480
+ charset?: string | null;
465
481
  };
466
482
  export declare type SiteAddonCloudflare400 = {
467
483
  error?: string;
@@ -556,6 +572,8 @@ export declare type SiteUpdateBody = {
556
572
  disk_limit_gib?: number;
557
573
  /** Number of PHP workers */
558
574
  workers?: number;
575
+ /** Skip FG domain checks for HAL domain */
576
+ skip_fg_checks?: boolean;
559
577
  };
560
578
  export declare type SitesInfo200ResourcesStorage = {
561
579
  available?: number | null;
@@ -772,6 +790,8 @@ export declare type HostingSiteAddBody = {
772
790
  workers?: number;
773
791
  /** Datacenter to host site in. */
774
792
  datacenter?: HostingSiteAddBodyDatacenter;
793
+ /** HAL site id to clone */
794
+ clone_site_id?: number;
775
795
  };
776
796
  export declare type HostingShellInfo200 = {
777
797
  enabled?: boolean;
@@ -1217,19 +1237,34 @@ export declare type HostingAdvancedServerStatusBody = {
1217
1237
  export declare type HostingAdvancedServer200Actions = {
1218
1238
  [key: string]: any;
1219
1239
  };
1240
+ export declare type HostingAdvancedServer200Ips = {
1241
+ /** primary IP of server */
1242
+ primary_ip?: string;
1243
+ other_ips?: string[];
1244
+ };
1220
1245
  export declare type HostingAdvancedServer200 = {
1221
1246
  status?: string;
1247
+ /** hostname of server */
1248
+ hostname?: string;
1249
+ ips?: HostingAdvancedServer200Ips;
1250
+ /** Operating system name */
1251
+ os_name?: string;
1252
+ /** Operating system version */
1253
+ os_version?: string;
1222
1254
  uptime?: string;
1223
1255
  uptime_seconds?: number;
1224
1256
  actions?: HostingAdvancedServer200Actions;
1225
1257
  };
1258
+ export declare type HostingAddons200RowsItemMeta = {
1259
+ [key: string]: any;
1260
+ };
1226
1261
  export declare type HostingAddons200RowsItem = {
1227
1262
  id?: string;
1228
1263
  type?: string;
1229
1264
  subtype?: string;
1230
1265
  status?: string;
1231
1266
  status_user?: string;
1232
- meta?: string;
1267
+ meta?: HostingAddons200RowsItemMeta;
1233
1268
  };
1234
1269
  export declare type HostingAddons200 = {
1235
1270
  rows?: HostingAddons200RowsItem[];
@@ -10,6 +10,7 @@ export const SitesSsoBounceName = {
10
10
  themes: 'themes',
11
11
  phpmyadmin: 'phpmyadmin',
12
12
  filemanager: 'filemanager',
13
+ store: 'store',
13
14
  };
14
15
  // eslint-disable-next-line @typescript-eslint/no-redeclare
15
16
  export const SitesAutoupdatesUpdateBodyType = {