@newfold/huapi-js 1.521.0 → 1.528.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 +1 -1
- package/src/index.d.ts +31 -2
- package/src/index.js +36 -1
- package/src/index.msw.d.ts +20 -0
- package/src/index.msw.js +9 -3
- package/src/index.schemas.d.ts +21 -1
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: 1.528.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 { 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';
|
|
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, 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, 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, SitesSsl200, 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
|
/**
|
|
@@ -548,6 +548,20 @@ export declare const useDbList: <TData = AxiosResponse<DbList200, any>, TError =
|
|
|
548
548
|
} | undefined) => UseQueryResult<TData, TError> & {
|
|
549
549
|
queryKey: QueryKey;
|
|
550
550
|
};
|
|
551
|
+
/**
|
|
552
|
+
* Returns a list of db and table limits and usage.
|
|
553
|
+
* @summary DB usage
|
|
554
|
+
*/
|
|
555
|
+
export declare const dbUsage: (hostingId: string, options?: AxiosRequestConfig) => Promise<AxiosResponse<DbUsage200>>;
|
|
556
|
+
export declare const getDbUsageQueryKey: (hostingId: string) => string[];
|
|
557
|
+
export declare type DbUsageQueryResult = NonNullable<Awaited<ReturnType<typeof dbUsage>>>;
|
|
558
|
+
export declare type DbUsageQueryError = AxiosError<unknown>;
|
|
559
|
+
export declare const useDbUsage: <TData = AxiosResponse<DbUsage200, any>, TError = AxiosError<unknown, any>>(hostingId: string, options?: {
|
|
560
|
+
query?: UseQueryOptions<AxiosResponse<DbUsage200, any>, TError, TData, QueryKey> | undefined;
|
|
561
|
+
axios?: AxiosRequestConfig<any> | undefined;
|
|
562
|
+
} | undefined) => UseQueryResult<TData, TError> & {
|
|
563
|
+
queryKey: QueryKey;
|
|
564
|
+
};
|
|
551
565
|
/**
|
|
552
566
|
* Get user privileges on a database.
|
|
553
567
|
* @summary Get user privileges on a database.
|
|
@@ -1518,6 +1532,7 @@ export declare const useSitesSecuritySslAcme: <TError = AxiosError<unknown, any>
|
|
|
1518
1532
|
}, TContext>;
|
|
1519
1533
|
/**
|
|
1520
1534
|
* Returns the site's SSL Status
|
|
1535
|
+
* @deprecated
|
|
1521
1536
|
* @summary ssl status
|
|
1522
1537
|
*/
|
|
1523
1538
|
export declare const sitesSecuritySslStatus: (siteId: number, options?: AxiosRequestConfig) => Promise<AxiosResponse<SitesSecuritySslStatus200>>;
|
|
@@ -1694,6 +1709,20 @@ export declare const useSitesSettingsPhpVersions: <TData = AxiosResponse<SitesSe
|
|
|
1694
1709
|
} | undefined) => UseQueryResult<TData, TError> & {
|
|
1695
1710
|
queryKey: QueryKey;
|
|
1696
1711
|
};
|
|
1712
|
+
/**
|
|
1713
|
+
* Returns information about the site domain's SSL/TLS certificate
|
|
1714
|
+
* @summary Site domain SSL cert info
|
|
1715
|
+
*/
|
|
1716
|
+
export declare const sitesSsl: (siteId: number, options?: AxiosRequestConfig) => Promise<AxiosResponse<SitesSsl200>>;
|
|
1717
|
+
export declare const getSitesSslQueryKey: (siteId: number) => string[];
|
|
1718
|
+
export declare type SitesSslQueryResult = NonNullable<Awaited<ReturnType<typeof sitesSsl>>>;
|
|
1719
|
+
export declare type SitesSslQueryError = AxiosError<unknown>;
|
|
1720
|
+
export declare const useSitesSsl: <TData = AxiosResponse<SitesSsl200, any>, TError = AxiosError<unknown, any>>(siteId: number, options?: {
|
|
1721
|
+
query?: UseQueryOptions<AxiosResponse<SitesSsl200, any>, TError, TData, QueryKey> | undefined;
|
|
1722
|
+
axios?: AxiosRequestConfig<any> | undefined;
|
|
1723
|
+
} | undefined) => UseQueryResult<TData, TError> & {
|
|
1724
|
+
queryKey: QueryKey;
|
|
1725
|
+
};
|
|
1697
1726
|
/**
|
|
1698
1727
|
* Returns an SSO token or login URL for the site (if supported).
|
|
1699
1728
|
* @summary sso
|
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.
|
|
6
|
+
* OpenAPI spec version: 1.528.0
|
|
7
7
|
*/
|
|
8
8
|
import axios from 'axios';
|
|
9
9
|
import { useQuery, useMutation } from '@tanstack/react-query';
|
|
@@ -553,6 +553,23 @@ export const useDbList = (hostingId, options) => {
|
|
|
553
553
|
query.queryKey = queryKey;
|
|
554
554
|
return query;
|
|
555
555
|
};
|
|
556
|
+
/**
|
|
557
|
+
* Returns a list of db and table limits and usage.
|
|
558
|
+
* @summary DB usage
|
|
559
|
+
*/
|
|
560
|
+
export const dbUsage = (hostingId, options) => {
|
|
561
|
+
return axios.get(`/v1/hosting/${hostingId}/db/usage`, options);
|
|
562
|
+
};
|
|
563
|
+
export const getDbUsageQueryKey = (hostingId) => [`/v1/hosting/${hostingId}/db/usage`];
|
|
564
|
+
export const useDbUsage = (hostingId, options) => {
|
|
565
|
+
var _a;
|
|
566
|
+
const { query: queryOptions, axios: axiosOptions } = options !== null && options !== void 0 ? options : {};
|
|
567
|
+
const queryKey = (_a = queryOptions === null || queryOptions === void 0 ? void 0 : queryOptions.queryKey) !== null && _a !== void 0 ? _a : getDbUsageQueryKey(hostingId);
|
|
568
|
+
const queryFn = ({ signal }) => dbUsage(hostingId, Object.assign({ signal }, axiosOptions));
|
|
569
|
+
const query = useQuery(Object.assign({ queryKey, queryFn, enabled: !!(hostingId) }, queryOptions));
|
|
570
|
+
query.queryKey = queryKey;
|
|
571
|
+
return query;
|
|
572
|
+
};
|
|
556
573
|
/**
|
|
557
574
|
* Get user privileges on a database.
|
|
558
575
|
* @summary Get user privileges on a database.
|
|
@@ -1551,6 +1568,7 @@ export const useSitesSecuritySslAcme = (options) => {
|
|
|
1551
1568
|
};
|
|
1552
1569
|
/**
|
|
1553
1570
|
* Returns the site's SSL Status
|
|
1571
|
+
* @deprecated
|
|
1554
1572
|
* @summary ssl status
|
|
1555
1573
|
*/
|
|
1556
1574
|
export const sitesSecuritySslStatus = (siteId, options) => {
|
|
@@ -1730,6 +1748,23 @@ export const useSitesSettingsPhpVersions = (siteId, options) => {
|
|
|
1730
1748
|
query.queryKey = queryKey;
|
|
1731
1749
|
return query;
|
|
1732
1750
|
};
|
|
1751
|
+
/**
|
|
1752
|
+
* Returns information about the site domain's SSL/TLS certificate
|
|
1753
|
+
* @summary Site domain SSL cert info
|
|
1754
|
+
*/
|
|
1755
|
+
export const sitesSsl = (siteId, options) => {
|
|
1756
|
+
return axios.get(`/v1/sites/${siteId}/ssl`, options);
|
|
1757
|
+
};
|
|
1758
|
+
export const getSitesSslQueryKey = (siteId) => [`/v1/sites/${siteId}/ssl`];
|
|
1759
|
+
export const useSitesSsl = (siteId, options) => {
|
|
1760
|
+
var _a;
|
|
1761
|
+
const { query: queryOptions, axios: axiosOptions } = options !== null && options !== void 0 ? options : {};
|
|
1762
|
+
const queryKey = (_a = queryOptions === null || queryOptions === void 0 ? void 0 : queryOptions.queryKey) !== null && _a !== void 0 ? _a : getSitesSslQueryKey(siteId);
|
|
1763
|
+
const queryFn = ({ signal }) => sitesSsl(siteId, Object.assign({ signal }, axiosOptions));
|
|
1764
|
+
const query = useQuery(Object.assign({ queryKey, queryFn, enabled: !!(siteId) }, queryOptions));
|
|
1765
|
+
query.queryKey = queryKey;
|
|
1766
|
+
return query;
|
|
1767
|
+
};
|
|
1733
1768
|
/**
|
|
1734
1769
|
* Returns an SSO token or login URL for the site (if supported).
|
|
1735
1770
|
* @summary sso
|
package/src/index.msw.d.ts
CHANGED
|
@@ -52,6 +52,8 @@ export declare const getCodeguardPlanInfoMock: () => {
|
|
|
52
52
|
seat_count: number | undefined;
|
|
53
53
|
seat_limit: number | undefined;
|
|
54
54
|
status: string | undefined;
|
|
55
|
+
back_reference: string | undefined;
|
|
56
|
+
can_upgrade: boolean | undefined;
|
|
55
57
|
plan_name: string | undefined;
|
|
56
58
|
seats: {
|
|
57
59
|
url: string | undefined;
|
|
@@ -199,6 +201,10 @@ export declare const getDbListMock: () => {
|
|
|
199
201
|
}[] | undefined;
|
|
200
202
|
}[] | undefined;
|
|
201
203
|
};
|
|
204
|
+
export declare const getDbUsageMock: () => {
|
|
205
|
+
db_limit: number | null | undefined;
|
|
206
|
+
db_count: number | undefined;
|
|
207
|
+
};
|
|
202
208
|
export declare const getDbUserPrivsGetMock: () => {
|
|
203
209
|
privileges: string[] | undefined;
|
|
204
210
|
};
|
|
@@ -554,8 +560,12 @@ export declare const getSitesSecuritySslAcmeMock: () => {
|
|
|
554
560
|
message: string | undefined;
|
|
555
561
|
};
|
|
556
562
|
export declare const getSitesSecuritySslStatusMock: () => {
|
|
563
|
+
domain: string | undefined;
|
|
557
564
|
status: string | undefined;
|
|
558
565
|
message: string | undefined;
|
|
566
|
+
product: string | undefined;
|
|
567
|
+
provider: string | undefined;
|
|
568
|
+
upgradeable: boolean | undefined;
|
|
559
569
|
};
|
|
560
570
|
export declare const getSiteSettingsAutoupdatePluginsMock: () => {
|
|
561
571
|
status: number | undefined;
|
|
@@ -589,6 +599,16 @@ export declare const getSitesSettingsPhpVersionUpdateMock: () => {
|
|
|
589
599
|
export declare const getSitesSettingsPhpVersionsMock: () => {
|
|
590
600
|
versions: string[] | undefined;
|
|
591
601
|
};
|
|
602
|
+
export declare const getSitesSslMock: () => {
|
|
603
|
+
domain: string | undefined;
|
|
604
|
+
domain_dns_status: string | undefined;
|
|
605
|
+
expiration: string | null | undefined;
|
|
606
|
+
issuer: string | undefined;
|
|
607
|
+
product: string | undefined;
|
|
608
|
+
provider: string | null | undefined;
|
|
609
|
+
status: string | undefined;
|
|
610
|
+
upgradeable: boolean | undefined;
|
|
611
|
+
};
|
|
592
612
|
export declare const getSitesSsoMock: () => {
|
|
593
613
|
sso: string | undefined;
|
|
594
614
|
};
|
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.
|
|
6
|
+
* OpenAPI spec version: 1.528.0
|
|
7
7
|
*/
|
|
8
8
|
import { rest } from 'msw';
|
|
9
9
|
import { faker } from '@faker-js/faker';
|
|
@@ -16,7 +16,7 @@ export const getCodeguardDatabaseBackupListMock = () => ({ backups: faker.helper
|
|
|
16
16
|
export const getCodeguardDatabaseBackupCreateMock = () => ({ status: faker.helpers.arrayElement([faker.random.word(), undefined]) });
|
|
17
17
|
export const getCodeguardDatabaseBackupRestoreMock = () => ({ status: faker.helpers.arrayElement([faker.random.word(), undefined]) });
|
|
18
18
|
export const getCodeguardLoginLinkMock = () => ({ link: faker.helpers.arrayElement([faker.random.word(), undefined]) });
|
|
19
|
-
export const getCodeguardPlanInfoMock = () => ({ size: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), size_limit: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), seat_count: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), seat_limit: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), status: faker.helpers.arrayElement([faker.random.word(), undefined]), plan_name: faker.helpers.arrayElement([faker.random.word(), undefined]), seats: faker.helpers.arrayElement([Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ url: faker.helpers.arrayElement([faker.random.word(), undefined]), activated: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), website_id: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]) })), undefined]) });
|
|
19
|
+
export const getCodeguardPlanInfoMock = () => ({ size: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), size_limit: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), seat_count: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), seat_limit: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), status: faker.helpers.arrayElement([faker.random.word(), undefined]), back_reference: faker.helpers.arrayElement([faker.random.word(), undefined]), can_upgrade: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), plan_name: faker.helpers.arrayElement([faker.random.word(), undefined]), seats: faker.helpers.arrayElement([Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ url: faker.helpers.arrayElement([faker.random.word(), undefined]), activated: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), website_id: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]) })), undefined]) });
|
|
20
20
|
export const getCodeguardWebsiteListMock = () => ({ website_list: faker.helpers.arrayElement([Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ website: faker.helpers.arrayElement([{ id: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), activated: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), url: faker.helpers.arrayElement([faker.random.word(), undefined]) }, undefined]) })), undefined]) });
|
|
21
21
|
export const getCodeguardWebsiteBackupListMock = () => ({ backups: faker.helpers.arrayElement([Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ commit_id: faker.helpers.arrayElement([faker.random.word(), undefined]), event_time: faker.helpers.arrayElement([faker.random.word(), undefined]), modifications: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), new_content: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]) })), undefined]) });
|
|
22
22
|
export const getCodeguardWebsiteBackupCreateMock = () => ({ status: faker.helpers.arrayElement([faker.random.word(), undefined]) });
|
|
@@ -41,6 +41,7 @@ export const getCronMock = () => ({ success: faker.helpers.arrayElement([faker.d
|
|
|
41
41
|
export const getDbAddMock = () => ({ dbname: faker.helpers.arrayElement([faker.random.word(), undefined]), status: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), type: faker.helpers.arrayElement([faker.random.word(), undefined]) });
|
|
42
42
|
export const getDbMock = () => ({ dbname: faker.helpers.arrayElement([faker.random.word(), undefined]), status: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), type: faker.helpers.arrayElement([faker.random.word(), undefined]) });
|
|
43
43
|
export const getDbListMock = () => ({ status: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), databases: faker.helpers.arrayElement([Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ db: faker.helpers.arrayElement([faker.random.word(), undefined]), sitename: faker.helpers.arrayElement([faker.random.word(), undefined]), size: faker.helpers.arrayElement([faker.random.word(), undefined]), sizemeg: faker.helpers.arrayElement([faker.random.word(), undefined]), usercount: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), userlist: faker.helpers.arrayElement([Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ db: faker.helpers.arrayElement([faker.random.word(), undefined]), user: faker.helpers.arrayElement([faker.random.word(), undefined]) })), undefined]) })), undefined]) });
|
|
44
|
+
export const getDbUsageMock = () => ({ db_limit: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), null]), undefined]), db_count: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]) });
|
|
44
45
|
export const getDbUserPrivsGetMock = () => ({ privileges: faker.helpers.arrayElement([Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => (faker.random.word())), undefined]) });
|
|
45
46
|
export const getDbUserAddMock = () => ({ username: faker.helpers.arrayElement([faker.random.word(), undefined]), password: faker.helpers.arrayElement([faker.random.word(), undefined]) });
|
|
46
47
|
export const getDbUserDeleteMock = () => ({});
|
|
@@ -103,7 +104,7 @@ export const getSitesSecurityHttpsRedirectionStatusMock = () => ({ success: fake
|
|
|
103
104
|
export const getSitesSecurityHttpsEnableDisableSslMock = () => ({ success: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), redirection_status: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), message: faker.helpers.arrayElement([faker.random.word(), undefined]) });
|
|
104
105
|
export const getSitesSecuritySitelockMock = () => ({ addon_id: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), plan: faker.helpers.arrayElement([faker.random.word(), undefined]), billing_code: faker.helpers.arrayElement([faker.random.word(), undefined]), success: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), subscription_id: faker.helpers.arrayElement([faker.random.word(), undefined]), upgrade_levels: faker.helpers.arrayElement([Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => (faker.random.word())), undefined]) });
|
|
105
106
|
export const getSitesSecuritySslAcmeMock = () => ({ success: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), message: faker.helpers.arrayElement([faker.random.word(), undefined]) });
|
|
106
|
-
export const getSitesSecuritySslStatusMock = () => ({ status: faker.helpers.arrayElement([faker.random.word(), undefined]), message: faker.helpers.arrayElement([faker.random.word(), undefined]) });
|
|
107
|
+
export const getSitesSecuritySslStatusMock = () => ({ domain: faker.helpers.arrayElement([faker.random.word(), undefined]), status: faker.helpers.arrayElement([faker.random.word(), undefined]), message: faker.helpers.arrayElement([faker.random.word(), undefined]), product: faker.helpers.arrayElement([faker.random.word(), undefined]), provider: faker.helpers.arrayElement([faker.random.word(), undefined]), upgradeable: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]) });
|
|
107
108
|
export const getSiteSettingsAutoupdatePluginsMock = () => ({ status: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]) });
|
|
108
109
|
export const getSitesSettingsAutoupdatesMock = () => ({ auto_update_plugin: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), auto_update_theme: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), auto_update_core: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]) });
|
|
109
110
|
export const getSitesSettingsAutoupdatesCoreMock = () => ({ success: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]) });
|
|
@@ -114,6 +115,7 @@ export const getSitesSettingsDebugMock = () => ({ status: faker.helpers.arrayEle
|
|
|
114
115
|
export const getSitesSettingsDebugToggleMock = () => ({ success: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]) });
|
|
115
116
|
export const getSitesSettingsPhpVersionUpdateMock = () => ({ success: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]) });
|
|
116
117
|
export const getSitesSettingsPhpVersionsMock = () => ({ versions: faker.helpers.arrayElement([Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => (faker.random.word())), undefined]) });
|
|
118
|
+
export const getSitesSslMock = () => ({ domain: faker.helpers.arrayElement([faker.random.word(), undefined]), domain_dns_status: faker.helpers.arrayElement([faker.random.word(), undefined]), expiration: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]), issuer: faker.helpers.arrayElement([faker.random.word(), undefined]), product: faker.helpers.arrayElement([faker.random.word(), undefined]), provider: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]), status: faker.helpers.arrayElement([faker.random.word(), undefined]), upgradeable: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]) });
|
|
117
119
|
export const getSitesSsoMock = () => ({ sso: faker.helpers.arrayElement([faker.random.word(), undefined]) });
|
|
118
120
|
export const getSiteStatusMock = () => ({ url: faker.helpers.arrayElement([faker.random.word(), undefined]), pending_url: faker.helpers.arrayElement([faker.random.word(), undefined]), cloudflare_ready: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]) });
|
|
119
121
|
export const getSiteUsersMock = () => ({ users: Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ display_name: faker.helpers.arrayElement([faker.random.word(), undefined]), id: faker.datatype.number({ min: undefined, max: undefined }), meta: faker.helpers.arrayElement([{ maestro_web_pro: faker.helpers.arrayElement([faker.random.word(), undefined]), maestro_wpp_identifier: faker.helpers.arrayElement([faker.random.word(), undefined]) }, undefined]), post_count: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), role: faker.random.word(), user_email: faker.random.word(), user_id: faker.datatype.number({ min: undefined, max: undefined }), user_login: faker.random.word(), user_nicename: faker.random.word() })) });
|
|
@@ -189,6 +191,8 @@ export const getHostingUAPIMSW = () => [
|
|
|
189
191
|
return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json(getDbMock()));
|
|
190
192
|
}), rest.get('*/v1/hosting/:hostingId/db', (_req, res, ctx) => {
|
|
191
193
|
return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json(getDbListMock()));
|
|
194
|
+
}), rest.get('*/v1/hosting/:hostingId/db/usage', (_req, res, ctx) => {
|
|
195
|
+
return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json(getDbUsageMock()));
|
|
192
196
|
}), rest.get('*/v1/hosting/:hostingId/db/user/privileges', (_req, res, ctx) => {
|
|
193
197
|
return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json(getDbUserPrivsGetMock()));
|
|
194
198
|
}), rest.post('*/v1/hosting/:hostingId/db/users', (_req, res, ctx) => {
|
|
@@ -335,6 +339,8 @@ export const getHostingUAPIMSW = () => [
|
|
|
335
339
|
return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json(getSitesSettingsPhpVersionUpdateMock()));
|
|
336
340
|
}), rest.get('*/v1/sites/:siteId/settings/php-versions', (_req, res, ctx) => {
|
|
337
341
|
return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json(getSitesSettingsPhpVersionsMock()));
|
|
342
|
+
}), rest.get('*/v1/sites/:siteId/ssl', (_req, res, ctx) => {
|
|
343
|
+
return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json(getSitesSslMock()));
|
|
338
344
|
}), rest.get('*/v1/sites/:siteId/sso', (_req, res, ctx) => {
|
|
339
345
|
return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json(getSitesSsoMock()));
|
|
340
346
|
}), rest.get('*/v1/sites/:siteId/status', (_req, res, ctx) => {
|
package/src/index.schemas.d.ts
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.
|
|
6
|
+
* OpenAPI spec version: 1.528.0
|
|
7
7
|
*/
|
|
8
8
|
export declare type SshKeyListV2200RowsItem = {
|
|
9
9
|
name?: string;
|
|
@@ -79,6 +79,16 @@ export declare type SitesSsoParams = {
|
|
|
79
79
|
user_email?: string;
|
|
80
80
|
user_id?: string;
|
|
81
81
|
};
|
|
82
|
+
export declare type SitesSsl200 = {
|
|
83
|
+
domain?: string;
|
|
84
|
+
domain_dns_status?: string;
|
|
85
|
+
expiration?: string | null;
|
|
86
|
+
issuer?: string;
|
|
87
|
+
product?: string;
|
|
88
|
+
provider?: string | null;
|
|
89
|
+
status?: string;
|
|
90
|
+
upgradeable?: boolean;
|
|
91
|
+
};
|
|
82
92
|
export declare type SitesSettingsPhpVersions200 = {
|
|
83
93
|
versions?: string[];
|
|
84
94
|
};
|
|
@@ -129,8 +139,12 @@ export declare type SiteSettingsAutoupdatePlugins200 = {
|
|
|
129
139
|
status?: number;
|
|
130
140
|
};
|
|
131
141
|
export declare type SitesSecuritySslStatus200 = {
|
|
142
|
+
domain?: string;
|
|
132
143
|
status?: string;
|
|
133
144
|
message?: string;
|
|
145
|
+
product?: string;
|
|
146
|
+
provider?: string;
|
|
147
|
+
upgradeable?: boolean;
|
|
134
148
|
};
|
|
135
149
|
export declare type SitesSecuritySslAcme200 = {
|
|
136
150
|
success?: number;
|
|
@@ -792,6 +806,10 @@ export declare type DbUserPrivsGetParams = {
|
|
|
792
806
|
database: string;
|
|
793
807
|
dbuser: string;
|
|
794
808
|
};
|
|
809
|
+
export declare type DbUsage200 = {
|
|
810
|
+
db_limit?: number | null;
|
|
811
|
+
db_count?: number;
|
|
812
|
+
};
|
|
795
813
|
export declare type DbList200DatabasesItemUserlistItem = {
|
|
796
814
|
db?: string;
|
|
797
815
|
user?: string;
|
|
@@ -1056,6 +1074,8 @@ export declare type CodeguardPlanInfo200 = {
|
|
|
1056
1074
|
seat_count?: number;
|
|
1057
1075
|
seat_limit?: number;
|
|
1058
1076
|
status?: string;
|
|
1077
|
+
back_reference?: string;
|
|
1078
|
+
can_upgrade?: boolean;
|
|
1059
1079
|
plan_name?: string;
|
|
1060
1080
|
seats?: CodeguardPlanInfo200SeatsItem[];
|
|
1061
1081
|
};
|