@newfold/huapi-js 1.946.0 → 1.949.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.
@@ -0,0 +1,2127 @@
1
+ /**
2
+ * Generated by orval v6.12.1 🍺
3
+ * Do not edit manually.
4
+ * Hosting UAPI
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.949.0
7
+ */
8
+ export declare type SitesListV3200 = {
9
+ total?: number;
10
+ page?: number;
11
+ limit?: number;
12
+ items?: SitesListV3200ItemsItem[];
13
+ };
14
+ export declare type SitesListV3200ItemsItemResourcesStorage = {
15
+ available?: number | null;
16
+ total?: number | null;
17
+ unit?: string;
18
+ used?: number | null;
19
+ };
20
+ export declare type SitesListV3200ItemsItemResources = {
21
+ storage?: SitesListV3200ItemsItemResourcesStorage;
22
+ workers?: number | null;
23
+ };
24
+ export declare type SitesListV3200ItemsItemPendingUrlData = {
25
+ error?: string | null;
26
+ stage?: string | null;
27
+ /** The Fully Qualified Domain Name (FQDN) */
28
+ domain?: string | null;
29
+ /** The root domain name */
30
+ base_domain?: string | null;
31
+ /** Flag indicating whether the pending_url is temporary or not */
32
+ is_temp?: boolean;
33
+ } | null;
34
+ export declare type SitesListV3200ItemsItem = {
35
+ id?: string;
36
+ account_back_ref?: string | null;
37
+ account_id?: string;
38
+ base_domain?: string | null;
39
+ /** False if site was added by site scanner */
40
+ confirmed?: boolean | null;
41
+ datacenter?: string | null;
42
+ date_added?: string;
43
+ date_modified?: string;
44
+ detected_type?: string;
45
+ docroot?: string | null;
46
+ domain?: string | null;
47
+ edge_cache?: boolean;
48
+ /** True if docpath is public_html, otherwise False */
49
+ is_primary?: boolean;
50
+ last_error?: string | null;
51
+ path?: string;
52
+ migration_id?: string | null;
53
+ name?: string | null;
54
+ pending_url?: string | null;
55
+ /** The Php Version. If unable to determine, it will be NULL */
56
+ php_version?: string | null;
57
+ status?: string;
58
+ subtype?: string;
59
+ type?: string;
60
+ url?: string | null;
61
+ url_is_provisional?: boolean | null;
62
+ version?: string | null;
63
+ installed_id?: string | null;
64
+ pending_url_data?: SitesListV3200ItemsItemPendingUrlData;
65
+ /** The WP Version */
66
+ version_ptr?: string | null;
67
+ resources?: SitesListV3200ItemsItemResources;
68
+ };
69
+ export declare type SitesSecuritySitelockV2200 = {
70
+ addon_id?: number | null;
71
+ source?: string | null;
72
+ plan?: string | null;
73
+ billing_code?: string | null;
74
+ success?: number;
75
+ platform_id?: string | null;
76
+ upgrade_levels?: string[];
77
+ domains?: string[];
78
+ message?: string;
79
+ has_cdn?: boolean | null;
80
+ /** Sitelock can be attached directly to a site, or it will fallback and return the sitelock for entire hosting account */
81
+ scope?: string | null;
82
+ };
83
+ export declare type SitesSecuritySitelockV2Source = typeof SitesSecuritySitelockV2Source[keyof typeof SitesSecuritySitelockV2Source];
84
+ export declare const SitesSecuritySitelockV2Source: {
85
+ readonly hal: "hal";
86
+ readonly fg: "fg";
87
+ readonly halfg: "halfg";
88
+ };
89
+ export declare type SitesSecuritySitelockV2Params = {
90
+ /**
91
+ * fetch the sitelock data based on source(fg/hal)
92
+ */
93
+ source?: SitesSecuritySitelockV2Source;
94
+ };
95
+ export declare type SitesDomainsV2200DomainsItemSetupProgress = {
96
+ /** Most recent error logged during domain validation. Remains set if validation tries run out. Gets reset by new validation job. */
97
+ validate_error?: string | null;
98
+ /** Result of domain dns validation (null=not started,0=started,1=succeeded,2=skipped) */
99
+ validate_dns?: number | null;
100
+ /** Result of domain ssl validation (null=not started,0=started,1=succeeded,2=skipped) */
101
+ validate_ssl?: number | null;
102
+ /** Result of domain cdn validation (null=not started,0=started,1=succeeded,2=skipped) */
103
+ validate_cdn?: number | null;
104
+ } | null;
105
+ export declare type SitesDomainsV2200DomainsItem = {
106
+ id?: number;
107
+ account_back_ref?: string | null;
108
+ authoritative?: boolean | null;
109
+ autogen_id?: number | null;
110
+ back_reference?: string | null;
111
+ base_domain?: string;
112
+ date_added?: string;
113
+ date_modified?: string;
114
+ date_ssl_exp?: string | null;
115
+ docroot?: string | null;
116
+ dns_status?: string;
117
+ domain?: string;
118
+ homedir?: string | null;
119
+ hosting_id?: number | null;
120
+ setup_progress?: SitesDomainsV2200DomainsItemSetupProgress;
121
+ ssl_issuer?: string | null;
122
+ ssl_status?: string | null;
123
+ ssl_type?: string | null;
124
+ status?: string;
125
+ type?: string;
126
+ };
127
+ export declare type SitesDomainsV2200 = {
128
+ total?: number;
129
+ page?: number;
130
+ limit?: number;
131
+ domains?: SitesDomainsV2200DomainsItem[];
132
+ };
133
+ export declare type SitesDomainsV2Params = {
134
+ scan?: boolean;
135
+ };
136
+ export declare type SitesListV2200 = {
137
+ total?: number;
138
+ page?: number;
139
+ limit?: number;
140
+ items?: SitesListV2200ItemsItem[];
141
+ };
142
+ export declare type SitesListV2200ItemsItemResourcesStorage = {
143
+ available?: number | null;
144
+ total?: number | null;
145
+ unit?: string;
146
+ used?: number | null;
147
+ };
148
+ export declare type SitesListV2200ItemsItemResources = {
149
+ storage?: SitesListV2200ItemsItemResourcesStorage;
150
+ workers?: number | null;
151
+ };
152
+ /**
153
+ * Job ids for the site
154
+ */
155
+ export declare type SitesListV2200ItemsItemJobs = {
156
+ [key: string]: any;
157
+ };
158
+ export declare type SitesListV2200ItemsItemPendingUrlData = {
159
+ error?: string | null;
160
+ stage?: string | null;
161
+ /** The Fully Qualified Domain Name (FQDN) */
162
+ domain?: string | null;
163
+ /** The current pending_url's HAL Domain ID */
164
+ domain_id?: number | null;
165
+ /** The root domain name */
166
+ base_domain?: string | null;
167
+ /** Flag indicating whether the url_sync job has run out of attempts */
168
+ job_failed?: boolean | null;
169
+ /** Flag indicating whether the pending_url is temporary or not */
170
+ is_temp?: boolean;
171
+ } | null;
172
+ export declare type SitesListV2200ItemsItem = {
173
+ id?: number;
174
+ account_back_ref?: string | null;
175
+ account_id?: string;
176
+ base_domain?: string | null;
177
+ /** False if site was added by site scanner */
178
+ confirmed?: boolean | null;
179
+ datacenter?: string | null;
180
+ date_added?: string;
181
+ date_modified?: string;
182
+ detected_type?: string;
183
+ docroot?: string | null;
184
+ domain?: string | null;
185
+ edge_cache?: boolean;
186
+ /** True if docpath is public_html, otherwise False */
187
+ is_primary?: boolean;
188
+ last_error?: string | null;
189
+ path?: string;
190
+ handler_404?: string;
191
+ migration_id?: string | null;
192
+ name?: string | null;
193
+ pending_url?: string | null;
194
+ /** The Php Version. If unable to determine, it will be NULL */
195
+ php_version?: string | null;
196
+ status?: string;
197
+ subtype?: string;
198
+ type?: string;
199
+ url?: string | null;
200
+ url_is_provisional?: boolean | null;
201
+ version?: string | null;
202
+ installed_id?: string | null;
203
+ pending_url_data?: SitesListV2200ItemsItemPendingUrlData;
204
+ /** The WP Version */
205
+ version_ptr?: string | null;
206
+ /** Job ids for the site */
207
+ jobs?: SitesListV2200ItemsItemJobs;
208
+ resources?: SitesListV2200ItemsItemResources;
209
+ };
210
+ export declare type SshKeyListV2200RowsItem = {
211
+ name?: string;
212
+ type?: string;
213
+ mtime?: string;
214
+ key?: string;
215
+ };
216
+ export declare type SshKeyListV2200 = {
217
+ rows?: SshKeyListV2200RowsItem[];
218
+ };
219
+ export declare type HostingSitesV2200 = {
220
+ total?: number;
221
+ page?: number;
222
+ limit?: number;
223
+ /** Maximum number of sites the customer can have. Null means 'unlimited'. */
224
+ max_sites?: number | null;
225
+ /** Current number of sites in use by the customer. its normal for this value to be different than the total number of sites in the list. */
226
+ used_sites?: number;
227
+ /** Remaining number of sites the customer can create. Max sites - used sites. Null means 'unlimited'. */
228
+ available_sites?: number | null;
229
+ items?: HostingSitesV2200ItemsItem[];
230
+ };
231
+ export declare type HostingSitesV2200ItemsItemResourcesStorage = {
232
+ available?: number | null;
233
+ total?: number | null;
234
+ unit?: string;
235
+ used?: number | null;
236
+ };
237
+ export declare type HostingSitesV2200ItemsItemResources = {
238
+ storage?: HostingSitesV2200ItemsItemResourcesStorage;
239
+ workers?: number | null;
240
+ };
241
+ /**
242
+ * Job ids for the site
243
+ */
244
+ export declare type HostingSitesV2200ItemsItemJobs = {
245
+ [key: string]: any;
246
+ };
247
+ export declare type HostingSitesV2200ItemsItemPendingUrlData = {
248
+ error?: string | null;
249
+ stage?: string | null;
250
+ /** The Fully Qualified Domain Name (FQDN) */
251
+ domain?: string | null;
252
+ /** The current pending_url's HAL Domain ID */
253
+ domain_id?: number | null;
254
+ /** The root domain name */
255
+ base_domain?: string | null;
256
+ /** Flag indicating whether the url_sync job has run out of attempts */
257
+ job_failed?: boolean | null;
258
+ /** Flag indicating whether the pending_url is temporary or not */
259
+ is_temp?: boolean;
260
+ } | null;
261
+ export declare type HostingSitesV2200ItemsItem = {
262
+ id?: number;
263
+ account_back_ref?: string | null;
264
+ account_id?: string;
265
+ /** False if site was added by site scanner */
266
+ confirmed?: boolean | null;
267
+ datacenter?: string | null;
268
+ date_added?: string;
269
+ date_modified?: string;
270
+ detected_type?: string;
271
+ docroot?: string | null;
272
+ edge_cache?: boolean;
273
+ /** True if docpath is public_html, otherwise False */
274
+ is_primary?: boolean;
275
+ path?: string;
276
+ handler_404?: string;
277
+ domain?: string | null;
278
+ base_domain?: string | null;
279
+ last_error?: string | null;
280
+ migration_id?: string | null;
281
+ name?: string | null;
282
+ pending_url?: string | null;
283
+ /** The Php Version. If unable to determine, it will be NULL */
284
+ php_version?: string | null;
285
+ status?: string;
286
+ subtype?: string;
287
+ type?: string;
288
+ url?: string | null;
289
+ url_is_provisional?: boolean | null;
290
+ version?: string | null;
291
+ installed_id?: string | null;
292
+ pending_url_data?: HostingSitesV2200ItemsItemPendingUrlData;
293
+ /** The WP Version */
294
+ version_ptr?: string | null;
295
+ /** Job ids for the site */
296
+ jobs?: HostingSitesV2200ItemsItemJobs;
297
+ resources?: HostingSitesV2200ItemsItemResources;
298
+ };
299
+ export declare type HostingNameserversV2200HostsItem = {
300
+ host?: string;
301
+ ips?: string[];
302
+ };
303
+ export declare type HostingNameserversV2200 = {
304
+ id: number;
305
+ is_default?: string;
306
+ brand: string;
307
+ hosts: HostingNameserversV2200HostsItem[];
308
+ };
309
+ export declare type AddonsSitelockSsoV2200 = {
310
+ site_url?: string | null;
311
+ sitelock_id?: string;
312
+ url?: string;
313
+ };
314
+ export declare type AddonsSitelockSsoV2Params = {
315
+ /**
316
+ * fetch the sso data based on source(fg/hal)
317
+ */
318
+ source?: string;
319
+ };
320
+ export declare type SitesVersion200 = {
321
+ current?: string;
322
+ latest?: string;
323
+ update?: boolean;
324
+ };
325
+ export declare type SiteUsers200UsersItemMeta = {
326
+ maestro_web_pro?: string;
327
+ maestro_wpp_identifier?: string;
328
+ };
329
+ export declare type SiteUsers200UsersItem = {
330
+ display_name?: string;
331
+ id: number;
332
+ meta?: SiteUsers200UsersItemMeta;
333
+ post_count?: number;
334
+ role: string;
335
+ user_email: string;
336
+ user_id: number;
337
+ user_login: string;
338
+ user_nicename: string;
339
+ };
340
+ export declare type SiteUsers200 = {
341
+ users: SiteUsers200UsersItem[];
342
+ };
343
+ export declare type SiteStatus200 = {
344
+ url?: string;
345
+ pending_url?: string;
346
+ cloudflare_ready?: boolean | null;
347
+ };
348
+ export declare type SitesSso200OtherItem = {
349
+ addon_id?: number;
350
+ type?: string;
351
+ subtype?: string;
352
+ domain?: string;
353
+ added?: string;
354
+ };
355
+ export declare type SitesSso200 = {
356
+ sso?: string | null;
357
+ type?: string | null;
358
+ other?: SitesSso200OtherItem[] | null;
359
+ };
360
+ export declare type SitesSsoBounceName = typeof SitesSsoBounceName[keyof typeof SitesSsoBounceName];
361
+ export declare const SitesSsoBounceName: {
362
+ readonly jetpackbackup: "jetpackbackup";
363
+ readonly jetpackdashboard: "jetpackdashboard";
364
+ readonly staging: "staging";
365
+ readonly updatecore: "updatecore";
366
+ readonly password: "password";
367
+ readonly profile: "profile";
368
+ readonly plugins: "plugins";
369
+ readonly themes: "themes";
370
+ readonly phpmyadmin: "phpmyadmin";
371
+ readonly filemanager: "filemanager";
372
+ readonly store: "store";
373
+ readonly wpmigration: "wpmigration";
374
+ };
375
+ export declare type SitesSsoParams = {
376
+ addon_id?: string;
377
+ bounce_name?: SitesSsoBounceName;
378
+ user_email?: string;
379
+ user_id?: string;
380
+ };
381
+ export declare type SitesSsl200 = {
382
+ domain?: string;
383
+ domain_dns_status?: string;
384
+ expiration?: string | null;
385
+ issuer?: string | null;
386
+ product?: string | null;
387
+ provider?: string | null;
388
+ status?: string;
389
+ type?: string | null;
390
+ upgradeable?: boolean;
391
+ };
392
+ export declare type SitesSshUserUpdate200 = {
393
+ [key: string]: any;
394
+ };
395
+ export declare type SitesSshUserUpdateBody = {
396
+ /** username of user */
397
+ ssh_user: string;
398
+ /** optional password */
399
+ pass?: string;
400
+ /** optional public key */
401
+ pubkey?: string;
402
+ /** optional flag to generate public key */
403
+ generate_pubkey?: boolean;
404
+ };
405
+ export declare type SitesSshUserDelete200 = {
406
+ [key: string]: any;
407
+ };
408
+ export declare type SitesSshUserDeleteBody = {
409
+ ssh_user?: string;
410
+ };
411
+ export declare type SitesSshUserCreate200 = {
412
+ /** optional public key */
413
+ public_key?: string | null;
414
+ /** optional private key */
415
+ private_key?: string | null;
416
+ };
417
+ export declare type SitesSshUserCreateBody = {
418
+ /** username of user */
419
+ ssh_user: string;
420
+ /** optional password */
421
+ pass?: string;
422
+ /** optional public key */
423
+ pubkey?: string;
424
+ /** optional auto-generate public key flag */
425
+ generate_pubkey?: boolean;
426
+ };
427
+ export declare type SitesSshUserList200 = {
428
+ users?: string[];
429
+ };
430
+ export declare type SitesSettingsPhpVersions200 = {
431
+ default?: string;
432
+ latest?: string;
433
+ versions?: string[];
434
+ deprecated?: string[];
435
+ };
436
+ export declare type SitesSettingsPhpVersionUpdate200 = {
437
+ success?: number;
438
+ };
439
+ export declare type SitesSettingsPhpVersionUpdateBody = {
440
+ /** The version should match the pattern i.e. PHP 8.0 */
441
+ php_version: string;
442
+ force?: boolean;
443
+ };
444
+ export declare type SitesSettingsDebugToggle200 = {
445
+ success?: number;
446
+ };
447
+ export declare type SitesSettingsDebugToggleBody = {
448
+ enable?: boolean;
449
+ };
450
+ export declare type SitesSettingsDebug200 = {
451
+ status?: number;
452
+ };
453
+ export declare type SitesSettingsComingSoonToggle200 = {
454
+ success?: number;
455
+ };
456
+ export declare type SitesSettingsComingSoonToggleBody = {
457
+ enable?: boolean;
458
+ };
459
+ export declare type SitesSettingsComingSoon200 = {
460
+ enable?: boolean;
461
+ };
462
+ export declare type SitesSecuritySslStatus200 = {
463
+ domain?: string;
464
+ ssl_status?: string;
465
+ message?: string;
466
+ product?: string;
467
+ provider?: string;
468
+ upgradeable?: boolean;
469
+ };
470
+ export declare type SitesSecuritySslAcme200 = {
471
+ success?: number;
472
+ message?: string;
473
+ };
474
+ export declare type SitesSecuritySitelock200 = {
475
+ addon_id?: number;
476
+ plan?: string;
477
+ billing_code?: string;
478
+ success?: number;
479
+ platform_id?: string;
480
+ upgrade_levels?: string[];
481
+ message?: string;
482
+ has_cdn?: boolean;
483
+ /** Sitelock can be attached directly to a site, or it will fallback and return the sitelock for entire hosting account */
484
+ scope?: string;
485
+ };
486
+ export declare type SitesSecurityHttpsEnableDisableSsl200 = {
487
+ success?: number;
488
+ redirection_status?: number;
489
+ message?: string;
490
+ };
491
+ export declare type SitesSecurityHttpsEnableDisableSslBody = {
492
+ /** enable or disable */
493
+ forced_redirection?: string;
494
+ };
495
+ export declare type SitesSecurityHttpsRedirectionStatus200 = {
496
+ success?: number;
497
+ redirection_status?: number;
498
+ message?: string;
499
+ };
500
+ export declare type SitesSecurityResetCoreFiles200 = {
501
+ results?: string;
502
+ success?: number;
503
+ };
504
+ export declare type SitesSecurityCheckCore200 = {
505
+ results?: string;
506
+ success?: number;
507
+ };
508
+ export declare type ResetSite200 = {
509
+ previous_status: string;
510
+ status: string;
511
+ };
512
+ export declare type ResetSiteBody = {
513
+ /** Site type to morph to */
514
+ type?: string;
515
+ /** Site subtype to morph to */
516
+ subtype?: string;
517
+ };
518
+ export declare type SitePluginsUpdate200 = {
519
+ success: boolean;
520
+ };
521
+ export declare type SitePluginsUpdateBody = {
522
+ /** The plugin id */
523
+ id: string;
524
+ };
525
+ export declare type SitePluginsToggle200 = {
526
+ success: boolean;
527
+ };
528
+ export declare type SitePluginsToggleBody = {
529
+ /** The plugin id */
530
+ id: string;
531
+ /** activate or deactivate the plugin */
532
+ activate: boolean;
533
+ };
534
+ export declare type SitePluginsAutoupdate200 = {
535
+ success: boolean;
536
+ };
537
+ export declare type SitePluginsAutoupdateBody = {
538
+ enable: boolean;
539
+ };
540
+ export declare type SitePluginUpdate200 = {
541
+ id: string;
542
+ status: string;
543
+ };
544
+ export declare type SitePluginUpdateBody = {
545
+ /** The plugin id */
546
+ id: string;
547
+ /** activate or deactivate the plugin */
548
+ activate: boolean;
549
+ };
550
+ export declare type SitePlugins200PluginsItem = {
551
+ id: string;
552
+ status: string;
553
+ title: string;
554
+ update: boolean;
555
+ version?: string;
556
+ };
557
+ export declare type SitePlugins200 = {
558
+ subtype: string;
559
+ auto_update: boolean;
560
+ plugins: SitePlugins200PluginsItem[];
561
+ };
562
+ export declare type SitePluginsParams = {
563
+ plugin_id?: string;
564
+ };
565
+ export declare type SitesPerformanceEndurancePageCache200 = {
566
+ result?: string;
567
+ status?: string;
568
+ };
569
+ export declare type SitesPerformanceEnduranceCacheLevel200Options = {
570
+ [key: string]: any;
571
+ };
572
+ export declare type SitesPerformanceEnduranceCacheLevel200 = {
573
+ options?: SitesPerformanceEnduranceCacheLevel200Options;
574
+ };
575
+ export declare type SitesPerformanceEnduranceCacheLevelBody = {
576
+ endurance_cache_level?: number;
577
+ };
578
+ export declare type SitesPerformanceEnduranceCacheLevelStatus200 = {
579
+ endurance_cache_level?: number;
580
+ };
581
+ export declare type SitesPerformanceEdgecache200 = {
582
+ [key: string]: any;
583
+ };
584
+ export declare type SitesPerformanceEdgecacheBody = {
585
+ /** Pass either 0 or 1 */
586
+ edge_cache: number;
587
+ };
588
+ export declare type SitesPerformanceCachepurge200 = {
589
+ success?: boolean;
590
+ };
591
+ export declare type SitesPerformanceCachepurgeBody = {
592
+ /** */
593
+ assets?: string[];
594
+ /** */
595
+ hosts: string[];
596
+ /** Pass either 0, basic, premium, india or hostgator */
597
+ cf?: string;
598
+ /** Pass either 0 or 1 */
599
+ epc?: number;
600
+ };
601
+ export declare type SitePendingDomainDelete200 = {
602
+ [key: string]: any;
603
+ };
604
+ export declare type SitesMetricDimensions200 = {
605
+ date_end?: string;
606
+ date_start?: string;
607
+ elapsed?: number;
608
+ metric?: string;
609
+ dimensions?: SitesMetricDimensions200Dimensions;
610
+ };
611
+ export declare type SitesMetricDimensions200DimensionsVisitorIsCrawlerItemDimension = {
612
+ [key: string]: number;
613
+ };
614
+ export declare type SitesMetricDimensions200DimensionsVisitorIsCrawlerItem = {
615
+ dimension?: SitesMetricDimensions200DimensionsVisitorIsCrawlerItemDimension;
616
+ timestamp?: number;
617
+ };
618
+ export declare type SitesMetricDimensions200DimensionsVisitorCountryCodeItemDimension = {
619
+ [key: string]: number;
620
+ };
621
+ export declare type SitesMetricDimensions200DimensionsVisitorCountryCodeItem = {
622
+ dimension?: SitesMetricDimensions200DimensionsVisitorCountryCodeItemDimension;
623
+ timestamp?: number;
624
+ };
625
+ export declare type SitesMetricDimensions200DimensionsVisitorAsnItemDimension = {
626
+ [key: string]: number;
627
+ };
628
+ export declare type SitesMetricDimensions200DimensionsVisitorAsnItem = {
629
+ dimension?: SitesMetricDimensions200DimensionsVisitorAsnItemDimension;
630
+ timestamp?: number;
631
+ };
632
+ export declare type SitesMetricDimensions200DimensionsWpAdminAjaxActionItemDimension = {
633
+ [key: string]: number;
634
+ };
635
+ export declare type SitesMetricDimensions200DimensionsWpAdminAjaxActionItem = {
636
+ dimension?: SitesMetricDimensions200DimensionsWpAdminAjaxActionItemDimension;
637
+ timestamp?: number;
638
+ };
639
+ export declare type SitesMetricDimensions200DimensionsPageIsCachedItemDimension = {
640
+ [key: string]: number;
641
+ };
642
+ export declare type SitesMetricDimensions200DimensionsPageIsCachedItem = {
643
+ dimension?: SitesMetricDimensions200DimensionsPageIsCachedItemDimension;
644
+ timestamp?: number;
645
+ };
646
+ export declare type SitesMetricDimensions200DimensionsPageRendererItemDimension = {
647
+ [key: string]: number;
648
+ };
649
+ export declare type SitesMetricDimensions200DimensionsPageRendererItem = {
650
+ dimension?: SitesMetricDimensions200DimensionsPageRendererItemDimension;
651
+ timestamp?: number;
652
+ };
653
+ export declare type SitesMetricDimensions200Dimensions = {
654
+ http_version?: SitesMetricDimensions200DimensionsHttpVersionItem[];
655
+ http_verb?: SitesMetricDimensions200DimensionsHttpVerbItem[];
656
+ http_host?: SitesMetricDimensions200DimensionsHttpHostItem[];
657
+ http_status?: SitesMetricDimensions200DimensionsHttpStatusItem[];
658
+ page_renderer?: SitesMetricDimensions200DimensionsPageRendererItem[];
659
+ page_is_cached?: SitesMetricDimensions200DimensionsPageIsCachedItem[];
660
+ wp_admin_ajax_action?: SitesMetricDimensions200DimensionsWpAdminAjaxActionItem[];
661
+ visitor_asn?: SitesMetricDimensions200DimensionsVisitorAsnItem[];
662
+ visitor_country_code?: SitesMetricDimensions200DimensionsVisitorCountryCodeItem[];
663
+ visitor_is_crawler?: SitesMetricDimensions200DimensionsVisitorIsCrawlerItem[];
664
+ };
665
+ export declare type SitesMetricDimensions200DimensionsHttpStatusItemDimension = {
666
+ [key: string]: number;
667
+ };
668
+ export declare type SitesMetricDimensions200DimensionsHttpStatusItem = {
669
+ dimension?: SitesMetricDimensions200DimensionsHttpStatusItemDimension;
670
+ timestamp?: number;
671
+ };
672
+ export declare type SitesMetricDimensions200DimensionsHttpHostItemDimension = {
673
+ [key: string]: number;
674
+ };
675
+ export declare type SitesMetricDimensions200DimensionsHttpHostItem = {
676
+ dimension?: SitesMetricDimensions200DimensionsHttpHostItemDimension;
677
+ timestamp?: number;
678
+ };
679
+ export declare type SitesMetricDimensions200DimensionsHttpVerbItemDimension = {
680
+ [key: string]: number;
681
+ };
682
+ export declare type SitesMetricDimensions200DimensionsHttpVerbItem = {
683
+ dimension?: SitesMetricDimensions200DimensionsHttpVerbItemDimension;
684
+ timestamp?: number;
685
+ };
686
+ export declare type SitesMetricDimensions200DimensionsHttpVersionItemDimension = {
687
+ [key: string]: number;
688
+ };
689
+ export declare type SitesMetricDimensions200DimensionsHttpVersionItem = {
690
+ dimension?: SitesMetricDimensions200DimensionsHttpVersionItemDimension;
691
+ timestamp?: number;
692
+ };
693
+ export declare type SitesMetricDimensionsParams = {
694
+ start?: string;
695
+ end?: string;
696
+ };
697
+ export declare type SitesMetricsDimensionAveraged200Metrics = {
698
+ requests_persec?: number[];
699
+ response_bytes_persec?: number[];
700
+ response_bytes_average?: number[];
701
+ response_time_average?: number[];
702
+ };
703
+ export declare type SitesMetricsDimensionAveraged200 = {
704
+ date_end?: string;
705
+ date_start?: string;
706
+ dimension?: string;
707
+ elapsed?: number;
708
+ unit?: string;
709
+ metrics?: SitesMetricsDimensionAveraged200Metrics;
710
+ };
711
+ export declare type SitesMetricsDimensionAveragedParams = {
712
+ start?: string;
713
+ end?: string;
714
+ };
715
+ export declare type SiteMalwareStatus200 = {
716
+ /** malware status given by jetpack protect addon */
717
+ malware_status?: string | null;
718
+ /** scanner state */
719
+ scanner_state?: string | null;
720
+ };
721
+ export declare type SitesErrorLogsDownloadSort = typeof SitesErrorLogsDownloadSort[keyof typeof SitesErrorLogsDownloadSort];
722
+ export declare const SitesErrorLogsDownloadSort: {
723
+ readonly asc: "asc";
724
+ readonly desc: "desc";
725
+ };
726
+ export declare type SitesErrorLogsDownloadParams = {
727
+ /**
728
+ * Start time. Can be a unix time, a timestamp, or a {n}[dhm] format. Default is -1 day.
729
+ */
730
+ start?: string;
731
+ /**
732
+ * End time. Can be a unix time, a timestamp, now, or a {n}[dhm] format. Default is now.
733
+ */
734
+ end?: string;
735
+ sort?: SitesErrorLogsDownloadSort;
736
+ /**
737
+ * Items to filter on. Supported filters include: severity
738
+ */
739
+ filter?: {
740
+ severity?: string[];
741
+ };
742
+ };
743
+ export declare type SitesErrorLogs200LogsItem = {
744
+ datetime?: string;
745
+ file?: string;
746
+ kind?: string;
747
+ line?: number;
748
+ message?: string;
749
+ name?: string;
750
+ severity?: string;
751
+ epoch?: number;
752
+ };
753
+ export declare type SitesErrorLogs200 = {
754
+ datetime_end?: string;
755
+ datetime_start?: string;
756
+ page_id?: string | null;
757
+ total?: number;
758
+ logs?: SitesErrorLogs200LogsItem[];
759
+ };
760
+ export declare type SitesErrorLogsSort = typeof SitesErrorLogsSort[keyof typeof SitesErrorLogsSort];
761
+ export declare const SitesErrorLogsSort: {
762
+ readonly asc: "asc";
763
+ readonly desc: "desc";
764
+ };
765
+ export declare type SitesErrorLogsParams = {
766
+ /**
767
+ * Start time. Can be a unix time, a timestamp, or a {n}[dhm] format. Default is -1 day.
768
+ */
769
+ start?: string;
770
+ /**
771
+ * End time. Can be a unix time, a timestamp, now, or a {n}[dhm] format. Default is now.
772
+ */
773
+ end?: string;
774
+ /**
775
+ * max number of logs to return (default: 25)
776
+ */
777
+ limit?: number;
778
+ page_id?: string;
779
+ sort?: SitesErrorLogsSort;
780
+ /**
781
+ * Items to filter on. Supported filters include: severity
782
+ */
783
+ filter?: {
784
+ severity?: string[];
785
+ };
786
+ };
787
+ export declare type SitesAccessLogsDownloadSort = typeof SitesAccessLogsDownloadSort[keyof typeof SitesAccessLogsDownloadSort];
788
+ export declare const SitesAccessLogsDownloadSort: {
789
+ readonly asc: "asc";
790
+ readonly desc: "desc";
791
+ };
792
+ export declare type SitesAccessLogsDownloadParams = {
793
+ /**
794
+ * Start time. Can be a unix time, a timestamp, or a {n}[dhm] format.
795
+ */
796
+ start?: string;
797
+ /**
798
+ * End time. Can be a unix time, a timestamp, now, or a {n}[dhm] format.
799
+ */
800
+ end?: string;
801
+ sort?: SitesAccessLogsDownloadSort;
802
+ /**
803
+ * Items to filter on. Supported filters include: cached, renderer, request_type, status, user_ip
804
+ */
805
+ filter?: {
806
+ cached?: string[];
807
+ renderer?: string[];
808
+ request_type?: string[];
809
+ status?: number[];
810
+ user_ip?: string[];
811
+ };
812
+ };
813
+ export declare type SitesAccessLogs200LogsItem = {
814
+ body_bytes_sent?: number;
815
+ cached?: string;
816
+ datetime?: string;
817
+ http_host?: string;
818
+ http_referrer?: string;
819
+ http_user_agent?: string;
820
+ http_x_forwarded_for?: string;
821
+ renderer?: string;
822
+ request_completion?: string;
823
+ request_time?: number;
824
+ request_type?: string;
825
+ request_url?: string;
826
+ scheme?: string;
827
+ status?: number;
828
+ epoch?: number;
829
+ type?: string;
830
+ user_ip?: string;
831
+ };
832
+ export declare type SitesAccessLogs200 = {
833
+ datetime_end?: string;
834
+ datetime_start?: string;
835
+ page_id?: string | null;
836
+ total?: number;
837
+ logs?: SitesAccessLogs200LogsItem[];
838
+ };
839
+ export declare type SitesAccessLogsSort = typeof SitesAccessLogsSort[keyof typeof SitesAccessLogsSort];
840
+ export declare const SitesAccessLogsSort: {
841
+ readonly asc: "asc";
842
+ readonly desc: "desc";
843
+ };
844
+ export declare type SitesAccessLogsParams = {
845
+ /**
846
+ * Start time. Can be a unix time, a timestamp, or a {n}[dhm] format.
847
+ */
848
+ start?: string;
849
+ /**
850
+ * End time. Can be a unix time, a timestamp, now, or a {n}[dhm] format.
851
+ */
852
+ end?: string;
853
+ /**
854
+ * max number of logs to return (default: 25)
855
+ */
856
+ limit?: number;
857
+ page_id?: string;
858
+ sort?: SitesAccessLogsSort;
859
+ /**
860
+ * Items to filter on. Supported filters include: cached, renderer, request_type, status, user_ip
861
+ */
862
+ filter?: {
863
+ cached?: string[];
864
+ renderer?: string[];
865
+ request_type?: string[];
866
+ status?: number[];
867
+ user_ip?: string[];
868
+ };
869
+ };
870
+ export declare type SitesDomainsCreate200 = {
871
+ id?: number;
872
+ status?: string;
873
+ };
874
+ export declare type SitesDomainsCreateBody = {
875
+ /** The new domain to be added */
876
+ domain: string;
877
+ };
878
+ export declare type SitesDomainUrl200 = {
879
+ success?: boolean;
880
+ };
881
+ export declare type SitesDomainUrlBody = {
882
+ force?: boolean;
883
+ /** Option to create the temporary domain */
884
+ temp_domain?: boolean;
885
+ /** URL of the site to be updated */
886
+ url?: string;
887
+ /** Optional to unassign the domain after switching to temporary domain */
888
+ unassign_domain?: boolean;
889
+ };
890
+ export declare type SitesDomain200Wanted = {
891
+ a?: string[];
892
+ ns?: string[];
893
+ };
894
+ export declare type SitesDomain200Detected = {
895
+ a?: string[];
896
+ ns?: string[];
897
+ };
898
+ export declare type SitesDomain200 = {
899
+ connected?: boolean;
900
+ a_match?: boolean;
901
+ nameserver_match?: boolean;
902
+ detected?: SitesDomain200Detected;
903
+ wanted?: SitesDomain200Wanted;
904
+ };
905
+ export declare type SitesDomainParams = {
906
+ domain?: string;
907
+ };
908
+ export declare type SitesDns200RecordsItem = {
909
+ name?: string;
910
+ value?: string;
911
+ type?: string;
912
+ };
913
+ export declare type SitesDns200 = {
914
+ success?: boolean;
915
+ source?: string;
916
+ records?: SitesDns200RecordsItem[];
917
+ };
918
+ export declare type SitesDnsParams = {
919
+ type?: string;
920
+ };
921
+ export declare type SitesDatabasePasswordsync200 = {
922
+ [key: string]: any;
923
+ };
924
+ export declare type SitesDatabaseInfo200 = {
925
+ collation?: string | null;
926
+ charset?: string | null;
927
+ };
928
+ export declare type SiteAddonCloudflare400 = {
929
+ error?: string;
930
+ };
931
+ export declare type SiteAddonCloudflare200 = {
932
+ addon_id?: number;
933
+ };
934
+ export declare type BackupsJetpackBackup200 = {
935
+ [key: string]: any;
936
+ };
937
+ export declare type JetpackBackupStatus200 = {
938
+ plugin_exists?: boolean;
939
+ addon_exists?: boolean;
940
+ addon_id?: string | null;
941
+ status?: string | null;
942
+ plan_name?: string | null;
943
+ can_upgrade?: boolean;
944
+ has_active_plugin?: boolean;
945
+ has_active_addon?: boolean;
946
+ addon_back_reference?: string | null;
947
+ pending_upgrade?: boolean;
948
+ next_url?: string | null;
949
+ };
950
+ export declare type SitesBackupsDetails200Jetpack = {
951
+ plugin_exists?: boolean;
952
+ addon_exists?: boolean;
953
+ addon_id?: string | null;
954
+ status?: string | null;
955
+ plan_name?: string | null;
956
+ can_upgrade?: boolean;
957
+ has_active_plugin?: boolean;
958
+ has_active_addon?: boolean;
959
+ addon_back_reference?: string | null;
960
+ pending_upgrade?: boolean;
961
+ next_url?: string | null;
962
+ last_backup_date?: string | null;
963
+ };
964
+ export declare type SitesBackupsDetails200Codeguard = {
965
+ addon_id?: string;
966
+ status?: boolean;
967
+ seats_available?: number;
968
+ seats_count?: number;
969
+ website_id?: string | null;
970
+ database_id?: string | null;
971
+ activated?: boolean;
972
+ url?: string | null;
973
+ };
974
+ export declare type SitesBackupsDetails200 = {
975
+ codeguard?: SitesBackupsDetails200Codeguard;
976
+ jetpack?: SitesBackupsDetails200Jetpack;
977
+ };
978
+ export declare type SitesBackupsCodeguard200 = {
979
+ website_id?: number;
980
+ database_id?: number;
981
+ success?: number;
982
+ };
983
+ export declare type SitesHasBackups200 = {
984
+ has_backups?: boolean;
985
+ };
986
+ export declare type SitesBackups200 = {
987
+ has_backups?: boolean;
988
+ };
989
+ /**
990
+ * autoupdate type
991
+ */
992
+ export declare type SitesAutoupdatesUpdateBodyType = typeof SitesAutoupdatesUpdateBodyType[keyof typeof SitesAutoupdatesUpdateBodyType];
993
+ export declare const SitesAutoupdatesUpdateBodyType: {
994
+ readonly core: "core";
995
+ readonly plugins: "plugins";
996
+ readonly themes: "themes";
997
+ };
998
+ export declare type SitesAutoupdatesUpdateBody = {
999
+ /** autoupdate type */
1000
+ type: SitesAutoupdatesUpdateBodyType;
1001
+ /** true to enable, false for disable */
1002
+ enabled: boolean;
1003
+ };
1004
+ export declare type Site200 = {
1005
+ success: boolean;
1006
+ };
1007
+ export declare type SiteUpdate400 = {
1008
+ error?: string;
1009
+ };
1010
+ export declare type SiteUpdate200 = {
1011
+ success: boolean;
1012
+ };
1013
+ /**
1014
+ * WP version
1015
+ */
1016
+ export declare type SiteUpdateBodyVersionPtr = typeof SiteUpdateBodyVersionPtr[keyof typeof SiteUpdateBodyVersionPtr];
1017
+ export declare const SiteUpdateBodyVersionPtr: {
1018
+ readonly latest: "latest";
1019
+ readonly previous: "previous";
1020
+ readonly beta: "beta";
1021
+ };
1022
+ export declare type SiteUpdateBody = {
1023
+ /** title of the site to be updated */
1024
+ title?: string;
1025
+ /** domain for the site to be added */
1026
+ domain?: string;
1027
+ /** filesystem path that follows the domain in the url */
1028
+ path?: string;
1029
+ /** Disk space in GiB */
1030
+ disk_limit_gib?: number;
1031
+ /** Number of PHP workers */
1032
+ workers?: number;
1033
+ /** Skip FG domain checks for HAL domain */
1034
+ skip_fg_checks?: boolean;
1035
+ /** WP version */
1036
+ version_ptr?: SiteUpdateBodyVersionPtr;
1037
+ /** toggle between wordpress/lightweight for non-existent static file */
1038
+ handler_404?: boolean;
1039
+ };
1040
+ export declare type SitesInfo200ResourcesStorage = {
1041
+ available?: number | null;
1042
+ total?: number | null;
1043
+ unit?: string;
1044
+ used?: number | null;
1045
+ };
1046
+ export declare type SitesInfo200Resources = {
1047
+ storage?: SitesInfo200ResourcesStorage;
1048
+ workers?: number | null;
1049
+ };
1050
+ /**
1051
+ * Job ids for the site
1052
+ */
1053
+ export declare type SitesInfo200Jobs = {
1054
+ [key: string]: any;
1055
+ };
1056
+ export declare type SitesInfo200PendingUrlData = {
1057
+ error?: string | null;
1058
+ stage?: string | null;
1059
+ /** The Fully Qualified Domain Name (FQDN) */
1060
+ domain?: string | null;
1061
+ /** The current pending_url's HAL Domain ID */
1062
+ domain_id?: number | null;
1063
+ /** The root domain name */
1064
+ base_domain?: string | null;
1065
+ /** Flag indicating whether the url_sync job has run out of attempts */
1066
+ job_failed?: boolean | null;
1067
+ /** Flag indicating whether the pending_url is temporary or not */
1068
+ is_temp?: boolean;
1069
+ } | null;
1070
+ export declare type SitesInfo200 = {
1071
+ id?: number;
1072
+ account_back_ref?: string | null;
1073
+ account_id?: string;
1074
+ /** False if site was added by site scanner */
1075
+ confirmed?: boolean | null;
1076
+ datacenter?: string | null;
1077
+ date_added?: string;
1078
+ date_modified?: string;
1079
+ detected_type?: string;
1080
+ docroot?: string | null;
1081
+ edge_cache?: boolean;
1082
+ /** True if docpath is public_html, otherwise False */
1083
+ is_primary?: boolean;
1084
+ last_error?: string | null;
1085
+ path?: string;
1086
+ domain?: string | null;
1087
+ base_domain?: string | null;
1088
+ migration_id?: string | null;
1089
+ name?: string | null;
1090
+ pending_url?: string | null;
1091
+ /** The Php Version. If unable to determine, it will be NULL */
1092
+ php_version?: string | null;
1093
+ status?: string;
1094
+ subtype?: string;
1095
+ type?: string;
1096
+ url?: string | null;
1097
+ url_is_provisional?: boolean | null;
1098
+ version?: string | null;
1099
+ installed_id?: string | null;
1100
+ handler_404?: string | null;
1101
+ pending_url_data?: SitesInfo200PendingUrlData;
1102
+ /** The WP Version */
1103
+ version_ptr?: string | null;
1104
+ /** Job ids for the site */
1105
+ jobs?: SitesInfo200Jobs;
1106
+ resources?: SitesInfo200Resources;
1107
+ };
1108
+ export declare type SitesList200ItemsItem = {
1109
+ id?: string;
1110
+ name?: string;
1111
+ url?: string;
1112
+ docroot?: string;
1113
+ status?: string;
1114
+ };
1115
+ export declare type SitesList200 = {
1116
+ items?: SitesList200ItemsItem[];
1117
+ };
1118
+ export declare type Sso200 = {
1119
+ url: string;
1120
+ };
1121
+ export declare type SsoApp = typeof SsoApp[keyof typeof SsoApp];
1122
+ export declare const SsoApp: {
1123
+ readonly phpmyadmin: "phpmyadmin";
1124
+ readonly filemanager: "filemanager";
1125
+ readonly cronjobs: "cronjobs";
1126
+ readonly accesslogs: "accesslogs";
1127
+ readonly errorlogs: "errorlogs";
1128
+ readonly domainredirects: "domainredirects";
1129
+ readonly sshkeys: "sshkeys";
1130
+ readonly ftp: "ftp";
1131
+ readonly sslsigningrequests: "sslsigningrequests";
1132
+ readonly ssluploadcert: "ssluploadcert";
1133
+ readonly sslviewlogs: "sslviewlogs";
1134
+ readonly emailaccounts: "emailaccounts";
1135
+ readonly emailforwarders: "emailforwarders";
1136
+ readonly emailfilters: "emailfilters";
1137
+ readonly emailglobalfilters: "emailglobalfilters";
1138
+ readonly emailspamfilters: "emailspamfilters";
1139
+ readonly emailautoresponders: "emailautoresponders";
1140
+ readonly emailrouting: "emailrouting";
1141
+ readonly softaculous: "softaculous";
1142
+ readonly mysql: "mysql";
1143
+ readonly zoneeditor: "zoneeditor";
1144
+ };
1145
+ export declare type SsoParams = {
1146
+ app?: SsoApp;
1147
+ dir?: string;
1148
+ domain?: string;
1149
+ };
1150
+ export declare type SshKeyGenerate200 = {
1151
+ key_name?: string;
1152
+ private_key_path?: string;
1153
+ public_key_path?: string;
1154
+ };
1155
+ /**
1156
+ * The SSH key's encryption method for authentication (rsa or dsa). Defaults to rsa.
1157
+ */
1158
+ export declare type SshKeyGenerateBodyEncType = typeof SshKeyGenerateBodyEncType[keyof typeof SshKeyGenerateBodyEncType];
1159
+ export declare const SshKeyGenerateBodyEncType: {
1160
+ readonly rsa: "rsa";
1161
+ readonly dsa: "dsa";
1162
+ readonly ed25519: "ed25519";
1163
+ readonly ecdsa: "ecdsa";
1164
+ };
1165
+ /**
1166
+ * A positive integer of 1024 or more. Defaults to 2048 bits.
1167
+ */
1168
+ export declare type SshKeyGenerateBodyBits = typeof SshKeyGenerateBodyBits[keyof typeof SshKeyGenerateBodyBits];
1169
+ export declare const SshKeyGenerateBodyBits: {
1170
+ readonly NUMBER_1024: 1024;
1171
+ readonly NUMBER_2048: 2048;
1172
+ readonly NUMBER_4096: 4096;
1173
+ };
1174
+ export declare type SshKeyGenerateBody = {
1175
+ /** A positive integer of 1024 or more. Defaults to 2048 bits. */
1176
+ bits?: SshKeyGenerateBodyBits;
1177
+ /** The SSH key's encryption method for authentication (rsa or dsa). Defaults to rsa. */
1178
+ enc_type?: SshKeyGenerateBodyEncType;
1179
+ /** The SSH key's filename */
1180
+ name: string;
1181
+ /** A note to log alongside the secure_action_log entry. */
1182
+ note?: string;
1183
+ /** The SSH key's password. Must be four or more secure characters. */
1184
+ pass?: string;
1185
+ /** The entity that initiated the GAP call */
1186
+ source?: string;
1187
+ };
1188
+ export declare type SshKey200 = {
1189
+ deleted?: number;
1190
+ key_name?: string;
1191
+ };
1192
+ export declare type SshKeyBody = {
1193
+ name: string;
1194
+ note?: string;
1195
+ source?: string;
1196
+ };
1197
+ export declare type SshKeyList200KeysItem = {
1198
+ file?: string;
1199
+ haspub?: number;
1200
+ key?: string;
1201
+ name?: string;
1202
+ };
1203
+ export declare type SshKeyList200 = {
1204
+ keys?: SshKeyList200KeysItem[];
1205
+ };
1206
+ export declare type SshKeyImport200 = {
1207
+ key_name?: string;
1208
+ };
1209
+ export declare type SshKeyImportBody = {
1210
+ /** A Valid SSH key */
1211
+ key: string;
1212
+ /** The SSH key's filename */
1213
+ name: string;
1214
+ /** A note to log alongside the secure_action_log entry. */
1215
+ note?: string;
1216
+ /** The SSH key's password. Must be four or more secure characters. */
1217
+ pass?: string;
1218
+ /** The entity that initiated the GAP call */
1219
+ source?: string;
1220
+ };
1221
+ export declare type SshKeyFetch200 = {
1222
+ key_name?: string;
1223
+ key?: string;
1224
+ type?: string;
1225
+ };
1226
+ export declare type SshKeyFetchPrivate = typeof SshKeyFetchPrivate[keyof typeof SshKeyFetchPrivate];
1227
+ export declare const SshKeyFetchPrivate: {
1228
+ readonly NUMBER_0: "0";
1229
+ readonly NUMBER_1: "1";
1230
+ };
1231
+ export declare type SshKeyFetchParams = {
1232
+ name: string;
1233
+ private?: SshKeyFetchPrivate;
1234
+ };
1235
+ export declare type HostingSshInfo200 = {
1236
+ credential?: string;
1237
+ status?: string;
1238
+ success?: boolean;
1239
+ };
1240
+ export declare type SitesBatch200 = {
1241
+ success?: boolean;
1242
+ };
1243
+ export declare type SitesBatchBodySitesItem = {
1244
+ /** site_id of the site to be updated */
1245
+ site_id?: number;
1246
+ /** Disk space in GiB */
1247
+ disk_limit_gib?: number;
1248
+ /** Number of PHP workers */
1249
+ workers?: number;
1250
+ };
1251
+ export declare type SitesBatchBody = {
1252
+ sites?: SitesBatchBodySitesItem[];
1253
+ };
1254
+ export declare type HostingSiteAdd200 = {
1255
+ id?: number;
1256
+ status?: string;
1257
+ success: boolean;
1258
+ };
1259
+ /**
1260
+ * Datacenter to host site in.
1261
+ */
1262
+ export declare type HostingSiteAddBodyDatacenter = typeof HostingSiteAddBodyDatacenter[keyof typeof HostingSiteAddBodyDatacenter];
1263
+ export declare const HostingSiteAddBodyDatacenter: {
1264
+ readonly 'Amsterdam,_Netherlands': "Amsterdam, Netherlands";
1265
+ readonly 'Ashburn,_Virginia': "Ashburn, Virginia";
1266
+ readonly 'Dallas,_Texas': "Dallas, Texas";
1267
+ readonly 'Los_Angeles,_California': "Los Angeles, California";
1268
+ };
1269
+ export declare type HostingSiteAddBody = {
1270
+ /** domain for the site to be added */
1271
+ domain?: string;
1272
+ /** Installation Path */
1273
+ path?: string;
1274
+ /** Site Subtype */
1275
+ subtype: string;
1276
+ /** title of the site to be added */
1277
+ title?: string;
1278
+ /** Migrate an existing wordpress site */
1279
+ migration_id?: string;
1280
+ /** Admin email for the site user */
1281
+ admin_email?: string;
1282
+ /** Admin user for the site */
1283
+ admin_user?: string;
1284
+ /** Disk space in GiB */
1285
+ disk_limit_gib?: number;
1286
+ /** Number of PHP workers */
1287
+ workers?: number;
1288
+ /** toggle between wordpress/lightweight for non-existent static file */
1289
+ handler_404?: boolean;
1290
+ /** Datacenter to host site in. */
1291
+ datacenter?: HostingSiteAddBodyDatacenter;
1292
+ /** HAL site id to clone */
1293
+ clone_site_id?: number;
1294
+ };
1295
+ export declare type HostingShellInfo200 = {
1296
+ enabled?: boolean;
1297
+ };
1298
+ export declare type HostingShellToggle200 = {
1299
+ enabled?: boolean;
1300
+ };
1301
+ export declare type HostingShellToggleBody = {
1302
+ /** boolean flag to enable or disable hosting shell */
1303
+ enabled: boolean;
1304
+ };
1305
+ export declare type HostingResellerSsoWhm200 = {
1306
+ url?: string;
1307
+ };
1308
+ export declare type HostingRedirects200Item = {
1309
+ docroot?: string;
1310
+ domain?: string;
1311
+ http_status_code?: number;
1312
+ redirect_wwww?: boolean;
1313
+ wildcard?: boolean;
1314
+ src?: string;
1315
+ type?: string;
1316
+ url?: string;
1317
+ };
1318
+ export declare type HostingOnboardingDataUpdate200 = {
1319
+ completed?: boolean;
1320
+ };
1321
+ export declare type HostingOnboardingDataUpdateBody = {
1322
+ completed?: boolean;
1323
+ };
1324
+ export declare type HostingOnboardingData200 = {
1325
+ completed?: boolean | null;
1326
+ };
1327
+ export declare type HostingNameservers200 = {
1328
+ nameservers: string[];
1329
+ };
1330
+ export declare type HostingMigrationSiteScanStatus200 = {
1331
+ transferable?: boolean;
1332
+ callback_url?: string;
1333
+ };
1334
+ export declare type HostingMigrationSiteScanStatusParams = {
1335
+ /**
1336
+ * valid domain, URI format is preferred
1337
+ */
1338
+ prospect_url: string;
1339
+ };
1340
+ export declare type HostingMigrationInfo200 = {
1341
+ migration_id?: string;
1342
+ domain?: string;
1343
+ site_url?: string;
1344
+ hostname?: string;
1345
+ feasible?: string;
1346
+ incoming_domain?: string;
1347
+ is_valid_migration_id?: boolean;
1348
+ };
1349
+ export declare type HostingMigrationInfoParams = {
1350
+ migration_id: string;
1351
+ };
1352
+ export declare type HostingMigrationsEvent200 = {
1353
+ success?: boolean;
1354
+ };
1355
+ export declare type HostingMigrationsEventBodyEventName = typeof HostingMigrationsEventBodyEventName[keyof typeof HostingMigrationsEventBodyEventName];
1356
+ export declare const HostingMigrationsEventBodyEventName: {
1357
+ readonly inReview: "inReview";
1358
+ readonly approved: "approved";
1359
+ readonly disapproved: "disapproved";
1360
+ readonly propagationComplete: "propagationComplete";
1361
+ readonly propagationTimeout: "propagationTimeout";
1362
+ readonly transferComplete: "transferComplete";
1363
+ readonly failedCreate: "failedCreate";
1364
+ };
1365
+ export declare type HostingMigrationsEventBody = {
1366
+ /** The migration id that corresponds to CWM */
1367
+ migration_id: string;
1368
+ event_name: HostingMigrationsEventBodyEventName;
1369
+ };
1370
+ export declare type HostingMigrationsCheck200 = {
1371
+ transferable?: boolean;
1372
+ description?: string;
1373
+ };
1374
+ export declare type HostingMigrationsCheckParams = {
1375
+ /**
1376
+ * Migration ID to be checked if already used to migrate site on the hosting account
1377
+ */
1378
+ migration_id: string;
1379
+ };
1380
+ export declare type HostingMigrations200 = {
1381
+ success?: boolean;
1382
+ };
1383
+ export declare type HostingMigrationsBody = {
1384
+ /** The migration id that corresponds to CWM */
1385
+ migration_id: string;
1386
+ };
1387
+ export declare type HostingMigrationStatus200RowsItem = {
1388
+ id?: string;
1389
+ type?: string;
1390
+ subtype?: string;
1391
+ status?: string;
1392
+ };
1393
+ export declare type HostingMigrationStatus200 = {
1394
+ rows?: HostingMigrationStatus200RowsItem[];
1395
+ };
1396
+ export declare type HostingLead400 = {
1397
+ [key: string]: any;
1398
+ };
1399
+ export declare type HostingLead200ResponseItemData = {
1400
+ leadId?: string;
1401
+ message?: string;
1402
+ };
1403
+ export declare type HostingLead200ResponseItem = {
1404
+ providerApplicationName?: string;
1405
+ clientRequestId?: string;
1406
+ status?: string;
1407
+ errors?: string;
1408
+ data?: HostingLead200ResponseItemData;
1409
+ messageId?: string;
1410
+ };
1411
+ export declare type HostingLead200 = {
1412
+ response?: HostingLead200ResponseItem[];
1413
+ } | null;
1414
+ export declare type HostingLeadParams = {
1415
+ phone?: string;
1416
+ };
1417
+ export declare type HostingInfoDiskUsage200 = {
1418
+ diskused?: string;
1419
+ disklimit?: string;
1420
+ fileslimit?: number | null;
1421
+ filesused?: number | null;
1422
+ disklastupdated?: string | null;
1423
+ };
1424
+ export declare type HostingInfo200 = {
1425
+ ip?: string;
1426
+ };
1427
+ export declare type HostingFtp200 = {
1428
+ status?: number;
1429
+ /** Username */
1430
+ user?: string;
1431
+ };
1432
+ export declare type HostingFtpBody = {
1433
+ /** Username for FTP account to delete. */
1434
+ user: string;
1435
+ /** Tear down FTP account home directory. Defaults to false (i.e., do not destroy). WARNING: There are many cases where destroying the ftp directory would be undesirable. */
1436
+ destroy?: boolean;
1437
+ /** Optional: A note to log alongside the secure_action_log entry. */
1438
+ note?: string;
1439
+ /** Optional: The entity that initiated the GAP call, eg. i_cluster, admin_user, script, cron, addon_$type($id) */
1440
+ source?: string;
1441
+ };
1442
+ export declare type HostingFtpUpdate200 = {
1443
+ status?: number;
1444
+ };
1445
+ /**
1446
+ * Must pass either password or quota.
1447
+ */
1448
+ export declare type HostingFtpUpdateBodyUserTypeSet = typeof HostingFtpUpdateBodyUserTypeSet[keyof typeof HostingFtpUpdateBodyUserTypeSet];
1449
+ export declare const HostingFtpUpdateBodyUserTypeSet: {
1450
+ readonly password: "password";
1451
+ readonly quota: "quota";
1452
+ };
1453
+ export declare type HostingFtpUpdateBody = {
1454
+ /** Username for FTP account. */
1455
+ user: string;
1456
+ /** Update quota for user. Quota value should be greater than or equal to 0. */
1457
+ quota?: number;
1458
+ /** Update password for user */
1459
+ password?: string;
1460
+ /** Must pass either password or quota. */
1461
+ user_type_set?: HostingFtpUpdateBodyUserTypeSet;
1462
+ };
1463
+ export declare type HostingFtpAdd200 = {
1464
+ user?: string;
1465
+ pass?: string;
1466
+ };
1467
+ export declare type HostingFtpAddBody = {
1468
+ /** Optional username. If not included then type is required and will generate a random username. Good for temp ftp user. Do not append domain. */
1469
+ user: string;
1470
+ /** Optional password. One will be generated if not included */
1471
+ pass?: string;
1472
+ /** Optional domain. If provided, returns the username as $user@$domain instead of just $user. Either way, FTP logins must still be fully qualified as $user@some-domain-on-account. */
1473
+ domain?: string;
1474
+ /** Path to FTP folder. Default is /. (will be relative from homedir) */
1475
+ folder?: string;
1476
+ /** Text to prepended in random username generation. */
1477
+ type?: string;
1478
+ /** Optional: A note to log alongside the secure_action_log entry. */
1479
+ note?: string;
1480
+ /** Optional: The entity that initiated the GAP call, eg. i_cluster, admin_user, script, cron, addon_$type($id) */
1481
+ source?: string;
1482
+ user_type_set?: string;
1483
+ };
1484
+ export declare type HostingFtpList200SpecialFtpAccountsItem = {
1485
+ user?: string;
1486
+ homedir?: string;
1487
+ type?: string;
1488
+ account?: string;
1489
+ domain?: string;
1490
+ };
1491
+ export declare type HostingFtpList200FtpAccountsItem = {
1492
+ user?: string;
1493
+ homedir?: string;
1494
+ type?: string;
1495
+ account?: string;
1496
+ domain?: string;
1497
+ };
1498
+ export declare type HostingFtpList200 = {
1499
+ ftp_accounts?: HostingFtpList200FtpAccountsItem[];
1500
+ special_ftp_accounts?: HostingFtpList200SpecialFtpAccountsItem[];
1501
+ server_name?: string;
1502
+ };
1503
+ export declare type HostingEcommerceInfo200 = {
1504
+ addon_id?: number;
1505
+ /** eCommerce addon back reference (a.k.a. prodInstId) */
1506
+ back_ref?: string;
1507
+ level?: string;
1508
+ name?: string;
1509
+ type?: string;
1510
+ status?: string;
1511
+ subtype?: string | null;
1512
+ } | null;
1513
+ export declare type HostingDomainsUnassign200 = {
1514
+ queued?: boolean;
1515
+ };
1516
+ export declare type HostingDomainsUnassignBody = {
1517
+ /** The domain id to be unassigned */
1518
+ domain_id: number;
1519
+ };
1520
+ export declare type Domains200DomainsItem = {
1521
+ docroot: string;
1522
+ domain: string;
1523
+ type: string;
1524
+ id: number;
1525
+ };
1526
+ export declare type Domains200 = {
1527
+ domains: Domains200DomainsItem[];
1528
+ };
1529
+ export declare type DomainsType = typeof DomainsType[keyof typeof DomainsType];
1530
+ export declare const DomainsType: {
1531
+ readonly addon: "addon";
1532
+ readonly main: "main";
1533
+ readonly parked: "parked";
1534
+ readonly sub: "sub";
1535
+ readonly unassigned: "unassigned";
1536
+ };
1537
+ export declare type DomainsParams = {
1538
+ type?: DomainsType;
1539
+ };
1540
+ export declare type DbUserList200UsersItem = {
1541
+ dblist?: string[];
1542
+ shortuser?: string;
1543
+ user?: string;
1544
+ };
1545
+ export declare type DbUserList200 = {
1546
+ users?: DbUserList200UsersItem[];
1547
+ };
1548
+ export declare type DbUserDelete200 = {
1549
+ dbuser?: string;
1550
+ };
1551
+ export declare type DbUserDeleteBody = {
1552
+ /** The complete database username */
1553
+ dbuser: string;
1554
+ };
1555
+ export declare type DbUserAdd200 = {
1556
+ username?: string;
1557
+ password?: string;
1558
+ };
1559
+ /**
1560
+ * Set for wanting either mysql or postgres
1561
+ */
1562
+ export declare type DbUserAddBodyDbType = typeof DbUserAddBodyDbType[keyof typeof DbUserAddBodyDbType];
1563
+ export declare const DbUserAddBodyDbType: {
1564
+ readonly mysql: "mysql";
1565
+ readonly postgres: "postgres";
1566
+ };
1567
+ export declare type DbUserAddBody = {
1568
+ /** username to be created for the DB */
1569
+ dbuser: string;
1570
+ /** Set for wanting either mysql or postgres */
1571
+ db_type?: DbUserAddBodyDbType;
1572
+ /** Database password for this new user. If not provided one will be generated. */
1573
+ password?: string;
1574
+ /** The account type; eg, cg for codeguard, used for auto-generated usernames. Max 2 characters. */
1575
+ type?: string;
1576
+ /** Database name. */
1577
+ database?: string;
1578
+ /** An array of user privileges. */
1579
+ privileges?: string[];
1580
+ };
1581
+ export declare type DbUserPrivsSet200 = {
1582
+ status?: number;
1583
+ };
1584
+ /**
1585
+ * Type of database
1586
+ */
1587
+ export declare type DbUserPrivsSetBodyType = typeof DbUserPrivsSetBodyType[keyof typeof DbUserPrivsSetBodyType];
1588
+ export declare const DbUserPrivsSetBodyType: {
1589
+ readonly mysql: "mysql";
1590
+ readonly postgres: "postgres";
1591
+ };
1592
+ export declare type DbUserPrivsSetBody = {
1593
+ /** Database name. */
1594
+ database?: string;
1595
+ /** Database user names. */
1596
+ dbusers?: string[];
1597
+ /** An array of user privileges. */
1598
+ privileges?: string[];
1599
+ /** Type of database */
1600
+ type?: DbUserPrivsSetBodyType;
1601
+ };
1602
+ export declare type DbUserPrivsGet200 = {
1603
+ privileges?: string[];
1604
+ };
1605
+ export declare type DbUserPrivsGetParams = {
1606
+ database: string;
1607
+ dbuser: string;
1608
+ };
1609
+ export declare type DbUserPasswordSet200 = {
1610
+ dbuser?: string;
1611
+ };
1612
+ export declare type DbUserPasswordSetBody = {
1613
+ /** Database user name. */
1614
+ dbuser: string;
1615
+ /** Database password to be updated. */
1616
+ password: string;
1617
+ };
1618
+ export declare type DbUsage200 = {
1619
+ db_limit?: number | null;
1620
+ db_count?: number;
1621
+ };
1622
+ export declare type DbList200DatabasesItemUserlistItem = {
1623
+ db?: string;
1624
+ user?: string;
1625
+ };
1626
+ export declare type DbList200DatabasesItem = {
1627
+ db?: string;
1628
+ sitename?: string;
1629
+ size?: string;
1630
+ sizemeg?: string;
1631
+ usercount?: number;
1632
+ userlist?: DbList200DatabasesItemUserlistItem[];
1633
+ };
1634
+ export declare type DbList200 = {
1635
+ status?: boolean;
1636
+ databases?: DbList200DatabasesItem[];
1637
+ };
1638
+ export declare type Db200 = {
1639
+ dbname?: string;
1640
+ status?: number;
1641
+ type?: string;
1642
+ };
1643
+ /**
1644
+ * Type of database
1645
+ */
1646
+ export declare type DbBodyType = typeof DbBodyType[keyof typeof DbBodyType];
1647
+ export declare const DbBodyType: {
1648
+ readonly mysql: "mysql";
1649
+ readonly postgres: "postgres";
1650
+ };
1651
+ export declare type DbBody = {
1652
+ /** The name of the database to delete.First 8 characters of account username will be prepended.ex: {username}_{dbname} */
1653
+ dbname: string;
1654
+ /** Type of database */
1655
+ type?: DbBodyType;
1656
+ };
1657
+ export declare type DbAdd200 = {
1658
+ dbname?: string;
1659
+ status?: number;
1660
+ type?: string;
1661
+ };
1662
+ /**
1663
+ * Type of database to add
1664
+ */
1665
+ export declare type DbAddBodyType = typeof DbAddBodyType[keyof typeof DbAddBodyType];
1666
+ export declare const DbAddBodyType: {
1667
+ readonly mysql: "mysql";
1668
+ readonly postgres: "postgres";
1669
+ };
1670
+ export declare type DbAddBody = {
1671
+ /** The database name. Account username_ will be prepended. Max length is 54 characters */
1672
+ dbname: string;
1673
+ /** Type of database to add */
1674
+ type?: DbAddBodyType;
1675
+ };
1676
+ export declare type Cron200 = {
1677
+ success?: boolean;
1678
+ };
1679
+ export declare type CronBody = {
1680
+ /** unique key for cron that is being updated */
1681
+ key: number;
1682
+ };
1683
+ export declare type UpdateCron200 = {
1684
+ key?: number;
1685
+ };
1686
+ export declare type UpdateCronBody = {
1687
+ /** unique key for cron that is being updated */
1688
+ key: number;
1689
+ /** command to run as a cron, needs to be a valid string */
1690
+ command: string;
1691
+ /** The day of the month on which the cron job runs. An integer between 1 and 31. * - Every day. *\/2 - Every other day. 1,15 - On the 1st and 15th of the month. */
1692
+ day: string;
1693
+ /** The hour of the day on which the cron job runs. An integer between 0 and 23. * - Every hour. *\/2 - Every other hour. 0,12 - Every 12 hours. */
1694
+ hour: string;
1695
+ /** The minute of the hour on which the cron job runs. An integer between 0 and 59. * - Once per minute. *\/2 - Every other minute. *\/10 - Every 10 minutes. 0,30 - Every 30 minutes. */
1696
+ minute: string;
1697
+ /** The month of the year on which the cron job runs. An integer between 1 and 12. * - Every month. *\/2 - Every other month. *\/6 - Every six months. */
1698
+ month: string;
1699
+ /** The day of the week on which the cron job runs, 0-6. 0 - Sunday. 1 - Monday. 2 - Tuesday. 3 - Wednesday. 4 - Thursday. 5 - Friday. 6 - Saturday. * - Every day. */
1700
+ weekday: string;
1701
+ /** Type of command (command, variable, comment, blank, unparsed) */
1702
+ type?: string;
1703
+ };
1704
+ export declare type AddCron400 = {
1705
+ error?: string;
1706
+ };
1707
+ export declare type AddCron200 = {
1708
+ key?: string;
1709
+ };
1710
+ export declare type AddCronBody = {
1711
+ /** command to run as a cron, needs to be a valid string */
1712
+ command: string;
1713
+ /** The day of the month on which the cron job runs. An integer between 1 and 31. * - Every day. *\/2 - Every other day. 1,15 - On the 1st and 15th of the month. */
1714
+ day?: string;
1715
+ /** The hour of the day on which the cron job runs. An integer between 0 and 23. * - Every hour. *\/2 - Every other hour. 0,12 - Every 12 hours. */
1716
+ hour?: string;
1717
+ /** The minute of the hour on which the cron job runs. An integer between 0 and 59. * - Once per minute. *\/2 - Every other minute. *\/10 - Every 10 minutes. 0,30 - Every 30 minutes. */
1718
+ minute?: string;
1719
+ /** The month of the year on which the cron job runs. An integer between 1 and 12. * - Every month. *\/2 - Every other month. *\/6 - Every six months. */
1720
+ month?: string;
1721
+ /** The day of the week on which the cron job runs, 0-6. 0 - Sunday. 1 - Monday. 2 - Tuesday. 3 - Wednesday. 4 - Thursday. 5 - Friday. 6 - Saturday. * - Every day. */
1722
+ weekday?: string;
1723
+ };
1724
+ export declare type ListCrons200RowsItem = {
1725
+ command?: string;
1726
+ day?: string;
1727
+ hour?: string;
1728
+ key?: string;
1729
+ line?: string;
1730
+ minute?: string;
1731
+ month?: string;
1732
+ type?: string;
1733
+ weekday?: string;
1734
+ email?: string;
1735
+ };
1736
+ export declare type ListCrons200 = {
1737
+ rows?: ListCrons200RowsItem[];
1738
+ };
1739
+ export declare type AddonCloudflare200 = {
1740
+ status?: string;
1741
+ addon_id?: number;
1742
+ };
1743
+ export declare type AddonCloudflareBody = {
1744
+ /** The domain. */
1745
+ domain: string;
1746
+ };
1747
+ export declare type HostingCapabilities200 = {
1748
+ server_controls?: boolean;
1749
+ sites?: boolean;
1750
+ cpanel?: boolean;
1751
+ whm?: boolean;
1752
+ advanced_hosting?: boolean;
1753
+ reset_password?: boolean;
1754
+ is_sitelock_migrated?: boolean;
1755
+ };
1756
+ export declare type HostingAdvancedSystemConsole200 = {
1757
+ url?: string;
1758
+ };
1759
+ export declare type HostingAdvancedSsoWhm200 = {
1760
+ url?: string;
1761
+ };
1762
+ export declare type HostingAdvancedPassword200 = {
1763
+ success?: boolean;
1764
+ };
1765
+ export declare type HostingAdvancedPasswordBody = {
1766
+ /** The username to be updated */
1767
+ account_username?: string;
1768
+ /** The password to be updated to */
1769
+ password: string;
1770
+ };
1771
+ export declare type HostingAdvancedServerStatus200Actions = {
1772
+ [key: string]: any;
1773
+ };
1774
+ export declare type HostingAdvancedServerStatus200 = {
1775
+ status?: string;
1776
+ uptime?: string;
1777
+ uptime_seconds?: number;
1778
+ actions?: HostingAdvancedServerStatus200Actions;
1779
+ };
1780
+ export declare type HostingAdvancedServerStatusBody = {
1781
+ /** action to be performed */
1782
+ action?: string;
1783
+ };
1784
+ export declare type HostingAdvancedServer200Actions = {
1785
+ [key: string]: any;
1786
+ };
1787
+ export declare type HostingAdvancedServer200Ips = {
1788
+ /** primary IP of server */
1789
+ primary_ip?: string;
1790
+ other_ips?: string[];
1791
+ };
1792
+ export declare type HostingAdvancedServer200 = {
1793
+ status?: string;
1794
+ /** hostname of server */
1795
+ hostname?: string;
1796
+ ips?: HostingAdvancedServer200Ips;
1797
+ /** Operating system name */
1798
+ os_name?: string;
1799
+ /** Operating system version */
1800
+ os_version?: string;
1801
+ uptime?: string;
1802
+ uptime_seconds?: number;
1803
+ actions?: HostingAdvancedServer200Actions;
1804
+ };
1805
+ export declare type HostingAddons200RowsItemMeta = {
1806
+ [key: string]: any;
1807
+ };
1808
+ export declare type HostingAddons200RowsItem = {
1809
+ id?: string;
1810
+ type?: string;
1811
+ subtype?: string;
1812
+ status?: string;
1813
+ status_user?: string;
1814
+ meta?: HostingAddons200RowsItemMeta;
1815
+ };
1816
+ export declare type HostingAddons200 = {
1817
+ rows?: HostingAddons200RowsItem[];
1818
+ };
1819
+ export declare type HostingAddonsParams = {
1820
+ status?: string;
1821
+ subtype?: string;
1822
+ type?: string;
1823
+ };
1824
+ export declare type HostingAccount200ResourcesWorkers = {
1825
+ available?: number | null;
1826
+ total?: number | null;
1827
+ used?: number | null;
1828
+ };
1829
+ export declare type HostingAccount200ResourcesStorage = {
1830
+ available?: number | null;
1831
+ total?: number | null;
1832
+ unit?: string;
1833
+ used?: number | null;
1834
+ };
1835
+ export declare type HostingAccount200Resources = {
1836
+ storage?: HostingAccount200ResourcesStorage;
1837
+ workers?: HostingAccount200ResourcesWorkers;
1838
+ } | null;
1839
+ export declare type HostingAccount200Billing = {
1840
+ product_name?: string;
1841
+ };
1842
+ export declare type HostingAccount200 = {
1843
+ id?: string;
1844
+ account_id?: string;
1845
+ brand?: string;
1846
+ platform?: string;
1847
+ username?: string;
1848
+ status?: string;
1849
+ type?: string;
1850
+ advanced?: boolean;
1851
+ billing?: HostingAccount200Billing;
1852
+ panel?: string;
1853
+ plan_key?: string;
1854
+ resources?: HostingAccount200Resources;
1855
+ };
1856
+ export declare type DomainUnassign200 = {
1857
+ [key: string]: any;
1858
+ };
1859
+ export declare type DomainInfo200SetupProgress = {
1860
+ /** Most recent error logged during domain validation. Remains set if validation tries run out. Gets reset by new validation job. */
1861
+ validate_error?: string | null;
1862
+ /** Result of domain dns validation (null=not started,0=started,1=succeeded,2=skipped) */
1863
+ validate_dns?: number | null;
1864
+ /** Result of domain ssl validation (null=not started,0=started,1=succeeded,2=skipped) */
1865
+ validate_ssl?: number | null;
1866
+ /** Result of domain cdn validation (null=not started,0=started,1=succeeded,2=skipped) */
1867
+ validate_cdn?: number | null;
1868
+ } | null;
1869
+ export declare type DomainInfo200 = {
1870
+ id?: number;
1871
+ account_back_ref?: string | null;
1872
+ authoritative?: boolean | null;
1873
+ autogen_id?: number | null;
1874
+ back_reference?: string | null;
1875
+ base_domain?: string;
1876
+ date_added?: string;
1877
+ date_modified?: string;
1878
+ date_ssl_exp?: string | null;
1879
+ docroot?: string | null;
1880
+ dns_status?: string;
1881
+ domain?: string;
1882
+ homedir?: string | null;
1883
+ hosting_id?: number | null;
1884
+ setup_progress?: DomainInfo200SetupProgress;
1885
+ ssl_issuer?: string | null;
1886
+ ssl_status?: string | null;
1887
+ ssl_type?: string | null;
1888
+ status?: string;
1889
+ type?: string;
1890
+ };
1891
+ export declare type WeeblySso200 = {
1892
+ sso?: string;
1893
+ };
1894
+ export declare type WebzaiSso200 = {
1895
+ sso?: string;
1896
+ };
1897
+ export declare type AddonsSpamexpertsSso200 = {
1898
+ url?: string;
1899
+ };
1900
+ export declare type AddonsInfo200 = {
1901
+ id?: string;
1902
+ };
1903
+ export declare type AddonsCloudflare200 = {
1904
+ status?: string;
1905
+ };
1906
+ export declare type AddonsSitelockSso200 = {
1907
+ site_url?: string;
1908
+ sitelock_id?: string;
1909
+ url?: string;
1910
+ };
1911
+ export declare type CodeguardWebsiteBackupRestore200 = {
1912
+ status?: string;
1913
+ };
1914
+ export declare type CodeguardWebsiteBackupRestoreBody = {
1915
+ /** The id of the website the given database is associated with. */
1916
+ website_id?: number;
1917
+ /** The commit id to restore the website from. */
1918
+ commit_id?: string;
1919
+ };
1920
+ export declare type CodeguardWebsiteBackupCreate200 = {
1921
+ status?: string;
1922
+ };
1923
+ export declare type CodeguardWebsiteBackupCreateBody = {
1924
+ /** The id for the website to create a backup for. This id can be obtained through a call to the website_list action. */
1925
+ website_id?: number;
1926
+ };
1927
+ export declare type CodeguardWebsiteBackupList200BackupsItem = {
1928
+ commit_id?: string;
1929
+ event_time?: string;
1930
+ modifications?: number;
1931
+ new_content?: boolean;
1932
+ };
1933
+ export declare type CodeguardWebsiteBackupList200 = {
1934
+ backups?: CodeguardWebsiteBackupList200BackupsItem[];
1935
+ };
1936
+ export declare type CodeguardWebsiteBackupListParams = {
1937
+ website_id?: number;
1938
+ };
1939
+ export declare type CodeguardWebsiteList200WebsiteListItemWebsite = {
1940
+ id?: number;
1941
+ activated?: boolean;
1942
+ url?: string;
1943
+ };
1944
+ export declare type CodeguardWebsiteList200WebsiteListItem = {
1945
+ website?: CodeguardWebsiteList200WebsiteListItemWebsite;
1946
+ };
1947
+ export declare type CodeguardWebsiteList200 = {
1948
+ website_list?: CodeguardWebsiteList200WebsiteListItem[];
1949
+ };
1950
+ export declare type CodeguardPlanInfo200SeatsItem = {
1951
+ url?: string;
1952
+ activated?: boolean;
1953
+ website_id?: number;
1954
+ };
1955
+ export declare type CodeguardPlanInfo200 = {
1956
+ size?: number;
1957
+ size_limit?: number;
1958
+ seat_count?: number;
1959
+ seat_limit?: number;
1960
+ status?: string;
1961
+ back_reference?: string;
1962
+ can_upgrade?: boolean;
1963
+ plan_name?: string;
1964
+ seats?: CodeguardPlanInfo200SeatsItem[];
1965
+ };
1966
+ export declare type CodeguardLoginLink200 = {
1967
+ link?: string;
1968
+ };
1969
+ export declare type CodeguardDatabaseBackupRestore200 = {
1970
+ status?: string;
1971
+ };
1972
+ export declare type CodeguardDatabaseBackupRestoreBody = {
1973
+ /** The id for the database to create a new backup for. */
1974
+ database_id?: number;
1975
+ /** The id of the website the given database is associated with. */
1976
+ website_id?: number;
1977
+ /** The commit_id for the backup to restore */
1978
+ commit_id?: string;
1979
+ };
1980
+ export declare type CodeguardDatabaseBackupCreate200 = {
1981
+ status?: string;
1982
+ };
1983
+ export declare type CodeguardDatabaseBackupCreateBody = {
1984
+ /** The id for the database to create a new backup for. */
1985
+ database_id?: number;
1986
+ /** The id of the website the given database is associated with. */
1987
+ website_id?: number;
1988
+ };
1989
+ export declare type CodeguardDatabaseBackupList200BackupsItem = {
1990
+ commit_id?: string;
1991
+ event_time?: string;
1992
+ };
1993
+ export declare type CodeguardDatabaseBackupList200 = {
1994
+ backups?: CodeguardDatabaseBackupList200BackupsItem[];
1995
+ };
1996
+ export declare type CodeguardDatabaseBackupListParams = {
1997
+ database_id?: number;
1998
+ website_id?: number;
1999
+ };
2000
+ export declare type CodeguardDatabaseList200DatabasesItemDatabaseBackup = {
2001
+ id?: number;
2002
+ account?: string;
2003
+ website_id?: number;
2004
+ commit_id?: string;
2005
+ };
2006
+ export declare type CodeguardDatabaseList200DatabasesItem = {
2007
+ database_backup?: CodeguardDatabaseList200DatabasesItemDatabaseBackup;
2008
+ };
2009
+ export declare type CodeguardDatabaseList200 = {
2010
+ status?: number;
2011
+ databases?: CodeguardDatabaseList200DatabasesItem[];
2012
+ };
2013
+ export declare type CodeguardBackupRestore200 = {
2014
+ website_success?: boolean;
2015
+ database_success?: boolean;
2016
+ };
2017
+ export declare type CodeguardBackupRestoreBody = {
2018
+ /** The id of the website the given database is associated with. */
2019
+ website_id?: number;
2020
+ /** The commit id to restore the website from. */
2021
+ website_commit_id?: string;
2022
+ /** The id of the database the given database is associated with. */
2023
+ database_id?: number;
2024
+ /** The commit id to restore the database from. */
2025
+ database_commit_id?: string;
2026
+ };
2027
+ export declare type CodeguardBackupDownload200 = {
2028
+ status?: string;
2029
+ };
2030
+ export declare type CodeguardBackupDownloadBody = {
2031
+ /** The id of the website the given database is associated with. */
2032
+ website_id?: number;
2033
+ /** The commit id to restore the website from. */
2034
+ website_commit_id?: string;
2035
+ /** The commit id to restore the database from. */
2036
+ database_commit_id?: string;
2037
+ };
2038
+ export declare type CodeguardBackupCreate200 = {
2039
+ status?: string;
2040
+ };
2041
+ export declare type CodeguardBackupCreateBody = {
2042
+ /** The id of the website the given database is associated with. */
2043
+ website_id?: number;
2044
+ /** The id of the database the given database is associated with. */
2045
+ database_id?: number;
2046
+ };
2047
+ export declare type CodeguardBackupList200BackupsItemDatabaseBackupsItem = {
2048
+ id?: number;
2049
+ commit_id?: string;
2050
+ event_time?: string;
2051
+ recommended?: boolean;
2052
+ };
2053
+ export declare type CodeguardBackupList200BackupsItem = {
2054
+ website_commit_id?: string;
2055
+ event_time?: string;
2056
+ database_backups?: CodeguardBackupList200BackupsItemDatabaseBackupsItem[];
2057
+ };
2058
+ export declare type CodeguardBackupList200 = {
2059
+ backups?: CodeguardBackupList200BackupsItem[];
2060
+ };
2061
+ export declare type CodeguardBackupListParams = {
2062
+ website_id: number;
2063
+ };
2064
+ export declare type AccountHostingList200AccountsItem = {
2065
+ /** HAL Account back_reference */
2066
+ prod_inst_id?: string;
2067
+ feature_set?: string;
2068
+ status?: string;
2069
+ /** HAL Account ID */
2070
+ hosting_id?: string;
2071
+ platform?: string;
2072
+ /** Jarvis Account ID, HAL tenant_back_ref */
2073
+ account_id?: string;
2074
+ current_sites?: number;
2075
+ max_sites?: string;
2076
+ };
2077
+ export declare type AccountHostingList200 = {
2078
+ accounts?: AccountHostingList200AccountsItem[];
2079
+ };
2080
+ export declare type AccountEventList200EventsItem = {
2081
+ /** ID of HAL Account associated with this event */
2082
+ hosting_id?: number;
2083
+ /** ID of HAL Addon associated with this event */
2084
+ addon_id?: number | null;
2085
+ /** How many times this event has triggered between date_first and date_last */
2086
+ count?: number;
2087
+ /** UTC timestamp of first occurrence of this event */
2088
+ date_first?: string;
2089
+ /** UTC timestamp of most recent occurrence of this event */
2090
+ date_last?: string;
2091
+ /** ID of HAL Domain associated with this event */
2092
+ domain_id?: number | null;
2093
+ /** Name of the event this entry was triggered by */
2094
+ event?: string;
2095
+ /** ID of HAL Site associated with this event */
2096
+ site_id?: number | null;
2097
+ /** ID of HAL Tenant associated with this event */
2098
+ tenant_id?: number;
2099
+ };
2100
+ export declare type AccountEventList200 = {
2101
+ events?: AccountEventList200EventsItem[];
2102
+ /** Date of most recent event update. Can pass back in when determining whether to query new data */
2103
+ utc?: string;
2104
+ };
2105
+ export declare type AccountEventListParams = {
2106
+ /**
2107
+ * ID of the HAL Addon to query event info about
2108
+ */
2109
+ addon_id?: number;
2110
+ /**
2111
+ * ID of the HAL Domain to query event info about
2112
+ */
2113
+ domain_id?: number;
2114
+ /**
2115
+ * ID of the HAL Site to query event info about
2116
+ */
2117
+ site_id?: number;
2118
+ /**
2119
+ * Date-time to check for new events *after*; ISO format.
2120
+ */
2121
+ date_last?: string;
2122
+ };
2123
+ export interface SitesAutoupdatesResponse {
2124
+ plugins?: boolean | null;
2125
+ core?: boolean | null;
2126
+ themes?: boolean | null;
2127
+ }