@newfold/huapi-js 1.468.0 → 1.472.0

package/package.json

@@ -10,7 +10,7 @@
     "tslib": "2.4.0"
   },
   "module": "dist/index.ts",
-  "version": "1.468.0",
+  "version": "1.472.0",
   "sideEffects": false,
   "main": "./src/index.js",
   "types": "./src/index.d.ts",

package/src/index.d.ts

@@ -3,12 +3,12 @@
  * Do not edit manually.
  * Hosting UAPI
  * Hosting UAPI is an API to expose Hosting, Addons, and Site functionality to a customer-facing Front End such as (Account Manager).
- * OpenAPI spec version: 1.468.0
+ * OpenAPI spec version: 1.472.0
  */
 import axios from 'axios';
 import type { AxiosRequestConfig, AxiosResponse, AxiosError } from 'axios';
 import type { UseQueryOptions, UseMutationOptions, UseQueryResult, QueryKey } from '@tanstack/react-query';
-import type { 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, 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, DbUserList200, Domains200, DomainsParams, HostingFtpList200, HostingFtpAdd200, HostingFtpAddBody, HostingFtpUpdate200, HostingFtpUpdateBody, HostingFtp200, HostingFtpBody, HostingInfo200, HostingInfoDiskUsage200, HostingMigrationStatus200, HostingMigrations200, HostingMigrationsBody, HostingMigrationsEvent200, HostingMigrationsEventBody, HostingMigrationInfo200, HostingMigrationInfoParams, HostingMigrationSiteScanStatus200, HostingMigrationSiteScanStatusParams, HostingNameservers200, HostingShellToggle200, HostingShellToggleBody, HostingShellInfo200, HostingSites200, 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, SitesDns200, SitesDnsParams, SitesDomain200, SitesDomainUrl200, SitesDomainUrlBody, SitePendingDomainDelete200, SitesPerformanceCachepurge200, SitesPerformanceCachepurgeBody, SitesPerformanceEnduranceCacheLevelStatus200, SitesPerformanceEnduranceCacheLevel200, SitesPerformanceEnduranceCacheLevelBody, SitesPerformanceEndurancePageCache200, SitePlugins200, SitePluginsAutoupdate200, SitePluginsAutoupdateBody, SitePluginsToggle200, SitePluginsToggleBody, SitePluginsUpdate200, SitePluginsUpdateBody, ResetSite200, SitesSecurityCheckCore200, SitesSecurityResetCoreFiles200, SitesSecurityHttpsRedirectionStatus200, SitesSecurityHttpsEnableDisableSsl200, SitesSecurityHttpsEnableDisableSslBody, SitesSecuritySitelock200, SitesSecuritySslAcme200, SitesSecuritySslStatus200, SiteSettingsAutoupdatePlugins200, SitesSettingsAutoupdates200, SitesSettingsAutoupdatesCore200, SitesSettingsAutoupdatesCoreBody, SitesSettingsAutoupdatesTheme200, SitesSettingsAutoupdatesThemeBody, SitesSettingsComingSoon200, SitesSettingsComingSoonToggle200, SitesSettingsComingSoonToggleBody, SitesSettingsDebug200, SitesSettingsDebugToggle200, SitesSettingsDebugToggleBody, SitesSettingsPhpVersionUpdate200, SitesSettingsPhpVersionUpdateBody, SitesSettingsPhpVersions200, SitesSso200, SitesSsoParams, SiteStatus200, SiteUsers200, SitesVersion200, HostingSitesV2200, SshKeyListV2200 } from './index.schemas';
+import type { 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, 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, DbUserList200, Domains200, DomainsParams, HostingFtpList200, HostingFtpAdd200, HostingFtpAddBody, HostingFtpUpdate200, HostingFtpUpdateBody, HostingFtp200, HostingFtpBody, HostingInfo200, HostingInfoDiskUsage200, HostingMigrationStatus200, HostingMigrations200, HostingMigrationsBody, HostingMigrationsEvent200, HostingMigrationsEventBody, HostingMigrationInfo200, HostingMigrationInfoParams, HostingMigrationSiteScanStatus200, HostingMigrationSiteScanStatusParams, HostingNameservers200, HostingOnboardingData200, HostingOnboardingDataUpdate200, HostingOnboardingDataUpdateBody, HostingShellToggle200, HostingShellToggleBody, HostingShellInfo200, HostingSites200, 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, SitesDns200, SitesDnsParams, SitesDomain200, SitesDomainUrl200, SitesDomainUrlBody, SitePendingDomainDelete200, SitesPerformanceCachepurge200, SitesPerformanceCachepurgeBody, SitesPerformanceEnduranceCacheLevelStatus200, SitesPerformanceEnduranceCacheLevel200, SitesPerformanceEnduranceCacheLevelBody, SitesPerformanceEndurancePageCache200, SitePlugins200, SitePluginsAutoupdate200, SitePluginsAutoupdateBody, SitePluginsToggle200, SitePluginsToggleBody, SitePluginsUpdate200, SitePluginsUpdateBody, ResetSite200, SitesSecurityCheckCore200, SitesSecurityResetCoreFiles200, SitesSecurityHttpsRedirectionStatus200, SitesSecurityHttpsEnableDisableSsl200, SitesSecurityHttpsEnableDisableSslBody, SitesSecuritySitelock200, SitesSecuritySslAcme200, SitesSecuritySslStatus200, SiteSettingsAutoupdatePlugins200, SitesSettingsAutoupdates200, SitesSettingsAutoupdatesCore200, SitesSettingsAutoupdatesCoreBody, SitesSettingsAutoupdatesTheme200, SitesSettingsAutoupdatesThemeBody, SitesSettingsComingSoon200, SitesSettingsComingSoonToggle200, SitesSettingsComingSoonToggleBody, SitesSettingsDebug200, SitesSettingsDebugToggle200, SitesSettingsDebugToggleBody, SitesSettingsPhpVersionUpdate200, SitesSettingsPhpVersionUpdateBody, SitesSettingsPhpVersions200, SitesSso200, SitesSsoParams, SiteStatus200, SiteUsers200, SitesVersion200, HostingSitesV2200, SshKeyListV2200 } from './index.schemas';
 declare type AwaitedInput<T> = PromiseLike<T> | T;
 declare type Awaited<O> = O extends AwaitedInput<infer T> ? T : never;
 /**
@@ -750,6 +750,37 @@ export declare const useHostingNameservers: <TData = AxiosResponse<HostingNamese
 } | undefined) => UseQueryResult<TData, TError> & {
     queryKey: QueryKey;
 };
+/**
+ * Returns onboarding data
+ * @summary Returns hosting onboarding data
+ */
+export declare const hostingOnboardingData: (hostingId: string, options?: AxiosRequestConfig) => Promise<AxiosResponse<HostingOnboardingData200>>;
+export declare const getHostingOnboardingDataQueryKey: (hostingId: string) => string[];
+export declare type HostingOnboardingDataQueryResult = NonNullable<Awaited<ReturnType<typeof hostingOnboardingData>>>;
+export declare type HostingOnboardingDataQueryError = AxiosError<unknown>;
+export declare const useHostingOnboardingData: <TData = AxiosResponse<HostingOnboardingData200, any>, TError = AxiosError<unknown, any>>(hostingId: string, options?: {
+    query?: UseQueryOptions<AxiosResponse<HostingOnboardingData200, any>, TError, TData, QueryKey> | undefined;
+    axios?: AxiosRequestConfig<any> | undefined;
+} | undefined) => UseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+/**
+ * @summary Updates hosting onboarding data
+ */
+export declare const hostingOnboardingDataUpdate: (hostingId: string, hostingOnboardingDataUpdateBody: HostingOnboardingDataUpdateBody, options?: AxiosRequestConfig) => Promise<AxiosResponse<HostingOnboardingDataUpdate200>>;
+export declare type HostingOnboardingDataUpdateMutationResult = NonNullable<Awaited<ReturnType<typeof hostingOnboardingDataUpdate>>>;
+export declare type HostingOnboardingDataUpdateMutationBody = HostingOnboardingDataUpdateBody;
+export declare type HostingOnboardingDataUpdateMutationError = AxiosError<unknown>;
+export declare const useHostingOnboardingDataUpdate: <TError = AxiosError<unknown, any>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<AxiosResponse<HostingOnboardingDataUpdate200, any>, TError, {
+        hostingId: string;
+        data: HostingOnboardingDataUpdateBody;
+    }, TContext> | undefined;
+    axios?: AxiosRequestConfig<any> | undefined;
+} | undefined) => import("@tanstack/react-query").UseMutationResult<AxiosResponse<HostingOnboardingDataUpdate200, any>, TError, {
+    hostingId: string;
+    data: HostingOnboardingDataUpdateBody;
+}, TContext>;
 /**
  * Enable or disable shell access on an account by setting the shell.SSH key access must be established separately.
  * @summary hosting shell toggle

package/src/index.js

@@ -3,7 +3,7 @@
  * Do not edit manually.
  * Hosting UAPI
  * Hosting UAPI is an API to expose Hosting, Addons, and Site functionality to a customer-facing Front End such as (Account Manager).
- * OpenAPI spec version: 1.468.0
+ * OpenAPI spec version: 1.472.0
  */
 import axios from 'axios';
 import { useQuery, useMutation } from '@tanstack/react-query';
@@ -764,6 +764,37 @@ export const useHostingNameservers = (hostingId, options) => {
     query.queryKey = queryKey;
     return query;
 };
+/**
+ * Returns onboarding data
+ * @summary Returns hosting onboarding data
+ */
+export const hostingOnboardingData = (hostingId, options) => {
+    return axios.get(`/v1/hosting/${hostingId}/onboarding`, options);
+};
+export const getHostingOnboardingDataQueryKey = (hostingId) => [`/v1/hosting/${hostingId}/onboarding`];
+export const useHostingOnboardingData = (hostingId, options) => {
+    var _a;
+    const { query: queryOptions, axios: axiosOptions } = options !== null && options !== void 0 ? options : {};
+    const queryKey = (_a = queryOptions === null || queryOptions === void 0 ? void 0 : queryOptions.queryKey) !== null && _a !== void 0 ? _a : getHostingOnboardingDataQueryKey(hostingId);
+    const queryFn = ({ signal }) => hostingOnboardingData(hostingId, Object.assign({ signal }, axiosOptions));
+    const query = useQuery(Object.assign({ queryKey, queryFn, enabled: !!(hostingId) }, queryOptions));
+    query.queryKey = queryKey;
+    return query;
+};
+/**
+ * @summary Updates hosting onboarding data
+ */
+export const hostingOnboardingDataUpdate = (hostingId, hostingOnboardingDataUpdateBody, options) => {
+    return axios.put(`/v1/hosting/${hostingId}/onboarding`, hostingOnboardingDataUpdateBody, options);
+};
+export const useHostingOnboardingDataUpdate = (options) => {
+    const { mutation: mutationOptions, axios: axiosOptions } = options !== null && options !== void 0 ? options : {};
+    const mutationFn = (props) => {
+        const { hostingId, data } = props !== null && props !== void 0 ? props : {};
+        return hostingOnboardingDataUpdate(hostingId, data, axiosOptions);
+    };
+    return useMutation(mutationFn, mutationOptions);
+};
 /**
  * Enable or disable shell access on an account by setting the shell.SSH key access must be established separately.
  * @summary hosting shell toggle

package/src/index.msw.d.ts

@@ -271,6 +271,12 @@ export declare const getHostingMigrationSiteScanStatusMock: () => {
 export declare const getHostingNameserversMock: () => {
     nameservers: string[];
 };
+export declare const getHostingOnboardingDataMock: () => {
+    completed: boolean | undefined;
+};
+export declare const getHostingOnboardingDataUpdateMock: () => {
+    completed: boolean | undefined;
+};
 export declare const getHostingShellToggleMock: () => {
     enabled: boolean | undefined;
 };

package/src/index.msw.js

@@ -3,7 +3,7 @@
  * Do not edit manually.
  * Hosting UAPI
  * Hosting UAPI is an API to expose Hosting, Addons, and Site functionality to a customer-facing Front End such as (Account Manager).
- * OpenAPI spec version: 1.468.0
+ * OpenAPI spec version: 1.472.0
  */
 import { rest } from 'msw';
 import { faker } from '@faker-js/faker';
@@ -54,6 +54,8 @@ export const getHostingMigrationsEventMock = () => ({ success: faker.helpers.arr
 export const getHostingMigrationInfoMock = () => ({ migration_id: faker.helpers.arrayElement([faker.random.word(), undefined]), domain: faker.helpers.arrayElement([faker.random.word(), undefined]), site_url: faker.helpers.arrayElement([faker.random.word(), undefined]), hostname: faker.helpers.arrayElement([faker.random.word(), undefined]), feasible: faker.helpers.arrayElement([faker.random.word(), undefined]), source_type: faker.helpers.arrayElement([faker.random.word(), undefined]), product_type: faker.helpers.arrayElement([faker.random.word(), undefined]), incoming_domain: faker.helpers.arrayElement([faker.random.word(), undefined]) });
 export const getHostingMigrationSiteScanStatusMock = () => ({ transferable: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), callback_url: faker.helpers.arrayElement([faker.random.word(), undefined]) });
 export const getHostingNameserversMock = () => ({ nameservers: Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => (faker.random.word())) });
+export const getHostingOnboardingDataMock = () => ({ completed: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]) });
+export const getHostingOnboardingDataUpdateMock = () => ({ completed: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]) });
 export const getHostingShellToggleMock = () => ({ enabled: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]) });
 export const getHostingShellInfoMock = () => ({ enabled: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]) });
 export const getHostingSitesMock = () => ({ n_rows: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), n_pages: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), limit: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), max_sites: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), null]), undefined]), used_sites: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), available_sites: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), 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]), name: faker.helpers.arrayElement([faker.random.word(), undefined]), url: faker.helpers.arrayElement([faker.random.word(), undefined]), docroot: faker.helpers.arrayElement([faker.random.word(), undefined]), status: faker.helpers.arrayElement([faker.random.word(), undefined]), pending_url: faker.helpers.arrayElement([faker.random.word(), undefined]), meta: faker.helpers.arrayElement([{ pending_url: faker.helpers.arrayElement([faker.random.word(), undefined]) }, undefined]) })), undefined]) });
@@ -207,6 +209,10 @@ export const getHostingUAPIMSW = () => [
         return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json(getHostingMigrationSiteScanStatusMock()));
     }), rest.get('*/v1/hosting/:hostingId/nameservers', (_req, res, ctx) => {
         return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json(getHostingNameserversMock()));
+    }), rest.get('*/v1/hosting/:hostingId/onboarding', (_req, res, ctx) => {
+        return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json(getHostingOnboardingDataMock()));
+    }), rest.put('*/v1/hosting/:hostingId/onboarding', (_req, res, ctx) => {
+        return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json(getHostingOnboardingDataUpdateMock()));
     }), rest.put('*/v1/hosting/:hostingId/shell', (_req, res, ctx) => {
         return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json(getHostingShellToggleMock()));
     }), rest.get('*/v1/hosting/:hostingId/shell', (_req, res, ctx) => {

package/src/index.schemas.d.ts

@@ -3,7 +3,7 @@
  * Do not edit manually.
  * Hosting UAPI
  * Hosting UAPI is an API to expose Hosting, Addons, and Site functionality to a customer-facing Front End such as (Account Manager).
- * OpenAPI spec version: 1.468.0
+ * OpenAPI spec version: 1.472.0
  */
 export declare type SshKeyListV2200RowsItem = {
     name?: string;
@@ -528,6 +528,15 @@ export declare type HostingShellToggleBody = {
     /** boolean flag to enable or disable hosting shell */
     enabled: boolean;
 };
+export declare type HostingOnboardingDataUpdate200 = {
+    completed?: boolean;
+};
+export declare type HostingOnboardingDataUpdateBody = {
+    completed?: boolean;
+};
+export declare type HostingOnboardingData200 = {
+    completed?: boolean | null;
+};
 export declare type HostingNameservers200 = {
     nameservers: string[];
 };