@newfold/huapi-js 1.687.0 → 1.690.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -10,7 +10,7 @@
10
10
  "tslib": "2.4.0"
11
11
  },
12
12
  "module": "dist/index.ts",
13
- "version": "1.687.0",
13
+ "version": "1.690.0",
14
14
  "sideEffects": false,
15
15
  "main": "./src/index.js",
16
16
  "types": "./src/index.d.ts",
package/src/index.d.ts CHANGED
@@ -3,12 +3,12 @@
3
3
  * Do not edit manually.
4
4
  * Hosting UAPI
5
5
  * Hosting UAPI is an API to expose Hosting, Addons, and Site functionality to a customer-facing Front End such as (Account Manager).
6
- * OpenAPI spec version: 1.687.0
6
+ * OpenAPI spec version: 1.690.0
7
7
  */
8
8
  import axios from 'axios';
9
9
  import type { AxiosRequestConfig, AxiosResponse, AxiosError } from 'axios';
10
10
  import type { UseQueryOptions, UseMutationOptions, UseQueryResult, QueryKey } from '@tanstack/react-query';
11
- import type { AccountHostingList200, CodeguardBackupList200, CodeguardBackupListParams, CodeguardBackupCreate200, CodeguardBackupCreateBody, CodeguardBackupDownload200, CodeguardBackupDownloadBody, CodeguardBackupRestore200, CodeguardBackupRestoreBody, CodeguardDatabaseList200, CodeguardDatabaseBackupList200, CodeguardDatabaseBackupListParams, CodeguardDatabaseBackupCreate200, CodeguardDatabaseBackupCreateBody, CodeguardDatabaseBackupRestore200, CodeguardDatabaseBackupRestoreBody, CodeguardLoginLink200, CodeguardPlanInfo200, CodeguardWebsiteList200, CodeguardWebsiteBackupList200, CodeguardWebsiteBackupListParams, CodeguardWebsiteBackupCreate200, CodeguardWebsiteBackupCreateBody, CodeguardWebsiteBackupRestore200, CodeguardWebsiteBackupRestoreBody, AddonsSitelockSso200, AddonsCloudflare200, AddonsInfo200, AddonsSpamexpertsSso200, HostingAccount200, HostingAddons200, HostingAddonsParams, HostingAdvancedServer200, HostingAdvancedServerStatus200, HostingAdvancedServerStatusBody, HostingAdvancedPassword200, HostingAdvancedPasswordBody, HostingAdvancedSsoWhm200, HostingAdvancedSystemConsole200, HostingCapabilities200, AddonCloudflare200, AddonCloudflareBody, ListCrons200, AddCron200, AddCron400, AddCronBody, UpdateCron200, UpdateCronBody, Cron200, CronBody, DbAdd200, DbAddBody, Db200, DbBody, DbList200, DbUsage200, DbUserPrivsGet200, DbUserPrivsGetParams, DbUserAdd200, DbUserAddBody, DbUserDelete200, DbUserDeleteBody, DbUserList200, Domains200, DomainsParams, HostingEcommerceInfo200, HostingFtpList200, HostingFtpAdd200, HostingFtpAddBody, HostingFtpUpdate200, HostingFtpUpdateBody, HostingFtp200, HostingFtpBody, HostingInfo200, HostingInfoDiskUsage200, HostingLead200, HostingLead400, HostingLeadParams, HostingMigrationStatus200, HostingMigrations200, HostingMigrationsBody, HostingMigrationsCheck200, HostingMigrationsCheckParams, HostingMigrationsEvent200, HostingMigrationsEventBody, HostingMigrationInfo200, HostingMigrationInfoParams, HostingMigrationSiteScanStatus200, HostingMigrationSiteScanStatusParams, HostingNameservers200, HostingOnboardingData200, HostingOnboardingDataUpdate200, HostingOnboardingDataUpdateBody, HostingResellerSsoWhm200, HostingShellToggle200, HostingShellToggleBody, HostingShellInfo200, HostingSiteAdd200, HostingSiteAddBody, HostingSshInfo200, SshKeyFetch200, SshKeyFetchParams, SshKeyImport200, SshKeyImportBody, SshKeyList200, SshKey200, SshKeyBody, SshKeyGenerate200, SshKeyGenerateBody, Sso200, SsoParams, SitesList200, SitesInfo200, SiteUpdate200, SiteUpdate400, SiteUpdateBody, Site200, SitesAutoupdatesResponse, SitesAutoupdatesUpdateBody, SitesBackups200, SitesHasBackups200, SitesBackupsCodeguard200, SitesBackupsDetails200, JetpackBackupStatus200, BackupsJetpackBackup200, SiteAddonCloudflare200, SiteAddonCloudflare400, 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, SitesSettingsComingSoon200, SitesSettingsComingSoonToggle200, SitesSettingsComingSoonToggleBody, SitesSettingsDebug200, SitesSettingsDebugToggle200, SitesSettingsDebugToggleBody, SitesSettingsPhpVersionUpdate200, SitesSettingsPhpVersionUpdateBody, SitesSettingsPhpVersions200, SitesSsl200, SitesSso200, SitesSsoParams, SiteStatus200, SiteUsers200, SitesVersion200, HostingNameserversV2200, HostingSitesV2200, SshKeyListV2200, SitesListV2200 } from './index.schemas';
11
+ import type { AccountHostingList200, CodeguardBackupList200, CodeguardBackupListParams, CodeguardBackupCreate200, CodeguardBackupCreateBody, CodeguardBackupDownload200, CodeguardBackupDownloadBody, CodeguardBackupRestore200, CodeguardBackupRestoreBody, CodeguardDatabaseList200, CodeguardDatabaseBackupList200, CodeguardDatabaseBackupListParams, CodeguardDatabaseBackupCreate200, CodeguardDatabaseBackupCreateBody, CodeguardDatabaseBackupRestore200, CodeguardDatabaseBackupRestoreBody, CodeguardLoginLink200, CodeguardPlanInfo200, CodeguardWebsiteList200, CodeguardWebsiteBackupList200, CodeguardWebsiteBackupListParams, CodeguardWebsiteBackupCreate200, CodeguardWebsiteBackupCreateBody, CodeguardWebsiteBackupRestore200, CodeguardWebsiteBackupRestoreBody, AddonsSitelockSso200, AddonsCloudflare200, AddonsInfo200, AddonsSpamexpertsSso200, WebzaiSso200, WeeblySso200, HostingAccount200, HostingAddons200, HostingAddonsParams, HostingAdvancedServer200, HostingAdvancedServerStatus200, HostingAdvancedServerStatusBody, HostingAdvancedPassword200, HostingAdvancedPasswordBody, HostingAdvancedSsoWhm200, HostingAdvancedSystemConsole200, HostingCapabilities200, AddonCloudflare200, AddonCloudflareBody, ListCrons200, AddCron200, AddCron400, AddCronBody, UpdateCron200, UpdateCronBody, Cron200, CronBody, DbAdd200, DbAddBody, Db200, DbBody, DbList200, DbUsage200, DbUserPrivsGet200, DbUserPrivsGetParams, DbUserAdd200, DbUserAddBody, DbUserDelete200, DbUserDeleteBody, DbUserList200, Domains200, DomainsParams, HostingEcommerceInfo200, HostingFtpList200, HostingFtpAdd200, HostingFtpAddBody, HostingFtpUpdate200, HostingFtpUpdateBody, HostingFtp200, HostingFtpBody, HostingInfo200, HostingInfoDiskUsage200, HostingLead200, HostingLead400, HostingLeadParams, HostingMigrationStatus200, HostingMigrations200, HostingMigrationsBody, HostingMigrationsCheck200, HostingMigrationsCheckParams, HostingMigrationsEvent200, HostingMigrationsEventBody, HostingMigrationInfo200, HostingMigrationInfoParams, HostingMigrationSiteScanStatus200, HostingMigrationSiteScanStatusParams, HostingNameservers200, HostingOnboardingData200, HostingOnboardingDataUpdate200, HostingOnboardingDataUpdateBody, HostingResellerSsoWhm200, HostingShellToggle200, HostingShellToggleBody, HostingShellInfo200, HostingSiteAdd200, HostingSiteAddBody, HostingSshInfo200, SshKeyFetch200, SshKeyFetchParams, SshKeyImport200, SshKeyImportBody, SshKeyList200, SshKey200, SshKeyBody, SshKeyGenerate200, SshKeyGenerateBody, Sso200, SsoParams, SitesList200, SitesInfo200, SiteUpdate200, SiteUpdate400, SiteUpdateBody, Site200, SitesAutoupdatesResponse, SitesAutoupdatesUpdateBody, SitesBackups200, SitesHasBackups200, SitesBackupsCodeguard200, SitesBackupsDetails200, JetpackBackupStatus200, BackupsJetpackBackup200, SiteAddonCloudflare200, SiteAddonCloudflare400, 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, SitesSettingsComingSoon200, SitesSettingsComingSoonToggle200, SitesSettingsComingSoonToggleBody, SitesSettingsDebug200, SitesSettingsDebugToggle200, SitesSettingsDebugToggleBody, SitesSettingsPhpVersionUpdate200, SitesSettingsPhpVersionUpdateBody, SitesSettingsPhpVersions200, SitesSsl200, SitesSso200, SitesSsoParams, SiteStatus200, SiteUsers200, SitesVersion200, HostingNameserversV2200, HostingSitesV2200, SshKeyListV2200, SitesListV2200 } from './index.schemas';
12
12
  declare type AwaitedInput<T> = PromiseLike<T> | T;
13
13
  declare type Awaited<O> = O extends AwaitedInput<infer T> ? T : never;
14
14
  /**
@@ -306,6 +306,34 @@ export declare const useAddonsSpamexpertsSso: <TData = AxiosResponse<AddonsSpame
306
306
  } | undefined) => UseQueryResult<TData, TError> & {
307
307
  queryKey: QueryKey;
308
308
  };
309
+ /**
310
+ * Returns WebZai SSO URL
311
+ * @summary webzai sso
312
+ */
313
+ export declare const webzaiSso: (addonId: string, options?: AxiosRequestConfig) => Promise<AxiosResponse<WebzaiSso200>>;
314
+ export declare const getWebzaiSsoQueryKey: (addonId: string) => string[];
315
+ export declare type WebzaiSsoQueryResult = NonNullable<Awaited<ReturnType<typeof webzaiSso>>>;
316
+ export declare type WebzaiSsoQueryError = AxiosError<unknown>;
317
+ export declare const useWebzaiSso: <TData = AxiosResponse<WebzaiSso200, any>, TError = AxiosError<unknown, any>>(addonId: string, options?: {
318
+ query?: UseQueryOptions<AxiosResponse<WebzaiSso200, any>, TError, TData, QueryKey> | undefined;
319
+ axios?: AxiosRequestConfig<any> | undefined;
320
+ } | undefined) => UseQueryResult<TData, TError> & {
321
+ queryKey: QueryKey;
322
+ };
323
+ /**
324
+ * Returns Weebly SSO URL
325
+ * @summary weebly sso
326
+ */
327
+ export declare const weeblySso: (addonId: string, options?: AxiosRequestConfig) => Promise<AxiosResponse<WeeblySso200>>;
328
+ export declare const getWeeblySsoQueryKey: (addonId: string) => string[];
329
+ export declare type WeeblySsoQueryResult = NonNullable<Awaited<ReturnType<typeof weeblySso>>>;
330
+ export declare type WeeblySsoQueryError = AxiosError<unknown>;
331
+ export declare const useWeeblySso: <TData = AxiosResponse<WeeblySso200, any>, TError = AxiosError<unknown, any>>(addonId: string, options?: {
332
+ query?: UseQueryOptions<AxiosResponse<WeeblySso200, any>, TError, TData, QueryKey> | undefined;
333
+ axios?: AxiosRequestConfig<any> | undefined;
334
+ } | undefined) => UseQueryResult<TData, TError> & {
335
+ queryKey: QueryKey;
336
+ };
309
337
  /**
310
338
  * Returns HAL hosting account-level information
311
339
  * @summary HAL Hosting Account Info
package/src/index.js CHANGED
@@ -3,7 +3,7 @@
3
3
  * Do not edit manually.
4
4
  * Hosting UAPI
5
5
  * Hosting UAPI is an API to expose Hosting, Addons, and Site functionality to a customer-facing Front End such as (Account Manager).
6
- * OpenAPI spec version: 1.687.0
6
+ * OpenAPI spec version: 1.690.0
7
7
  */
8
8
  import axios from 'axios';
9
9
  import { useQuery, useMutation } from '@tanstack/react-query';
@@ -314,6 +314,40 @@ export const useAddonsSpamexpertsSso = (addonId, options) => {
314
314
  query.queryKey = queryKey;
315
315
  return query;
316
316
  };
317
+ /**
318
+ * Returns WebZai SSO URL
319
+ * @summary webzai sso
320
+ */
321
+ export const webzaiSso = (addonId, options) => {
322
+ return axios.get(`/v1/addons/${addonId}/webzai/sso`, options);
323
+ };
324
+ export const getWebzaiSsoQueryKey = (addonId) => [`/v1/addons/${addonId}/webzai/sso`];
325
+ export const useWebzaiSso = (addonId, options) => {
326
+ var _a;
327
+ const { query: queryOptions, axios: axiosOptions } = options !== null && options !== void 0 ? options : {};
328
+ const queryKey = (_a = queryOptions === null || queryOptions === void 0 ? void 0 : queryOptions.queryKey) !== null && _a !== void 0 ? _a : getWebzaiSsoQueryKey(addonId);
329
+ const queryFn = ({ signal }) => webzaiSso(addonId, Object.assign({ signal }, axiosOptions));
330
+ const query = useQuery(Object.assign({ queryKey, queryFn, enabled: !!(addonId) }, queryOptions));
331
+ query.queryKey = queryKey;
332
+ return query;
333
+ };
334
+ /**
335
+ * Returns Weebly SSO URL
336
+ * @summary weebly sso
337
+ */
338
+ export const weeblySso = (addonId, options) => {
339
+ return axios.get(`/v1/addons/${addonId}/weebly/sso`, options);
340
+ };
341
+ export const getWeeblySsoQueryKey = (addonId) => [`/v1/addons/${addonId}/weebly/sso`];
342
+ export const useWeeblySso = (addonId, options) => {
343
+ var _a;
344
+ const { query: queryOptions, axios: axiosOptions } = options !== null && options !== void 0 ? options : {};
345
+ const queryKey = (_a = queryOptions === null || queryOptions === void 0 ? void 0 : queryOptions.queryKey) !== null && _a !== void 0 ? _a : getWeeblySsoQueryKey(addonId);
346
+ const queryFn = ({ signal }) => weeblySso(addonId, Object.assign({ signal }, axiosOptions));
347
+ const query = useQuery(Object.assign({ queryKey, queryFn, enabled: !!(addonId) }, queryOptions));
348
+ query.queryKey = queryKey;
349
+ return query;
350
+ };
317
351
  /**
318
352
  * Returns HAL hosting account-level information
319
353
  * @summary HAL Hosting Account Info
@@ -110,6 +110,12 @@ export declare const getAddonsInfoMock: () => {
110
110
  export declare const getAddonsSpamexpertsSsoMock: () => {
111
111
  url: string | undefined;
112
112
  };
113
+ export declare const getWebzaiSsoMock: () => {
114
+ sso: string | undefined;
115
+ };
116
+ export declare const getWeeblySsoMock: () => {
117
+ sso: string | undefined;
118
+ };
113
119
  export declare const getHostingAccountMock: () => {
114
120
  id: string | undefined;
115
121
  account_id: string | undefined;
package/src/index.msw.js CHANGED
@@ -3,7 +3,7 @@
3
3
  * Do not edit manually.
4
4
  * Hosting UAPI
5
5
  * Hosting UAPI is an API to expose Hosting, Addons, and Site functionality to a customer-facing Front End such as (Account Manager).
6
- * OpenAPI spec version: 1.687.0
6
+ * OpenAPI spec version: 1.690.0
7
7
  */
8
8
  import { rest } from 'msw';
9
9
  import { faker } from '@faker-js/faker';
@@ -26,6 +26,8 @@ export const getAddonsSitelockSsoMock = () => ({ site_url: faker.helpers.arrayEl
26
26
  export const getAddonsCloudflareMock = () => ({ status: faker.helpers.arrayElement([faker.random.word(), undefined]) });
27
27
  export const getAddonsInfoMock = () => ({ id: faker.helpers.arrayElement([faker.random.word(), undefined]) });
28
28
  export const getAddonsSpamexpertsSsoMock = () => ({ url: faker.helpers.arrayElement([faker.random.word(), undefined]) });
29
+ export const getWebzaiSsoMock = () => ({ sso: faker.helpers.arrayElement([faker.random.word(), undefined]) });
30
+ export const getWeeblySsoMock = () => ({ sso: faker.helpers.arrayElement([faker.random.word(), undefined]) });
29
31
  export const getHostingAccountMock = () => ({ id: faker.helpers.arrayElement([faker.random.word(), undefined]), account_id: faker.helpers.arrayElement([faker.random.word(), undefined]), brand: faker.helpers.arrayElement([faker.random.word(), undefined]), platform: faker.helpers.arrayElement([faker.random.word(), undefined]), username: faker.helpers.arrayElement([faker.random.word(), undefined]), status: faker.helpers.arrayElement([faker.random.word(), undefined]), type: faker.helpers.arrayElement([faker.random.word(), undefined]), advanced: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), billing: faker.helpers.arrayElement([{ product_name: faker.helpers.arrayElement([faker.random.word(), undefined]) }, undefined]), panel: faker.helpers.arrayElement([faker.random.word(), undefined]), plan_key: faker.helpers.arrayElement([faker.random.word(), undefined]) });
30
32
  export const getHostingAddonsMock = () => ({ rows: faker.helpers.arrayElement([Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ id: faker.helpers.arrayElement([faker.random.word(), undefined]), type: faker.helpers.arrayElement([faker.random.word(), undefined]), subtype: faker.helpers.arrayElement([faker.random.word(), undefined]), status: faker.helpers.arrayElement([faker.random.word(), undefined]), status_user: faker.helpers.arrayElement([faker.random.word(), undefined]), meta: faker.helpers.arrayElement([faker.random.word(), undefined]) })), undefined]) });
31
33
  export const getHostingAdvancedServerMock = () => ({ status: faker.helpers.arrayElement([faker.random.word(), undefined]), uptime: faker.helpers.arrayElement([faker.random.word(), undefined]), uptime_seconds: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), actions: faker.helpers.arrayElement([{}, undefined]) });
@@ -163,6 +165,10 @@ export const getHostingUAPIMSW = () => [
163
165
  return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json(getAddonsInfoMock()));
164
166
  }), rest.get('*/v1/addons/:addonId/spamexperts/sso', (_req, res, ctx) => {
165
167
  return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json(getAddonsSpamexpertsSsoMock()));
168
+ }), rest.get('*/v1/addons/:addonId/webzai/sso', (_req, res, ctx) => {
169
+ return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json(getWebzaiSsoMock()));
170
+ }), rest.get('*/v1/addons/:addonId/weebly/sso', (_req, res, ctx) => {
171
+ return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json(getWeeblySsoMock()));
166
172
  }), rest.get('*/v1/hosting/:hostingId', (_req, res, ctx) => {
167
173
  return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json(getHostingAccountMock()));
168
174
  }), rest.get('*/v1/hosting/:hostingId/addons', (_req, res, ctx) => {
@@ -3,7 +3,7 @@
3
3
  * Do not edit manually.
4
4
  * Hosting UAPI
5
5
  * Hosting UAPI is an API to expose Hosting, Addons, and Site functionality to a customer-facing Front End such as (Account Manager).
6
- * OpenAPI spec version: 1.687.0
6
+ * OpenAPI spec version: 1.690.0
7
7
  */
8
8
  export declare type SitesListV2200ItemsItem = {
9
9
  id?: number;
@@ -1053,6 +1053,12 @@ export declare type HostingAccount200 = {
1053
1053
  panel?: string;
1054
1054
  plan_key?: string;
1055
1055
  };
1056
+ export declare type WeeblySso200 = {
1057
+ sso?: string;
1058
+ };
1059
+ export declare type WebzaiSso200 = {
1060
+ sso?: string;
1061
+ };
1056
1062
  export declare type AddonsSpamexpertsSso200 = {
1057
1063
  url?: string;
1058
1064
  };