@newfold/huapi-js 1.3.0 → 1.4.0

package/README.md

@@ -1,83 +1,11 @@
-# @newfold/huapi-js
+# huapi-js
 
-> A JavaScript Client Library for HUAPI
+This library was generated with [Nx](https://nx.dev).
 
-## Installation
+## Building
 
-```sh
-$ yarn add @newfold/huapi-js
-# yarn package installed
-```
+Run `nx build huapi-js` to build the library.
 
-## Usage
+## Running unit tests
 
-### React Hooks
-
-```js
-import React from 'react';
-
-import { useHostingSites } from '@newfold/huapi-js';
-
-const MyComponent = () => {
-  const hostingId = '2';
-  const { isLoading, data } = useHostingSites(hostingId);
-
-  if (isLoading) return <h1>Loading...</h1>;
-
-  return (
-    <div>
-      {data?.data?.rows?.map((site) => {
-        <div key={site.id}>{site.name}</div>;
-      })}
-    </div>
-  );
-};
-```
-
-### 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
+Run `nx test huapi-js` to execute the unit tests via [Jest](https://jestjs.io).

package/package.json

@@ -1,31 +1,15 @@
 {
   "name": "@newfold/huapi-js",
-  "version": "1.3.0",
-  "license": "MIT",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
-  "dependencies": {
+  "version": "1.4.0",
+  "peerDependencies": {
     "@faker-js/faker": "^6.1.2",
     "axios": "^0.26.1",
+    "react": "^17.0.0 || ^18.0.0",
+    "react-query": "^3.39.0",
     "msw": "^0.39.2",
-    "react-query": "^3.34.19"
-  },
-  "devDependencies": {
-    "orval": "^6.7.1",
-    "react": "^18.1.0",
-    "typescript": "^4.6.3"
-  },
-  "peerDependencies": {
-    "react": "^17.0.0 || ^18.0.0"
+    "tslib": "^2.3.0"
   },
-  "scripts": {
-    "get-schema": "curl -O https://beta-hosting-uapi.apps.provo1.endurancemb.com/openapi.json",
-    "clean": "rm -rf ./dist",
-    "orval": "orval",
-    "typescript": "npx tsc",
-    "build": "yarn clean && yarn get-schema && yarn orval && yarn typescript"
-  }
+  "main": "./src/index.js",
+  "typings": "./src/index.d.ts",
+  "dependencies": {}
 }

package/src/handlers.d.ts

@@ -0,0 +1,2 @@
+export * from './lib/handlers';
+export * from './orval-generated/index.msw';

package/src/handlers.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+// export custom handlers
+tslib_1.__exportStar(require("./lib/handlers"), exports);
+// export orval-generated handlers
+tslib_1.__exportStar(require("./orval-generated/index.msw"), exports);

package/src/index.d.ts

@@ -0,0 +1 @@
+export * from './orval-generated';

package/src/index.js

@@ -0,0 +1,5 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+// export orval-generated
+tslib_1.__exportStar(require("./orval-generated"), exports);

package/{dist/handlers.msw.d.ts → src/lib/handlers/index.d.ts}

@@ -2,4 +2,4 @@
  * NOTE: this will move to @newfold/huapi-js in the future
  * Usage: `import { getHostingSitesHandler } from '@newfold/huapi-js';`
  */
-export * from './handlers/sites/getHostingSitesHandler';
+export * from './sites/getHostingSitesHandler';

package/src/lib/handlers/index.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+/**
+ * NOTE: this will move to @newfold/huapi-js in the future
+ * Usage: `import { getHostingSitesHandler } from '@newfold/huapi-js';`
+ */
+tslib_1.__exportStar(require("./sites/getHostingSitesHandler"), exports);

package/{dist → src/orval-generated}/index.d.ts

@@ -1,25 +1,27 @@
 /**
- * Generated by orval v6.7.1 🍺
+ * Generated by orval v6.8.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 * as axios from 'axios';
+import type { AxiosResponse, AxiosError } from 'axios';
 import { UseQueryOptions, UseMutationOptions, UseQueryResult, QueryKey } from 'react-query';
-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;
+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, Sso200, SitesSso200, SitesInfo200, HostingSites200 } from './models';
+declare type AwaitedInput<T> = PromiseLike<T> | T;
+declare type Awaited<O> = O extends AwaitedInput<infer T> ? T : never;
 /**
  * Return all website records CodeGuard maintains for this user's account.
  * @summary  addons codeguard website_list
  */
-export declare const addonsCodeguardWebsiteList: (addonId: number, options?: AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<AddonsCodeguardWebsiteList200>>;
+export declare const addonsCodeguardWebsiteList: (addonId: number, options?: axios.AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<AddonsCodeguardWebsiteList200>>;
 export declare const getAddonsCodeguardWebsiteListQueryKey: (addonId: number) => string[];
-export declare type AddonsCodeguardWebsiteListQueryResult = NonNullable<AsyncReturnType<typeof addonsCodeguardWebsiteList>>;
+export declare type AddonsCodeguardWebsiteListQueryResult = NonNullable<Awaited<ReturnType<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;
+export declare const useAddonsCodeguardWebsiteList: <TData = axios.AxiosResponse<AddonsCodeguardWebsiteList200, any>, TError = axios.AxiosError<unknown, any>>(addonId: number, options?: {
+    query?: UseQueryOptions<axios.AxiosResponse<AddonsCodeguardWebsiteList200, any>, TError, TData, QueryKey> | undefined;
+    axios?: axios.AxiosRequestConfig<any> | undefined;
 } | undefined) => UseQueryResult<TData, TError> & {
     queryKey: QueryKey;
 };
@@ -27,13 +29,13 @@ export declare const useAddonsCodeguardWebsiteList: <TData = AxiosResponse<Addon
  * Returns a combined backup list with website commit ids and corresponding database commits
  * @summary addons codeguard backups
  */
-export declare const addonsCodeguardBackups: (addonId: number, params?: AddonsCodeguardBackupsParams | undefined, options?: AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<AddonsCodeguardBackups200>>;
+export declare const addonsCodeguardBackups: (addonId: number, params?: AddonsCodeguardBackupsParams | undefined, options?: axios.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 AddonsCodeguardBackupsQueryResult = NonNullable<Awaited<ReturnType<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;
+export declare const useAddonsCodeguardBackups: <TData = axios.AxiosResponse<AddonsCodeguardBackups200, any>, TError = axios.AxiosError<unknown, any>>(addonId: number, params?: AddonsCodeguardBackupsParams | undefined, options?: {
+    query?: UseQueryOptions<axios.AxiosResponse<AddonsCodeguardBackups200, any>, TError, TData, QueryKey> | undefined;
+    axios?: axios.AxiosRequestConfig<any> | undefined;
 } | undefined) => UseQueryResult<TData, TError> & {
     queryKey: QueryKey;
 };
@@ -41,13 +43,13 @@ export declare const useAddonsCodeguardBackups: <TData = AxiosResponse<AddonsCod
  * 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 addonsCodeguardLoginLinkGenerate: (addonId: number, options?: axios.AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<AddonsCodeguardLoginLinkGenerate200>>;
 export declare const getAddonsCodeguardLoginLinkGenerateQueryKey: (addonId: number) => string[];
-export declare type AddonsCodeguardLoginLinkGenerateQueryResult = NonNullable<AsyncReturnType<typeof addonsCodeguardLoginLinkGenerate>>;
+export declare type AddonsCodeguardLoginLinkGenerateQueryResult = NonNullable<Awaited<ReturnType<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;
+export declare const useAddonsCodeguardLoginLinkGenerate: <TData = axios.AxiosResponse<AddonsCodeguardLoginLinkGenerate200, any>, TError = axios.AxiosError<unknown, any>>(addonId: number, options?: {
+    query?: UseQueryOptions<axios.AxiosResponse<AddonsCodeguardLoginLinkGenerate200, any>, TError, TData, QueryKey> | undefined;
+    axios?: axios.AxiosRequestConfig<any> | undefined;
 } | undefined) => UseQueryResult<TData, TError> & {
     queryKey: QueryKey;
 };
@@ -55,17 +57,17 @@ export declare const useAddonsCodeguardLoginLinkGenerate: <TData = AxiosResponse
  * 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 const addonsCodeguardDatabaseBackupCreate: (addonId: number, addonsCodeguardDatabaseBackupCreateBody: AddonsCodeguardDatabaseBackupCreateBody, options?: axios.AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<AddonsCodeguardDatabaseBackupCreate200>>;
+export declare type AddonsCodeguardDatabaseBackupCreateMutationResult = NonNullable<Awaited<ReturnType<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, {
+export declare const useAddonsCodeguardDatabaseBackupCreate: <TError = axios.AxiosError<unknown, any>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<axios.AxiosResponse<AddonsCodeguardDatabaseBackupCreate200, any>, TError, {
         addonId: number;
         data: AddonsCodeguardDatabaseBackupCreateBody;
     }, TContext> | undefined;
-    axios?: AxiosRequestConfig<any> | undefined;
-} | undefined) => import("react-query").UseMutationResult<AxiosResponse<AddonsCodeguardDatabaseBackupCreate200, any>, TError, {
+    axios?: axios.AxiosRequestConfig<any> | undefined;
+} | undefined) => import("react-query").UseMutationResult<axios.AxiosResponse<AddonsCodeguardDatabaseBackupCreate200, any>, TError, {
     addonId: number;
     data: AddonsCodeguardDatabaseBackupCreateBody;
 }, TContext>;
@@ -73,17 +75,17 @@ export declare const useAddonsCodeguardDatabaseBackupCreate: <TError = AxiosErro
  * 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 const addonsCodeguardWebsiteBackupCreate: (addonId: number, addonsCodeguardWebsiteBackupCreateBody: AddonsCodeguardWebsiteBackupCreateBody, options?: axios.AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<AddonsCodeguardWebsiteBackupCreate200>>;
+export declare type AddonsCodeguardWebsiteBackupCreateMutationResult = NonNullable<Awaited<ReturnType<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, {
+export declare const useAddonsCodeguardWebsiteBackupCreate: <TError = axios.AxiosError<unknown, any>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<axios.AxiosResponse<AddonsCodeguardWebsiteBackupCreate200, any>, TError, {
         addonId: number;
         data: AddonsCodeguardWebsiteBackupCreateBody;
     }, TContext> | undefined;
-    axios?: AxiosRequestConfig<any> | undefined;
-} | undefined) => import("react-query").UseMutationResult<AxiosResponse<AddonsCodeguardWebsiteBackupCreate200, any>, TError, {
+    axios?: axios.AxiosRequestConfig<any> | undefined;
+} | undefined) => import("react-query").UseMutationResult<axios.AxiosResponse<AddonsCodeguardWebsiteBackupCreate200, any>, TError, {
     addonId: number;
     data: AddonsCodeguardWebsiteBackupCreateBody;
 }, TContext>;
@@ -91,13 +93,13 @@ export declare const useAddonsCodeguardWebsiteBackupCreate: <TError = AxiosError
  * Return all database records CodeGuard maintains for this user's account.
  * @summary  addons codeguard database_list
  */
-export declare const addonsCodeguardDatabaseList: (addonId: number, options?: AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<AddonsCodeguardDatabaseList200>>;
+export declare const addonsCodeguardDatabaseList: (addonId: number, options?: axios.AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<AddonsCodeguardDatabaseList200>>;
 export declare const getAddonsCodeguardDatabaseListQueryKey: (addonId: number) => string[];
-export declare type AddonsCodeguardDatabaseListQueryResult = NonNullable<AsyncReturnType<typeof addonsCodeguardDatabaseList>>;
+export declare type AddonsCodeguardDatabaseListQueryResult = NonNullable<Awaited<ReturnType<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;
+export declare const useAddonsCodeguardDatabaseList: <TData = axios.AxiosResponse<AddonsCodeguardDatabaseList200, any>, TError = axios.AxiosError<unknown, any>>(addonId: number, options?: {
+    query?: UseQueryOptions<axios.AxiosResponse<AddonsCodeguardDatabaseList200, any>, TError, TData, QueryKey> | undefined;
+    axios?: axios.AxiosRequestConfig<any> | undefined;
 } | undefined) => UseQueryResult<TData, TError> & {
     queryKey: QueryKey;
 };
@@ -105,13 +107,13 @@ export declare const useAddonsCodeguardDatabaseList: <TData = AxiosResponse<Addo
  * 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 addonsCodeguardWebsiteBackupList: (addonId: number, params?: AddonsCodeguardWebsiteBackupListParams | undefined, options?: axios.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 AddonsCodeguardWebsiteBackupListQueryResult = NonNullable<Awaited<ReturnType<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;
+export declare const useAddonsCodeguardWebsiteBackupList: <TData = axios.AxiosResponse<AddonsCodeguardWebsiteBackupList200, any>, TError = axios.AxiosError<unknown, any>>(addonId: number, params?: AddonsCodeguardWebsiteBackupListParams | undefined, options?: {
+    query?: UseQueryOptions<axios.AxiosResponse<AddonsCodeguardWebsiteBackupList200, any>, TError, TData, QueryKey> | undefined;
+    axios?: axios.AxiosRequestConfig<any> | undefined;
 } | undefined) => UseQueryResult<TData, TError> & {
     queryKey: QueryKey;
 };
@@ -119,13 +121,13 @@ export declare const useAddonsCodeguardWebsiteBackupList: <TData = AxiosResponse
  * 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 addonsCodeguardDatabaseBackupList: (addonId: number, params?: AddonsCodeguardDatabaseBackupListParams | undefined, options?: axios.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 AddonsCodeguardDatabaseBackupListQueryResult = NonNullable<Awaited<ReturnType<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;
+export declare const useAddonsCodeguardDatabaseBackupList: <TData = axios.AxiosResponse<AddonsCodeguardDatabaseBackupList200, any>, TError = axios.AxiosError<unknown, any>>(addonId: number, params?: AddonsCodeguardDatabaseBackupListParams | undefined, options?: {
+    query?: UseQueryOptions<axios.AxiosResponse<AddonsCodeguardDatabaseBackupList200, any>, TError, TData, QueryKey> | undefined;
+    axios?: axios.AxiosRequestConfig<any> | undefined;
 } | undefined) => UseQueryResult<TData, TError> & {
     queryKey: QueryKey;
 };
@@ -133,17 +135,17 @@ export declare const useAddonsCodeguardDatabaseBackupList: <TData = AxiosRespons
  * 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 const addonsCodeguardBackupRestore: (addonId: number, addonsCodeguardBackupRestoreBody: AddonsCodeguardBackupRestoreBody, options?: axios.AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<AddonsCodeguardBackupRestore200>>;
+export declare type AddonsCodeguardBackupRestoreMutationResult = NonNullable<Awaited<ReturnType<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, {
+export declare const useAddonsCodeguardBackupRestore: <TError = axios.AxiosError<unknown, any>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<axios.AxiosResponse<AddonsCodeguardBackupRestore200, any>, TError, {
         addonId: number;
         data: AddonsCodeguardBackupRestoreBody;
     }, TContext> | undefined;
-    axios?: AxiosRequestConfig<any> | undefined;
-} | undefined) => import("react-query").UseMutationResult<AxiosResponse<AddonsCodeguardBackupRestore200, any>, TError, {
+    axios?: axios.AxiosRequestConfig<any> | undefined;
+} | undefined) => import("react-query").UseMutationResult<axios.AxiosResponse<AddonsCodeguardBackupRestore200, any>, TError, {
     addonId: number;
     data: AddonsCodeguardBackupRestoreBody;
 }, TContext>;
@@ -151,17 +153,17 @@ export declare const useAddonsCodeguardBackupRestore: <TError = AxiosError<unkno
  * 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 const addonsCodeguardWebsiteBackupRestore: (addonId: number, addonsCodeguardWebsiteBackupRestoreBody: AddonsCodeguardWebsiteBackupRestoreBody, options?: axios.AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<AddonsCodeguardWebsiteBackupRestore200>>;
+export declare type AddonsCodeguardWebsiteBackupRestoreMutationResult = NonNullable<Awaited<ReturnType<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, {
+export declare const useAddonsCodeguardWebsiteBackupRestore: <TError = axios.AxiosError<AddonsCodeguardWebsiteBackupRestore400, any>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<axios.AxiosResponse<AddonsCodeguardWebsiteBackupRestore200, any>, TError, {
         addonId: number;
         data: AddonsCodeguardWebsiteBackupRestoreBody;
     }, TContext> | undefined;
-    axios?: AxiosRequestConfig<any> | undefined;
-} | undefined) => import("react-query").UseMutationResult<AxiosResponse<AddonsCodeguardWebsiteBackupRestore200, any>, TError, {
+    axios?: axios.AxiosRequestConfig<any> | undefined;
+} | undefined) => import("react-query").UseMutationResult<axios.AxiosResponse<AddonsCodeguardWebsiteBackupRestore200, any>, TError, {
     addonId: number;
     data: AddonsCodeguardWebsiteBackupRestoreBody;
 }, TContext>;
@@ -169,17 +171,17 @@ export declare const useAddonsCodeguardWebsiteBackupRestore: <TError = AxiosErro
  * 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 const addonsCodeguardDatabaseBackupRestore: (addonId: number, addonsCodeguardDatabaseBackupRestoreBody: AddonsCodeguardDatabaseBackupRestoreBody, options?: axios.AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<AddonsCodeguardDatabaseBackupRestore200>>;
+export declare type AddonsCodeguardDatabaseBackupRestoreMutationResult = NonNullable<Awaited<ReturnType<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, {
+export declare const useAddonsCodeguardDatabaseBackupRestore: <TError = axios.AxiosError<unknown, any>, TContext = unknown>(options?: {
+    mutation?: UseMutationOptions<axios.AxiosResponse<AddonsCodeguardDatabaseBackupRestore200, any>, TError, {
         addonId: number;
         data: AddonsCodeguardDatabaseBackupRestoreBody;
     }, TContext> | undefined;
-    axios?: AxiosRequestConfig<any> | undefined;
-} | undefined) => import("react-query").UseMutationResult<AxiosResponse<AddonsCodeguardDatabaseBackupRestore200, any>, TError, {
+    axios?: axios.AxiosRequestConfig<any> | undefined;
+} | undefined) => import("react-query").UseMutationResult<axios.AxiosResponse<AddonsCodeguardDatabaseBackupRestore200, any>, TError, {
     addonId: number;
     data: AddonsCodeguardDatabaseBackupRestoreBody;
 }, TContext>;
@@ -187,13 +189,13 @@ export declare const useAddonsCodeguardDatabaseBackupRestore: <TError = AxiosErr
  * 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 hostingInfo: (hostingId: number, options?: axios.AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<HostingInfo200>>;
 export declare const getHostingInfoQueryKey: (hostingId: number) => string[];
-export declare type HostingInfoQueryResult = NonNullable<AsyncReturnType<typeof hostingInfo>>;
+export declare type HostingInfoQueryResult = NonNullable<Awaited<ReturnType<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;
+export declare const useHostingInfo: <TData = axios.AxiosResponse<HostingInfo200, any>, TError = axios.AxiosError<unknown, any>>(hostingId: number, options?: {
+    query?: UseQueryOptions<axios.AxiosResponse<HostingInfo200, any>, TError, TData, QueryKey> | undefined;
+    axios?: axios.AxiosRequestConfig<any> | undefined;
 } | undefined) => UseQueryResult<TData, TError> & {
     queryKey: QueryKey;
 };
@@ -201,13 +203,13 @@ export declare const useHostingInfo: <TData = AxiosResponse<HostingInfo200, any>
  * 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 hostingAddons: (hostingId: number, params?: HostingAddonsParams | undefined, options?: axios.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 HostingAddonsQueryResult = NonNullable<Awaited<ReturnType<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;
+export declare const useHostingAddons: <TData = axios.AxiosResponse<HostingAddons200, any>, TError = axios.AxiosError<unknown, any>>(hostingId: number, params?: HostingAddonsParams | undefined, options?: {
+    query?: UseQueryOptions<axios.AxiosResponse<HostingAddons200, any>, TError, TData, QueryKey> | undefined;
+    axios?: axios.AxiosRequestConfig<any> | undefined;
 } | undefined) => UseQueryResult<TData, TError> & {
     queryKey: QueryKey;
 };
@@ -215,13 +217,27 @@ export declare const useHostingAddons: <TData = AxiosResponse<HostingAddons200,
  * List FTP accounts.
  * @summary hosting ftp list
  */
-export declare const hostingFtpList: (hostingId: number, options?: AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<HostingFtpList200>>;
+export declare const hostingFtpList: (hostingId: number, options?: axios.AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<HostingFtpList200>>;
 export declare const getHostingFtpListQueryKey: (hostingId: number) => string[];
-export declare type HostingFtpListQueryResult = NonNullable<AsyncReturnType<typeof hostingFtpList>>;
+export declare type HostingFtpListQueryResult = NonNullable<Awaited<ReturnType<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;
+export declare const useHostingFtpList: <TData = axios.AxiosResponse<HostingFtpList200, any>, TError = axios.AxiosError<unknown, any>>(hostingId: number, options?: {
+    query?: UseQueryOptions<axios.AxiosResponse<HostingFtpList200, any>, TError, TData, QueryKey> | undefined;
+    axios?: axios.AxiosRequestConfig<any> | undefined;
+} | undefined) => UseQueryResult<TData, TError> & {
+    queryKey: QueryKey;
+};
+/**
+ * Return a SSO login token for a hosting account
+ * @summary sso
+ */
+export declare const sso: (hostingId: number, options?: axios.AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<Sso200>>;
+export declare const getSsoQueryKey: (hostingId: number) => string[];
+export declare type SsoQueryResult = NonNullable<Awaited<ReturnType<typeof sso>>>;
+export declare type SsoQueryError = AxiosError<unknown>;
+export declare const useSso: <TData = axios.AxiosResponse<Sso200, any>, TError = axios.AxiosError<unknown, any>>(hostingId: number, options?: {
+    query?: UseQueryOptions<axios.AxiosResponse<Sso200, any>, TError, TData, QueryKey> | undefined;
+    axios?: axios.AxiosRequestConfig<any> | undefined;
 } | undefined) => UseQueryResult<TData, TError> & {
     queryKey: QueryKey;
 };
@@ -229,13 +245,13 @@ export declare const useHostingFtpList: <TData = AxiosResponse<HostingFtpList200
  * Return an SSO token or login URL for this site (if supported).
  * @summary sites sso
  */
-export declare const sitesSso: (siteId: number, options?: AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<SitesSso200>>;
+export declare const sitesSso: (siteId: number, options?: axios.AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<SitesSso200>>;
 export declare const getSitesSsoQueryKey: (siteId: number) => string[];
-export declare type SitesSsoQueryResult = NonNullable<AsyncReturnType<typeof sitesSso>>;
+export declare type SitesSsoQueryResult = NonNullable<Awaited<ReturnType<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;
+export declare const useSitesSso: <TData = axios.AxiosResponse<SitesSso200, any>, TError = axios.AxiosError<unknown, any>>(siteId: number, options?: {
+    query?: UseQueryOptions<axios.AxiosResponse<SitesSso200, any>, TError, TData, QueryKey> | undefined;
+    axios?: axios.AxiosRequestConfig<any> | undefined;
 } | undefined) => UseQueryResult<TData, TError> & {
     queryKey: QueryKey;
 };
@@ -243,13 +259,13 @@ export declare const useSitesSso: <TData = AxiosResponse<SitesSso200, any>, TErr
  * Return info about a specific site
  * @summary sites info
  */
-export declare const sitesInfo: (siteId: number, options?: AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<SitesInfo200>>;
+export declare const sitesInfo: (siteId: number, options?: axios.AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<SitesInfo200>>;
 export declare const getSitesInfoQueryKey: (siteId: number) => string[];
-export declare type SitesInfoQueryResult = NonNullable<AsyncReturnType<typeof sitesInfo>>;
+export declare type SitesInfoQueryResult = NonNullable<Awaited<ReturnType<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;
+export declare const useSitesInfo: <TData = axios.AxiosResponse<SitesInfo200, any>, TError = axios.AxiosError<unknown, any>>(siteId: number, options?: {
+    query?: UseQueryOptions<axios.AxiosResponse<SitesInfo200, any>, TError, TData, QueryKey> | undefined;
+    axios?: axios.AxiosRequestConfig<any> | undefined;
 } | undefined) => UseQueryResult<TData, TError> & {
     queryKey: QueryKey;
 };
@@ -257,13 +273,13 @@ export declare const useSitesInfo: <TData = AxiosResponse<SitesInfo200, any>, TE
  * Obtain a list of sites.
  * @summary hosting sites
  */
-export declare const hostingSites: (hostingId: number, options?: AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<HostingSites200>>;
+export declare const hostingSites: (hostingId: number, options?: axios.AxiosRequestConfig<any> | undefined) => Promise<AxiosResponse<HostingSites200>>;
 export declare const getHostingSitesQueryKey: (hostingId: number) => string[];
-export declare type HostingSitesQueryResult = NonNullable<AsyncReturnType<typeof hostingSites>>;
+export declare type HostingSitesQueryResult = NonNullable<Awaited<ReturnType<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;
+export declare const useHostingSites: <TData = axios.AxiosResponse<HostingSites200, any>, TError = axios.AxiosError<unknown, any>>(hostingId: number, options?: {
+    query?: UseQueryOptions<axios.AxiosResponse<HostingSites200, any>, TError, TData, QueryKey> | undefined;
+    axios?: axios.AxiosRequestConfig<any> | undefined;
 } | undefined) => UseQueryResult<TData, TError> & {
     queryKey: QueryKey;
 };