@newfold/huapi-js 2.1898.0 → 2.1900.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 +228 -1
- package/src/index.js +183 -1
- package/src/index.msw.d.ts +15 -1
- package/src/index.msw.js +86 -2
- package/src/index.schemas.d.ts +213 -110
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.1900.0
|
|
7
7
|
*/
|
|
8
8
|
export declare type SshKeyListV4200RowsItem = {
|
|
9
9
|
authorize?: boolean;
|
|
@@ -2369,13 +2369,6 @@ export declare type SitePendingDomainDelete200 = {
|
|
|
2369
2369
|
export declare type SitesOnboardingSteps200 = {
|
|
2370
2370
|
steps?: SiteOnboardingStepModel[];
|
|
2371
2371
|
};
|
|
2372
|
-
export declare type SitesMetricDimensions200 = {
|
|
2373
|
-
date_end?: string;
|
|
2374
|
-
date_start?: string;
|
|
2375
|
-
dimensions?: SitesMetricDimensions200Dimensions;
|
|
2376
|
-
elapsed?: number;
|
|
2377
|
-
metric?: string;
|
|
2378
|
-
};
|
|
2379
2372
|
export declare type SitesMetricDimensions200DimensionsWpAdminAjaxActionItemDimension = {
|
|
2380
2373
|
[key: string]: number;
|
|
2381
2374
|
};
|
|
@@ -2458,6 +2451,13 @@ export declare type SitesMetricDimensions200Dimensions = {
|
|
|
2458
2451
|
visitor_is_crawler?: SitesMetricDimensions200DimensionsVisitorIsCrawlerItem[];
|
|
2459
2452
|
wp_admin_ajax_action?: SitesMetricDimensions200DimensionsWpAdminAjaxActionItem[];
|
|
2460
2453
|
};
|
|
2454
|
+
export declare type SitesMetricDimensions200 = {
|
|
2455
|
+
date_end?: string;
|
|
2456
|
+
date_start?: string;
|
|
2457
|
+
dimensions?: SitesMetricDimensions200Dimensions;
|
|
2458
|
+
elapsed?: number;
|
|
2459
|
+
metric?: string;
|
|
2460
|
+
};
|
|
2461
2461
|
export declare type SitesMetricDimensionsParams = {
|
|
2462
2462
|
start?: string;
|
|
2463
2463
|
end?: string;
|
|
@@ -2763,6 +2763,9 @@ export declare type SiteAddonCloudflare400 = {
|
|
|
2763
2763
|
export declare type SiteAddonCloudflare200 = {
|
|
2764
2764
|
addon_id?: number;
|
|
2765
2765
|
};
|
|
2766
|
+
export declare type SitesBackupsXcitium200 = {
|
|
2767
|
+
website_id?: number;
|
|
2768
|
+
};
|
|
2766
2769
|
export declare type BackupsJetpackBackup200 = {
|
|
2767
2770
|
[key: string]: unknown;
|
|
2768
2771
|
};
|
|
@@ -2784,6 +2787,28 @@ export declare type JetpackBackupStatus200 = {
|
|
|
2784
2787
|
/** @nullable */
|
|
2785
2788
|
status?: string | null;
|
|
2786
2789
|
};
|
|
2790
|
+
export declare type SitesBackupsDetails200Xcitium = {
|
|
2791
|
+
activated?: boolean;
|
|
2792
|
+
/** @nullable */
|
|
2793
|
+
addon_back_reference?: string | null;
|
|
2794
|
+
addon_id?: string;
|
|
2795
|
+
can_upgrade?: boolean;
|
|
2796
|
+
/** @nullable */
|
|
2797
|
+
database_id?: string | null;
|
|
2798
|
+
/** @nullable */
|
|
2799
|
+
disabled?: boolean | null;
|
|
2800
|
+
/** @nullable */
|
|
2801
|
+
over_quota?: boolean | null;
|
|
2802
|
+
/** @nullable */
|
|
2803
|
+
plan_name?: string | null;
|
|
2804
|
+
seats_available?: number;
|
|
2805
|
+
seats_count?: number;
|
|
2806
|
+
status?: boolean;
|
|
2807
|
+
/** @nullable */
|
|
2808
|
+
url?: string | null;
|
|
2809
|
+
/** @nullable */
|
|
2810
|
+
website_id?: string | null;
|
|
2811
|
+
};
|
|
2787
2812
|
export declare type SitesBackupsDetails200Jetpack = {
|
|
2788
2813
|
/** @nullable */
|
|
2789
2814
|
addon_back_reference?: string | null;
|
|
@@ -2832,6 +2857,7 @@ export declare type SitesBackupsDetails200Codeguard = {
|
|
|
2832
2857
|
export declare type SitesBackupsDetails200 = {
|
|
2833
2858
|
codeguard?: SitesBackupsDetails200Codeguard;
|
|
2834
2859
|
jetpack?: SitesBackupsDetails200Jetpack;
|
|
2860
|
+
xcitium?: SitesBackupsDetails200Xcitium;
|
|
2835
2861
|
};
|
|
2836
2862
|
export declare type SitesBackupsCodeguard200 = {
|
|
2837
2863
|
database_id?: number;
|
|
@@ -2980,6 +3006,71 @@ export declare type SitesInfo200Staging = {
|
|
|
2980
3006
|
/** A list of staging sites of the current site */
|
|
2981
3007
|
sites?: number[];
|
|
2982
3008
|
} | null;
|
|
3009
|
+
export declare type SitesInfo200ResourcesStorage = {
|
|
3010
|
+
/** @nullable */
|
|
3011
|
+
available?: number | null;
|
|
3012
|
+
/** @nullable */
|
|
3013
|
+
total?: number | null;
|
|
3014
|
+
unit?: string;
|
|
3015
|
+
/** @nullable */
|
|
3016
|
+
used?: number | null;
|
|
3017
|
+
};
|
|
3018
|
+
export declare type SitesInfo200Resources = {
|
|
3019
|
+
storage?: SitesInfo200ResourcesStorage;
|
|
3020
|
+
/** @nullable */
|
|
3021
|
+
workers?: number | null;
|
|
3022
|
+
};
|
|
3023
|
+
/**
|
|
3024
|
+
* @nullable
|
|
3025
|
+
*/
|
|
3026
|
+
export declare type SitesInfo200PendingUrlData = {
|
|
3027
|
+
/**
|
|
3028
|
+
* The root domain name
|
|
3029
|
+
* @nullable
|
|
3030
|
+
*/
|
|
3031
|
+
base_domain?: string | null;
|
|
3032
|
+
/**
|
|
3033
|
+
* The Fully Qualified Domain Name (FQDN)
|
|
3034
|
+
* @nullable
|
|
3035
|
+
*/
|
|
3036
|
+
domain?: string | null;
|
|
3037
|
+
/**
|
|
3038
|
+
* The current pending_url's HAL Domain ID
|
|
3039
|
+
* @nullable
|
|
3040
|
+
*/
|
|
3041
|
+
domain_id?: number | null;
|
|
3042
|
+
/** @nullable */
|
|
3043
|
+
error?: string | null;
|
|
3044
|
+
/** Flag indicating whether the pending_url is temporary or not */
|
|
3045
|
+
is_temp?: boolean;
|
|
3046
|
+
/**
|
|
3047
|
+
* Flag indicating whether the url_sync job has run out of attempts
|
|
3048
|
+
* @nullable
|
|
3049
|
+
*/
|
|
3050
|
+
job_failed?: boolean | null;
|
|
3051
|
+
/** @nullable */
|
|
3052
|
+
stage?: string | null;
|
|
3053
|
+
/**
|
|
3054
|
+
* Timestamp for when we will update the WP url, regardless of active sessions
|
|
3055
|
+
* @nullable
|
|
3056
|
+
*/
|
|
3057
|
+
wp_session?: string | null;
|
|
3058
|
+
} | null;
|
|
3059
|
+
/**
|
|
3060
|
+
* @nullable
|
|
3061
|
+
*/
|
|
3062
|
+
export declare type SitesInfo200Pagespeed = {
|
|
3063
|
+
lastrun?: string;
|
|
3064
|
+
performance?: string;
|
|
3065
|
+
strategy?: string;
|
|
3066
|
+
} | null;
|
|
3067
|
+
/**
|
|
3068
|
+
* Job ids for the site
|
|
3069
|
+
* @nullable
|
|
3070
|
+
*/
|
|
3071
|
+
export declare type SitesInfo200Jobs = {
|
|
3072
|
+
[key: string]: unknown;
|
|
3073
|
+
} | null;
|
|
2983
3074
|
export declare type SitesInfo200 = {
|
|
2984
3075
|
/** @nullable */
|
|
2985
3076
|
account_back_ref?: string | null;
|
|
@@ -3063,71 +3154,6 @@ export declare type SitesInfo200 = {
|
|
|
3063
3154
|
/** @nullable */
|
|
3064
3155
|
wp_multi_site?: SitesInfo200WpMultiSite;
|
|
3065
3156
|
};
|
|
3066
|
-
export declare type SitesInfo200ResourcesStorage = {
|
|
3067
|
-
/** @nullable */
|
|
3068
|
-
available?: number | null;
|
|
3069
|
-
/** @nullable */
|
|
3070
|
-
total?: number | null;
|
|
3071
|
-
unit?: string;
|
|
3072
|
-
/** @nullable */
|
|
3073
|
-
used?: number | null;
|
|
3074
|
-
};
|
|
3075
|
-
export declare type SitesInfo200Resources = {
|
|
3076
|
-
storage?: SitesInfo200ResourcesStorage;
|
|
3077
|
-
/** @nullable */
|
|
3078
|
-
workers?: number | null;
|
|
3079
|
-
};
|
|
3080
|
-
/**
|
|
3081
|
-
* @nullable
|
|
3082
|
-
*/
|
|
3083
|
-
export declare type SitesInfo200PendingUrlData = {
|
|
3084
|
-
/**
|
|
3085
|
-
* The root domain name
|
|
3086
|
-
* @nullable
|
|
3087
|
-
*/
|
|
3088
|
-
base_domain?: string | null;
|
|
3089
|
-
/**
|
|
3090
|
-
* The Fully Qualified Domain Name (FQDN)
|
|
3091
|
-
* @nullable
|
|
3092
|
-
*/
|
|
3093
|
-
domain?: string | null;
|
|
3094
|
-
/**
|
|
3095
|
-
* The current pending_url's HAL Domain ID
|
|
3096
|
-
* @nullable
|
|
3097
|
-
*/
|
|
3098
|
-
domain_id?: number | null;
|
|
3099
|
-
/** @nullable */
|
|
3100
|
-
error?: string | null;
|
|
3101
|
-
/** Flag indicating whether the pending_url is temporary or not */
|
|
3102
|
-
is_temp?: boolean;
|
|
3103
|
-
/**
|
|
3104
|
-
* Flag indicating whether the url_sync job has run out of attempts
|
|
3105
|
-
* @nullable
|
|
3106
|
-
*/
|
|
3107
|
-
job_failed?: boolean | null;
|
|
3108
|
-
/** @nullable */
|
|
3109
|
-
stage?: string | null;
|
|
3110
|
-
/**
|
|
3111
|
-
* Timestamp for when we will update the WP url, regardless of active sessions
|
|
3112
|
-
* @nullable
|
|
3113
|
-
*/
|
|
3114
|
-
wp_session?: string | null;
|
|
3115
|
-
} | null;
|
|
3116
|
-
/**
|
|
3117
|
-
* @nullable
|
|
3118
|
-
*/
|
|
3119
|
-
export declare type SitesInfo200Pagespeed = {
|
|
3120
|
-
lastrun?: string;
|
|
3121
|
-
performance?: string;
|
|
3122
|
-
strategy?: string;
|
|
3123
|
-
} | null;
|
|
3124
|
-
/**
|
|
3125
|
-
* Job ids for the site
|
|
3126
|
-
* @nullable
|
|
3127
|
-
*/
|
|
3128
|
-
export declare type SitesInfo200Jobs = {
|
|
3129
|
-
[key: string]: unknown;
|
|
3130
|
-
} | null;
|
|
3131
3157
|
/**
|
|
3132
3158
|
* Links
|
|
3133
3159
|
* @nullable
|
|
@@ -5738,28 +5764,6 @@ export declare type ActivityLog200 = {
|
|
|
5738
5764
|
export declare type ActivityLogParams = {
|
|
5739
5765
|
days?: number;
|
|
5740
5766
|
};
|
|
5741
|
-
export declare type HostingAccount200 = {
|
|
5742
|
-
account_id?: string;
|
|
5743
|
-
account_limits?: HostingAccount200AccountLimits;
|
|
5744
|
-
/** The timestamp that the hosting addon was created */
|
|
5745
|
-
addon_date_added?: string;
|
|
5746
|
-
advanced?: boolean;
|
|
5747
|
-
billing?: HostingAccount200Billing;
|
|
5748
|
-
brand?: string;
|
|
5749
|
-
id?: string;
|
|
5750
|
-
panel?: string;
|
|
5751
|
-
plan_key?: string;
|
|
5752
|
-
platform?: string;
|
|
5753
|
-
/** @nullable */
|
|
5754
|
-
resources?: HostingAccount200Resources;
|
|
5755
|
-
/** @nullable */
|
|
5756
|
-
server_status?: string | null;
|
|
5757
|
-
/** @nullable */
|
|
5758
|
-
ssh_hostname?: string | null;
|
|
5759
|
-
status?: string;
|
|
5760
|
-
type?: string;
|
|
5761
|
-
username?: string;
|
|
5762
|
-
};
|
|
5763
5767
|
export declare type HostingAccount200ResourcesWorkers = {
|
|
5764
5768
|
/** @nullable */
|
|
5765
5769
|
available?: number | null;
|
|
@@ -5777,6 +5781,14 @@ export declare type HostingAccount200ResourcesStorage = {
|
|
|
5777
5781
|
/** @nullable */
|
|
5778
5782
|
used?: number | null;
|
|
5779
5783
|
};
|
|
5784
|
+
/**
|
|
5785
|
+
* @nullable
|
|
5786
|
+
*/
|
|
5787
|
+
export declare type HostingAccount200Resources = {
|
|
5788
|
+
staging?: HostingAccount200ResourcesStaging;
|
|
5789
|
+
storage?: HostingAccount200ResourcesStorage;
|
|
5790
|
+
workers?: HostingAccount200ResourcesWorkers;
|
|
5791
|
+
} | null;
|
|
5780
5792
|
export declare type HostingAccount200ResourcesStagingWorkers = {
|
|
5781
5793
|
/** @nullable */
|
|
5782
5794
|
available?: number | null;
|
|
@@ -5798,14 +5810,6 @@ export declare type HostingAccount200ResourcesStaging = {
|
|
|
5798
5810
|
storage?: HostingAccount200ResourcesStagingStorage;
|
|
5799
5811
|
workers?: HostingAccount200ResourcesStagingWorkers;
|
|
5800
5812
|
};
|
|
5801
|
-
/**
|
|
5802
|
-
* @nullable
|
|
5803
|
-
*/
|
|
5804
|
-
export declare type HostingAccount200Resources = {
|
|
5805
|
-
staging?: HostingAccount200ResourcesStaging;
|
|
5806
|
-
storage?: HostingAccount200ResourcesStorage;
|
|
5807
|
-
workers?: HostingAccount200ResourcesWorkers;
|
|
5808
|
-
} | null;
|
|
5809
5813
|
export declare type HostingAccount200Billing = {
|
|
5810
5814
|
prod_code?: string;
|
|
5811
5815
|
product_name?: string;
|
|
@@ -5823,6 +5827,28 @@ export declare type HostingAccount200AccountLimits = {
|
|
|
5823
5827
|
*/
|
|
5824
5828
|
sites?: number | null;
|
|
5825
5829
|
};
|
|
5830
|
+
export declare type HostingAccount200 = {
|
|
5831
|
+
account_id?: string;
|
|
5832
|
+
account_limits?: HostingAccount200AccountLimits;
|
|
5833
|
+
/** The timestamp that the hosting addon was created */
|
|
5834
|
+
addon_date_added?: string;
|
|
5835
|
+
advanced?: boolean;
|
|
5836
|
+
billing?: HostingAccount200Billing;
|
|
5837
|
+
brand?: string;
|
|
5838
|
+
id?: string;
|
|
5839
|
+
panel?: string;
|
|
5840
|
+
plan_key?: string;
|
|
5841
|
+
platform?: string;
|
|
5842
|
+
/** @nullable */
|
|
5843
|
+
resources?: HostingAccount200Resources;
|
|
5844
|
+
/** @nullable */
|
|
5845
|
+
server_status?: string | null;
|
|
5846
|
+
/** @nullable */
|
|
5847
|
+
ssh_hostname?: string | null;
|
|
5848
|
+
status?: string;
|
|
5849
|
+
type?: string;
|
|
5850
|
+
username?: string;
|
|
5851
|
+
};
|
|
5826
5852
|
export declare type DomainZoneeditorUrl200 = {
|
|
5827
5853
|
url: string;
|
|
5828
5854
|
};
|
|
@@ -6510,10 +6536,6 @@ export declare type BackupCreateOndemandV1Body = {
|
|
|
6510
6536
|
/** Whether to include a link to the backup tarball */
|
|
6511
6537
|
include_backup_tar_link?: BackupCreateOndemandV1BodyIncludeBackupTarLink;
|
|
6512
6538
|
};
|
|
6513
|
-
export declare type BackupMeta200 = {
|
|
6514
|
-
account?: BackupMeta200Account;
|
|
6515
|
-
site?: BackupMeta200Site;
|
|
6516
|
-
};
|
|
6517
6539
|
/**
|
|
6518
6540
|
* @nullable
|
|
6519
6541
|
*/
|
|
@@ -6547,6 +6569,10 @@ export declare type BackupMeta200Site = {
|
|
|
6547
6569
|
/** @nullable */
|
|
6548
6570
|
cbs_restore_consent_info?: BackupMeta200SiteCbsRestoreConsentInfo;
|
|
6549
6571
|
};
|
|
6572
|
+
export declare type BackupMeta200 = {
|
|
6573
|
+
account?: BackupMeta200Account;
|
|
6574
|
+
site?: BackupMeta200Site;
|
|
6575
|
+
};
|
|
6550
6576
|
/**
|
|
6551
6577
|
* @nullable
|
|
6552
6578
|
*/
|
|
@@ -6587,6 +6613,9 @@ export declare type BackupMeta200Account = {
|
|
|
6587
6613
|
export declare type BackupMetaParams = {
|
|
6588
6614
|
site_id?: number;
|
|
6589
6615
|
};
|
|
6616
|
+
export declare type BackupList200 = {
|
|
6617
|
+
home?: BackupList200HomeItem[];
|
|
6618
|
+
};
|
|
6590
6619
|
export declare type BackupList200HomeItemBackupStatus = {
|
|
6591
6620
|
/** @nullable */
|
|
6592
6621
|
download_url?: string | null;
|
|
@@ -6598,9 +6627,6 @@ export declare type BackupList200HomeItem = {
|
|
|
6598
6627
|
backup_status?: BackupList200HomeItemBackupStatus;
|
|
6599
6628
|
time_created?: string;
|
|
6600
6629
|
};
|
|
6601
|
-
export declare type BackupList200 = {
|
|
6602
|
-
home?: BackupList200HomeItem[];
|
|
6603
|
-
};
|
|
6604
6630
|
export declare type BackupListBackupType = typeof BackupListBackupType[keyof typeof BackupListBackupType];
|
|
6605
6631
|
export declare const BackupListBackupType: {
|
|
6606
6632
|
readonly full: "full";
|
|
@@ -6639,6 +6665,83 @@ export declare type BackupInitiateBody = {
|
|
|
6639
6665
|
/** Backup Volume store ID to get the backup */
|
|
6640
6666
|
backup_volume_store_id: string;
|
|
6641
6667
|
};
|
|
6668
|
+
export declare type XcitiumSso200 = {
|
|
6669
|
+
/** URL that allows SSOing in to manage the Xcitium backup account */
|
|
6670
|
+
url?: string;
|
|
6671
|
+
};
|
|
6672
|
+
export declare type XcitiumPlanInfo200SeatsItem = {
|
|
6673
|
+
activated?: boolean;
|
|
6674
|
+
url?: string;
|
|
6675
|
+
website_id?: number;
|
|
6676
|
+
};
|
|
6677
|
+
export declare type XcitiumPlanInfo200 = {
|
|
6678
|
+
back_reference?: string;
|
|
6679
|
+
can_upgrade?: boolean;
|
|
6680
|
+
/** @nullable */
|
|
6681
|
+
disabled?: boolean | null;
|
|
6682
|
+
/** @nullable */
|
|
6683
|
+
over_quota?: boolean | null;
|
|
6684
|
+
plan_name?: string;
|
|
6685
|
+
seat_count?: number;
|
|
6686
|
+
seat_limit?: number;
|
|
6687
|
+
seats?: XcitiumPlanInfo200SeatsItem[];
|
|
6688
|
+
size?: number;
|
|
6689
|
+
size_limit?: number;
|
|
6690
|
+
status?: string;
|
|
6691
|
+
};
|
|
6692
|
+
export declare type XcitiumBackupRestore200 = {
|
|
6693
|
+
database_success?: boolean;
|
|
6694
|
+
website_success?: boolean;
|
|
6695
|
+
};
|
|
6696
|
+
export declare type XcitiumBackupRestoreBody = {
|
|
6697
|
+
/** The commit id to restore the database from. */
|
|
6698
|
+
database_commit_id?: string;
|
|
6699
|
+
/** The id of the database the given database is associated with. */
|
|
6700
|
+
database_id?: number;
|
|
6701
|
+
/** The commit id to restore the website from. */
|
|
6702
|
+
website_commit_id?: string;
|
|
6703
|
+
/** The id of the website the given database is associated with. */
|
|
6704
|
+
website_id?: number;
|
|
6705
|
+
};
|
|
6706
|
+
export declare type XcitiumBackupDownload200 = {
|
|
6707
|
+
database_success?: number;
|
|
6708
|
+
website_success?: number;
|
|
6709
|
+
};
|
|
6710
|
+
export declare type XcitiumBackupDownloadBody = {
|
|
6711
|
+
/** The commit id to restore the database from. */
|
|
6712
|
+
database_commit_id?: string;
|
|
6713
|
+
/** The commit id to restore the website from. */
|
|
6714
|
+
website_commit_id?: string;
|
|
6715
|
+
/** The id of the website the given database is associated with. */
|
|
6716
|
+
website_id?: number;
|
|
6717
|
+
};
|
|
6718
|
+
export declare type XcitiumBackupCreate200 = {
|
|
6719
|
+
database_success?: number;
|
|
6720
|
+
website_success?: number;
|
|
6721
|
+
};
|
|
6722
|
+
export declare type XcitiumBackupCreateBody = {
|
|
6723
|
+
/** The id of the database the given database is associated with. */
|
|
6724
|
+
database_id?: number;
|
|
6725
|
+
/** The id of the website the given database is associated with. */
|
|
6726
|
+
website_id?: number;
|
|
6727
|
+
};
|
|
6728
|
+
export declare type XcitiumBackupList200BackupsItemDatabaseBackupsItem = {
|
|
6729
|
+
commit_id?: string;
|
|
6730
|
+
event_time?: string;
|
|
6731
|
+
id?: number;
|
|
6732
|
+
recommended?: boolean;
|
|
6733
|
+
};
|
|
6734
|
+
export declare type XcitiumBackupList200BackupsItem = {
|
|
6735
|
+
database_backups?: XcitiumBackupList200BackupsItemDatabaseBackupsItem[];
|
|
6736
|
+
event_time?: string;
|
|
6737
|
+
website_commit_id?: string;
|
|
6738
|
+
};
|
|
6739
|
+
export declare type XcitiumBackupList200 = {
|
|
6740
|
+
backups?: XcitiumBackupList200BackupsItem[];
|
|
6741
|
+
};
|
|
6742
|
+
export declare type XcitiumBackupListParams = {
|
|
6743
|
+
website_id: number;
|
|
6744
|
+
};
|
|
6642
6745
|
export declare type AddonsSitelockSso200 = {
|
|
6643
6746
|
site_url?: string;
|
|
6644
6747
|
sitelock_id?: string;
|