@newfold/huapi-js 1.2.8-alpha → 1.2.9

package/README.md

@@ -14,12 +14,12 @@ $ yarn add @newfold/huapi-js
 ### React Hooks
 
 ```js
-import React from "react";
+import React from 'react';
 
-import { useHostingSites } from "@newfold/huapi-js";
+import { useHostingSites } from '@newfold/huapi-js';
 
 const MyComponent = () => {
-  const hostingId = "2";
+  const hostingId = '2';
   const { isLoading, data } = useHostingSites(hostingId);
 
   if (isLoading) return <h1>Loading...</h1>;
@@ -33,3 +33,51 @@ const MyComponent = () => {
   );
 };
 ```
+
+### Mocking with custom handlers
+
+Custom [Mock Service Worker](https://mswjs.io/) handlers can be imported directly from `@newfold/huapi-js` to easily manipulate your local application or unit tests in an offline testing setting.
+
+First, ensure that [Mock Service Worker](https://mswjs.io/) is configured in your project, then import and add handlers during your `setupWorker` or `setupServer` calls as follows:
+
+```js
+// import handlers to override data as needed for testing
+import { getHostingSitesHandler } from '@newfold/huapi-js/dist/handlers.msw';
+
+// add the handlers to your setupServer call
+const server = setupServer(
+  ...[
+    // mock GET /hosting/:hosting-id/sites
+    getHostingSitesHandler(),
+
+    // add additional handlers here:
+    // postHostingSite(),
+  ],
+);
+```
+
+#### Advanced handlers
+
+## Building from huapi
+
+Eventually we would like to have an automatic CICD pipeline that kicks off when new `huapi` builds change the openapi.json specification file (OAS). For now, we can do this manually by running the build command locally and publishing to npm. This can be done with the following steps:
+
+1. Ensure your repo is on the `main` branch and in a clean state locally (no unstaged changes)
+2. Run `yarn build` to pull down the OAS and create new build files
+3. Publish to npm with `yarn publish --public` [or to use `npm` first manually update the version in package.json and git commit/push this change, then use `npm publish --access public` to publish the changes]
+
+   > NOTE: You may need to request permissions to publish to the npm registry. Please speak to your manager to request access for this through the Hosting Engineering Leadership Team. Please provide your npmjs.com username with your request, and ensure 2FA Authentication is enabled in your npmjs.com dashboard.
+
+## Development
+
+### Adding Endpoints
+
+`@newfold/haupi-js` is based on the OpenAPI specification file that is published by the core `huapi` project. To add new endpoints, update the core project and publish an updated file, then ensure the build script in `package.json` is pointed to it.
+
+```sh
+# run the build command to build a new verions
+$ yarn build
+# building @newfold/huapi-js...
+```
+
+### Adding Custom Mock Handlers

package/dist/index.d.ts

@@ -2,95 +2,267 @@
  * Generated by orval v6.7.1 🍺
  * 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: 0.1.0
  */
 import { AxiosRequestConfig, AxiosResponse, AxiosError } from 'axios';
 import { UseQueryOptions, UseMutationOptions, UseQueryResult, QueryKey } from 'react-query';
-import type { GetAddonsCodeguardWebsiteListV1200, GetHostingInfoV1200, GetHostingFtpV1200, PostHostingFtpV1200, PostHostingFtpV1Body, GetSitesSsoV1200, GetHostingSitesV1200 } from './models';
+import type { AddonsCodeguardWebsiteList200, AddonsCodeguardBackups200, AddonsCodeguardBackupsParams, AddonsCodeguardLoginLinkGenerate200, AddonsCodeguardDatabaseBackupCreate200, AddonsCodeguardDatabaseBackupCreateBody, AddonsCodeguardWebsiteBackupCreate200, AddonsCodeguardWebsiteBackupCreateBody, AddonsCodeguardDatabaseList200, AddonsCodeguardWebsiteBackupList200, AddonsCodeguardWebsiteBackupListParams, AddonsCodeguardDatabaseBackupList200, AddonsCodeguardDatabaseBackupListParams, AddonsCodeguardBackupRestore200, AddonsCodeguardBackupRestoreBody, AddonsCodeguardWebsiteBackupRestore200, AddonsCodeguardWebsiteBackupRestore400, AddonsCodeguardWebsiteBackupRestoreBody, AddonsCodeguardDatabaseBackupRestore200, AddonsCodeguardDatabaseBackupRestoreBody, HostingInfo200, HostingAddons200, HostingAddonsParams, HostingFtpList200, SitesSso200, SitesInfo200, HostingSites200 } from './models';
 declare type AsyncReturnType<T extends (...args: any) => Promise<any>> = T extends (...args: any) => Promise<infer R> ? R : any;
 /**
  * Return all website records CodeGuard maintains for this user's account.
  * @summary  addons codeguard website_list
  */
-export declare const getAddonsCodeguardWebsiteListV1: (addonId: number, options?: AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<GetAddonsCodeguardWebsiteListV1200>>;
-export declare const getGetAddonsCodeguardWebsiteListV1QueryKey: (addonId: number) => string[];
-export declare type GetAddonsCodeguardWebsiteListV1QueryResult = NonNullable<AsyncReturnType<typeof getAddonsCodeguardWebsiteListV1>>;
-export declare type GetAddonsCodeguardWebsiteListV1QueryError = AxiosError<unknown>;
-export declare const useGetAddonsCodeguardWebsiteListV1: <TData = AxiosResponse<GetAddonsCodeguardWebsiteListV1200, any>, TError = AxiosError<unknown, any>>(addonId: number, options?: {
-    query?: UseQueryOptions<AxiosResponse<GetAddonsCodeguardWebsiteListV1200, any>, TError, TData, QueryKey> | undefined;
+export declare const addonsCodeguardWebsiteList: (addonId: number, options?: AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<AddonsCodeguardWebsiteList200>>;
+export declare const getAddonsCodeguardWebsiteListQueryKey: (addonId: number) => string[];
+export declare type AddonsCodeguardWebsiteListQueryResult = NonNullable<AsyncReturnType<typeof addonsCodeguardWebsiteList>>;
+export declare type AddonsCodeguardWebsiteListQueryError = AxiosError<unknown>;
+export declare const useAddonsCodeguardWebsiteList: <TData = AxiosResponse<AddonsCodeguardWebsiteList200, any>, TError = AxiosError<unknown, any>>(addonId: number, options?: {
+    query?: UseQueryOptions<AxiosResponse<AddonsCodeguardWebsiteList200, any>, TError, TData, QueryKey> | undefined;
     axios?: AxiosRequestConfig<any> | undefined;
 } | undefined) => UseQueryResult<TData, TError> & {
     queryKey: QueryKey;
 };
 /**
- * Return info about a specific account
- * @summary  hosting info
+ * Returns a combined backup list with website commit ids and corresponding database commits
+ * @summary addons codeguard backups
  */
-export declare const getHostingInfoV1: (hostingId: number, options?: AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<GetHostingInfoV1200>>;
-export declare const getGetHostingInfoV1QueryKey: (hostingId: number) => string[];
-export declare type GetHostingInfoV1QueryResult = NonNullable<AsyncReturnType<typeof getHostingInfoV1>>;
-export declare type GetHostingInfoV1QueryError = AxiosError<unknown>;
-export declare const useGetHostingInfoV1: <TData = AxiosResponse<GetHostingInfoV1200, any>, TError = AxiosError<unknown, any>>(hostingId: number, options?: {
-    query?: UseQueryOptions<AxiosResponse<GetHostingInfoV1200, any>, TError, TData, QueryKey> | undefined;
+export declare const addonsCodeguardBackups: (addonId: number, params?: AddonsCodeguardBackupsParams | undefined, options?: AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<AddonsCodeguardBackups200>>;
+export declare const getAddonsCodeguardBackupsQueryKey: (addonId: number, params?: AddonsCodeguardBackupsParams | undefined) => (string | AddonsCodeguardBackupsParams)[];
+export declare type AddonsCodeguardBackupsQueryResult = NonNullable<AsyncReturnType<typeof addonsCodeguardBackups>>;
+export declare type AddonsCodeguardBackupsQueryError = AxiosError<unknown>;
+export declare const useAddonsCodeguardBackups: <TData = AxiosResponse<AddonsCodeguardBackups200, any>, TError = AxiosError<unknown, any>>(addonId: number, params?: AddonsCodeguardBackupsParams | undefined, options?: {
+    query?: UseQueryOptions<AxiosResponse<AddonsCodeguardBackups200, any>, TError, TData, QueryKey> | undefined;
     axios?: AxiosRequestConfig<any> | undefined;
 } | undefined) => UseQueryResult<TData, TError> & {
     queryKey: QueryKey;
 };
 /**
- * List FTP accounts.
- * @summary  hosting ftp
+ * Returns an oauth login URL that can be used to access CodeGuard dashboard for a user.
+ * @summary addons codeguard login_link_generate
+ */
+export declare const addonsCodeguardLoginLinkGenerate: (addonId: number, options?: AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<AddonsCodeguardLoginLinkGenerate200>>;
+export declare const getAddonsCodeguardLoginLinkGenerateQueryKey: (addonId: number) => string[];
+export declare type AddonsCodeguardLoginLinkGenerateQueryResult = NonNullable<AsyncReturnType<typeof addonsCodeguardLoginLinkGenerate>>;
+export declare type AddonsCodeguardLoginLinkGenerateQueryError = AxiosError<unknown>;
+export declare const useAddonsCodeguardLoginLinkGenerate: <TData = AxiosResponse<AddonsCodeguardLoginLinkGenerate200, any>, TError = AxiosError<unknown, any>>(addonId: number, options?: {
+    query?: UseQueryOptions<AxiosResponse<AddonsCodeguardLoginLinkGenerate200, any>, TError, TData, QueryKey> | undefined;
+    axios?: AxiosRequestConfig<any> | undefined;
+} | undefined) => UseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+/**
+ * Queue the creation of a database backup.
+ * @summary addons codeguard database_backup_create
+ */
+export declare const addonsCodeguardDatabaseBackupCreate: (addonId: number, addonsCodeguardDatabaseBackupCreateBody: AddonsCodeguardDatabaseBackupCreateBody, options?: AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<AddonsCodeguardDatabaseBackupCreate200>>;
+export declare type AddonsCodeguardDatabaseBackupCreateMutationResult = NonNullable<AsyncReturnType<typeof addonsCodeguardDatabaseBackupCreate>>;
+export declare type AddonsCodeguardDatabaseBackupCreateMutationBody = AddonsCodeguardDatabaseBackupCreateBody;
+export declare type AddonsCodeguardDatabaseBackupCreateMutationError = AxiosError<unknown>;
+export declare const useAddonsCodeguardDatabaseBackupCreate: <TError = AxiosError<unknown, any>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<AxiosResponse<AddonsCodeguardDatabaseBackupCreate200, any>, TError, {
+        addonId: number;
+        data: AddonsCodeguardDatabaseBackupCreateBody;
+    }, TContext> | undefined;
+    axios?: AxiosRequestConfig<any> | undefined;
+} | undefined) => import("react-query").UseMutationResult<AxiosResponse<AddonsCodeguardDatabaseBackupCreate200, any>, TError, {
+    addonId: number;
+    data: AddonsCodeguardDatabaseBackupCreateBody;
+}, TContext>;
+/**
+ * Initiate the creation of a new backup for a given website
+ * @summary addons codeguard website_backup_create
+ */
+export declare const addonsCodeguardWebsiteBackupCreate: (addonId: number, addonsCodeguardWebsiteBackupCreateBody: AddonsCodeguardWebsiteBackupCreateBody, options?: AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<AddonsCodeguardWebsiteBackupCreate200>>;
+export declare type AddonsCodeguardWebsiteBackupCreateMutationResult = NonNullable<AsyncReturnType<typeof addonsCodeguardWebsiteBackupCreate>>;
+export declare type AddonsCodeguardWebsiteBackupCreateMutationBody = AddonsCodeguardWebsiteBackupCreateBody;
+export declare type AddonsCodeguardWebsiteBackupCreateMutationError = AxiosError<unknown>;
+export declare const useAddonsCodeguardWebsiteBackupCreate: <TError = AxiosError<unknown, any>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<AxiosResponse<AddonsCodeguardWebsiteBackupCreate200, any>, TError, {
+        addonId: number;
+        data: AddonsCodeguardWebsiteBackupCreateBody;
+    }, TContext> | undefined;
+    axios?: AxiosRequestConfig<any> | undefined;
+} | undefined) => import("react-query").UseMutationResult<AxiosResponse<AddonsCodeguardWebsiteBackupCreate200, any>, TError, {
+    addonId: number;
+    data: AddonsCodeguardWebsiteBackupCreateBody;
+}, TContext>;
+/**
+ * Return all database records CodeGuard maintains for this user's account.
+ * @summary  addons codeguard database_list
  */
-export declare const getHostingFtpV1: (hostingId: number, options?: AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<GetHostingFtpV1200>>;
-export declare const getGetHostingFtpV1QueryKey: (hostingId: number) => string[];
-export declare type GetHostingFtpV1QueryResult = NonNullable<AsyncReturnType<typeof getHostingFtpV1>>;
-export declare type GetHostingFtpV1QueryError = AxiosError<unknown>;
-export declare const useGetHostingFtpV1: <TData = AxiosResponse<GetHostingFtpV1200, any>, TError = AxiosError<unknown, any>>(hostingId: number, options?: {
-    query?: UseQueryOptions<AxiosResponse<GetHostingFtpV1200, any>, TError, TData, QueryKey> | undefined;
+export declare const addonsCodeguardDatabaseList: (addonId: number, options?: AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<AddonsCodeguardDatabaseList200>>;
+export declare const getAddonsCodeguardDatabaseListQueryKey: (addonId: number) => string[];
+export declare type AddonsCodeguardDatabaseListQueryResult = NonNullable<AsyncReturnType<typeof addonsCodeguardDatabaseList>>;
+export declare type AddonsCodeguardDatabaseListQueryError = AxiosError<unknown>;
+export declare const useAddonsCodeguardDatabaseList: <TData = AxiosResponse<AddonsCodeguardDatabaseList200, any>, TError = AxiosError<unknown, any>>(addonId: number, options?: {
+    query?: UseQueryOptions<AxiosResponse<AddonsCodeguardDatabaseList200, any>, TError, TData, QueryKey> | undefined;
     axios?: AxiosRequestConfig<any> | undefined;
 } | undefined) => UseQueryResult<TData, TError> & {
     queryKey: QueryKey;
 };
 /**
- * Makes a FTP account and returns login credentials for it.
- * @summary  hosting ftp
- */
-export declare const postHostingFtpV1: (hostingId: number, postHostingFtpV1Body: PostHostingFtpV1Body, options?: AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<PostHostingFtpV1200>>;
-export declare type PostHostingFtpV1MutationResult = NonNullable<AsyncReturnType<typeof postHostingFtpV1>>;
-export declare type PostHostingFtpV1MutationBody = PostHostingFtpV1Body;
-export declare type PostHostingFtpV1MutationError = AxiosError<unknown>;
-export declare const usePostHostingFtpV1: <TError = AxiosError<unknown, any>, TContext = unknown>(options?: {
-    mutation?: UseMutationOptions<AxiosResponse<PostHostingFtpV1200, any>, TError, {
-        hostingId: number;
-        data: PostHostingFtpV1Body;
+ * Return all website backup records CodeGuard maintains for this user's account.
+ * @summary  addons codeguard website backup list
+ */
+export declare const addonsCodeguardWebsiteBackupList: (addonId: number, params?: AddonsCodeguardWebsiteBackupListParams | undefined, options?: AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<AddonsCodeguardWebsiteBackupList200>>;
+export declare const getAddonsCodeguardWebsiteBackupListQueryKey: (addonId: number, params?: AddonsCodeguardWebsiteBackupListParams | undefined) => (string | AddonsCodeguardWebsiteBackupListParams)[];
+export declare type AddonsCodeguardWebsiteBackupListQueryResult = NonNullable<AsyncReturnType<typeof addonsCodeguardWebsiteBackupList>>;
+export declare type AddonsCodeguardWebsiteBackupListQueryError = AxiosError<unknown>;
+export declare const useAddonsCodeguardWebsiteBackupList: <TData = AxiosResponse<AddonsCodeguardWebsiteBackupList200, any>, TError = AxiosError<unknown, any>>(addonId: number, params?: AddonsCodeguardWebsiteBackupListParams | undefined, options?: {
+    query?: UseQueryOptions<AxiosResponse<AddonsCodeguardWebsiteBackupList200, any>, TError, TData, QueryKey> | undefined;
+    axios?: AxiosRequestConfig<any> | undefined;
+} | undefined) => UseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+/**
+ * Return all database backup records CodeGuard maintains for this user's account.
+ * @summary  addons codeguard database backup list
+ */
+export declare const addonsCodeguardDatabaseBackupList: (addonId: number, params?: AddonsCodeguardDatabaseBackupListParams | undefined, options?: AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<AddonsCodeguardDatabaseBackupList200>>;
+export declare const getAddonsCodeguardDatabaseBackupListQueryKey: (addonId: number, params?: AddonsCodeguardDatabaseBackupListParams | undefined) => (string | AddonsCodeguardDatabaseBackupListParams)[];
+export declare type AddonsCodeguardDatabaseBackupListQueryResult = NonNullable<AsyncReturnType<typeof addonsCodeguardDatabaseBackupList>>;
+export declare type AddonsCodeguardDatabaseBackupListQueryError = AxiosError<unknown>;
+export declare const useAddonsCodeguardDatabaseBackupList: <TData = AxiosResponse<AddonsCodeguardDatabaseBackupList200, any>, TError = AxiosError<unknown, any>>(addonId: number, params?: AddonsCodeguardDatabaseBackupListParams | undefined, options?: {
+    query?: UseQueryOptions<AxiosResponse<AddonsCodeguardDatabaseBackupList200, any>, TError, TData, QueryKey> | undefined;
+    axios?: AxiosRequestConfig<any> | undefined;
+} | undefined) => UseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+/**
+ * Restores the website backup
+ * @summary  addons codeguard website backup restore
+ */
+export declare const addonsCodeguardBackupRestore: (addonId: number, addonsCodeguardBackupRestoreBody: AddonsCodeguardBackupRestoreBody, options?: AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<AddonsCodeguardBackupRestore200>>;
+export declare type AddonsCodeguardBackupRestoreMutationResult = NonNullable<AsyncReturnType<typeof addonsCodeguardBackupRestore>>;
+export declare type AddonsCodeguardBackupRestoreMutationBody = AddonsCodeguardBackupRestoreBody;
+export declare type AddonsCodeguardBackupRestoreMutationError = AxiosError<unknown>;
+export declare const useAddonsCodeguardBackupRestore: <TError = AxiosError<unknown, any>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<AxiosResponse<AddonsCodeguardBackupRestore200, any>, TError, {
+        addonId: number;
+        data: AddonsCodeguardBackupRestoreBody;
+    }, TContext> | undefined;
+    axios?: AxiosRequestConfig<any> | undefined;
+} | undefined) => import("react-query").UseMutationResult<AxiosResponse<AddonsCodeguardBackupRestore200, any>, TError, {
+    addonId: number;
+    data: AddonsCodeguardBackupRestoreBody;
+}, TContext>;
+/**
+ * Restores the website backup
+ * @summary  addons codeguard website backup restore
+ */
+export declare const addonsCodeguardWebsiteBackupRestore: (addonId: number, addonsCodeguardWebsiteBackupRestoreBody: AddonsCodeguardWebsiteBackupRestoreBody, options?: AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<AddonsCodeguardWebsiteBackupRestore200>>;
+export declare type AddonsCodeguardWebsiteBackupRestoreMutationResult = NonNullable<AsyncReturnType<typeof addonsCodeguardWebsiteBackupRestore>>;
+export declare type AddonsCodeguardWebsiteBackupRestoreMutationBody = AddonsCodeguardWebsiteBackupRestoreBody;
+export declare type AddonsCodeguardWebsiteBackupRestoreMutationError = AxiosError<AddonsCodeguardWebsiteBackupRestore400>;
+export declare const useAddonsCodeguardWebsiteBackupRestore: <TError = AxiosError<AddonsCodeguardWebsiteBackupRestore400, any>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<AxiosResponse<AddonsCodeguardWebsiteBackupRestore200, any>, TError, {
+        addonId: number;
+        data: AddonsCodeguardWebsiteBackupRestoreBody;
     }, TContext> | undefined;
     axios?: AxiosRequestConfig<any> | undefined;
-} | undefined) => import("react-query").UseMutationResult<AxiosResponse<PostHostingFtpV1200, any>, TError, {
-    hostingId: number;
-    data: PostHostingFtpV1Body;
+} | undefined) => import("react-query").UseMutationResult<AxiosResponse<AddonsCodeguardWebsiteBackupRestore200, any>, TError, {
+    addonId: number;
+    data: AddonsCodeguardWebsiteBackupRestoreBody;
 }, TContext>;
+/**
+ * Restores the database backup
+ * @summary  addons codeguard database backup restore
+ */
+export declare const addonsCodeguardDatabaseBackupRestore: (addonId: number, addonsCodeguardDatabaseBackupRestoreBody: AddonsCodeguardDatabaseBackupRestoreBody, options?: AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<AddonsCodeguardDatabaseBackupRestore200>>;
+export declare type AddonsCodeguardDatabaseBackupRestoreMutationResult = NonNullable<AsyncReturnType<typeof addonsCodeguardDatabaseBackupRestore>>;
+export declare type AddonsCodeguardDatabaseBackupRestoreMutationBody = AddonsCodeguardDatabaseBackupRestoreBody;
+export declare type AddonsCodeguardDatabaseBackupRestoreMutationError = AxiosError<unknown>;
+export declare const useAddonsCodeguardDatabaseBackupRestore: <TError = AxiosError<unknown, any>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<AxiosResponse<AddonsCodeguardDatabaseBackupRestore200, any>, TError, {
+        addonId: number;
+        data: AddonsCodeguardDatabaseBackupRestoreBody;
+    }, TContext> | undefined;
+    axios?: AxiosRequestConfig<any> | undefined;
+} | undefined) => import("react-query").UseMutationResult<AxiosResponse<AddonsCodeguardDatabaseBackupRestore200, any>, TError, {
+    addonId: number;
+    data: AddonsCodeguardDatabaseBackupRestoreBody;
+}, TContext>;
+/**
+ * Return info about a specific account
+ * @summary hosting info
+ */
+export declare const hostingInfo: (hostingId: number, options?: AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<HostingInfo200>>;
+export declare const getHostingInfoQueryKey: (hostingId: number) => string[];
+export declare type HostingInfoQueryResult = NonNullable<AsyncReturnType<typeof hostingInfo>>;
+export declare type HostingInfoQueryError = AxiosError<unknown>;
+export declare const useHostingInfo: <TData = AxiosResponse<HostingInfo200, any>, TError = AxiosError<unknown, any>>(hostingId: number, options?: {
+    query?: UseQueryOptions<AxiosResponse<HostingInfo200, any>, TError, TData, QueryKey> | undefined;
+    axios?: AxiosRequestConfig<any> | undefined;
+} | undefined) => UseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+/**
+ * Obtain a list of addons.
+ * @summary hosting addons
+ */
+export declare const hostingAddons: (hostingId: number, params?: HostingAddonsParams | undefined, options?: AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<HostingAddons200>>;
+export declare const getHostingAddonsQueryKey: (hostingId: number, params?: HostingAddonsParams | undefined) => (string | HostingAddonsParams)[];
+export declare type HostingAddonsQueryResult = NonNullable<AsyncReturnType<typeof hostingAddons>>;
+export declare type HostingAddonsQueryError = AxiosError<unknown>;
+export declare const useHostingAddons: <TData = AxiosResponse<HostingAddons200, any>, TError = AxiosError<unknown, any>>(hostingId: number, params?: HostingAddonsParams | undefined, options?: {
+    query?: UseQueryOptions<AxiosResponse<HostingAddons200, any>, TError, TData, QueryKey> | undefined;
+    axios?: AxiosRequestConfig<any> | undefined;
+} | undefined) => UseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+/**
+ * List FTP accounts.
+ * @summary hosting ftp list
+ */
+export declare const hostingFtpList: (hostingId: number, options?: AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<HostingFtpList200>>;
+export declare const getHostingFtpListQueryKey: (hostingId: number) => string[];
+export declare type HostingFtpListQueryResult = NonNullable<AsyncReturnType<typeof hostingFtpList>>;
+export declare type HostingFtpListQueryError = AxiosError<unknown>;
+export declare const useHostingFtpList: <TData = AxiosResponse<HostingFtpList200, any>, TError = AxiosError<unknown, any>>(hostingId: number, options?: {
+    query?: UseQueryOptions<AxiosResponse<HostingFtpList200, any>, TError, TData, QueryKey> | undefined;
+    axios?: AxiosRequestConfig<any> | undefined;
+} | undefined) => UseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
 /**
  * Return an SSO token or login URL for this site (if supported).
- * @summary  sites sso
+ * @summary sites sso
+ */
+export declare const sitesSso: (siteId: number, options?: AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<SitesSso200>>;
+export declare const getSitesSsoQueryKey: (siteId: number) => string[];
+export declare type SitesSsoQueryResult = NonNullable<AsyncReturnType<typeof sitesSso>>;
+export declare type SitesSsoQueryError = AxiosError<unknown>;
+export declare const useSitesSso: <TData = AxiosResponse<SitesSso200, any>, TError = AxiosError<unknown, any>>(siteId: number, options?: {
+    query?: UseQueryOptions<AxiosResponse<SitesSso200, any>, TError, TData, QueryKey> | undefined;
+    axios?: AxiosRequestConfig<any> | undefined;
+} | undefined) => UseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+/**
+ * Return info about a specific site
+ * @summary sites info
  */
-export declare const getSitesSsoV1: (siteId: number, options?: AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<GetSitesSsoV1200>>;
-export declare const getGetSitesSsoV1QueryKey: (siteId: number) => string[];
-export declare type GetSitesSsoV1QueryResult = NonNullable<AsyncReturnType<typeof getSitesSsoV1>>;
-export declare type GetSitesSsoV1QueryError = AxiosError<unknown>;
-export declare const useGetSitesSsoV1: <TData = AxiosResponse<GetSitesSsoV1200, any>, TError = AxiosError<unknown, any>>(siteId: number, options?: {
-    query?: UseQueryOptions<AxiosResponse<GetSitesSsoV1200, any>, TError, TData, QueryKey> | undefined;
+export declare const sitesInfo: (siteId: number, options?: AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<SitesInfo200>>;
+export declare const getSitesInfoQueryKey: (siteId: number) => string[];
+export declare type SitesInfoQueryResult = NonNullable<AsyncReturnType<typeof sitesInfo>>;
+export declare type SitesInfoQueryError = AxiosError<unknown>;
+export declare const useSitesInfo: <TData = AxiosResponse<SitesInfo200, any>, TError = AxiosError<unknown, any>>(siteId: number, options?: {
+    query?: UseQueryOptions<AxiosResponse<SitesInfo200, any>, TError, TData, QueryKey> | undefined;
     axios?: AxiosRequestConfig<any> | undefined;
 } | undefined) => UseQueryResult<TData, TError> & {
     queryKey: QueryKey;
 };
 /**
  * Obtain a list of sites.
- * @summary  hosting sites
- */
-export declare const getHostingSitesV1: (hostingId: number, options?: AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<GetHostingSitesV1200>>;
-export declare const getGetHostingSitesV1QueryKey: (hostingId: number) => string[];
-export declare type GetHostingSitesV1QueryResult = NonNullable<AsyncReturnType<typeof getHostingSitesV1>>;
-export declare type GetHostingSitesV1QueryError = AxiosError<unknown>;
-export declare const useGetHostingSitesV1: <TData = AxiosResponse<GetHostingSitesV1200, any>, TError = AxiosError<unknown, any>>(hostingId: number, options?: {
-    query?: UseQueryOptions<AxiosResponse<GetHostingSitesV1200, any>, TError, TData, QueryKey> | undefined;
+ * @summary hosting sites
+ */
+export declare const hostingSites: (hostingId: number, options?: AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<HostingSites200>>;
+export declare const getHostingSitesQueryKey: (hostingId: number) => string[];
+export declare type HostingSitesQueryResult = NonNullable<AsyncReturnType<typeof hostingSites>>;
+export declare type HostingSitesQueryError = AxiosError<unknown>;
+export declare const useHostingSites: <TData = AxiosResponse<HostingSites200, any>, TError = AxiosError<unknown, any>>(hostingId: number, options?: {
+    query?: UseQueryOptions<AxiosResponse<HostingSites200, any>, TError, TData, QueryKey> | undefined;
     axios?: AxiosRequestConfig<any> | undefined;
 } | undefined) => UseQueryResult<TData, TError> & {
     queryKey: QueryKey;