@newfold/huapi-js 1.690.0 → 1.717.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 +16 -2
- package/src/index.js +18 -1
- package/src/index.msw.d.ts +27 -6
- package/src/index.msw.js +8 -5
- package/src/index.schemas.d.ts +35 -7
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.717.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, 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';
|
|
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, SitesDomains200, 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
|
/**
|
|
@@ -1365,6 +1365,20 @@ export declare const useSitesDomainUrl: <TError = AxiosError<unknown, any>, TCon
|
|
|
1365
1365
|
siteId: number;
|
|
1366
1366
|
data: SitesDomainUrlBody;
|
|
1367
1367
|
}, TContext>;
|
|
1368
|
+
/**
|
|
1369
|
+
* Provides the domains list associated with the site
|
|
1370
|
+
* @summary Domains list for the site
|
|
1371
|
+
*/
|
|
1372
|
+
export declare const sitesDomains: (siteId: number, options?: AxiosRequestConfig) => Promise<AxiosResponse<SitesDomains200>>;
|
|
1373
|
+
export declare const getSitesDomainsQueryKey: (siteId: number) => string[];
|
|
1374
|
+
export declare type SitesDomainsQueryResult = NonNullable<Awaited<ReturnType<typeof sitesDomains>>>;
|
|
1375
|
+
export declare type SitesDomainsQueryError = AxiosError<unknown>;
|
|
1376
|
+
export declare const useSitesDomains: <TData = AxiosResponse<SitesDomains200, any>, TError = AxiosError<unknown, any>>(siteId: number, options?: {
|
|
1377
|
+
query?: UseQueryOptions<AxiosResponse<SitesDomains200, any>, TError, TData, QueryKey> | undefined;
|
|
1378
|
+
axios?: AxiosRequestConfig<any> | undefined;
|
|
1379
|
+
} | undefined) => UseQueryResult<TData, TError> & {
|
|
1380
|
+
queryKey: QueryKey;
|
|
1381
|
+
};
|
|
1368
1382
|
/**
|
|
1369
1383
|
* Delete pending domain
|
|
1370
1384
|
* @summary Delete pending domain
|
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.717.0
|
|
7
7
|
*/
|
|
8
8
|
import axios from 'axios';
|
|
9
9
|
import { useQuery, useMutation } from '@tanstack/react-query';
|
|
@@ -1416,6 +1416,23 @@ export const useSitesDomainUrl = (options) => {
|
|
|
1416
1416
|
};
|
|
1417
1417
|
return useMutation(mutationFn, mutationOptions);
|
|
1418
1418
|
};
|
|
1419
|
+
/**
|
|
1420
|
+
* Provides the domains list associated with the site
|
|
1421
|
+
* @summary Domains list for the site
|
|
1422
|
+
*/
|
|
1423
|
+
export const sitesDomains = (siteId, options) => {
|
|
1424
|
+
return axios.get(`/v1/sites/${siteId}/domains`, options);
|
|
1425
|
+
};
|
|
1426
|
+
export const getSitesDomainsQueryKey = (siteId) => [`/v1/sites/${siteId}/domains`];
|
|
1427
|
+
export const useSitesDomains = (siteId, options) => {
|
|
1428
|
+
var _a;
|
|
1429
|
+
const { query: queryOptions, axios: axiosOptions } = options !== null && options !== void 0 ? options : {};
|
|
1430
|
+
const queryKey = (_a = queryOptions === null || queryOptions === void 0 ? void 0 : queryOptions.queryKey) !== null && _a !== void 0 ? _a : getSitesDomainsQueryKey(siteId);
|
|
1431
|
+
const queryFn = ({ signal }) => sitesDomains(siteId, Object.assign({ signal }, axiosOptions));
|
|
1432
|
+
const query = useQuery(Object.assign({ queryKey, queryFn, enabled: !!(siteId) }, queryOptions));
|
|
1433
|
+
query.queryKey = queryKey;
|
|
1434
|
+
return query;
|
|
1435
|
+
};
|
|
1419
1436
|
/**
|
|
1420
1437
|
* Delete pending domain
|
|
1421
1438
|
* @summary Delete pending domain
|
package/src/index.msw.d.ts
CHANGED
|
@@ -409,8 +409,10 @@ export declare const getSitesInfoMock: () => {
|
|
|
409
409
|
date_modified: string | undefined;
|
|
410
410
|
detected_type: string | undefined;
|
|
411
411
|
docroot: string | null | undefined;
|
|
412
|
+
is_primary: boolean | undefined;
|
|
412
413
|
path: string | undefined;
|
|
413
414
|
domain: string | null | undefined;
|
|
415
|
+
base_domain: string | null | undefined;
|
|
414
416
|
name: string | null | undefined;
|
|
415
417
|
pending_url: string | null | undefined;
|
|
416
418
|
php_version: string | null | undefined;
|
|
@@ -424,6 +426,8 @@ export declare const getSitesInfoMock: () => {
|
|
|
424
426
|
pending_url_data: {
|
|
425
427
|
error: string | null | undefined;
|
|
426
428
|
stage: string | null | undefined;
|
|
429
|
+
domain: string | null | undefined;
|
|
430
|
+
base_domain: string | null | undefined;
|
|
427
431
|
} | undefined;
|
|
428
432
|
};
|
|
429
433
|
export declare const getSiteUpdateMock: () => {
|
|
@@ -518,6 +522,17 @@ export declare const getSitesDomainMock: () => {
|
|
|
518
522
|
export declare const getSitesDomainUrlMock: () => {
|
|
519
523
|
success: boolean | undefined;
|
|
520
524
|
};
|
|
525
|
+
export declare const getSitesDomainsMock: () => {
|
|
526
|
+
domains: {
|
|
527
|
+
id: number | undefined;
|
|
528
|
+
autogen_id: number | undefined;
|
|
529
|
+
dns_status: string | undefined;
|
|
530
|
+
docroot: string | undefined;
|
|
531
|
+
domain: string | undefined;
|
|
532
|
+
ssl_type: string | undefined;
|
|
533
|
+
type: string | undefined;
|
|
534
|
+
}[] | undefined;
|
|
535
|
+
};
|
|
521
536
|
export declare const getSitePendingDomainDeleteMock: () => {};
|
|
522
537
|
export declare const getSitesPerformanceCachepurgeMock: () => {
|
|
523
538
|
success: boolean | undefined;
|
|
@@ -578,8 +593,11 @@ export declare const getSitesSecuritySitelockMock: () => {
|
|
|
578
593
|
plan: string | undefined;
|
|
579
594
|
billing_code: string | undefined;
|
|
580
595
|
success: number | undefined;
|
|
581
|
-
|
|
596
|
+
platform_id: string | undefined;
|
|
582
597
|
upgrade_levels: string[] | undefined;
|
|
598
|
+
message: string | undefined;
|
|
599
|
+
has_cdn: boolean | undefined;
|
|
600
|
+
scope: string | undefined;
|
|
583
601
|
};
|
|
584
602
|
export declare const getSitesSecuritySslAcmeMock: () => {
|
|
585
603
|
success: number | undefined;
|
|
@@ -682,6 +700,7 @@ export declare const getHostingSitesV2Mock: () => {
|
|
|
682
700
|
confirmed: boolean | undefined;
|
|
683
701
|
detected_type: string | undefined;
|
|
684
702
|
docroot: string | undefined;
|
|
703
|
+
is_primary: boolean | undefined;
|
|
685
704
|
status: string | undefined;
|
|
686
705
|
type: string | undefined;
|
|
687
706
|
pending_url: string | undefined;
|
|
@@ -701,15 +720,17 @@ export declare const getSitesListV2Mock: () => {
|
|
|
701
720
|
page: number | undefined;
|
|
702
721
|
limit: number | undefined;
|
|
703
722
|
items: {
|
|
704
|
-
id: number | undefined;
|
|
705
723
|
confirmed: boolean | undefined;
|
|
706
|
-
name: string | undefined;
|
|
707
|
-
url: string | undefined;
|
|
708
724
|
docroot: string | undefined;
|
|
725
|
+
id: number | undefined;
|
|
726
|
+
is_primary: boolean | undefined;
|
|
727
|
+
migration_id: string | undefined;
|
|
728
|
+
name: string | undefined;
|
|
729
|
+
path: string | undefined;
|
|
730
|
+
pending_url: string | undefined;
|
|
709
731
|
status: string | undefined;
|
|
710
732
|
type: string | undefined;
|
|
711
|
-
|
|
712
|
-
migration_id: string | undefined;
|
|
733
|
+
url: string | undefined;
|
|
713
734
|
}[] | undefined;
|
|
714
735
|
};
|
|
715
736
|
export declare const getHostingUAPIMSW: () => import("msw").RestHandler<import("msw/lib/glossary-58eca5a8").M<import("msw/lib/glossary-58eca5a8").c>>[];
|
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.717.0
|
|
7
7
|
*/
|
|
8
8
|
import { rest } from 'msw';
|
|
9
9
|
import { faker } from '@faker-js/faker';
|
|
@@ -79,7 +79,7 @@ export const getSshKeyMock = () => ({ deleted: faker.helpers.arrayElement([faker
|
|
|
79
79
|
export const getSshKeyGenerateMock = () => ({ key_name: faker.helpers.arrayElement([faker.random.word(), undefined]), private_key_path: faker.helpers.arrayElement([faker.random.word(), undefined]), public_key_path: faker.helpers.arrayElement([faker.random.word(), undefined]) });
|
|
80
80
|
export const getSsoMock = () => ({ url: faker.random.word() });
|
|
81
81
|
export const getSitesListMock = () => ({ items: 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]), name: faker.helpers.arrayElement([faker.random.word(), undefined]), url: faker.helpers.arrayElement([faker.random.word(), undefined]), docroot: faker.helpers.arrayElement([faker.random.word(), undefined]), status: faker.helpers.arrayElement([faker.random.word(), undefined]) })), undefined]) });
|
|
82
|
-
export const getSitesInfoMock = () => ({ id: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), account_back_ref: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]), account_id: faker.helpers.arrayElement([faker.random.word(), undefined]), confirmed: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), date_added: faker.helpers.arrayElement([faker.random.word(), undefined]), date_modified: faker.helpers.arrayElement([faker.random.word(), undefined]), detected_type: faker.helpers.arrayElement([faker.random.word(), undefined]), docroot: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]), path: faker.helpers.arrayElement([faker.random.word(), undefined]), domain: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]), name: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]), pending_url: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]), php_version: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]), status: faker.helpers.arrayElement([faker.random.word(), undefined]), subtype: faker.helpers.arrayElement([faker.random.word(), undefined]), type: faker.helpers.arrayElement([faker.random.word(), undefined]), url: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]), url_is_provisional: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), version: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]), installed_id: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]), pending_url_data: faker.helpers.arrayElement([{ error: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]), stage: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]) }, undefined]) });
|
|
82
|
+
export const getSitesInfoMock = () => ({ id: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), account_back_ref: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]), account_id: faker.helpers.arrayElement([faker.random.word(), undefined]), confirmed: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), date_added: faker.helpers.arrayElement([faker.random.word(), undefined]), date_modified: faker.helpers.arrayElement([faker.random.word(), undefined]), detected_type: faker.helpers.arrayElement([faker.random.word(), undefined]), docroot: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]), is_primary: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), path: faker.helpers.arrayElement([faker.random.word(), undefined]), domain: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]), base_domain: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]), name: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]), pending_url: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]), php_version: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]), status: faker.helpers.arrayElement([faker.random.word(), undefined]), subtype: faker.helpers.arrayElement([faker.random.word(), undefined]), type: faker.helpers.arrayElement([faker.random.word(), undefined]), url: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]), url_is_provisional: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), version: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]), installed_id: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]), pending_url_data: faker.helpers.arrayElement([{ error: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]), stage: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]), domain: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]), base_domain: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.random.word(), null]), undefined]) }, undefined]) });
|
|
83
83
|
export const getSiteUpdateMock = () => ({ success: faker.datatype.boolean() });
|
|
84
84
|
export const getSiteMock = () => ({ success: faker.datatype.boolean() });
|
|
85
85
|
export const getSitesAutoupdatesInfoMock = () => ({ plugins: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), core: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), themes: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]) });
|
|
@@ -94,6 +94,7 @@ export const getSiteAddonCloudflareMock = () => ({ addon_id: faker.helpers.array
|
|
|
94
94
|
export const getSitesDnsMock = () => ({ success: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), source: faker.helpers.arrayElement([faker.random.word(), undefined]), records: faker.helpers.arrayElement([Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ name: faker.helpers.arrayElement([faker.random.word(), undefined]), value: faker.helpers.arrayElement([faker.random.word(), undefined]), type: faker.helpers.arrayElement([faker.random.word(), undefined]) })), undefined]) });
|
|
95
95
|
export const getSitesDomainMock = () => ({ connected: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), a_match: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), nameserver_match: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), detected: faker.helpers.arrayElement([{ a: faker.helpers.arrayElement([Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => (faker.random.word())), undefined]), ns: faker.helpers.arrayElement([Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => (faker.random.word())), undefined]) }, undefined]), wanted: faker.helpers.arrayElement([{ a: faker.helpers.arrayElement([Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => (faker.random.word())), undefined]), ns: faker.helpers.arrayElement([Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => (faker.random.word())), undefined]) }, undefined]) });
|
|
96
96
|
export const getSitesDomainUrlMock = () => ({ success: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]) });
|
|
97
|
+
export const getSitesDomainsMock = () => ({ domains: faker.helpers.arrayElement([Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ id: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), autogen_id: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), dns_status: faker.helpers.arrayElement([faker.random.word(), undefined]), docroot: faker.helpers.arrayElement([faker.random.word(), undefined]), domain: faker.helpers.arrayElement([faker.random.word(), undefined]), ssl_type: faker.helpers.arrayElement([faker.random.word(), undefined]), type: faker.helpers.arrayElement([faker.random.word(), undefined]) })), undefined]) });
|
|
97
98
|
export const getSitePendingDomainDeleteMock = () => ({});
|
|
98
99
|
export const getSitesPerformanceCachepurgeMock = () => ({ success: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]) });
|
|
99
100
|
export const getSitesPerformanceEnduranceCacheLevelStatusMock = () => ({ endurance_cache_level: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]) });
|
|
@@ -108,7 +109,7 @@ export const getSitesSecurityCheckCoreMock = () => ({ results: faker.helpers.arr
|
|
|
108
109
|
export const getSitesSecurityResetCoreFilesMock = () => ({ results: faker.helpers.arrayElement([faker.random.word(), undefined]), success: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]) });
|
|
109
110
|
export const getSitesSecurityHttpsRedirectionStatusMock = () => ({ 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]) });
|
|
110
111
|
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]) });
|
|
111
|
-
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]),
|
|
112
|
+
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]), platform_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]), message: faker.helpers.arrayElement([faker.random.word(), undefined]), has_cdn: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), scope: faker.helpers.arrayElement([faker.random.word(), undefined]) });
|
|
112
113
|
export const getSitesSecuritySslAcmeMock = () => ({ success: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), message: faker.helpers.arrayElement([faker.random.word(), undefined]) });
|
|
113
114
|
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]) });
|
|
114
115
|
export const getSitesSettingsComingSoonMock = () => ({ enable: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]) });
|
|
@@ -123,9 +124,9 @@ export const getSiteStatusMock = () => ({ url: faker.helpers.arrayElement([faker
|
|
|
123
124
|
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() })) });
|
|
124
125
|
export const getSitesVersionMock = () => ({ current: faker.helpers.arrayElement([faker.random.word(), undefined]), latest: faker.helpers.arrayElement([faker.random.word(), undefined]), update: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]) });
|
|
125
126
|
export const getHostingNameserversV2Mock = () => ({ id: faker.datatype.number({ min: undefined, max: undefined }), is_default: faker.helpers.arrayElement([faker.random.word(), undefined]), brand: faker.random.word(), hosts: Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ host: faker.helpers.arrayElement([faker.random.word(), undefined]), ips: faker.helpers.arrayElement([Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => (faker.random.word())), undefined]) })) });
|
|
126
|
-
export const getHostingSitesV2Mock = () => ({ total: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), page: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), limit: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), max_sites: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), null]), undefined]), used_sites: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), available_sites: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), null]), undefined]), items: faker.helpers.arrayElement([Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ id: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), name: faker.helpers.arrayElement([faker.random.word(), undefined]), url: faker.helpers.arrayElement([faker.random.word(), undefined]), confirmed: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), detected_type: faker.helpers.arrayElement([faker.random.word(), undefined]), docroot: faker.helpers.arrayElement([faker.random.word(), undefined]), status: faker.helpers.arrayElement([faker.random.word(), undefined]), type: faker.helpers.arrayElement([faker.random.word(), undefined]), pending_url: faker.helpers.arrayElement([faker.random.word(), undefined]), migration_id: faker.helpers.arrayElement([faker.random.word(), undefined]) })), undefined]) });
|
|
127
|
+
export const getHostingSitesV2Mock = () => ({ total: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), page: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), limit: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), max_sites: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), null]), undefined]), used_sites: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), available_sites: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), null]), undefined]), items: faker.helpers.arrayElement([Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ id: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), name: faker.helpers.arrayElement([faker.random.word(), undefined]), url: faker.helpers.arrayElement([faker.random.word(), undefined]), confirmed: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), detected_type: faker.helpers.arrayElement([faker.random.word(), undefined]), docroot: faker.helpers.arrayElement([faker.random.word(), undefined]), is_primary: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), status: faker.helpers.arrayElement([faker.random.word(), undefined]), type: faker.helpers.arrayElement([faker.random.word(), undefined]), pending_url: faker.helpers.arrayElement([faker.random.word(), undefined]), migration_id: faker.helpers.arrayElement([faker.random.word(), undefined]) })), undefined]) });
|
|
127
128
|
export const getSshKeyListV2Mock = () => ({ rows: faker.helpers.arrayElement([Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ name: faker.helpers.arrayElement([faker.random.word(), undefined]), type: faker.helpers.arrayElement([faker.random.word(), undefined]), mtime: faker.helpers.arrayElement([faker.random.word(), undefined]), key: faker.helpers.arrayElement([faker.random.word(), undefined]) })), undefined]) });
|
|
128
|
-
export const getSitesListV2Mock = () => ({ total: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), page: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), limit: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), items: faker.helpers.arrayElement([Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ id: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]),
|
|
129
|
+
export const getSitesListV2Mock = () => ({ total: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), page: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), limit: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), items: faker.helpers.arrayElement([Array.from({ length: faker.datatype.number({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ confirmed: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), docroot: faker.helpers.arrayElement([faker.random.word(), undefined]), id: faker.helpers.arrayElement([faker.datatype.number({ min: undefined, max: undefined }), undefined]), is_primary: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), migration_id: faker.helpers.arrayElement([faker.random.word(), undefined]), name: faker.helpers.arrayElement([faker.random.word(), undefined]), path: faker.helpers.arrayElement([faker.random.word(), undefined]), pending_url: faker.helpers.arrayElement([faker.random.word(), undefined]), status: faker.helpers.arrayElement([faker.random.word(), undefined]), type: faker.helpers.arrayElement([faker.random.word(), undefined]), url: faker.helpers.arrayElement([faker.random.word(), undefined]) })), undefined]) });
|
|
129
130
|
export const getHostingUAPIMSW = () => [
|
|
130
131
|
rest.get('*/v1/account/hosting', (_req, res, ctx) => {
|
|
131
132
|
return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json(getAccountHostingListMock()));
|
|
@@ -301,6 +302,8 @@ export const getHostingUAPIMSW = () => [
|
|
|
301
302
|
return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json(getSitesDomainMock()));
|
|
302
303
|
}), rest.post('*/v1/sites/:siteId/domain', (_req, res, ctx) => {
|
|
303
304
|
return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json(getSitesDomainUrlMock()));
|
|
305
|
+
}), rest.get('*/v1/sites/:siteId/domains', (_req, res, ctx) => {
|
|
306
|
+
return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json(getSitesDomainsMock()));
|
|
304
307
|
}), rest.delete('*/v1/sites/:siteId/pending-domain', (_req, res, ctx) => {
|
|
305
308
|
return res(ctx.delay(1000), ctx.status(200, 'Mocked status'), ctx.json(getSitePendingDomainDeleteMock()));
|
|
306
309
|
}), rest.post('*/v1/sites/:siteId/performance/cachepurge', (_req, res, ctx) => {
|
package/src/index.schemas.d.ts
CHANGED
|
@@ -3,19 +3,22 @@
|
|
|
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.717.0
|
|
7
7
|
*/
|
|
8
8
|
export declare type SitesListV2200ItemsItem = {
|
|
9
|
-
id?: number;
|
|
10
9
|
/** False if site was added by site scanner */
|
|
11
10
|
confirmed?: boolean | null;
|
|
12
|
-
name?: string;
|
|
13
|
-
url?: string;
|
|
14
11
|
docroot?: string;
|
|
12
|
+
id?: number;
|
|
13
|
+
/** True if docpath is public_html, otherwise False */
|
|
14
|
+
is_primary?: boolean;
|
|
15
|
+
migration_id?: string;
|
|
16
|
+
name?: string;
|
|
17
|
+
path?: string;
|
|
18
|
+
pending_url?: string;
|
|
15
19
|
status?: string;
|
|
16
20
|
type?: string;
|
|
17
|
-
|
|
18
|
-
migration_id?: string;
|
|
21
|
+
url?: string;
|
|
19
22
|
};
|
|
20
23
|
export declare type SitesListV2200 = {
|
|
21
24
|
total?: number;
|
|
@@ -40,6 +43,8 @@ export declare type HostingSitesV2200ItemsItem = {
|
|
|
40
43
|
confirmed?: boolean | null;
|
|
41
44
|
detected_type?: string;
|
|
42
45
|
docroot?: string;
|
|
46
|
+
/** True if docpath is public_html, otherwise False */
|
|
47
|
+
is_primary?: boolean;
|
|
43
48
|
status?: string;
|
|
44
49
|
type?: string;
|
|
45
50
|
pending_url?: string;
|
|
@@ -179,8 +184,12 @@ export declare type SitesSecuritySitelock200 = {
|
|
|
179
184
|
plan?: string;
|
|
180
185
|
billing_code?: string;
|
|
181
186
|
success?: number;
|
|
182
|
-
|
|
187
|
+
platform_id?: string;
|
|
183
188
|
upgrade_levels?: string[];
|
|
189
|
+
message?: string;
|
|
190
|
+
has_cdn?: boolean;
|
|
191
|
+
/** Sitelock can be attached directly to a site, or it will fallback and return the sitelock for entire hosting account */
|
|
192
|
+
scope?: string;
|
|
184
193
|
};
|
|
185
194
|
export declare type SitesSecurityHttpsEnableDisableSsl200 = {
|
|
186
195
|
success?: number;
|
|
@@ -273,6 +282,18 @@ export declare type SitesPerformanceCachepurgeBody = {
|
|
|
273
282
|
export declare type SitePendingDomainDelete200 = {
|
|
274
283
|
[key: string]: any;
|
|
275
284
|
};
|
|
285
|
+
export declare type SitesDomains200DomainsItem = {
|
|
286
|
+
id?: number;
|
|
287
|
+
autogen_id?: number;
|
|
288
|
+
dns_status?: string;
|
|
289
|
+
docroot?: string;
|
|
290
|
+
domain?: string;
|
|
291
|
+
ssl_type?: string;
|
|
292
|
+
type?: string;
|
|
293
|
+
};
|
|
294
|
+
export declare type SitesDomains200 = {
|
|
295
|
+
domains?: SitesDomains200DomainsItem[];
|
|
296
|
+
};
|
|
276
297
|
export declare type SitesDomainUrl200 = {
|
|
277
298
|
success?: boolean;
|
|
278
299
|
};
|
|
@@ -404,6 +425,10 @@ export declare type SiteUpdateBody = {
|
|
|
404
425
|
export declare type SitesInfo200PendingUrlData = {
|
|
405
426
|
error?: string | null;
|
|
406
427
|
stage?: string | null;
|
|
428
|
+
/** The Fully Qualified Domain Name (FQDN) */
|
|
429
|
+
domain?: string | null;
|
|
430
|
+
/** The root domain name */
|
|
431
|
+
base_domain?: string | null;
|
|
407
432
|
} | null;
|
|
408
433
|
export declare type SitesInfo200 = {
|
|
409
434
|
id?: number;
|
|
@@ -415,8 +440,11 @@ export declare type SitesInfo200 = {
|
|
|
415
440
|
date_modified?: string;
|
|
416
441
|
detected_type?: string;
|
|
417
442
|
docroot?: string | null;
|
|
443
|
+
/** True if docpath is public_html, otherwise False */
|
|
444
|
+
is_primary?: boolean;
|
|
418
445
|
path?: string;
|
|
419
446
|
domain?: string | null;
|
|
447
|
+
base_domain?: string | null;
|
|
420
448
|
name?: string | null;
|
|
421
449
|
pending_url?: string | null;
|
|
422
450
|
/** The Php Version. If unable to determine, it will be NULL */
|