@newfold/huapi-js 1.413.0 → 1.413.1-alpha
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/README.md +0 -0
- package/orval.config.d.ts +0 -0
- package/orval.config.js +0 -0
- package/package.json +1 -1
- package/src/index.d.ts +265 -28
- package/src/index.js +253 -18
- package/src/index.msw.d.ts +91 -21
- package/src/index.msw.js +57 -12
- package/src/index.schemas.d.ts +185 -29
- package/src/index.schemas.js +7 -0
package/README.md
CHANGED
|
File without changes
|
package/orval.config.d.ts
CHANGED
|
File without changes
|
package/orval.config.js
CHANGED
|
File without changes
|
package/package.json
CHANGED
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.
|
|
6
|
+
* OpenAPI spec version: 0.1.0-unknown
|
|
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 { 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,
|
|
11
|
+
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, AddonsSpamexpertsSso200, 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, DbUserPrivsGet200, DbUserPrivsGetParams, DbUserAdd200, DbUserAddBody, DbUserDelete200, DbUserDeleteBody, DbUserList200, Domains200, DomainsParams, HostingEcommerceInfo200, HostingFtpList200, HostingFtpAdd200, HostingFtpAddBody, HostingFtpUpdate200, HostingFtpUpdateBody, HostingFtp200, HostingFtpBody, HostingInfo200, HostingInfoDiskUsage200, HostingLead200, HostingLead400, HostingLeadParams, 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';
|
|
12
12
|
declare type AwaitedInput<T> = PromiseLike<T> | T;
|
|
13
13
|
declare type Awaited<O> = O extends AwaitedInput<infer T> ? T : never;
|
|
14
14
|
/**
|
|
@@ -278,6 +278,20 @@ export declare const useAddonsInfo: <TData = AxiosResponse<AddonsInfo200, any>,
|
|
|
278
278
|
} | undefined) => UseQueryResult<TData, TError> & {
|
|
279
279
|
queryKey: QueryKey;
|
|
280
280
|
};
|
|
281
|
+
/**
|
|
282
|
+
* Returns spamexperts sso url
|
|
283
|
+
* @summary info
|
|
284
|
+
*/
|
|
285
|
+
export declare const addonsSpamexpertsSso: (addonId: string, options?: AxiosRequestConfig) => Promise<AxiosResponse<AddonsSpamexpertsSso200>>;
|
|
286
|
+
export declare const getAddonsSpamexpertsSsoQueryKey: (addonId: string) => string[];
|
|
287
|
+
export declare type AddonsSpamexpertsSsoQueryResult = NonNullable<Awaited<ReturnType<typeof addonsSpamexpertsSso>>>;
|
|
288
|
+
export declare type AddonsSpamexpertsSsoQueryError = AxiosError<unknown>;
|
|
289
|
+
export declare const useAddonsSpamexpertsSso: <TData = AxiosResponse<AddonsSpamexpertsSso200, any>, TError = AxiosError<unknown, any>>(addonId: string, options?: {
|
|
290
|
+
query?: UseQueryOptions<AxiosResponse<AddonsSpamexpertsSso200, any>, TError, TData, QueryKey> | undefined;
|
|
291
|
+
axios?: AxiosRequestConfig<any> | undefined;
|
|
292
|
+
} | undefined) => UseQueryResult<TData, TError> & {
|
|
293
|
+
queryKey: QueryKey;
|
|
294
|
+
};
|
|
281
295
|
/**
|
|
282
296
|
* Returns HAL hosting account-level information
|
|
283
297
|
* @summary HAL Hosting Account Info
|
|
@@ -296,30 +310,16 @@ export declare const useHostingAccount: <TData = AxiosResponse<HostingAccount200
|
|
|
296
310
|
* Returns a list of addons.
|
|
297
311
|
* @summary addon list
|
|
298
312
|
*/
|
|
299
|
-
export declare const hostingAddons: (hostingId:
|
|
300
|
-
export declare const getHostingAddonsQueryKey: (hostingId:
|
|
313
|
+
export declare const hostingAddons: (hostingId: string, params?: HostingAddonsParams, options?: AxiosRequestConfig) => Promise<AxiosResponse<HostingAddons200>>;
|
|
314
|
+
export declare const getHostingAddonsQueryKey: (hostingId: string, params?: HostingAddonsParams) => (string | HostingAddonsParams)[];
|
|
301
315
|
export declare type HostingAddonsQueryResult = NonNullable<Awaited<ReturnType<typeof hostingAddons>>>;
|
|
302
316
|
export declare type HostingAddonsQueryError = AxiosError<unknown>;
|
|
303
|
-
export declare const useHostingAddons: <TData = AxiosResponse<HostingAddons200, any>, TError = AxiosError<unknown, any>>(hostingId:
|
|
317
|
+
export declare const useHostingAddons: <TData = AxiosResponse<HostingAddons200, any>, TError = AxiosError<unknown, any>>(hostingId: string, params?: HostingAddonsParams, options?: {
|
|
304
318
|
query?: UseQueryOptions<AxiosResponse<HostingAddons200, any>, TError, TData, QueryKey> | undefined;
|
|
305
319
|
axios?: AxiosRequestConfig<any> | undefined;
|
|
306
320
|
} | undefined) => UseQueryResult<TData, TError> & {
|
|
307
321
|
queryKey: QueryKey;
|
|
308
322
|
};
|
|
309
|
-
/**
|
|
310
|
-
* Returns a list of cron jobs
|
|
311
|
-
* @summary cron_list
|
|
312
|
-
*/
|
|
313
|
-
export declare const hostingAdvancedCrontab: (hostingId: number, options?: AxiosRequestConfig) => Promise<AxiosResponse<HostingAdvancedCrontab200>>;
|
|
314
|
-
export declare const getHostingAdvancedCrontabQueryKey: (hostingId: number) => string[];
|
|
315
|
-
export declare type HostingAdvancedCrontabQueryResult = NonNullable<Awaited<ReturnType<typeof hostingAdvancedCrontab>>>;
|
|
316
|
-
export declare type HostingAdvancedCrontabQueryError = AxiosError<unknown>;
|
|
317
|
-
export declare const useHostingAdvancedCrontab: <TData = AxiosResponse<HostingAdvancedCrontab200, any>, TError = AxiosError<unknown, any>>(hostingId: number, options?: {
|
|
318
|
-
query?: UseQueryOptions<AxiosResponse<HostingAdvancedCrontab200, any>, TError, TData, QueryKey> | undefined;
|
|
319
|
-
axios?: AxiosRequestConfig<any> | undefined;
|
|
320
|
-
} | undefined) => UseQueryResult<TData, TError> & {
|
|
321
|
-
queryKey: QueryKey;
|
|
322
|
-
};
|
|
323
323
|
/**
|
|
324
324
|
* Returns the hosting server info
|
|
325
325
|
* @summary server status/info
|
|
@@ -402,11 +402,11 @@ export declare const useHostingAdvancedSystemConsole: <TData = AxiosResponse<Hos
|
|
|
402
402
|
* Returns the hosting capabilities
|
|
403
403
|
* @summary hosting capabilities
|
|
404
404
|
*/
|
|
405
|
-
export declare const hostingCapabilities: (hostingId:
|
|
406
|
-
export declare const getHostingCapabilitiesQueryKey: (hostingId:
|
|
405
|
+
export declare const hostingCapabilities: (hostingId: string, options?: AxiosRequestConfig) => Promise<AxiosResponse<HostingCapabilities200>>;
|
|
406
|
+
export declare const getHostingCapabilitiesQueryKey: (hostingId: string) => string[];
|
|
407
407
|
export declare type HostingCapabilitiesQueryResult = NonNullable<Awaited<ReturnType<typeof hostingCapabilities>>>;
|
|
408
408
|
export declare type HostingCapabilitiesQueryError = AxiosError<unknown>;
|
|
409
|
-
export declare const useHostingCapabilities: <TData = AxiosResponse<HostingCapabilities200, any>, TError = AxiosError<unknown, any>>(hostingId:
|
|
409
|
+
export declare const useHostingCapabilities: <TData = AxiosResponse<HostingCapabilities200, any>, TError = AxiosError<unknown, any>>(hostingId: string, options?: {
|
|
410
410
|
query?: UseQueryOptions<AxiosResponse<HostingCapabilities200, any>, TError, TData, QueryKey> | undefined;
|
|
411
411
|
axios?: AxiosRequestConfig<any> | undefined;
|
|
412
412
|
} | undefined) => UseQueryResult<TData, TError> & {
|
|
@@ -430,6 +430,74 @@ export declare const useAddonCloudflare: <TError = AxiosError<unknown, any>, TCo
|
|
|
430
430
|
hostingId: number;
|
|
431
431
|
data: AddonCloudflareBody;
|
|
432
432
|
}, TContext>;
|
|
433
|
+
/**
|
|
434
|
+
* Returns a list of cron jobs
|
|
435
|
+
* @summary cron_list
|
|
436
|
+
*/
|
|
437
|
+
export declare const listCrons: (hostingId: number, options?: AxiosRequestConfig) => Promise<AxiosResponse<ListCrons200>>;
|
|
438
|
+
export declare const getListCronsQueryKey: (hostingId: number) => string[];
|
|
439
|
+
export declare type ListCronsQueryResult = NonNullable<Awaited<ReturnType<typeof listCrons>>>;
|
|
440
|
+
export declare type ListCronsQueryError = AxiosError<unknown>;
|
|
441
|
+
export declare const useListCrons: <TData = AxiosResponse<ListCrons200, any>, TError = AxiosError<unknown, any>>(hostingId: number, options?: {
|
|
442
|
+
query?: UseQueryOptions<AxiosResponse<ListCrons200, any>, TError, TData, QueryKey> | undefined;
|
|
443
|
+
axios?: AxiosRequestConfig<any> | undefined;
|
|
444
|
+
} | undefined) => UseQueryResult<TData, TError> & {
|
|
445
|
+
queryKey: QueryKey;
|
|
446
|
+
};
|
|
447
|
+
/**
|
|
448
|
+
* Adds a new cron job
|
|
449
|
+
* @summary cron_add
|
|
450
|
+
*/
|
|
451
|
+
export declare const addCron: (hostingId: number, addCronBody: AddCronBody, options?: AxiosRequestConfig) => Promise<AxiosResponse<AddCron200>>;
|
|
452
|
+
export declare type AddCronMutationResult = NonNullable<Awaited<ReturnType<typeof addCron>>>;
|
|
453
|
+
export declare type AddCronMutationBody = AddCronBody;
|
|
454
|
+
export declare type AddCronMutationError = AxiosError<AddCron400>;
|
|
455
|
+
export declare const useAddCron: <TError = AxiosError<AddCron400, any>, TContext = unknown>(options?: {
|
|
456
|
+
mutation?: UseMutationOptions<AxiosResponse<AddCron200, any>, TError, {
|
|
457
|
+
hostingId: number;
|
|
458
|
+
data: AddCronBody;
|
|
459
|
+
}, TContext> | undefined;
|
|
460
|
+
axios?: AxiosRequestConfig<any> | undefined;
|
|
461
|
+
} | undefined) => import("@tanstack/react-query").UseMutationResult<AxiosResponse<AddCron200, any>, TError, {
|
|
462
|
+
hostingId: number;
|
|
463
|
+
data: AddCronBody;
|
|
464
|
+
}, TContext>;
|
|
465
|
+
/**
|
|
466
|
+
* Updates a cron job
|
|
467
|
+
* @summary cron_update
|
|
468
|
+
*/
|
|
469
|
+
export declare const updateCron: (hostingId: number, updateCronBody: UpdateCronBody, options?: AxiosRequestConfig) => Promise<AxiosResponse<UpdateCron200>>;
|
|
470
|
+
export declare type UpdateCronMutationResult = NonNullable<Awaited<ReturnType<typeof updateCron>>>;
|
|
471
|
+
export declare type UpdateCronMutationBody = UpdateCronBody;
|
|
472
|
+
export declare type UpdateCronMutationError = AxiosError<unknown>;
|
|
473
|
+
export declare const useUpdateCron: <TError = AxiosError<unknown, any>, TContext = unknown>(options?: {
|
|
474
|
+
mutation?: UseMutationOptions<AxiosResponse<UpdateCron200, any>, TError, {
|
|
475
|
+
hostingId: number;
|
|
476
|
+
data: UpdateCronBody;
|
|
477
|
+
}, TContext> | undefined;
|
|
478
|
+
axios?: AxiosRequestConfig<any> | undefined;
|
|
479
|
+
} | undefined) => import("@tanstack/react-query").UseMutationResult<AxiosResponse<UpdateCron200, any>, TError, {
|
|
480
|
+
hostingId: number;
|
|
481
|
+
data: UpdateCronBody;
|
|
482
|
+
}, TContext>;
|
|
483
|
+
/**
|
|
484
|
+
* Deletes a cron job
|
|
485
|
+
* @summary cron_delete
|
|
486
|
+
*/
|
|
487
|
+
export declare const cron: (hostingId: number, cronBody: CronBody, options?: AxiosRequestConfig) => Promise<AxiosResponse<Cron200>>;
|
|
488
|
+
export declare type CronMutationResult = NonNullable<Awaited<ReturnType<typeof cron>>>;
|
|
489
|
+
export declare type CronMutationBody = CronBody;
|
|
490
|
+
export declare type CronMutationError = AxiosError<unknown>;
|
|
491
|
+
export declare const useCron: <TError = AxiosError<unknown, any>, TContext = unknown>(options?: {
|
|
492
|
+
mutation?: UseMutationOptions<AxiosResponse<Cron200, any>, TError, {
|
|
493
|
+
hostingId: number;
|
|
494
|
+
data: CronBody;
|
|
495
|
+
}, TContext> | undefined;
|
|
496
|
+
axios?: AxiosRequestConfig<any> | undefined;
|
|
497
|
+
} | undefined) => import("@tanstack/react-query").UseMutationResult<AxiosResponse<Cron200, any>, TError, {
|
|
498
|
+
hostingId: number;
|
|
499
|
+
data: CronBody;
|
|
500
|
+
}, TContext>;
|
|
433
501
|
/**
|
|
434
502
|
* Add a new db to an account
|
|
435
503
|
* @summary Create a database for an account
|
|
@@ -480,20 +548,98 @@ export declare const useDbList: <TData = AxiosResponse<DbList200, any>, TError =
|
|
|
480
548
|
} | undefined) => UseQueryResult<TData, TError> & {
|
|
481
549
|
queryKey: QueryKey;
|
|
482
550
|
};
|
|
551
|
+
/**
|
|
552
|
+
* Get user privileges on a database.
|
|
553
|
+
* @summary Get user privileges on a database.
|
|
554
|
+
*/
|
|
555
|
+
export declare const dbUserPrivsGet: (hostingId: number, params: DbUserPrivsGetParams, options?: AxiosRequestConfig) => Promise<AxiosResponse<DbUserPrivsGet200>>;
|
|
556
|
+
export declare const getDbUserPrivsGetQueryKey: (hostingId: number, params: DbUserPrivsGetParams) => (string | DbUserPrivsGetParams)[];
|
|
557
|
+
export declare type DbUserPrivsGetQueryResult = NonNullable<Awaited<ReturnType<typeof dbUserPrivsGet>>>;
|
|
558
|
+
export declare type DbUserPrivsGetQueryError = AxiosError<unknown>;
|
|
559
|
+
export declare const useDbUserPrivsGet: <TData = AxiosResponse<DbUserPrivsGet200, any>, TError = AxiosError<unknown, any>>(hostingId: number, params: DbUserPrivsGetParams, options?: {
|
|
560
|
+
query?: UseQueryOptions<AxiosResponse<DbUserPrivsGet200, any>, TError, TData, QueryKey> | undefined;
|
|
561
|
+
axios?: AxiosRequestConfig<any> | undefined;
|
|
562
|
+
} | undefined) => UseQueryResult<TData, TError> & {
|
|
563
|
+
queryKey: QueryKey;
|
|
564
|
+
};
|
|
565
|
+
/**
|
|
566
|
+
* Creates a database user. The final username cannot exceed 16 characters, and will have the cpanel account username's first eight characters prepended to it.
|
|
567
|
+
* @summary Create a database user
|
|
568
|
+
*/
|
|
569
|
+
export declare const dbUserAdd: (hostingId: number, dbUserAddBody: DbUserAddBody, options?: AxiosRequestConfig) => Promise<AxiosResponse<DbUserAdd200>>;
|
|
570
|
+
export declare type DbUserAddMutationResult = NonNullable<Awaited<ReturnType<typeof dbUserAdd>>>;
|
|
571
|
+
export declare type DbUserAddMutationBody = DbUserAddBody;
|
|
572
|
+
export declare type DbUserAddMutationError = AxiosError<unknown>;
|
|
573
|
+
export declare const useDbUserAdd: <TError = AxiosError<unknown, any>, TContext = unknown>(options?: {
|
|
574
|
+
mutation?: UseMutationOptions<AxiosResponse<DbUserAdd200, any>, TError, {
|
|
575
|
+
hostingId: number;
|
|
576
|
+
data: DbUserAddBody;
|
|
577
|
+
}, TContext> | undefined;
|
|
578
|
+
axios?: AxiosRequestConfig<any> | undefined;
|
|
579
|
+
} | undefined) => import("@tanstack/react-query").UseMutationResult<AxiosResponse<DbUserAdd200, any>, TError, {
|
|
580
|
+
hostingId: number;
|
|
581
|
+
data: DbUserAddBody;
|
|
582
|
+
}, TContext>;
|
|
583
|
+
/**
|
|
584
|
+
* Delete db user
|
|
585
|
+
* @summary Delete db user
|
|
586
|
+
*/
|
|
587
|
+
export declare const dbUserDelete: (hostingId: number, dbUserDeleteBody: DbUserDeleteBody, options?: AxiosRequestConfig) => Promise<AxiosResponse<DbUserDelete200>>;
|
|
588
|
+
export declare type DbUserDeleteMutationResult = NonNullable<Awaited<ReturnType<typeof dbUserDelete>>>;
|
|
589
|
+
export declare type DbUserDeleteMutationBody = DbUserDeleteBody;
|
|
590
|
+
export declare type DbUserDeleteMutationError = AxiosError<unknown>;
|
|
591
|
+
export declare const useDbUserDelete: <TError = AxiosError<unknown, any>, TContext = unknown>(options?: {
|
|
592
|
+
mutation?: UseMutationOptions<AxiosResponse<DbUserDelete200, any>, TError, {
|
|
593
|
+
hostingId: number;
|
|
594
|
+
data: DbUserDeleteBody;
|
|
595
|
+
}, TContext> | undefined;
|
|
596
|
+
axios?: AxiosRequestConfig<any> | undefined;
|
|
597
|
+
} | undefined) => import("@tanstack/react-query").UseMutationResult<AxiosResponse<DbUserDelete200, any>, TError, {
|
|
598
|
+
hostingId: number;
|
|
599
|
+
data: DbUserDeleteBody;
|
|
600
|
+
}, TContext>;
|
|
601
|
+
/**
|
|
602
|
+
* List all DB users
|
|
603
|
+
* @summary Get list of db users
|
|
604
|
+
*/
|
|
605
|
+
export declare const dbUserList: (hostingId: number, options?: AxiosRequestConfig) => Promise<AxiosResponse<DbUserList200>>;
|
|
606
|
+
export declare const getDbUserListQueryKey: (hostingId: number) => string[];
|
|
607
|
+
export declare type DbUserListQueryResult = NonNullable<Awaited<ReturnType<typeof dbUserList>>>;
|
|
608
|
+
export declare type DbUserListQueryError = AxiosError<unknown>;
|
|
609
|
+
export declare const useDbUserList: <TData = AxiosResponse<DbUserList200, any>, TError = AxiosError<unknown, any>>(hostingId: number, options?: {
|
|
610
|
+
query?: UseQueryOptions<AxiosResponse<DbUserList200, any>, TError, TData, QueryKey> | undefined;
|
|
611
|
+
axios?: AxiosRequestConfig<any> | undefined;
|
|
612
|
+
} | undefined) => UseQueryResult<TData, TError> & {
|
|
613
|
+
queryKey: QueryKey;
|
|
614
|
+
};
|
|
483
615
|
/**
|
|
484
616
|
* Returns a list of domains
|
|
485
617
|
* @summary domain list
|
|
486
618
|
*/
|
|
487
|
-
export declare const domains: (hostingId:
|
|
488
|
-
export declare const getDomainsQueryKey: (hostingId:
|
|
619
|
+
export declare const domains: (hostingId: string, params?: DomainsParams, options?: AxiosRequestConfig) => Promise<AxiosResponse<Domains200>>;
|
|
620
|
+
export declare const getDomainsQueryKey: (hostingId: string, params?: DomainsParams) => (string | DomainsParams)[];
|
|
489
621
|
export declare type DomainsQueryResult = NonNullable<Awaited<ReturnType<typeof domains>>>;
|
|
490
622
|
export declare type DomainsQueryError = AxiosError<unknown>;
|
|
491
|
-
export declare const useDomains: <TData = AxiosResponse<Domains200, any>, TError = AxiosError<unknown, any>>(hostingId:
|
|
623
|
+
export declare const useDomains: <TData = AxiosResponse<Domains200, any>, TError = AxiosError<unknown, any>>(hostingId: string, params?: DomainsParams, options?: {
|
|
492
624
|
query?: UseQueryOptions<AxiosResponse<Domains200, any>, TError, TData, QueryKey> | undefined;
|
|
493
625
|
axios?: AxiosRequestConfig<any> | undefined;
|
|
494
626
|
} | undefined) => UseQueryResult<TData, TError> & {
|
|
495
627
|
queryKey: QueryKey;
|
|
496
628
|
};
|
|
629
|
+
/**
|
|
630
|
+
* Returns info about an existing ecommerce addon otherwise it returns null
|
|
631
|
+
* @summary ecommerce info
|
|
632
|
+
*/
|
|
633
|
+
export declare const hostingEcommerceInfo: (hostingId: number, options?: AxiosRequestConfig) => Promise<AxiosResponse<HostingEcommerceInfo200>>;
|
|
634
|
+
export declare const getHostingEcommerceInfoQueryKey: (hostingId: number) => string[];
|
|
635
|
+
export declare type HostingEcommerceInfoQueryResult = NonNullable<Awaited<ReturnType<typeof hostingEcommerceInfo>>>;
|
|
636
|
+
export declare type HostingEcommerceInfoQueryError = AxiosError<unknown>;
|
|
637
|
+
export declare const useHostingEcommerceInfo: <TData = AxiosResponse<HostingEcommerceInfo200, any>, TError = AxiosError<unknown, any>>(hostingId: number, options?: {
|
|
638
|
+
query?: UseQueryOptions<AxiosResponse<HostingEcommerceInfo200, any>, TError, TData, QueryKey> | undefined;
|
|
639
|
+
axios?: AxiosRequestConfig<any> | undefined;
|
|
640
|
+
} | undefined) => UseQueryResult<TData, TError> & {
|
|
641
|
+
queryKey: QueryKey;
|
|
642
|
+
};
|
|
497
643
|
/**
|
|
498
644
|
* Returns a list of FTP accounts.
|
|
499
645
|
* @summary ftp list
|
|
@@ -590,6 +736,23 @@ export declare const useHostingInfoDiskUsage: <TData = AxiosResponse<HostingInfo
|
|
|
590
736
|
} | undefined) => UseQueryResult<TData, TError> & {
|
|
591
737
|
queryKey: QueryKey;
|
|
592
738
|
};
|
|
739
|
+
/**
|
|
740
|
+
* Returns lead info for the user of the hosting account
|
|
741
|
+
* @summary Lead info
|
|
742
|
+
*/
|
|
743
|
+
export declare const hostingLead: (hostingId: string, params?: HostingLeadParams, options?: AxiosRequestConfig) => Promise<AxiosResponse<HostingLead200>>;
|
|
744
|
+
export declare type HostingLeadMutationResult = NonNullable<Awaited<ReturnType<typeof hostingLead>>>;
|
|
745
|
+
export declare type HostingLeadMutationError = AxiosError<HostingLead400>;
|
|
746
|
+
export declare const useHostingLead: <TError = AxiosError<HostingLead400, any>, TContext = unknown>(options?: {
|
|
747
|
+
mutation?: UseMutationOptions<AxiosResponse<HostingLead200, any>, TError, {
|
|
748
|
+
hostingId: string;
|
|
749
|
+
params?: HostingLeadParams | undefined;
|
|
750
|
+
}, TContext> | undefined;
|
|
751
|
+
axios?: AxiosRequestConfig<any> | undefined;
|
|
752
|
+
} | undefined) => import("@tanstack/react-query").UseMutationResult<AxiosResponse<HostingLead200, any>, TError, {
|
|
753
|
+
hostingId: string;
|
|
754
|
+
params?: HostingLeadParams | undefined;
|
|
755
|
+
}, TContext>;
|
|
593
756
|
/**
|
|
594
757
|
* Gets the Wordpress migration status
|
|
595
758
|
* @summary Wordpress migration status
|
|
@@ -682,6 +845,37 @@ export declare const useHostingNameservers: <TData = AxiosResponse<HostingNamese
|
|
|
682
845
|
} | undefined) => UseQueryResult<TData, TError> & {
|
|
683
846
|
queryKey: QueryKey;
|
|
684
847
|
};
|
|
848
|
+
/**
|
|
849
|
+
* Returns onboarding data
|
|
850
|
+
* @summary Returns hosting onboarding data
|
|
851
|
+
*/
|
|
852
|
+
export declare const hostingOnboardingData: (hostingId: string, options?: AxiosRequestConfig) => Promise<AxiosResponse<HostingOnboardingData200>>;
|
|
853
|
+
export declare const getHostingOnboardingDataQueryKey: (hostingId: string) => string[];
|
|
854
|
+
export declare type HostingOnboardingDataQueryResult = NonNullable<Awaited<ReturnType<typeof hostingOnboardingData>>>;
|
|
855
|
+
export declare type HostingOnboardingDataQueryError = AxiosError<unknown>;
|
|
856
|
+
export declare const useHostingOnboardingData: <TData = AxiosResponse<HostingOnboardingData200, any>, TError = AxiosError<unknown, any>>(hostingId: string, options?: {
|
|
857
|
+
query?: UseQueryOptions<AxiosResponse<HostingOnboardingData200, any>, TError, TData, QueryKey> | undefined;
|
|
858
|
+
axios?: AxiosRequestConfig<any> | undefined;
|
|
859
|
+
} | undefined) => UseQueryResult<TData, TError> & {
|
|
860
|
+
queryKey: QueryKey;
|
|
861
|
+
};
|
|
862
|
+
/**
|
|
863
|
+
* @summary Updates hosting onboarding data
|
|
864
|
+
*/
|
|
865
|
+
export declare const hostingOnboardingDataUpdate: (hostingId: string, hostingOnboardingDataUpdateBody: HostingOnboardingDataUpdateBody, options?: AxiosRequestConfig) => Promise<AxiosResponse<HostingOnboardingDataUpdate200>>;
|
|
866
|
+
export declare type HostingOnboardingDataUpdateMutationResult = NonNullable<Awaited<ReturnType<typeof hostingOnboardingDataUpdate>>>;
|
|
867
|
+
export declare type HostingOnboardingDataUpdateMutationBody = HostingOnboardingDataUpdateBody;
|
|
868
|
+
export declare type HostingOnboardingDataUpdateMutationError = AxiosError<unknown>;
|
|
869
|
+
export declare const useHostingOnboardingDataUpdate: <TError = AxiosError<unknown, any>, TContext = unknown>(options?: {
|
|
870
|
+
mutation?: UseMutationOptions<AxiosResponse<HostingOnboardingDataUpdate200, any>, TError, {
|
|
871
|
+
hostingId: string;
|
|
872
|
+
data: HostingOnboardingDataUpdateBody;
|
|
873
|
+
}, TContext> | undefined;
|
|
874
|
+
axios?: AxiosRequestConfig<any> | undefined;
|
|
875
|
+
} | undefined) => import("@tanstack/react-query").UseMutationResult<AxiosResponse<HostingOnboardingDataUpdate200, any>, TError, {
|
|
876
|
+
hostingId: string;
|
|
877
|
+
data: HostingOnboardingDataUpdateBody;
|
|
878
|
+
}, TContext>;
|
|
685
879
|
/**
|
|
686
880
|
* Enable or disable shell access on an account by setting the shell.SSH key access must be established separately.
|
|
687
881
|
* @summary hosting shell toggle
|
|
@@ -750,11 +944,11 @@ export declare const useHostingSiteAdd: <TError = AxiosError<unknown, any>, TCon
|
|
|
750
944
|
* Returns the hosting account's SSH information
|
|
751
945
|
* @summary ssh info
|
|
752
946
|
*/
|
|
753
|
-
export declare const hostingSshInfo: (hostingId:
|
|
754
|
-
export declare const getHostingSshInfoQueryKey: (hostingId:
|
|
947
|
+
export declare const hostingSshInfo: (hostingId: string, options?: AxiosRequestConfig) => Promise<AxiosResponse<HostingSshInfo200>>;
|
|
948
|
+
export declare const getHostingSshInfoQueryKey: (hostingId: string) => string[];
|
|
755
949
|
export declare type HostingSshInfoQueryResult = NonNullable<Awaited<ReturnType<typeof hostingSshInfo>>>;
|
|
756
950
|
export declare type HostingSshInfoQueryError = AxiosError<unknown>;
|
|
757
|
-
export declare const useHostingSshInfo: <TData = AxiosResponse<HostingSshInfo200, any>, TError = AxiosError<unknown, any>>(hostingId:
|
|
951
|
+
export declare const useHostingSshInfo: <TData = AxiosResponse<HostingSshInfo200, any>, TError = AxiosError<unknown, any>>(hostingId: string, options?: {
|
|
758
952
|
query?: UseQueryOptions<AxiosResponse<HostingSshInfo200, any>, TError, TData, QueryKey> | undefined;
|
|
759
953
|
axios?: AxiosRequestConfig<any> | undefined;
|
|
760
954
|
} | undefined) => UseQueryResult<TData, TError> & {
|
|
@@ -979,6 +1173,21 @@ export declare const useSitesHasBackups: <TData = AxiosResponse<SitesHasBackups2
|
|
|
979
1173
|
} | undefined) => UseQueryResult<TData, TError> & {
|
|
980
1174
|
queryKey: QueryKey;
|
|
981
1175
|
};
|
|
1176
|
+
/**
|
|
1177
|
+
* Adds the site to the codeguard
|
|
1178
|
+
* @summary Add additional sites to codeguard
|
|
1179
|
+
*/
|
|
1180
|
+
export declare const sitesBackupsCodeguard: (siteId: number, options?: AxiosRequestConfig) => Promise<AxiosResponse<SitesBackupsCodeguard200>>;
|
|
1181
|
+
export declare type SitesBackupsCodeguardMutationResult = NonNullable<Awaited<ReturnType<typeof sitesBackupsCodeguard>>>;
|
|
1182
|
+
export declare type SitesBackupsCodeguardMutationError = AxiosError<unknown>;
|
|
1183
|
+
export declare const useSitesBackupsCodeguard: <TError = AxiosError<unknown, any>, TContext = unknown>(options?: {
|
|
1184
|
+
mutation?: UseMutationOptions<AxiosResponse<SitesBackupsCodeguard200, any>, TError, {
|
|
1185
|
+
siteId: number;
|
|
1186
|
+
}, TContext> | undefined;
|
|
1187
|
+
axios?: AxiosRequestConfig<any> | undefined;
|
|
1188
|
+
} | undefined) => import("@tanstack/react-query").UseMutationResult<AxiosResponse<SitesBackupsCodeguard200, any>, TError, {
|
|
1189
|
+
siteId: number;
|
|
1190
|
+
}, TContext>;
|
|
982
1191
|
/**
|
|
983
1192
|
* Returns details about the backup options available for the site, i.e. details about the codeguard backup addon and the jetpack based on if one or both of them are added to the account.
|
|
984
1193
|
* @summary site backup details
|
|
@@ -1053,6 +1262,21 @@ export declare const useSitesDomainUrl: <TError = AxiosError<unknown, any>, TCon
|
|
|
1053
1262
|
siteId: number;
|
|
1054
1263
|
data: SitesDomainUrlBody;
|
|
1055
1264
|
}, TContext>;
|
|
1265
|
+
/**
|
|
1266
|
+
* Delete pending domain
|
|
1267
|
+
* @summary Delete pending domain
|
|
1268
|
+
*/
|
|
1269
|
+
export declare const sitePendingDomainDelete: (siteId: number, options?: AxiosRequestConfig) => Promise<AxiosResponse<SitePendingDomainDelete200>>;
|
|
1270
|
+
export declare type SitePendingDomainDeleteMutationResult = NonNullable<Awaited<ReturnType<typeof sitePendingDomainDelete>>>;
|
|
1271
|
+
export declare type SitePendingDomainDeleteMutationError = AxiosError<unknown>;
|
|
1272
|
+
export declare const useSitePendingDomainDelete: <TError = AxiosError<unknown, any>, TContext = unknown>(options?: {
|
|
1273
|
+
mutation?: UseMutationOptions<AxiosResponse<SitePendingDomainDelete200, any>, TError, {
|
|
1274
|
+
siteId: number;
|
|
1275
|
+
}, TContext> | undefined;
|
|
1276
|
+
axios?: AxiosRequestConfig<any> | undefined;
|
|
1277
|
+
} | undefined) => import("@tanstack/react-query").UseMutationResult<AxiosResponse<SitePendingDomainDelete200, any>, TError, {
|
|
1278
|
+
siteId: number;
|
|
1279
|
+
}, TContext>;
|
|
1056
1280
|
/**
|
|
1057
1281
|
* cache purge site and url
|
|
1058
1282
|
* @summary cache purge url
|
|
@@ -1484,6 +1708,19 @@ export declare const useSitesSso: <TData = AxiosResponse<SitesSso200, any>, TErr
|
|
|
1484
1708
|
} | undefined) => UseQueryResult<TData, TError> & {
|
|
1485
1709
|
queryKey: QueryKey;
|
|
1486
1710
|
};
|
|
1711
|
+
/**
|
|
1712
|
+
* @summary site status
|
|
1713
|
+
*/
|
|
1714
|
+
export declare const siteStatus: (siteId: number, options?: AxiosRequestConfig) => Promise<AxiosResponse<SiteStatus200>>;
|
|
1715
|
+
export declare const getSiteStatusQueryKey: (siteId: number) => string[];
|
|
1716
|
+
export declare type SiteStatusQueryResult = NonNullable<Awaited<ReturnType<typeof siteStatus>>>;
|
|
1717
|
+
export declare type SiteStatusQueryError = AxiosError<unknown>;
|
|
1718
|
+
export declare const useSiteStatus: <TData = AxiosResponse<SiteStatus200, any>, TError = AxiosError<unknown, any>>(siteId: number, options?: {
|
|
1719
|
+
query?: UseQueryOptions<AxiosResponse<SiteStatus200, any>, TError, TData, QueryKey> | undefined;
|
|
1720
|
+
axios?: AxiosRequestConfig<any> | undefined;
|
|
1721
|
+
} | undefined) => UseQueryResult<TData, TError> & {
|
|
1722
|
+
queryKey: QueryKey;
|
|
1723
|
+
};
|
|
1487
1724
|
/**
|
|
1488
1725
|
* Returns a list of the site's users
|
|
1489
1726
|
* @summary users
|