@newfold/huapi-js 2.1412.0 → 2.1437.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.
@@ -1,4813 +0,0 @@
1
- /**
2
- * Generated by orval v7.1.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.1412.0
7
- */
8
- export declare type SshKeyListV4200RowsItem = {
9
- authorize?: boolean;
10
- created_at?: string;
11
- name?: string;
12
- type?: string;
13
- };
14
- export declare type SshKeyListV4200 = {
15
- rows?: SshKeyListV4200RowsItem[];
16
- };
17
- export declare type SitesListV3200 = {
18
- items?: SiteInfoResponseModelV2[];
19
- /** page size */
20
- limit?: number;
21
- /** current page number */
22
- page?: number;
23
- /** total number of pages */
24
- pages?: number;
25
- /** total number of sites */
26
- rows?: number;
27
- /** total number of sites returned */
28
- total?: number;
29
- };
30
- export declare type SitesListV3Params = {
31
- limit?: number;
32
- page?: number;
33
- search?: string;
34
- };
35
- export declare type SshKeyListV3200RowsItem = {
36
- authorize?: boolean;
37
- mtime?: string;
38
- name?: string;
39
- type?: string;
40
- };
41
- export declare type SshKeyListV3200 = {
42
- rows?: SshKeyListV3200RowsItem[];
43
- };
44
- export declare type SshKeyImportV3200 = {
45
- /** @nullable */
46
- public_key_name?: string | null;
47
- };
48
- export declare type SshKeyImportV3Body = {
49
- /** The SSH key's filename */
50
- name: string;
51
- /** A note to log alongside the secure_action_log entry. */
52
- note?: string;
53
- /** A Valid SSH public key */
54
- pubkey?: string;
55
- /** The entity that initiated the GAP call */
56
- source?: string;
57
- };
58
- export declare type BackupCreateV3200 = {
59
- message?: string;
60
- tracking_id?: number;
61
- };
62
- /**
63
- * The type of the backup
64
- */
65
- export declare type BackupCreateV3BodyBackupType = typeof BackupCreateV3BodyBackupType[keyof typeof BackupCreateV3BodyBackupType];
66
- export declare const BackupCreateV3BodyBackupType: {
67
- readonly home: "home";
68
- readonly db: "db";
69
- readonly home_db: "home_db";
70
- };
71
- export declare type BackupCreateV3Body = {
72
- /** The type of the backup */
73
- backup_type?: BackupCreateV3BodyBackupType;
74
- };
75
- export declare type SiteUsersV2200UsersItemMeta = {
76
- maestro_web_pro?: string;
77
- maestro_wpp_identifier?: string;
78
- };
79
- export declare type SiteUsersV2200UsersItem = {
80
- display_name?: string;
81
- id: number;
82
- meta?: SiteUsersV2200UsersItemMeta;
83
- post_count?: number;
84
- role: string;
85
- user_email: string;
86
- user_id: number;
87
- user_login: string;
88
- user_nicename: string;
89
- };
90
- export declare type SiteUsersV2200 = {
91
- /** Total number of users that linked to the site */
92
- total_users: number;
93
- users: SiteUsersV2200UsersItem[];
94
- };
95
- export declare type SiteUsersV2Params = {
96
- limit?: number;
97
- page?: number;
98
- search?: string;
99
- };
100
- export declare type SitesSshUserListV2200 = {
101
- users?: SSHUsersV2Response[];
102
- };
103
- export declare type SitesSecuritySitelockV2200 = {
104
- /** @nullable */
105
- addon_id?: number | null;
106
- /** @nullable */
107
- billing_code?: string | null;
108
- /** @nullable */
109
- domain_name?: string | null;
110
- domains?: string[];
111
- /** @nullable */
112
- has_cdn?: boolean | null;
113
- is_migrated?: boolean;
114
- message?: string;
115
- /** @nullable */
116
- plan?: string | null;
117
- /** @nullable */
118
- platform_id?: string | null;
119
- /**
120
- * Sitelock can be attached directly to a site, or it will fallback and return the sitelock for entire hosting account
121
- * @nullable
122
- */
123
- scope?: string | null;
124
- /** @nullable */
125
- source?: string | null;
126
- success?: number;
127
- upgrade_levels?: string[];
128
- };
129
- export declare type SitesSecuritySitelockV2Source = typeof SitesSecuritySitelockV2Source[keyof typeof SitesSecuritySitelockV2Source];
130
- export declare const SitesSecuritySitelockV2Source: {
131
- readonly hal: "hal";
132
- readonly fg: "fg";
133
- readonly halfg: "halfg";
134
- };
135
- export declare type SitesSecuritySitelockV2Params = {
136
- /**
137
- * fetch the sitelock data based on source(fg/hal)
138
- */
139
- source?: SitesSecuritySitelockV2Source;
140
- };
141
- export declare type SiteMalwareStatusV2200 = {
142
- /**
143
- * addon state
144
- * @nullable
145
- */
146
- addon_state?: string | null;
147
- /**
148
- * malware status given by jetpack protect addon
149
- * @nullable
150
- */
151
- malware_state?: string | null;
152
- /**
153
- * plugin state
154
- * @nullable
155
- */
156
- plugin_state?: string | null;
157
- /**
158
- * scanner state
159
- * @nullable
160
- */
161
- scanner_state?: string | null;
162
- };
163
- /**
164
- * @nullable
165
- */
166
- export declare type SitesDomainsV2200DomainsItemSetupProgress = {
167
- /**
168
- * Result of domain cdn validation (null=not started,0=started,1=succeeded,2=skipped)
169
- * @nullable
170
- */
171
- validate_cdn?: number | null;
172
- /**
173
- * Most recent error logged during domain cdn validation. Remains set if validation tries run out. Gets reset by new validation job.
174
- * @nullable
175
- */
176
- validate_cdn_error?: string | null;
177
- /**
178
- * Result of domain dns validation (null=not started,0=started,1=succeeded,2=skipped)
179
- * @nullable
180
- */
181
- validate_dns?: number | null;
182
- /**
183
- * Whether dns_auto_repair was run on this domain (1=true)
184
- * @nullable
185
- */
186
- validate_dns_auto_repair?: number | null;
187
- /**
188
- * Most recent error logged during domain dns validation. Remains set if validation tries run out. Gets reset by new validation job.
189
- * @nullable
190
- */
191
- validate_dns_error?: string | null;
192
- /**
193
- * Most recent error logged during domain validation. Remains set if validation tries run out. Gets reset by new validation job.
194
- * @nullable
195
- */
196
- validate_error?: string | null;
197
- /**
198
- * Result of domain ssl validation (null=not started,0=started,1=succeeded,2=skipped)
199
- * @nullable
200
- */
201
- validate_ssl?: number | null;
202
- /**
203
- * Most recent error logged during domain ssl validation. Remains set if validation tries run out. Gets reset by new validation job.
204
- * @nullable
205
- */
206
- validate_ssl_error?: string | null;
207
- } | null;
208
- export declare type SitesDomainsV2200DomainsItem = {
209
- /** @nullable */
210
- account_back_ref?: string | null;
211
- /** @nullable */
212
- authoritative?: boolean | null;
213
- /** @nullable */
214
- autogen_id?: number | null;
215
- /** @nullable */
216
- back_reference?: string | null;
217
- base_domain?: string;
218
- /** @nullable */
219
- billing_account_id?: string | null;
220
- /** @nullable */
221
- billing_status?: string | null;
222
- date_added?: string;
223
- date_modified?: string;
224
- /** @nullable */
225
- date_ssl_exp?: string | null;
226
- dns_status?: string;
227
- /** @nullable */
228
- docroot?: string | null;
229
- domain?: string;
230
- /** @nullable */
231
- homedir?: string | null;
232
- /** @nullable */
233
- hosting_id?: number | null;
234
- id?: number;
235
- /**
236
- * Whether the domain is internal to us, external, or cannot be determined
237
- * @nullable
238
- */
239
- is_internal?: boolean | null;
240
- /** @nullable */
241
- nameservers?: string[] | null;
242
- /** @nullable */
243
- platform?: string | null;
244
- /** @nullable */
245
- platform_type?: string | null;
246
- /** @nullable */
247
- product_id?: string | null;
248
- /** @nullable */
249
- setup_progress?: SitesDomainsV2200DomainsItemSetupProgress;
250
- /** @nullable */
251
- ssl_issuer?: string | null;
252
- /** @nullable */
253
- ssl_status?: string | null;
254
- /** @nullable */
255
- ssl_type?: string | null;
256
- status?: string;
257
- /** @nullable */
258
- third_party_dns?: boolean | null;
259
- type?: string;
260
- };
261
- export declare type SitesDomainsV2200 = {
262
- domains?: SitesDomainsV2200DomainsItem[];
263
- limit?: number;
264
- page?: number;
265
- total?: number;
266
- };
267
- export declare type SitesDomainsV2Params = {
268
- scan?: boolean;
269
- };
270
- /**
271
- * @nullable
272
- */
273
- export declare type SitesListV2200ItemsItemStaging = {
274
- /**
275
- * Applies to staging site only; The id of the current site's parent site
276
- * @nullable
277
- */
278
- parent_site_id?: number | null;
279
- /**
280
- * Applies to parent site only; The id of the former parent site of the current site
281
- * @nullable
282
- */
283
- promoted_from?: number | null;
284
- /**
285
- * Applies to staging site only; The id of the parent site of the current site that is being promoted
286
- * @nullable
287
- */
288
- promoting_from?: number | null;
289
- /**
290
- * Applies to staging site only; The derived status based on promotion ids and jobs
291
- * @nullable
292
- */
293
- promotion_status?: string | null;
294
- /** A list of staging sites of the current site */
295
- sites?: number[];
296
- } | null;
297
- export declare type SitesListV2200ItemsItemResourcesStorage = {
298
- /** @nullable */
299
- available?: number | null;
300
- /** @nullable */
301
- total?: number | null;
302
- unit?: string;
303
- /** @nullable */
304
- used?: number | null;
305
- };
306
- export declare type SitesListV2200ItemsItemResources = {
307
- storage?: SitesListV2200ItemsItemResourcesStorage;
308
- /** @nullable */
309
- workers?: number | null;
310
- };
311
- /**
312
- * @nullable
313
- */
314
- export declare type SitesListV2200ItemsItemPendingUrlData = {
315
- /**
316
- * The root domain name
317
- * @nullable
318
- */
319
- base_domain?: string | null;
320
- /**
321
- * The Fully Qualified Domain Name (FQDN)
322
- * @nullable
323
- */
324
- domain?: string | null;
325
- /**
326
- * The current pending_url's HAL Domain ID
327
- * @nullable
328
- */
329
- domain_id?: number | null;
330
- /** @nullable */
331
- error?: string | null;
332
- /** Flag indicating whether the pending_url is temporary or not */
333
- is_temp?: boolean;
334
- /**
335
- * Flag indicating whether the url_sync job has run out of attempts
336
- * @nullable
337
- */
338
- job_failed?: boolean | null;
339
- /** @nullable */
340
- stage?: string | null;
341
- /**
342
- * Timestamp for when we will update the WP url, regardless of active sessions
343
- * @nullable
344
- */
345
- wp_session?: string | null;
346
- } | null;
347
- /**
348
- * Job ids for the site
349
- * @nullable
350
- */
351
- export declare type SitesListV2200ItemsItemJobs = {
352
- [key: string]: unknown;
353
- } | null;
354
- export declare type SitesListV2200ItemsItem = {
355
- /** @nullable */
356
- account_back_ref?: string | null;
357
- account_id?: string;
358
- /** @nullable */
359
- base_domain?: string | null;
360
- /**
361
- * False if site was added by site scanner
362
- * @nullable
363
- */
364
- confirmed?: boolean | null;
365
- /** @nullable */
366
- datacenter?: string | null;
367
- date_added?: string;
368
- date_modified?: string;
369
- detected_type?: string;
370
- /** @nullable */
371
- docpath?: string | null;
372
- /** @nullable */
373
- docroot?: string | null;
374
- /** @nullable */
375
- domain?: string | null;
376
- edge_cache?: boolean;
377
- handler_404?: string;
378
- id?: number;
379
- /** @nullable */
380
- installed_id?: string | null;
381
- /** True if docpath is public_html, otherwise False */
382
- is_primary?: boolean;
383
- /**
384
- * Job ids for the site
385
- * @nullable
386
- */
387
- jobs?: SitesListV2200ItemsItemJobs;
388
- /** @nullable */
389
- last_error?: string | null;
390
- /** @nullable */
391
- migration_id?: string | null;
392
- /** @nullable */
393
- name?: string | null;
394
- /**
395
- * Status of the site's onboarding
396
- * @nullable
397
- */
398
- onboarding?: number | null;
399
- path?: string;
400
- /** @nullable */
401
- pending_url?: string | null;
402
- /** @nullable */
403
- pending_url_data?: SitesListV2200ItemsItemPendingUrlData;
404
- /**
405
- * The Php Version. If unable to determine, it will be NULL
406
- * @nullable
407
- */
408
- php_version?: string | null;
409
- resources?: SitesListV2200ItemsItemResources;
410
- /** @nullable */
411
- staging?: SitesListV2200ItemsItemStaging;
412
- status?: string;
413
- subtype?: string;
414
- type?: string;
415
- /** @nullable */
416
- url?: string | null;
417
- /** @nullable */
418
- url_is_provisional?: boolean | null;
419
- /** @nullable */
420
- version?: string | null;
421
- /**
422
- * The WP Version
423
- * @nullable
424
- */
425
- version_ptr?: string | null;
426
- };
427
- export declare type SitesListV2200 = {
428
- items?: SitesListV2200ItemsItem[];
429
- /** page size */
430
- limit?: number;
431
- /** current page number */
432
- page?: number;
433
- /** total number of pages */
434
- pages?: number;
435
- /** total number of sites returned */
436
- total?: number;
437
- };
438
- export declare type SshKeyV2200 = {
439
- deleted?: number;
440
- key_name?: string;
441
- };
442
- export declare type SshKeyV2Body = {
443
- authorize: boolean;
444
- name: string;
445
- note?: string;
446
- source?: string;
447
- };
448
- export declare type SshKeyListV2200RowsItem = {
449
- key?: string;
450
- mtime?: string;
451
- name?: string;
452
- type?: string;
453
- };
454
- export declare type SshKeyListV2200 = {
455
- rows?: SshKeyListV2200RowsItem[];
456
- };
457
- export declare type SshKeyImportV2200 = {
458
- /** @nullable */
459
- private_key_name?: string | null;
460
- /** @nullable */
461
- public_key_name?: string | null;
462
- };
463
- export declare type SshKeyImportV2Body = {
464
- /** The SSH key's filename */
465
- name: string;
466
- /** A note to log alongside the secure_action_log entry. */
467
- note?: string;
468
- /**
469
- * The SSH key's password. Must be four or more secure characters.
470
- * @minLength 4
471
- */
472
- pass?: string;
473
- /** A Valid SSH private key */
474
- privkey?: string;
475
- /** A Valid SSH public key */
476
- pubkey?: string;
477
- /** The entity that initiated the GAP call */
478
- source?: string;
479
- };
480
- export declare type HostingSiteAddV2200 = {
481
- id?: number;
482
- status?: string;
483
- url?: string;
484
- };
485
- /**
486
- * Datacenter to host site in.
487
- */
488
- export declare type HostingSiteAddV2BodyDatacenter = typeof HostingSiteAddV2BodyDatacenter[keyof typeof HostingSiteAddV2BodyDatacenter];
489
- export declare const HostingSiteAddV2BodyDatacenter: {
490
- readonly 'Amsterdam,_Netherlands': "Amsterdam, Netherlands";
491
- readonly 'Ashburn,_Virginia': "Ashburn, Virginia";
492
- readonly 'Dallas,_Texas': "Dallas, Texas";
493
- readonly 'Los_Angeles,_California': "Los Angeles, California";
494
- };
495
- export declare type HostingSiteAddV2Body = {
496
- /** Admin email for the site user */
497
- admin_email?: string;
498
- /** Admin user for the site */
499
- admin_user?: string;
500
- /** HAL site id to clone */
501
- clone_site_id?: number;
502
- /** Datacenter to host site in. */
503
- datacenter?: HostingSiteAddV2BodyDatacenter;
504
- /** Disk space in GiB */
505
- disk_limit_gib?: number;
506
- /** domain for the site to be added */
507
- domain?: string;
508
- /** flag that causes the domain vhost to be forced to the new docroot */
509
- force_vhost?: boolean;
510
- /** toggle between wordpress/lightweight for non-existent static file */
511
- handler_404?: boolean;
512
- /** Migrate an existing wordpress site */
513
- migration_id?: string;
514
- /** When provided, parent_site_id will be set in the new site's meta to indicate it's a child (staging) site of the parent. */
515
- parent_site_id?: number;
516
- /** Installation Path */
517
- path?: string;
518
- /** Skip domain pointer order */
519
- skip_pointer?: boolean;
520
- /** flag indicating whether this site is for a self serve wp migration or not */
521
- ss_wp_mig?: boolean;
522
- /** Site Subtype */
523
- subtype: string;
524
- /** title of the site to be added */
525
- title?: string;
526
- /** Number of PHP workers */
527
- workers?: number;
528
- };
529
- export declare type HostingSitesV2200 = {
530
- /**
531
- * Remaining number of sites the customer can create. Max sites - used sites. Null means 'unlimited'.
532
- * @nullable
533
- */
534
- available_sites?: number | null;
535
- items?: HostingSitesV2200ItemsItem[];
536
- /** page size */
537
- limit?: number;
538
- /**
539
- * Maximum number of sites the customer can have. Null means 'unlimited'.
540
- * @nullable
541
- */
542
- max_sites?: number | null;
543
- /** current page number */
544
- page?: number;
545
- /** total number of pages */
546
- pages?: number;
547
- /** total number of sites returned */
548
- total?: number;
549
- /** 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. */
550
- used_sites?: number;
551
- };
552
- /**
553
- * @nullable
554
- */
555
- export declare type HostingSitesV2200ItemsItemStaging = {
556
- /**
557
- * Applies to staging site only; The id of the current site's parent site
558
- * @nullable
559
- */
560
- parent_site_id?: number | null;
561
- /**
562
- * Applies to parent site only; The id of the former parent site of the current site
563
- * @nullable
564
- */
565
- promoted_from?: number | null;
566
- /**
567
- * Applies to staging site only; The id of the parent site of the current site that is being promoted
568
- * @nullable
569
- */
570
- promoting_from?: number | null;
571
- /**
572
- * Applies to staging site only; The derived status based on promotion ids and jobs
573
- * @nullable
574
- */
575
- promotion_status?: string | null;
576
- /** A list of staging sites of the current site */
577
- sites?: number[];
578
- } | null;
579
- export declare type HostingSitesV2200ItemsItemResourcesStorage = {
580
- /** @nullable */
581
- available?: number | null;
582
- /** @nullable */
583
- total?: number | null;
584
- unit?: string;
585
- /** @nullable */
586
- used?: number | null;
587
- };
588
- export declare type HostingSitesV2200ItemsItemResources = {
589
- storage?: HostingSitesV2200ItemsItemResourcesStorage;
590
- /** @nullable */
591
- workers?: number | null;
592
- };
593
- /**
594
- * @nullable
595
- */
596
- export declare type HostingSitesV2200ItemsItemPendingUrlData = {
597
- /**
598
- * The root domain name
599
- * @nullable
600
- */
601
- base_domain?: string | null;
602
- /**
603
- * The Fully Qualified Domain Name (FQDN)
604
- * @nullable
605
- */
606
- domain?: string | null;
607
- /**
608
- * The current pending_url's HAL Domain ID
609
- * @nullable
610
- */
611
- domain_id?: number | null;
612
- /** @nullable */
613
- error?: string | null;
614
- /** Flag indicating whether the pending_url is temporary or not */
615
- is_temp?: boolean;
616
- /**
617
- * Flag indicating whether the url_sync job has run out of attempts
618
- * @nullable
619
- */
620
- job_failed?: boolean | null;
621
- /** @nullable */
622
- stage?: string | null;
623
- /**
624
- * Timestamp for when we will update the WP url, regardless of active sessions
625
- * @nullable
626
- */
627
- wp_session?: string | null;
628
- } | null;
629
- /**
630
- * Job ids for the site
631
- * @nullable
632
- */
633
- export declare type HostingSitesV2200ItemsItemJobs = {
634
- [key: string]: unknown;
635
- } | null;
636
- export declare type HostingSitesV2200ItemsItem = {
637
- /** @nullable */
638
- account_back_ref?: string | null;
639
- account_id?: string;
640
- /** @nullable */
641
- base_domain?: string | null;
642
- /**
643
- * False if site was added by site scanner
644
- * @nullable
645
- */
646
- confirmed?: boolean | null;
647
- /** @nullable */
648
- datacenter?: string | null;
649
- date_added?: string;
650
- date_modified?: string;
651
- detected_type?: string;
652
- /** @nullable */
653
- docpath?: string | null;
654
- /** @nullable */
655
- docroot?: string | null;
656
- /** @nullable */
657
- domain?: string | null;
658
- edge_cache?: boolean;
659
- handler_404?: string;
660
- id?: number;
661
- /** @nullable */
662
- installed_id?: string | null;
663
- /** True if docpath is public_html, otherwise False */
664
- is_primary?: boolean;
665
- /**
666
- * Job ids for the site
667
- * @nullable
668
- */
669
- jobs?: HostingSitesV2200ItemsItemJobs;
670
- /** @nullable */
671
- last_error?: string | null;
672
- /** @nullable */
673
- migration_id?: string | null;
674
- /** @nullable */
675
- name?: string | null;
676
- /**
677
- * Status of the site's onboarding
678
- * @nullable
679
- */
680
- onboarding?: number | null;
681
- path?: string;
682
- /** @nullable */
683
- pending_url?: string | null;
684
- /** @nullable */
685
- pending_url_data?: HostingSitesV2200ItemsItemPendingUrlData;
686
- /**
687
- * The Php Version. If unable to determine, it will be NULL
688
- * @nullable
689
- */
690
- php_version?: string | null;
691
- resources?: HostingSitesV2200ItemsItemResources;
692
- /** @nullable */
693
- staging?: HostingSitesV2200ItemsItemStaging;
694
- status?: string;
695
- subtype?: string;
696
- type?: string;
697
- /** @nullable */
698
- url?: string | null;
699
- /** @nullable */
700
- url_is_provisional?: boolean | null;
701
- /** @nullable */
702
- version?: string | null;
703
- /**
704
- * The WP Version
705
- * @nullable
706
- */
707
- version_ptr?: string | null;
708
- };
709
- export declare type HostingSitesV2Params = {
710
- limit?: number;
711
- page?: number;
712
- /**
713
- * If passed, will only return staging sites of that parent site on this hosting account
714
- */
715
- parent_site_id?: number;
716
- search?: string;
717
- };
718
- export declare type HostingRedirectsV2200Item = {
719
- docroot?: string;
720
- domain?: string;
721
- http_status_code?: number;
722
- redirect_www?: number;
723
- src?: string;
724
- type?: string;
725
- url?: string;
726
- wildcard?: number;
727
- };
728
- export declare type HostingNameserversV2200HostsItem = {
729
- host?: string;
730
- ips?: string[];
731
- };
732
- export declare type HostingNameserversV2200 = {
733
- brand: string;
734
- hosts: HostingNameserversV2200HostsItem[];
735
- id: number;
736
- is_default?: string;
737
- };
738
- export declare type ListFilesV2200FilesItem = {
739
- file?: string;
740
- path?: string;
741
- size?: number;
742
- type?: string;
743
- };
744
- export declare type ListFilesV2200 = {
745
- files?: ListFilesV2200FilesItem[];
746
- };
747
- export declare type ListFilesV2Params = {
748
- dir: string;
749
- showdotfiles?: boolean;
750
- };
751
- export declare type HostingDomainsUnassignV2200 = {
752
- [key: string]: unknown;
753
- };
754
- export declare type HostingDomainsUnassignV2Body = {
755
- /** The domain id to be unassigned */
756
- domain_id: number;
757
- /** The site id to be unassigned */
758
- site_id: number;
759
- };
760
- export declare type DbListV2200DatabasesItemUserlistItem = {
761
- db?: string;
762
- user?: string;
763
- };
764
- export declare type DbListV2200DatabasesItem = {
765
- db?: string;
766
- sitename?: string;
767
- sizemib?: string;
768
- usercount?: number;
769
- userlist?: DbListV2200DatabasesItemUserlistItem[];
770
- };
771
- export declare type DbListV2200 = {
772
- databases?: DbListV2200DatabasesItem[];
773
- };
774
- export declare type BackupStatusV2200 = {
775
- /** @nullable */
776
- backup_download_url?: string | null;
777
- status?: string;
778
- };
779
- export declare type BackupStatusV2Params = {
780
- tracking_id: number;
781
- };
782
- export declare type BackupRestoreV2200 = {
783
- message?: string;
784
- tracking_id?: number;
785
- };
786
- export declare type BackupRestoreV2Body = {
787
- /** Backup Volume store ID to get the backup */
788
- backup_id: string;
789
- dbs?: string[];
790
- /** Restore date */
791
- restore_date: string;
792
- /** Restore type */
793
- restore_type?: string;
794
- /** Site id */
795
- site_id?: number;
796
- };
797
- export declare type BackupListV2200BackupsItem = {
798
- backup_creation_time?: string;
799
- backup_id?: string;
800
- /** @nullable */
801
- databases?: string[] | null;
802
- type?: string;
803
- };
804
- export declare type BackupListV2200 = {
805
- backups?: BackupListV2200BackupsItem[];
806
- };
807
- export declare type BackupDownloadV2200 = {
808
- message?: string;
809
- tracking_id?: number;
810
- };
811
- export declare type BackupDownloadV2Body = {
812
- /** Backup Volume store ID to get the backup */
813
- backup_id: string;
814
- /** Type of the backup */
815
- backup_type?: string;
816
- dbs?: string[];
817
- /** Site id */
818
- site_id?: number;
819
- };
820
- export declare type BackupCreateV2200 = {
821
- message?: string;
822
- tracking_id?: number;
823
- };
824
- export declare type BackupCreateV2Body = {
825
- /** The type of the backup */
826
- backup_type?: string[];
827
- };
828
- export declare type AddonsSitelockSsoV2200 = {
829
- /** @nullable */
830
- site_url?: string | null;
831
- sitelock_id?: string;
832
- url?: string;
833
- };
834
- export declare type AddonsSitelockSsoV2Params = {
835
- /**
836
- * fetch the sso data based on source(fg/hal)
837
- */
838
- source?: string;
839
- };
840
- export declare type SiteAddonWpsolution400 = {
841
- error?: string;
842
- };
843
- export declare type SiteAddonWpsolution200 = {
844
- [key: string]: unknown;
845
- };
846
- /**
847
- * wpsolution addon subtype
848
- */
849
- export declare type SiteAddonWpsolutionBodySubtype = typeof SiteAddonWpsolutionBodySubtype[keyof typeof SiteAddonWpsolutionBodySubtype];
850
- export declare const SiteAddonWpsolutionBodySubtype: {
851
- readonly creator: "creator";
852
- readonly commerce: "commerce";
853
- };
854
- export declare type SiteAddonWpsolutionBody = {
855
- /** wpsolution product instance id */
856
- prod_inst_id: string;
857
- /** wpsolution addon subtype */
858
- subtype: SiteAddonWpsolutionBodySubtype;
859
- };
860
- export declare type SitesVersion200 = {
861
- current?: string;
862
- latest?: string;
863
- update?: boolean;
864
- };
865
- export declare type SiteUsers200UsersItemMeta = {
866
- maestro_web_pro?: string;
867
- maestro_wpp_identifier?: string;
868
- };
869
- export declare type SiteUsers200UsersItem = {
870
- display_name?: string;
871
- id: number;
872
- meta?: SiteUsers200UsersItemMeta;
873
- post_count?: number;
874
- role: string;
875
- user_email: string;
876
- user_id: number;
877
- user_login: string;
878
- user_nicename: string;
879
- };
880
- export declare type SiteUsers200 = {
881
- users: SiteUsers200UsersItem[];
882
- };
883
- export declare type SiteStatus200 = {
884
- /** @nullable */
885
- cloudflare_ready?: boolean | null;
886
- pending_url?: string;
887
- url?: string;
888
- };
889
- export declare type StagingSitePromote409DetailsLimitsItem = {
890
- /**
891
- * Respective limit that exceeded.
892
- * @nullable
893
- */
894
- limit?: string | null;
895
- /**
896
- * maximum limit allowed.
897
- * @nullable
898
- */
899
- max?: string | null;
900
- /**
901
- * site Id where the respective limit is exceeded.
902
- * @nullable
903
- */
904
- site_id?: string | null;
905
- /**
906
- * Type of limit exceeded.
907
- * @nullable
908
- */
909
- type?: string | null;
910
- /**
911
- * current usage.
912
- * @nullable
913
- */
914
- used?: number | null;
915
- };
916
- /**
917
- * @nullable
918
- */
919
- export declare type StagingSitePromote409Details = {
920
- limits?: StagingSitePromote409DetailsLimitsItem[];
921
- } | null;
922
- export declare type StagingSitePromote409 = {
923
- /** @nullable */
924
- details?: StagingSitePromote409Details;
925
- /** @nullable */
926
- error?: string | null;
927
- };
928
- export declare type StagingSitePromote200 = {
929
- /** @nullable */
930
- job_id?: number | null;
931
- };
932
- export declare type StagingSitePromoteBody = {
933
- /** Will only run site promote validation checks in hal if passed as true */
934
- validate_only?: boolean;
935
- };
936
- export declare type SitesSso200OtherItem = {
937
- added?: string;
938
- addon_id?: number;
939
- domain?: string;
940
- subtype?: string;
941
- type?: string;
942
- };
943
- export declare type SitesSso200 = {
944
- /** @nullable */
945
- other?: SitesSso200OtherItem[] | null;
946
- /** @nullable */
947
- sso?: string | null;
948
- /** @nullable */
949
- type?: string | null;
950
- };
951
- export declare type SitesSsoBounceName = typeof SitesSsoBounceName[keyof typeof SitesSsoBounceName];
952
- export declare const SitesSsoBounceName: {
953
- readonly jetpackbackup: "jetpackbackup";
954
- readonly jetpackdashboard: "jetpackdashboard";
955
- readonly staging: "staging";
956
- readonly updatecore: "updatecore";
957
- readonly password: "password";
958
- readonly profile: "profile";
959
- readonly plugins: "plugins";
960
- readonly themes: "themes";
961
- readonly phpmyadmin: "phpmyadmin";
962
- readonly filemanager: "filemanager";
963
- readonly store: "store";
964
- readonly wpmigration: "wpmigration";
965
- readonly mypluginsandtools: "mypluginsandtools";
966
- };
967
- export declare type SitesSsoParams = {
968
- addon_id?: string;
969
- bounce_name?: SitesSsoBounceName;
970
- user_email?: string;
971
- user_id?: string;
972
- };
973
- export declare type SitesSsl200 = {
974
- domain?: string;
975
- domain_dns_status?: string;
976
- /** @nullable */
977
- expiration?: string | null;
978
- /** @nullable */
979
- issuer?: string | null;
980
- /** @nullable */
981
- product?: string | null;
982
- /** @nullable */
983
- provider?: string | null;
984
- status?: string;
985
- /** @nullable */
986
- type?: string | null;
987
- upgradeable?: boolean;
988
- };
989
- export declare type SitesSshUserUpdate200 = {
990
- [key: string]: unknown;
991
- };
992
- export declare type SitesSshUserUpdateBody = {
993
- /** optional flag to generate public key */
994
- generate_pubkey?: boolean;
995
- /** optional password */
996
- pass?: string;
997
- /** optional public key */
998
- pubkey?: string;
999
- /** username of user */
1000
- ssh_user: string;
1001
- };
1002
- export declare type SitesSshUserDelete200 = {
1003
- [key: string]: unknown;
1004
- };
1005
- export declare type SitesSshUserDeleteBody = {
1006
- /** Tenant Public Key ID. Optional for non-global and required for global user. If supplied with ssh username for a global user, this attribute takes priority over ssh username and deletes by public key id. */
1007
- public_key_id?: number;
1008
- /** SSH User Name. Optional for global user and required for non-global user. */
1009
- ssh_user?: string;
1010
- };
1011
- export declare type SitesSshUserCreate200 = {
1012
- /**
1013
- * optional private key
1014
- * @nullable
1015
- */
1016
- private_key?: string | null;
1017
- /**
1018
- * optional public key
1019
- * @nullable
1020
- */
1021
- public_key?: string | null;
1022
- /**
1023
- * global site public key id
1024
- * @nullable
1025
- */
1026
- public_key_id?: number | null;
1027
- };
1028
- export declare type SitesSshUserCreateBody = {
1029
- /** optional auto-generate key pair flag */
1030
- generate_pubkey?: boolean;
1031
- /** Pass as true to create as a global public key */
1032
- is_global?: boolean;
1033
- /** optional password */
1034
- pass?: string;
1035
- /** optional public key */
1036
- pubkey?: string;
1037
- /** username of user */
1038
- ssh_user: string;
1039
- };
1040
- export declare type SitesSshUserList200 = {
1041
- users?: string[];
1042
- };
1043
- export declare type SitesSettingsPhpVersions200 = {
1044
- default?: string;
1045
- deprecated?: string[];
1046
- latest?: string;
1047
- versions?: string[];
1048
- };
1049
- export declare type SitesSettingsPhpVersionUpdate200 = {
1050
- success?: number;
1051
- };
1052
- export declare type SitesSettingsPhpVersionUpdateBody = {
1053
- force?: boolean;
1054
- /**
1055
- * The version should match the pattern i.e. PHP 8.0
1056
- * @pattern ^(PHP) ([0-9]+.[0-9])$
1057
- */
1058
- php_version: string;
1059
- };
1060
- export declare type SitesSettingsDebugToggle200 = {
1061
- success?: number;
1062
- };
1063
- export declare type SitesSettingsDebugToggleBody = {
1064
- enable?: boolean;
1065
- };
1066
- export declare type SitesSettingsDebug200 = {
1067
- status?: number;
1068
- };
1069
- export declare type SitesSettingsComingSoonToggle200 = {
1070
- success?: number;
1071
- };
1072
- export declare type SitesSettingsComingSoonToggleBody = {
1073
- enable?: boolean;
1074
- };
1075
- export declare type SitesSettingsComingSoon200 = {
1076
- enable?: boolean;
1077
- };
1078
- export declare type SitesSecuritySslStatus200 = {
1079
- domain?: string;
1080
- message?: string;
1081
- product?: string;
1082
- provider?: string;
1083
- ssl_status?: string;
1084
- upgradeable?: boolean;
1085
- };
1086
- export declare type SitesSecuritySslStatusParams = {
1087
- /**
1088
- * scans hal domains to get updated ssl information
1089
- */
1090
- domain_scan?: boolean;
1091
- };
1092
- export declare type SitesSecuritySslAcme200 = {
1093
- message?: string;
1094
- success?: number;
1095
- };
1096
- export declare type SitesSecuritySitelock200 = {
1097
- /** @nullable */
1098
- addon_id?: number | null;
1099
- /** @nullable */
1100
- billing_code?: string | null;
1101
- /** @nullable */
1102
- domain_name?: string | null;
1103
- domains?: string[];
1104
- /** @nullable */
1105
- has_cdn?: boolean | null;
1106
- is_migrated?: boolean;
1107
- message?: string;
1108
- /** @nullable */
1109
- plan?: string | null;
1110
- /** @nullable */
1111
- platform_id?: string | null;
1112
- /**
1113
- * Sitelock can be attached directly to a site, or it will fallback and return the sitelock for entire hosting account
1114
- * @nullable
1115
- */
1116
- scope?: string | null;
1117
- /** @nullable */
1118
- source?: string | null;
1119
- success?: number;
1120
- upgrade_levels?: string[];
1121
- };
1122
- export declare type SitesSecuritySitelockSource = typeof SitesSecuritySitelockSource[keyof typeof SitesSecuritySitelockSource];
1123
- export declare const SitesSecuritySitelockSource: {
1124
- readonly hal: "hal";
1125
- readonly fg: "fg";
1126
- readonly halfg: "halfg";
1127
- };
1128
- export declare type SitesSecuritySitelockParams = {
1129
- /**
1130
- * fetch the sitelock data based on source(fg/hal)
1131
- */
1132
- source?: SitesSecuritySitelockSource;
1133
- };
1134
- export declare type SitesSecurityHttpsEnableDisableSsl200 = {
1135
- message?: string;
1136
- redirection_status?: number;
1137
- success?: number;
1138
- };
1139
- export declare type SitesSecurityHttpsEnableDisableSslBody = {
1140
- /** enable or disable */
1141
- forced_redirection?: string;
1142
- };
1143
- export declare type SitesSecurityHttpsRedirectionStatus200 = {
1144
- message?: string;
1145
- redirection_status?: number;
1146
- success?: number;
1147
- };
1148
- export declare type SitesSecurityResetCoreFiles200 = {
1149
- results?: string;
1150
- success?: number;
1151
- };
1152
- export declare type SitesSecurityCheckCore200 = {
1153
- results?: string;
1154
- success?: number;
1155
- };
1156
- export declare type SitesSecurityBundle200 = {
1157
- eligible?: boolean;
1158
- };
1159
- export declare type ResetSite200 = {
1160
- previous_status: string;
1161
- status: string;
1162
- };
1163
- export declare type ResetSiteBody = {
1164
- /** Site subtype to morph to */
1165
- subtype?: string;
1166
- /** Site type to morph to */
1167
- type?: string;
1168
- };
1169
- export declare type SiteQualityMetrics200OriginLoadingExperience = {
1170
- [key: string]: unknown;
1171
- };
1172
- export declare type SiteQualityMetrics200LoadingExperience = {
1173
- [key: string]: unknown;
1174
- };
1175
- export declare type SiteQualityMetrics200Audits = {
1176
- [key: string]: unknown;
1177
- };
1178
- export declare type SiteQualityMetrics200AspectScores = {
1179
- accessibility?: number;
1180
- 'best-practices'?: number;
1181
- performance?: number;
1182
- seo?: number;
1183
- };
1184
- export declare type SiteQualityMetrics200AspectDetails = {
1185
- performance?: SiteQualityMetrics200AspectDetailsPerformance;
1186
- };
1187
- export declare type SiteQualityMetrics200 = {
1188
- aspect_details: SiteQualityMetrics200AspectDetails;
1189
- aspect_scores: SiteQualityMetrics200AspectScores;
1190
- audits: SiteQualityMetrics200Audits;
1191
- loading_experience?: SiteQualityMetrics200LoadingExperience;
1192
- origin_loading_experience?: SiteQualityMetrics200OriginLoadingExperience;
1193
- strategy?: string;
1194
- };
1195
- export declare type SiteQualityMetrics200AspectDetailsPerformanceTotalBlockingTime = {
1196
- [key: string]: unknown;
1197
- };
1198
- export declare type SiteQualityMetrics200AspectDetailsPerformanceSpeedIndex = {
1199
- [key: string]: unknown;
1200
- };
1201
- export declare type SiteQualityMetrics200AspectDetailsPerformanceLargestContentfulPaint = {
1202
- [key: string]: unknown;
1203
- };
1204
- export declare type SiteQualityMetrics200AspectDetailsPerformanceFirstContentfulPaint = {
1205
- [key: string]: unknown;
1206
- };
1207
- export declare type SiteQualityMetrics200AspectDetailsPerformanceCumulativeLayoutShift = {
1208
- [key: string]: unknown;
1209
- };
1210
- export declare type SiteQualityMetrics200AspectDetailsPerformance = {
1211
- 'cumulative-layout-shift'?: SiteQualityMetrics200AspectDetailsPerformanceCumulativeLayoutShift;
1212
- 'first-contentful-paint'?: SiteQualityMetrics200AspectDetailsPerformanceFirstContentfulPaint;
1213
- 'largest-contentful-paint'?: SiteQualityMetrics200AspectDetailsPerformanceLargestContentfulPaint;
1214
- 'speed-index'?: SiteQualityMetrics200AspectDetailsPerformanceSpeedIndex;
1215
- 'total-blocking-time'?: SiteQualityMetrics200AspectDetailsPerformanceTotalBlockingTime;
1216
- };
1217
- export declare type SiteQualityMetricsStrategy = typeof SiteQualityMetricsStrategy[keyof typeof SiteQualityMetricsStrategy];
1218
- export declare const SiteQualityMetricsStrategy: {
1219
- readonly MOBILE: "MOBILE";
1220
- readonly DESKTOP: "DESKTOP";
1221
- readonly STRATEGY_UNSPECIFIED: "STRATEGY_UNSPECIFIED";
1222
- };
1223
- export declare type SiteQualityMetricsParams = {
1224
- strategy: SiteQualityMetricsStrategy;
1225
- };
1226
- export declare type SitePluginsUpdate200 = {
1227
- success: boolean;
1228
- };
1229
- export declare type SitePluginsUpdateBody = {
1230
- /** The plugin id */
1231
- id: string;
1232
- };
1233
- export declare type SitePluginsToggle200 = {
1234
- success: boolean;
1235
- };
1236
- export declare type SitePluginsToggleBody = {
1237
- /** activate or deactivate the plugin */
1238
- activate: boolean;
1239
- /** The plugin id */
1240
- id: string;
1241
- };
1242
- export declare type SitePluginsAutoupdate200 = {
1243
- success: boolean;
1244
- };
1245
- export declare type SitePluginsAutoupdateBody = {
1246
- enable: boolean;
1247
- };
1248
- export declare type SitePluginUpdate200 = {
1249
- id: string;
1250
- status: string;
1251
- };
1252
- export declare type SitePluginUpdateBody = {
1253
- /** activate or deactivate the plugin */
1254
- activate: boolean;
1255
- /** The plugin id */
1256
- id: string;
1257
- };
1258
- export declare type SitePlugins200PluginsItem = {
1259
- id: string;
1260
- status: string;
1261
- title: string;
1262
- update: boolean;
1263
- version?: string;
1264
- };
1265
- export declare type SitePlugins200 = {
1266
- auto_update: boolean;
1267
- plugins: SitePlugins200PluginsItem[];
1268
- subtype: string;
1269
- };
1270
- export declare type SitePluginsParams = {
1271
- plugin_id?: string;
1272
- };
1273
- export declare type CreatePhpInfo200 = {
1274
- /** html file content */
1275
- html?: string;
1276
- };
1277
- export declare type SitesPerformanceEndurancePageCache200 = {
1278
- result?: string;
1279
- status?: string;
1280
- };
1281
- export declare type SitesPerformanceEnduranceCacheLevel200Options = {
1282
- [key: string]: unknown;
1283
- };
1284
- export declare type SitesPerformanceEnduranceCacheLevel200 = {
1285
- options?: SitesPerformanceEnduranceCacheLevel200Options;
1286
- };
1287
- export declare type SitesPerformanceEnduranceCacheLevelBody = {
1288
- /** @maximum 3 */
1289
- endurance_cache_level?: number;
1290
- };
1291
- export declare type SitesPerformanceEnduranceCacheLevelStatus200 = {
1292
- endurance_cache_level?: number;
1293
- };
1294
- export declare type SitesPerformanceEdgecache200 = {
1295
- [key: string]: unknown;
1296
- };
1297
- export declare type SitesPerformanceEdgecacheBody = {
1298
- /** Pass either 0 or 1 */
1299
- edge_cache: number;
1300
- };
1301
- export declare type SitesPerformanceCachepurge200 = {
1302
- success?: boolean;
1303
- };
1304
- export declare type SitesPerformanceCachepurgeBody = {
1305
- /** */
1306
- assets?: string[];
1307
- /** Pass either 0, basic, premium, india or hostgator */
1308
- cf?: string;
1309
- /** Pass either 0 or 1 */
1310
- epc?: number;
1311
- /** */
1312
- hosts: string[];
1313
- };
1314
- export declare type SitePendingDomainDelete200 = {
1315
- [key: string]: unknown;
1316
- };
1317
- export declare type SitesMetricDimensions200 = {
1318
- date_end?: string;
1319
- date_start?: string;
1320
- dimensions?: SitesMetricDimensions200Dimensions;
1321
- elapsed?: number;
1322
- metric?: string;
1323
- };
1324
- export declare type SitesMetricDimensions200DimensionsWpAdminAjaxActionItemDimension = {
1325
- [key: string]: number;
1326
- };
1327
- export declare type SitesMetricDimensions200DimensionsWpAdminAjaxActionItem = {
1328
- dimension?: SitesMetricDimensions200DimensionsWpAdminAjaxActionItemDimension;
1329
- timestamp?: number;
1330
- };
1331
- export declare type SitesMetricDimensions200DimensionsVisitorIsCrawlerItemDimension = {
1332
- [key: string]: number;
1333
- };
1334
- export declare type SitesMetricDimensions200DimensionsVisitorIsCrawlerItem = {
1335
- dimension?: SitesMetricDimensions200DimensionsVisitorIsCrawlerItemDimension;
1336
- timestamp?: number;
1337
- };
1338
- export declare type SitesMetricDimensions200DimensionsVisitorCountryCodeItemDimension = {
1339
- [key: string]: number;
1340
- };
1341
- export declare type SitesMetricDimensions200DimensionsVisitorCountryCodeItem = {
1342
- dimension?: SitesMetricDimensions200DimensionsVisitorCountryCodeItemDimension;
1343
- timestamp?: number;
1344
- };
1345
- export declare type SitesMetricDimensions200DimensionsVisitorAsnItemDimension = {
1346
- [key: string]: number;
1347
- };
1348
- export declare type SitesMetricDimensions200DimensionsVisitorAsnItem = {
1349
- dimension?: SitesMetricDimensions200DimensionsVisitorAsnItemDimension;
1350
- timestamp?: number;
1351
- };
1352
- export declare type SitesMetricDimensions200DimensionsPageRendererItemDimension = {
1353
- [key: string]: number;
1354
- };
1355
- export declare type SitesMetricDimensions200DimensionsPageRendererItem = {
1356
- dimension?: SitesMetricDimensions200DimensionsPageRendererItemDimension;
1357
- timestamp?: number;
1358
- };
1359
- export declare type SitesMetricDimensions200DimensionsPageIsCachedItemDimension = {
1360
- [key: string]: number;
1361
- };
1362
- export declare type SitesMetricDimensions200DimensionsPageIsCachedItem = {
1363
- dimension?: SitesMetricDimensions200DimensionsPageIsCachedItemDimension;
1364
- timestamp?: number;
1365
- };
1366
- export declare type SitesMetricDimensions200DimensionsHttpVersionItemDimension = {
1367
- [key: string]: number;
1368
- };
1369
- export declare type SitesMetricDimensions200DimensionsHttpVersionItem = {
1370
- dimension?: SitesMetricDimensions200DimensionsHttpVersionItemDimension;
1371
- timestamp?: number;
1372
- };
1373
- export declare type SitesMetricDimensions200DimensionsHttpVerbItemDimension = {
1374
- [key: string]: number;
1375
- };
1376
- export declare type SitesMetricDimensions200DimensionsHttpVerbItem = {
1377
- dimension?: SitesMetricDimensions200DimensionsHttpVerbItemDimension;
1378
- timestamp?: number;
1379
- };
1380
- export declare type SitesMetricDimensions200DimensionsHttpStatusItemDimension = {
1381
- [key: string]: number;
1382
- };
1383
- export declare type SitesMetricDimensions200DimensionsHttpStatusItem = {
1384
- dimension?: SitesMetricDimensions200DimensionsHttpStatusItemDimension;
1385
- timestamp?: number;
1386
- };
1387
- export declare type SitesMetricDimensions200DimensionsHttpHostItemDimension = {
1388
- [key: string]: number;
1389
- };
1390
- export declare type SitesMetricDimensions200DimensionsHttpHostItem = {
1391
- dimension?: SitesMetricDimensions200DimensionsHttpHostItemDimension;
1392
- timestamp?: number;
1393
- };
1394
- export declare type SitesMetricDimensions200Dimensions = {
1395
- http_host?: SitesMetricDimensions200DimensionsHttpHostItem[];
1396
- http_status?: SitesMetricDimensions200DimensionsHttpStatusItem[];
1397
- http_verb?: SitesMetricDimensions200DimensionsHttpVerbItem[];
1398
- http_version?: SitesMetricDimensions200DimensionsHttpVersionItem[];
1399
- page_is_cached?: SitesMetricDimensions200DimensionsPageIsCachedItem[];
1400
- page_renderer?: SitesMetricDimensions200DimensionsPageRendererItem[];
1401
- visitor_asn?: SitesMetricDimensions200DimensionsVisitorAsnItem[];
1402
- visitor_country_code?: SitesMetricDimensions200DimensionsVisitorCountryCodeItem[];
1403
- visitor_is_crawler?: SitesMetricDimensions200DimensionsVisitorIsCrawlerItem[];
1404
- wp_admin_ajax_action?: SitesMetricDimensions200DimensionsWpAdminAjaxActionItem[];
1405
- };
1406
- export declare type SitesMetricDimensionsParams = {
1407
- start?: string;
1408
- end?: string;
1409
- };
1410
- export declare type SitesMetricsDimensionAveraged200Metrics = {
1411
- requests_persec?: number[];
1412
- response_bytes_average?: number[];
1413
- response_bytes_persec?: number[];
1414
- response_time_average?: number[];
1415
- };
1416
- export declare type SitesMetricsDimensionAveraged200 = {
1417
- date_end?: string;
1418
- date_start?: string;
1419
- dimension?: string;
1420
- elapsed?: number;
1421
- metrics?: SitesMetricsDimensionAveraged200Metrics;
1422
- unit?: string;
1423
- };
1424
- export declare type SitesMetricsDimensionAveragedParams = {
1425
- start?: string;
1426
- end?: string;
1427
- };
1428
- export declare type SiteMalwareStatus200 = {
1429
- /**
1430
- * malware status given by jetpack protect addon
1431
- * @nullable
1432
- */
1433
- malware_status?: string | null;
1434
- /**
1435
- * scanner state
1436
- * @nullable
1437
- */
1438
- scanner_state?: string | null;
1439
- };
1440
- export declare type SitesErrorLogsDownloadSort = typeof SitesErrorLogsDownloadSort[keyof typeof SitesErrorLogsDownloadSort];
1441
- export declare const SitesErrorLogsDownloadSort: {
1442
- readonly asc: "asc";
1443
- readonly desc: "desc";
1444
- };
1445
- export declare type SitesErrorLogsDownloadParams = {
1446
- /**
1447
- * Start time. Can be a unix time, a timestamp, or a {n}[dhm] format. Default is -1 day.
1448
- */
1449
- start?: string;
1450
- /**
1451
- * End time. Can be a unix time, a timestamp, now, or a {n}[dhm] format. Default is now.
1452
- */
1453
- end?: string;
1454
- sort?: SitesErrorLogsDownloadSort;
1455
- /**
1456
- * Items to filter on. Supported filters include: severity
1457
- */
1458
- filter?: {
1459
- severity?: string[];
1460
- };
1461
- };
1462
- export declare type SitesErrorLogs200LogsItem = {
1463
- datetime?: string;
1464
- epoch?: number;
1465
- file?: string;
1466
- kind?: string;
1467
- line?: number;
1468
- message?: string;
1469
- name?: string;
1470
- severity?: string;
1471
- };
1472
- export declare type SitesErrorLogs200 = {
1473
- datetime_end?: string;
1474
- datetime_start?: string;
1475
- logs?: SitesErrorLogs200LogsItem[];
1476
- /** @nullable */
1477
- page_id?: string | null;
1478
- total?: number;
1479
- };
1480
- export declare type SitesErrorLogsSort = typeof SitesErrorLogsSort[keyof typeof SitesErrorLogsSort];
1481
- export declare const SitesErrorLogsSort: {
1482
- readonly asc: "asc";
1483
- readonly desc: "desc";
1484
- };
1485
- export declare type SitesErrorLogsParams = {
1486
- /**
1487
- * Start time. Can be a unix time, a timestamp, or a {n}[dhm] format. Default is -1 day.
1488
- */
1489
- start?: string;
1490
- /**
1491
- * End time. Can be a unix time, a timestamp, now, or a {n}[dhm] format. Default is now.
1492
- */
1493
- end?: string;
1494
- /**
1495
- * max number of logs to return (default: 25)
1496
- */
1497
- limit?: number;
1498
- page_id?: string;
1499
- sort?: SitesErrorLogsSort;
1500
- /**
1501
- * Items to filter on. Supported filters include: severity
1502
- */
1503
- filter?: {
1504
- severity?: string[];
1505
- };
1506
- };
1507
- export declare type SitesAccessLogsDownloadSort = typeof SitesAccessLogsDownloadSort[keyof typeof SitesAccessLogsDownloadSort];
1508
- export declare const SitesAccessLogsDownloadSort: {
1509
- readonly asc: "asc";
1510
- readonly desc: "desc";
1511
- };
1512
- export declare type SitesAccessLogsDownloadParams = {
1513
- /**
1514
- * Start time. Can be a unix time, a timestamp, or a {n}[dhm] format.
1515
- */
1516
- start?: string;
1517
- /**
1518
- * End time. Can be a unix time, a timestamp, now, or a {n}[dhm] format.
1519
- */
1520
- end?: string;
1521
- sort?: SitesAccessLogsDownloadSort;
1522
- /**
1523
- * Items to filter on. Supported filters include: cached, renderer, request_type, status, user_ip
1524
- */
1525
- filter?: {
1526
- cached?: string[];
1527
- renderer?: string[];
1528
- request_type?: string[];
1529
- status?: number[];
1530
- user_ip?: string[];
1531
- };
1532
- };
1533
- export declare type SitesAccessLogs200LogsItem = {
1534
- body_bytes_sent?: number;
1535
- cached?: string;
1536
- datetime?: string;
1537
- epoch?: number;
1538
- http_host?: string;
1539
- http_referrer?: string;
1540
- http_user_agent?: string;
1541
- http_x_forwarded_for?: string;
1542
- renderer?: string;
1543
- request_completion?: string;
1544
- request_time?: number;
1545
- request_type?: string;
1546
- request_url?: string;
1547
- scheme?: string;
1548
- status?: number;
1549
- type?: string;
1550
- user_ip?: string;
1551
- };
1552
- export declare type SitesAccessLogs200 = {
1553
- datetime_end?: string;
1554
- datetime_start?: string;
1555
- logs?: SitesAccessLogs200LogsItem[];
1556
- /** @nullable */
1557
- page_id?: string | null;
1558
- total?: number;
1559
- };
1560
- export declare type SitesAccessLogsSort = typeof SitesAccessLogsSort[keyof typeof SitesAccessLogsSort];
1561
- export declare const SitesAccessLogsSort: {
1562
- readonly asc: "asc";
1563
- readonly desc: "desc";
1564
- };
1565
- export declare type SitesAccessLogsParams = {
1566
- /**
1567
- * Start time. Can be a unix time, a timestamp, or a {n}[dhm] format.
1568
- */
1569
- start?: string;
1570
- /**
1571
- * End time. Can be a unix time, a timestamp, now, or a {n}[dhm] format.
1572
- */
1573
- end?: string;
1574
- /**
1575
- * max number of logs to return (default: 25)
1576
- */
1577
- limit?: number;
1578
- page_id?: string;
1579
- sort?: SitesAccessLogsSort;
1580
- /**
1581
- * Items to filter on. Supported filters include: cached, renderer, request_type, status, user_ip
1582
- */
1583
- filter?: {
1584
- cached?: string[];
1585
- renderer?: string[];
1586
- request_type?: string[];
1587
- status?: number[];
1588
- user_ip?: string[];
1589
- };
1590
- };
1591
- export declare type AddSiteIpaddress200 = {
1592
- success?: number;
1593
- };
1594
- export declare type AddSiteIpaddressBody = {
1595
- /** ip to block for the site */
1596
- blocked_ip: string;
1597
- };
1598
- export declare type SiteIpaddress200 = {
1599
- success?: number;
1600
- };
1601
- export declare type SiteIpaddressBody = {
1602
- /** ip to block for the site */
1603
- blocked_ip: string;
1604
- };
1605
- export declare type SiteIpaddressList200Item = {
1606
- beginning_ip?: string;
1607
- ending_ip?: string;
1608
- server_setting?: string;
1609
- };
1610
- export declare type ErrorPagesDelete200 = {
1611
- [key: string]: unknown;
1612
- };
1613
- export declare type ErrorPagesDeleteBody = {
1614
- /** Error code */
1615
- error_code: string;
1616
- };
1617
- export declare type ErrorPagesAdd200 = {
1618
- [key: string]: unknown;
1619
- };
1620
- export declare type ErrorPagesAddBody = {
1621
- /** Error code */
1622
- error_code: string;
1623
- /** Html content */
1624
- html_content: string;
1625
- };
1626
- export declare type ErrorPagesFetch200 = {
1627
- /** Error page file path */
1628
- error_page?: string;
1629
- /** Html content */
1630
- html_content?: string;
1631
- };
1632
- export declare type ErrorPagesFetchParams = {
1633
- /**
1634
- * Error code
1635
- */
1636
- error_code: string;
1637
- };
1638
- export declare type SitesDomainsCreate200 = {
1639
- id?: number;
1640
- status?: string;
1641
- };
1642
- export declare type SitesDomainsCreateBody = {
1643
- /** The new domain to be added */
1644
- domain: string;
1645
- /** Forces the domain to be reassigned to the new docroot if true */
1646
- force_vhost?: boolean;
1647
- };
1648
- export declare type SitesDomainUrl200 = {
1649
- success?: boolean;
1650
- };
1651
- export declare type SitesDomainUrlBody = {
1652
- force?: boolean;
1653
- /** Option to create the temporary domain */
1654
- temp_domain?: boolean;
1655
- /** Optional to unassign the domain after switching to temporary domain */
1656
- unassign_domain?: boolean;
1657
- /** URL of the site to be updated */
1658
- url?: string;
1659
- };
1660
- export declare type SitesDomain200Wanted = {
1661
- a?: string[];
1662
- ns?: string[];
1663
- };
1664
- export declare type SitesDomain200Detected = {
1665
- a?: string[];
1666
- ns?: string[];
1667
- };
1668
- export declare type SitesDomain200 = {
1669
- a_match?: boolean;
1670
- connected?: boolean;
1671
- detected?: SitesDomain200Detected;
1672
- /** @nullable */
1673
- is_internal?: boolean | null;
1674
- nameserver_match?: boolean;
1675
- wanted?: SitesDomain200Wanted;
1676
- };
1677
- export declare type SitesDomainParams = {
1678
- domain?: string;
1679
- };
1680
- export declare type SitesDns200RecordsItem = {
1681
- name?: string;
1682
- type?: string;
1683
- value?: string;
1684
- };
1685
- export declare type SitesDns200 = {
1686
- records?: SitesDns200RecordsItem[];
1687
- source?: string;
1688
- success?: boolean;
1689
- };
1690
- export declare type SitesDnsParams = {
1691
- type?: string;
1692
- };
1693
- export declare type SitesDatabasePasswordsync200 = {
1694
- [key: string]: unknown;
1695
- };
1696
- export declare type SitesDatabaseInfo200 = {
1697
- /** @nullable */
1698
- charset?: string | null;
1699
- /** @nullable */
1700
- collation?: string | null;
1701
- };
1702
- export declare type SiteAddonCloudflare400 = {
1703
- error?: string;
1704
- };
1705
- export declare type SiteAddonCloudflare200 = {
1706
- addon_id?: number;
1707
- };
1708
- export declare type BackupsJetpackBackup200 = {
1709
- [key: string]: unknown;
1710
- };
1711
- export declare type JetpackBackupStatus200 = {
1712
- /** @nullable */
1713
- addon_back_reference?: string | null;
1714
- addon_exists?: boolean;
1715
- /** @nullable */
1716
- addon_id?: string | null;
1717
- can_upgrade?: boolean;
1718
- has_active_addon?: boolean;
1719
- has_active_plugin?: boolean;
1720
- /** @nullable */
1721
- next_url?: string | null;
1722
- pending_upgrade?: boolean;
1723
- /** @nullable */
1724
- plan_name?: string | null;
1725
- plugin_exists?: boolean;
1726
- /** @nullable */
1727
- status?: string | null;
1728
- };
1729
- export declare type SitesBackupsDetails200Jetpack = {
1730
- /** @nullable */
1731
- addon_back_reference?: string | null;
1732
- addon_exists?: boolean;
1733
- /** @nullable */
1734
- addon_id?: string | null;
1735
- can_purchase?: boolean;
1736
- can_upgrade?: boolean;
1737
- has_active_addon?: boolean;
1738
- has_active_plugin?: boolean;
1739
- /** @nullable */
1740
- last_backup_date?: string | null;
1741
- /** @nullable */
1742
- next_url?: string | null;
1743
- pending_upgrade?: boolean;
1744
- /** @nullable */
1745
- plan_name?: string | null;
1746
- plugin_exists?: boolean;
1747
- /** @nullable */
1748
- status?: string | null;
1749
- };
1750
- export declare type SitesBackupsDetails200Codeguard = {
1751
- activated?: boolean;
1752
- /** @nullable */
1753
- addon_back_reference?: string | null;
1754
- addon_id?: string;
1755
- can_upgrade?: boolean;
1756
- /** @nullable */
1757
- database_id?: string | null;
1758
- /** @nullable */
1759
- disabled?: boolean | null;
1760
- /** @nullable */
1761
- over_quota?: boolean | null;
1762
- /** @nullable */
1763
- plan_name?: string | null;
1764
- seats_available?: number;
1765
- seats_count?: number;
1766
- status?: boolean;
1767
- /** @nullable */
1768
- url?: string | null;
1769
- /** @nullable */
1770
- website_id?: string | null;
1771
- };
1772
- export declare type SitesBackupsDetails200 = {
1773
- codeguard?: SitesBackupsDetails200Codeguard;
1774
- jetpack?: SitesBackupsDetails200Jetpack;
1775
- };
1776
- export declare type SitesBackupsCodeguard200 = {
1777
- database_id?: number;
1778
- success?: number;
1779
- website_id?: number;
1780
- };
1781
- export declare type SitesHasBackups200 = {
1782
- has_backups?: boolean;
1783
- };
1784
- export declare type SitesBackups200 = {
1785
- has_backups?: boolean;
1786
- };
1787
- /**
1788
- * autoupdate type
1789
- */
1790
- export declare type SitesAutoupdatesUpdateBodyType = typeof SitesAutoupdatesUpdateBodyType[keyof typeof SitesAutoupdatesUpdateBodyType];
1791
- export declare const SitesAutoupdatesUpdateBodyType: {
1792
- readonly core: "core";
1793
- readonly plugins: "plugins";
1794
- readonly themes: "themes";
1795
- };
1796
- export declare type SitesAutoupdatesUpdateBody = {
1797
- /** true to enable, false for disable */
1798
- enabled: boolean;
1799
- /** autoupdate type */
1800
- type: SitesAutoupdatesUpdateBodyType;
1801
- };
1802
- export declare type SitesAtomicMetrics200ViewsLastNDaysItem = {
1803
- hits: number;
1804
- name: string;
1805
- };
1806
- export declare type SitesAtomicMetrics200Views = {
1807
- last_n_days?: SitesAtomicMetrics200ViewsLastNDaysItem[];
1808
- total_hits?: number;
1809
- };
1810
- export declare type SitesAtomicMetrics200 = {
1811
- raw?: SitesAtomicMetrics200Raw;
1812
- views?: SitesAtomicMetrics200Views;
1813
- };
1814
- export declare type SitesAtomicMetrics200RawPeriodsItemDimension = {
1815
- [key: string]: string | number | number;
1816
- };
1817
- export declare type SitesAtomicMetrics200RawPeriodsItem = {
1818
- dimension: SitesAtomicMetrics200RawPeriodsItemDimension;
1819
- timestamp: number;
1820
- };
1821
- export declare type SitesAtomicMetrics200RawMetric = string | string[];
1822
- export declare type SitesAtomicMetrics200RawDimension = string | string[];
1823
- export declare type SitesAtomicMetrics200Raw = {
1824
- date_end?: string;
1825
- date_start?: string;
1826
- dimension?: SitesAtomicMetrics200RawDimension;
1827
- metric?: SitesAtomicMetrics200RawMetric;
1828
- periods?: SitesAtomicMetrics200RawPeriodsItem[];
1829
- resolution?: number;
1830
- };
1831
- export declare type SitesAtomicMetricsParams = {
1832
- metric?: string[];
1833
- dimension?: string[];
1834
- date_start?: string;
1835
- date_end?: string;
1836
- /**
1837
- * Return hits grouped by day instead of raw periods
1838
- */
1839
- daywise?: boolean;
1840
- };
1841
- export declare type Site200 = {
1842
- success: boolean;
1843
- };
1844
- export declare type SiteBody = {
1845
- /** Will only run site delete validation checks in hal if passed as true */
1846
- validate_only?: boolean;
1847
- };
1848
- export declare type SiteUpdate400 = {
1849
- error?: string;
1850
- };
1851
- export declare type SiteUpdate200 = {
1852
- success: boolean;
1853
- };
1854
- /**
1855
- * WP version
1856
- */
1857
- export declare type SiteUpdateBodyVersionPtr = typeof SiteUpdateBodyVersionPtr[keyof typeof SiteUpdateBodyVersionPtr];
1858
- export declare const SiteUpdateBodyVersionPtr: {
1859
- readonly latest: "latest";
1860
- readonly previous: "previous";
1861
- readonly beta: "beta";
1862
- };
1863
- export declare type SiteUpdateBody = {
1864
- /** Disk space in GiB */
1865
- disk_limit_gib?: number;
1866
- /** domain for the site to be added */
1867
- domain?: string;
1868
- /** toggle between wordpress/lightweight for non-existent static file */
1869
- handler_404?: boolean;
1870
- /** Status of the site's onboarding */
1871
- onboarding?: number;
1872
- /** filesystem path that follows the domain in the url */
1873
- path?: string;
1874
- /** Skip FG domain checks for HAL domain */
1875
- skip_fg_checks?: boolean;
1876
- /** title of the site to be updated */
1877
- title?: string;
1878
- /** WP version */
1879
- version_ptr?: SiteUpdateBodyVersionPtr;
1880
- /** Number of PHP workers */
1881
- workers?: number;
1882
- };
1883
- /**
1884
- * @nullable
1885
- */
1886
- export declare type SitesInfo200Staging = {
1887
- /**
1888
- * Applies to staging site only; The id of the current site's parent site
1889
- * @nullable
1890
- */
1891
- parent_site_id?: number | null;
1892
- /**
1893
- * Applies to parent site only; The id of the former parent site of the current site
1894
- * @nullable
1895
- */
1896
- promoted_from?: number | null;
1897
- /**
1898
- * Applies to staging site only; The id of the parent site of the current site that is being promoted
1899
- * @nullable
1900
- */
1901
- promoting_from?: number | null;
1902
- /**
1903
- * Applies to staging site only; The derived status based on promotion ids and jobs
1904
- * @nullable
1905
- */
1906
- promotion_status?: string | null;
1907
- /** A list of staging sites of the current site */
1908
- sites?: number[];
1909
- } | null;
1910
- export declare type SitesInfo200ResourcesStorage = {
1911
- /** @nullable */
1912
- available?: number | null;
1913
- /** @nullable */
1914
- total?: number | null;
1915
- unit?: string;
1916
- /** @nullable */
1917
- used?: number | null;
1918
- };
1919
- export declare type SitesInfo200Resources = {
1920
- storage?: SitesInfo200ResourcesStorage;
1921
- /** @nullable */
1922
- workers?: number | null;
1923
- };
1924
- /**
1925
- * @nullable
1926
- */
1927
- export declare type SitesInfo200PendingUrlData = {
1928
- /**
1929
- * The root domain name
1930
- * @nullable
1931
- */
1932
- base_domain?: string | null;
1933
- /**
1934
- * The Fully Qualified Domain Name (FQDN)
1935
- * @nullable
1936
- */
1937
- domain?: string | null;
1938
- /**
1939
- * The current pending_url's HAL Domain ID
1940
- * @nullable
1941
- */
1942
- domain_id?: number | null;
1943
- /** @nullable */
1944
- error?: string | null;
1945
- /** Flag indicating whether the pending_url is temporary or not */
1946
- is_temp?: boolean;
1947
- /**
1948
- * Flag indicating whether the url_sync job has run out of attempts
1949
- * @nullable
1950
- */
1951
- job_failed?: boolean | null;
1952
- /** @nullable */
1953
- stage?: string | null;
1954
- /**
1955
- * Timestamp for when we will update the WP url, regardless of active sessions
1956
- * @nullable
1957
- */
1958
- wp_session?: string | null;
1959
- } | null;
1960
- /**
1961
- * @nullable
1962
- */
1963
- export declare type SitesInfo200Pagespeed = {
1964
- lastrun?: string;
1965
- performance?: string;
1966
- strategy?: string;
1967
- } | null;
1968
- /**
1969
- * Job ids for the site
1970
- * @nullable
1971
- */
1972
- export declare type SitesInfo200Jobs = {
1973
- [key: string]: unknown;
1974
- } | null;
1975
- export declare type SitesInfo200 = {
1976
- /** @nullable */
1977
- account_back_ref?: string | null;
1978
- account_id?: string;
1979
- /** @nullable */
1980
- base_domain?: string | null;
1981
- /**
1982
- * False if site was added by site scanner
1983
- * @nullable
1984
- */
1985
- confirmed?: boolean | null;
1986
- /** @nullable */
1987
- datacenter?: string | null;
1988
- date_added?: string;
1989
- date_modified?: string;
1990
- detected_type?: string;
1991
- /** @nullable */
1992
- docpath?: string | null;
1993
- /** @nullable */
1994
- docroot?: string | null;
1995
- /** @nullable */
1996
- domain?: string | null;
1997
- edge_cache?: boolean;
1998
- /** @nullable */
1999
- handler_404?: string | null;
2000
- id?: number;
2001
- /** @nullable */
2002
- installed_id?: string | null;
2003
- /** True if docpath is public_html, otherwise False */
2004
- is_primary?: boolean;
2005
- /**
2006
- * Job ids for the site
2007
- * @nullable
2008
- */
2009
- jobs?: SitesInfo200Jobs;
2010
- /** @nullable */
2011
- last_error?: string | null;
2012
- /** @nullable */
2013
- migration_id?: string | null;
2014
- /** @nullable */
2015
- name?: string | null;
2016
- /**
2017
- * Status of the site's onboarding
2018
- * @nullable
2019
- */
2020
- onboarding?: number | null;
2021
- /** @nullable */
2022
- pagespeed?: SitesInfo200Pagespeed;
2023
- path?: string;
2024
- /** @nullable */
2025
- pending_url?: string | null;
2026
- /** @nullable */
2027
- pending_url_data?: SitesInfo200PendingUrlData;
2028
- /**
2029
- * The Php Version. If unable to determine, it will be NULL
2030
- * @nullable
2031
- */
2032
- php_version?: string | null;
2033
- resources?: SitesInfo200Resources;
2034
- /** @nullable */
2035
- staging?: SitesInfo200Staging;
2036
- status?: string;
2037
- subtype?: string;
2038
- type?: string;
2039
- /** @nullable */
2040
- url?: string | null;
2041
- /** @nullable */
2042
- url_is_provisional?: boolean | null;
2043
- /** @nullable */
2044
- version?: string | null;
2045
- /**
2046
- * The WP Version
2047
- * @nullable
2048
- */
2049
- version_ptr?: string | null;
2050
- };
2051
- export declare type HostingVisitors200VisitorsItem = {
2052
- bandwidth?: number;
2053
- hits?: number;
2054
- /** end date */
2055
- interval_end?: string;
2056
- /** start date */
2057
- interval_start?: string;
2058
- unique_visitors?: number;
2059
- visitors?: number;
2060
- };
2061
- export declare type HostingVisitors200 = {
2062
- daily?: HostingVisitors200Daily;
2063
- is_linked_domain?: boolean;
2064
- linked_domain?: string;
2065
- total_bandwidth?: number;
2066
- total_hits?: number;
2067
- total_pages?: number;
2068
- total_unique_visitors?: number;
2069
- total_visitors?: number;
2070
- visitors?: HostingVisitors200VisitorsItem[];
2071
- };
2072
- export declare type HostingVisitors200DailyTotal = {
2073
- total_bandwidth?: number;
2074
- total_hits?: number;
2075
- total_pages?: number;
2076
- total_visitors?: number;
2077
- };
2078
- export declare type HostingVisitors200DailyDataItem = {
2079
- bandwidth?: number;
2080
- date?: string;
2081
- hits?: number;
2082
- interval_end?: string;
2083
- interval_start?: string;
2084
- pages?: number;
2085
- visits?: number;
2086
- };
2087
- export declare type HostingVisitors200Daily = {
2088
- data?: HostingVisitors200DailyDataItem[];
2089
- total?: HostingVisitors200DailyTotal;
2090
- };
2091
- export declare type HostingVisitorsSource = typeof HostingVisitorsSource[keyof typeof HostingVisitorsSource];
2092
- export declare const HostingVisitorsSource: {
2093
- readonly http: "http";
2094
- readonly https: "https";
2095
- readonly combined: "combined";
2096
- };
2097
- export declare type HostingVisitorsInterval = typeof HostingVisitorsInterval[keyof typeof HostingVisitorsInterval];
2098
- export declare const HostingVisitorsInterval: {
2099
- readonly NUMBER_1: 1;
2100
- readonly NUMBER_24: 24;
2101
- };
2102
- export declare type HostingVisitorsParams = {
2103
- interval?: HostingVisitorsInterval;
2104
- source?: HostingVisitorsSource;
2105
- start: string;
2106
- end: string;
2107
- domain: string;
2108
- };
2109
- export declare type Sso200 = {
2110
- url: string;
2111
- };
2112
- export declare type SsoApp = typeof SsoApp[keyof typeof SsoApp];
2113
- export declare const SsoApp: {
2114
- readonly accesslogs: "accesslogs";
2115
- readonly awstats: "awstats";
2116
- readonly cronjobs: "cronjobs";
2117
- readonly domainredirects: "domainredirects";
2118
- readonly directoryprivacy: "directoryprivacy";
2119
- readonly errorlogs: "errorlogs";
2120
- readonly emailaccounts: "emailaccounts";
2121
- readonly emailforwarders: "emailforwarders";
2122
- readonly emailfilters: "emailfilters";
2123
- readonly emailglobalfilters: "emailglobalfilters";
2124
- readonly emailspamfilters: "emailspamfilters";
2125
- readonly emailautoresponders: "emailautoresponders";
2126
- readonly emailrouting: "emailrouting";
2127
- readonly ftp: "ftp";
2128
- readonly filemanager: "filemanager";
2129
- readonly ipblocker: "ipblocker";
2130
- readonly indexmanager: "indexmanager";
2131
- readonly mysql: "mysql";
2132
- readonly phpmyadmin: "phpmyadmin";
2133
- readonly sshkeys: "sshkeys";
2134
- readonly sslsigningrequests: "sslsigningrequests";
2135
- readonly ssluploadcert: "ssluploadcert";
2136
- readonly sslviewlogs: "sslviewlogs";
2137
- readonly sslmanager: "sslmanager";
2138
- readonly softaculous: "softaculous";
2139
- readonly zoneeditor: "zoneeditor";
2140
- };
2141
- export declare type SsoParams = {
2142
- app?: SsoApp;
2143
- dir?: string;
2144
- domain?: string;
2145
- db_name?: string;
2146
- bounce?: string;
2147
- };
2148
- export declare type SshKeyGenerate200 = {
2149
- key_name?: string;
2150
- private_key_path?: string;
2151
- public_key_path?: string;
2152
- };
2153
- /**
2154
- * The SSH key's encryption method for authentication (rsa or dsa). Defaults to rsa.
2155
- */
2156
- export declare type SshKeyGenerateBodyEncType = typeof SshKeyGenerateBodyEncType[keyof typeof SshKeyGenerateBodyEncType];
2157
- export declare const SshKeyGenerateBodyEncType: {
2158
- readonly rsa: "rsa";
2159
- readonly dsa: "dsa";
2160
- readonly ed25519: "ed25519";
2161
- readonly ecdsa: "ecdsa";
2162
- };
2163
- /**
2164
- * A positive integer of 1024 or more. Defaults to 2048 bits.
2165
- */
2166
- export declare type SshKeyGenerateBodyBits = typeof SshKeyGenerateBodyBits[keyof typeof SshKeyGenerateBodyBits];
2167
- export declare const SshKeyGenerateBodyBits: {
2168
- readonly NUMBER_1024: 1024;
2169
- readonly NUMBER_2048: 2048;
2170
- readonly NUMBER_4096: 4096;
2171
- };
2172
- export declare type SshKeyGenerateBody = {
2173
- /** A positive integer of 1024 or more. Defaults to 2048 bits. */
2174
- bits?: SshKeyGenerateBodyBits;
2175
- /** The SSH key's encryption method for authentication (rsa or dsa). Defaults to rsa. */
2176
- enc_type?: SshKeyGenerateBodyEncType;
2177
- /** The SSH key's filename */
2178
- name: string;
2179
- /** A note to log alongside the secure_action_log entry. */
2180
- note?: string;
2181
- /**
2182
- * The SSH key's password. Must be four or more secure characters.
2183
- * @minLength 4
2184
- */
2185
- pass?: string;
2186
- /** The entity that initiated the GAP call */
2187
- source?: string;
2188
- };
2189
- export declare type SshKey200 = {
2190
- deleted?: number;
2191
- key_name?: string;
2192
- };
2193
- export declare type SshKeyBody = {
2194
- name: string;
2195
- note?: string;
2196
- source?: string;
2197
- };
2198
- export declare type SshKeyList200KeysItem = {
2199
- file?: string;
2200
- haspub?: number;
2201
- key?: string;
2202
- name?: string;
2203
- };
2204
- export declare type SshKeyList200 = {
2205
- keys?: SshKeyList200KeysItem[];
2206
- };
2207
- export declare type SshKeyImport200 = {
2208
- key_name?: string;
2209
- };
2210
- export declare type SshKeyImportBody = {
2211
- /** The SSH key's filename */
2212
- name: string;
2213
- /** A note to log alongside the secure_action_log entry. */
2214
- note?: string;
2215
- /**
2216
- * The SSH key's password. Must be four or more secure characters.
2217
- * @minLength 4
2218
- */
2219
- pass?: string;
2220
- /** A Valid SSH private key */
2221
- privkey?: string;
2222
- /** A Valid SSH public key */
2223
- pubkey?: string;
2224
- /** The entity that initiated the GAP call */
2225
- source?: string;
2226
- };
2227
- export declare type SshKeyFetch200 = {
2228
- key?: string;
2229
- key_name?: string;
2230
- type?: string;
2231
- };
2232
- export declare type SshKeyFetchParams = {
2233
- name: string;
2234
- };
2235
- export declare type HostingSshInfo200 = {
2236
- credential?: string;
2237
- ip?: string;
2238
- status?: string;
2239
- success?: boolean;
2240
- username?: string;
2241
- };
2242
- export declare type SitesBatch200 = {
2243
- success?: boolean;
2244
- };
2245
- export declare type SitesBatchBodySitesItem = {
2246
- /** Disk space in GiB */
2247
- disk_limit_gib?: number;
2248
- /** site_id of the site to be updated */
2249
- site_id?: number;
2250
- /** Number of PHP workers */
2251
- workers?: number;
2252
- };
2253
- export declare type SitesBatchBody = {
2254
- sites?: SitesBatchBodySitesItem[];
2255
- };
2256
- export declare type HostingSiteAdd200 = {
2257
- id?: number;
2258
- status?: string;
2259
- success: boolean;
2260
- };
2261
- /**
2262
- * Datacenter to host site in.
2263
- */
2264
- export declare type HostingSiteAddBodyDatacenter = typeof HostingSiteAddBodyDatacenter[keyof typeof HostingSiteAddBodyDatacenter];
2265
- export declare const HostingSiteAddBodyDatacenter: {
2266
- readonly 'Amsterdam,_Netherlands': "Amsterdam, Netherlands";
2267
- readonly 'Ashburn,_Virginia': "Ashburn, Virginia";
2268
- readonly 'Dallas,_Texas': "Dallas, Texas";
2269
- readonly 'Los_Angeles,_California': "Los Angeles, California";
2270
- };
2271
- export declare type HostingSiteAddBody = {
2272
- /** Admin email for the site user */
2273
- admin_email?: string;
2274
- /** Admin user for the site */
2275
- admin_user?: string;
2276
- /** HAL site id to clone */
2277
- clone_site_id?: number;
2278
- /** Datacenter to host site in. */
2279
- datacenter?: HostingSiteAddBodyDatacenter;
2280
- /** Disk space in GiB */
2281
- disk_limit_gib?: number;
2282
- /** domain for the site to be added */
2283
- domain?: string;
2284
- /** flag that causes the domain vhost to be forced to the new docroot */
2285
- force_vhost?: boolean;
2286
- /** toggle between wordpress/lightweight for non-existent static file */
2287
- handler_404?: boolean;
2288
- /** Migrate an existing wordpress site */
2289
- migration_id?: string;
2290
- /** When provided, parent_site_id will be set in the new site's meta to indicate it's a child (staging) site of the parent. */
2291
- parent_site_id?: number;
2292
- /** Installation Path */
2293
- path?: string;
2294
- /** flag indicating whether this site is for a self serve wp migration or not */
2295
- ss_wp_mig?: boolean;
2296
- /** Site Subtype */
2297
- subtype: string;
2298
- /** title of the site to be added */
2299
- title?: string;
2300
- /** Number of PHP workers */
2301
- workers?: number;
2302
- };
2303
- export declare type HostingShellInfo200 = {
2304
- enabled?: boolean;
2305
- };
2306
- export declare type HostingShellToggle200 = {
2307
- enabled?: boolean;
2308
- };
2309
- export declare type HostingShellToggleBody = {
2310
- /** boolean flag to enable or disable hosting shell */
2311
- enabled: boolean;
2312
- };
2313
- export declare type HostingServerHits200ServerHitsLastNDaysItem = {
2314
- hits: number;
2315
- name: string;
2316
- };
2317
- export declare type HostingServerHits200ServerHits = {
2318
- last_n_days: HostingServerHits200ServerHitsLastNDaysItem[];
2319
- total_hits: number;
2320
- };
2321
- export declare type HostingServerHits200 = {
2322
- server_hits: HostingServerHits200ServerHits;
2323
- };
2324
- export declare type HostingServerHitsParams = {
2325
- /**
2326
- * The source of the traffic (http, https, combined)
2327
- */
2328
- source?: string;
2329
- /**
2330
- * The start date for fetching the server hits. Format is YYYY-MM-DD HH:MM:SS
2331
- */
2332
- start?: string;
2333
- /**
2334
- * The end date for fetching the server hits. Format is YYYY-MM-DD HH:MM:SS
2335
- */
2336
- end?: string;
2337
- /**
2338
- * The domain for which to fetch the server hits
2339
- */
2340
- domain: string;
2341
- /**
2342
- * The number of intervals (days) to fetch. Default is 30
2343
- */
2344
- interval?: number;
2345
- };
2346
- export declare type HostingResellerSsoWhm200 = {
2347
- url?: string;
2348
- };
2349
- export declare type AddHostingRedirects200 = {
2350
- success?: number;
2351
- };
2352
- export declare type AddHostingRedirectsBody = {
2353
- /** domain to redirect */
2354
- domain: string;
2355
- /** 3 (default) indicates redirect with or without www,2-Do Not Redirect www,1 only redirect with www */
2356
- redirect_www?: number;
2357
- /** path or or sub directory */
2358
- src?: string;
2359
- /** Permanent-301 notifies the visitors browser to update its records, Temporary-302 does not update browser bookmark */
2360
- type?: string;
2361
- /** destination url */
2362
- url: string;
2363
- /** redirects all files within a directory to the same filename in the redirected directory */
2364
- wildcard?: number;
2365
- };
2366
- export declare type HostingRedirect200 = {
2367
- success?: number;
2368
- };
2369
- export declare type HostingRedirectBody = {
2370
- /** domain to redirect */
2371
- domain: string;
2372
- /** docroot pointing to directory of redirect. If undefined cpanel looks up this field */
2373
- redirect?: string;
2374
- /** path or or sub directory */
2375
- src?: string;
2376
- };
2377
- export declare type HostingRedirects200Item = {
2378
- docroot?: string;
2379
- domain?: string;
2380
- http_status_code?: number;
2381
- redirect_www?: boolean;
2382
- src?: string;
2383
- type?: string;
2384
- url?: string;
2385
- wildcard?: boolean;
2386
- };
2387
- export declare type ProductLicenseDetails200WpsolutionCreatorItem = {
2388
- expirationDate?: string;
2389
- prodInstId?: string;
2390
- };
2391
- export declare type ProductLicenseDetails200WpsolutionCommerceItem = {
2392
- expirationDate?: string;
2393
- prodInstId?: string;
2394
- };
2395
- export declare type ProductLicenseDetails200Wpsolution = {
2396
- commerce?: ProductLicenseDetails200WpsolutionCommerceItem[];
2397
- creator?: ProductLicenseDetails200WpsolutionCreatorItem[];
2398
- };
2399
- export declare type ProductLicenseDetails200 = {
2400
- wpsolution?: ProductLicenseDetails200Wpsolution;
2401
- };
2402
- export declare type ProductLicenseDetailsProductName = typeof ProductLicenseDetailsProductName[keyof typeof ProductLicenseDetailsProductName];
2403
- export declare const ProductLicenseDetailsProductName: {
2404
- readonly wpsolution: "wpsolution";
2405
- };
2406
- export declare type ProductLicenseDetailsParams = {
2407
- product_name: ProductLicenseDetailsProductName;
2408
- };
2409
- export declare type PhpErrors200 = {
2410
- /** @nullable */
2411
- content?: string | null;
2412
- /** @nullable */
2413
- date?: string | null;
2414
- };
2415
- export declare type PhpErrorsParams = {
2416
- domain: string;
2417
- };
2418
- export declare type PasswordScore200 = {
2419
- score?: number;
2420
- };
2421
- export declare type PasswordScoreParams = {
2422
- password: string;
2423
- };
2424
- export declare type PasswordGenerate200 = {
2425
- password?: string;
2426
- };
2427
- export declare type HostingOnboardingDataUpdate200 = {
2428
- completed?: boolean;
2429
- };
2430
- export declare type HostingOnboardingDataUpdateBody = {
2431
- completed?: boolean;
2432
- };
2433
- export declare type HostingOnboardingData200 = {
2434
- /** @nullable */
2435
- completed?: boolean | null;
2436
- };
2437
- export declare type HostingNameservers200 = {
2438
- nameservers: string[];
2439
- };
2440
- export declare type HostingMigrationSiteScanStatus200 = {
2441
- callback_url?: string;
2442
- transferable?: boolean;
2443
- };
2444
- export declare type HostingMigrationSiteScanStatusParams = {
2445
- /**
2446
- * valid domain, URI format is preferred
2447
- */
2448
- prospect_url: string;
2449
- };
2450
- export declare type HostingMigrationInfo200 = {
2451
- domain?: string;
2452
- feasible?: string;
2453
- hostname?: string;
2454
- incoming_domain?: string;
2455
- is_valid_migration_id?: boolean;
2456
- migration_id?: string;
2457
- site_url?: string;
2458
- };
2459
- export declare type HostingMigrationInfoParams = {
2460
- migration_id: string;
2461
- };
2462
- export declare type HostingMigrationsEvent200 = {
2463
- success?: boolean;
2464
- };
2465
- export declare type HostingMigrationsEventBodyEventName = typeof HostingMigrationsEventBodyEventName[keyof typeof HostingMigrationsEventBodyEventName];
2466
- export declare const HostingMigrationsEventBodyEventName: {
2467
- readonly inReview: "inReview";
2468
- readonly approved: "approved";
2469
- readonly disapproved: "disapproved";
2470
- readonly propagationComplete: "propagationComplete";
2471
- readonly propagationTimeout: "propagationTimeout";
2472
- readonly transferComplete: "transferComplete";
2473
- readonly failedCreate: "failedCreate";
2474
- };
2475
- export declare type HostingMigrationsEventBody = {
2476
- event_name: HostingMigrationsEventBodyEventName;
2477
- /** The migration id that corresponds to CWM */
2478
- migration_id: string;
2479
- };
2480
- export declare type HostingMigrations200 = {
2481
- success?: boolean;
2482
- };
2483
- export declare type HostingMigrationsBody = {
2484
- /** The migration id that corresponds to CWM */
2485
- migration_id: string;
2486
- };
2487
- export declare type HostingMigrationStatus200RowsItem = {
2488
- id?: string;
2489
- status?: string;
2490
- subtype?: string;
2491
- type?: string;
2492
- };
2493
- export declare type HostingMigrationStatus200 = {
2494
- rows?: HostingMigrationStatus200RowsItem[];
2495
- };
2496
- export declare type HostingLead400 = {
2497
- [key: string]: unknown;
2498
- };
2499
- export declare type HostingLead200ResponseItemData = {
2500
- leadId?: string;
2501
- message?: string;
2502
- };
2503
- export declare type HostingLead200ResponseItem = {
2504
- clientRequestId?: string;
2505
- data?: HostingLead200ResponseItemData;
2506
- errors?: string;
2507
- messageId?: string;
2508
- providerApplicationName?: string;
2509
- status?: string;
2510
- };
2511
- /**
2512
- * @nullable
2513
- */
2514
- export declare type HostingLead200 = {
2515
- response?: HostingLead200ResponseItem[];
2516
- } | null;
2517
- export declare type HostingLeadParams = {
2518
- phone?: string;
2519
- };
2520
- export declare type HostingInfoDiskUsage200 = {
2521
- /** @nullable */
2522
- disklastupdated?: string | null;
2523
- disklimit?: string;
2524
- diskused?: string;
2525
- /** @nullable */
2526
- fileslimit?: number | null;
2527
- /** @nullable */
2528
- filesused?: number | null;
2529
- };
2530
- export declare type HostingInfo200 = {
2531
- ip?: string;
2532
- };
2533
- export declare type Index200 = {
2534
- /**
2535
- * docroot path
2536
- */
2537
- file?: string;
2538
- /** */
2539
- success?: number;
2540
- };
2541
- export declare type IndexBody = {
2542
- /** docroot path */
2543
- docpath: string;
2544
- };
2545
- export declare type AddIndex200 = {
2546
- /**
2547
- * docroot path
2548
- */
2549
- file?: string;
2550
- /** */
2551
- status?: string;
2552
- };
2553
- /**
2554
- * index type
2555
- */
2556
- export declare type AddIndexBodyType = typeof AddIndexBodyType[keyof typeof AddIndexBodyType];
2557
- export declare const AddIndexBodyType: {
2558
- readonly fancy: "fancy";
2559
- readonly standard: "standard";
2560
- readonly default: "default";
2561
- };
2562
- /**
2563
- * action name
2564
- */
2565
- export declare type AddIndexBodyAction = typeof AddIndexBodyAction[keyof typeof AddIndexBodyAction];
2566
- export declare const AddIndexBodyAction: {
2567
- readonly view: "view";
2568
- readonly enable: "enable";
2569
- readonly disable: "disable";
2570
- };
2571
- export declare type AddIndexBody = {
2572
- /** action name */
2573
- action?: AddIndexBodyAction;
2574
- /** docroot path */
2575
- docpath: string;
2576
- /** index type */
2577
- type?: AddIndexBodyType;
2578
- };
2579
- export declare type ListIndex200IndexesItem = {
2580
- index_options?: string[];
2581
- /** docroot path */
2582
- path?: string;
2583
- /** index status */
2584
- status?: string;
2585
- /** index type */
2586
- type?: string;
2587
- };
2588
- export declare type ListIndex200 = {
2589
- indexes?: ListIndex200IndexesItem[];
2590
- };
2591
- export declare type ListIndexParams = {
2592
- path?: string;
2593
- };
2594
- export declare type HotlinkconfigDelete200 = {
2595
- [key: string]: unknown;
2596
- };
2597
- export declare type HotlinkconfigDeleteBody = {
2598
- docpath: string;
2599
- };
2600
- export declare type HotlinkconfigAdd200 = {
2601
- [key: string]: unknown;
2602
- };
2603
- export declare type HotlinkconfigAddBody = {
2604
- direct_request: number;
2605
- docpath: string;
2606
- file_types: string[];
2607
- protocol_type: string;
2608
- redirect_url?: string;
2609
- };
2610
- export declare type HotlinkconfigDetails200 = {
2611
- direct_request?: number;
2612
- file_types?: string[];
2613
- protocol_type?: string;
2614
- redirect_url?: string;
2615
- };
2616
- export declare type HotlinkconfigDetailsParams = {
2617
- docpath: string;
2618
- };
2619
- export declare type HostingRepoLog200 = {
2620
- /** The output or logs from Git operations such as clone, pull, or deploy */
2621
- log?: string;
2622
- /** The file path where the Git repository is cloned */
2623
- path?: string;
2624
- };
2625
- export declare type HostingRepoLogParams = {
2626
- path: string;
2627
- };
2628
- export declare type HostingRepo200 = {
2629
- /** Directory path where the repository was cloned and should now be deleted */
2630
- path?: string;
2631
- /** The URL of the remote Git repository to be deleted */
2632
- repo_url?: string;
2633
- success?: boolean;
2634
- };
2635
- export declare type HostingRepoBody = {
2636
- /** Directory path where the repository was cloned and should now be deleted */
2637
- path?: string;
2638
- };
2639
- export declare type HostingRepoSync200 = {
2640
- /** The type of action taken */
2641
- action?: string;
2642
- /** Branch to checkout to */
2643
- branch?: string;
2644
- /** Deploy log */
2645
- log?: string;
2646
- /** Path to clone repo into */
2647
- path?: string;
2648
- /** The Clone URL */
2649
- repo_url?: string;
2650
- success?: boolean;
2651
- };
2652
- export declare type HostingRepoSyncBody = {
2653
- /** Branch to checkout to */
2654
- branch?: string;
2655
- /** Flag to check if it is to not_deploy(clone) or deploy */
2656
- clone?: boolean;
2657
- /** Path to clone repo into */
2658
- path?: string;
2659
- /** The Clone URL */
2660
- repo_url: string;
2661
- };
2662
- export declare type HostingRepoList200Item = {
2663
- /** The checked-out Git branch for the repository */
2664
- branch?: string;
2665
- /** The file path where the repository is cloned */
2666
- path?: string;
2667
- /** The remote Git repository URL from which the repository was cloned */
2668
- repo_url?: string;
2669
- };
2670
- export declare type HostingFtp200 = {
2671
- status?: number;
2672
- /** Username */
2673
- user?: string;
2674
- };
2675
- export declare type HostingFtpBody = {
2676
- /** 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. */
2677
- destroy?: boolean;
2678
- /** Optional: A note to log alongside the secure_action_log entry. */
2679
- note?: string;
2680
- /** Optional: The entity that initiated the GAP call, eg. i_cluster, admin_user, script, cron, addon_$type($id) */
2681
- source?: string;
2682
- /** Username for FTP account to delete. */
2683
- user: string;
2684
- };
2685
- export declare type HostingFtpUpdate200 = {
2686
- status?: number;
2687
- };
2688
- /**
2689
- * Must pass either password or quota.
2690
- */
2691
- export declare type HostingFtpUpdateBodyUserTypeSet = typeof HostingFtpUpdateBodyUserTypeSet[keyof typeof HostingFtpUpdateBodyUserTypeSet];
2692
- export declare const HostingFtpUpdateBodyUserTypeSet: {
2693
- readonly password: "password";
2694
- readonly quota: "quota";
2695
- };
2696
- export declare type HostingFtpUpdateBody = {
2697
- /** Domain for the user */
2698
- domain?: string;
2699
- /** Update password for user */
2700
- password?: string;
2701
- /** Update quota for user. Quota value should be greater than or equal to 0. */
2702
- quota?: number;
2703
- /** Username for FTP account. */
2704
- user: string;
2705
- /** Must pass either password or quota. */
2706
- user_type_set?: HostingFtpUpdateBodyUserTypeSet;
2707
- };
2708
- export declare type HostingFtpAdd200 = {
2709
- pass?: string;
2710
- user?: string;
2711
- };
2712
- export declare type HostingFtpAddBody = {
2713
- /** 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. */
2714
- domain?: string;
2715
- /** Path to FTP folder. Default is /. (will be relative from homedir) */
2716
- folder?: string;
2717
- /** Optional: A note to log alongside the secure_action_log entry. */
2718
- note?: string;
2719
- /** Optional password. One will be generated if not included */
2720
- pass?: string;
2721
- /** Optional: The entity that initiated the GAP call, eg. i_cluster, admin_user, script, cron, addon_$type($id) */
2722
- source?: string;
2723
- /** Text to prepended in random username generation. */
2724
- type?: string;
2725
- /** Optional username. If not included then type is required and will generate a random username. Good for temp ftp user. Do not append domain. */
2726
- user: string;
2727
- user_type_set?: string;
2728
- };
2729
- export declare type HostingFtpList200SpecialFtpAccountsItem = {
2730
- account?: string;
2731
- domain?: string;
2732
- homedir?: string;
2733
- type?: string;
2734
- user?: string;
2735
- };
2736
- export declare type HostingFtpList200FtpAccountsItem = {
2737
- account?: string;
2738
- domain?: string;
2739
- homedir?: string;
2740
- type?: string;
2741
- user?: string;
2742
- };
2743
- export declare type HostingFtpList200 = {
2744
- ftp_accounts?: HostingFtpList200FtpAccountsItem[];
2745
- server_name?: string;
2746
- special_ftp_accounts?: HostingFtpList200SpecialFtpAccountsItem[];
2747
- };
2748
- export declare type HostingFixownership200 = {
2749
- success?: boolean;
2750
- };
2751
- export declare type HostingEmailFolderList404 = {
2752
- /** Error message */
2753
- error?: string;
2754
- };
2755
- export declare type HostingEmailFolderList200FoldersItem = {
2756
- /** Child folders of the parent folder */
2757
- children?: FolderNode[];
2758
- /** The name of the parent folder */
2759
- name?: string;
2760
- };
2761
- export declare type HostingEmailFolderList200 = {
2762
- /** The number of email folders returned */
2763
- count?: number;
2764
- /** List of email address folders */
2765
- folders?: HostingEmailFolderList200FoldersItem[];
2766
- };
2767
- export declare type EmailSso512 = {
2768
- /** Customer error code */
2769
- error?: string;
2770
- };
2771
- export declare type EmailSso400 = {
2772
- /** Customer error code */
2773
- error?: string;
2774
- };
2775
- export declare type EmailSso200 = {
2776
- url: string;
2777
- };
2778
- export declare type EmailSsoParams = {
2779
- email: string;
2780
- };
2781
- export declare type HostingEmailSettings512 = {
2782
- /** Customer error code */
2783
- error?: string;
2784
- };
2785
- export declare type HostingEmailSettings404 = {
2786
- /** Customer error code */
2787
- error?: string;
2788
- };
2789
- export declare type HostingEmailSettings403 = {
2790
- /** Customer error code */
2791
- error?: string;
2792
- };
2793
- export declare type HostingEmailSettings200 = {
2794
- /**
2795
- * New status of account_incoming - ADDRESS ONLY
2796
- * @nullable
2797
- */
2798
- account_incoming?: string | null;
2799
- /**
2800
- * New status of account_login - ADDRESS ONLY
2801
- * @nullable
2802
- */
2803
- account_login?: string | null;
2804
- /**
2805
- * New status of account_outgoing - ADDRESS ONLY
2806
- * @nullable
2807
- */
2808
- account_outgoing?: string | null;
2809
- /** The address that was updated */
2810
- address?: string;
2811
- /**
2812
- * New status of automatic plus-addressed folder creation - ADDRESS or SYSTEM
2813
- * @nullable
2814
- */
2815
- autofolders?: string | null;
2816
- /**
2817
- * New status of utf8 folder usage - SYSTEM ONLY
2818
- * @nullable
2819
- */
2820
- utf8_folders?: string | null;
2821
- };
2822
- /**
2823
- * Whether to toggle utf8 folder usage on or off - SYSTEM ONLY
2824
- */
2825
- export declare type HostingEmailSettingsBodyUtf8Folders = typeof HostingEmailSettingsBodyUtf8Folders[keyof typeof HostingEmailSettingsBodyUtf8Folders];
2826
- export declare const HostingEmailSettingsBodyUtf8Folders: {
2827
- readonly enable: "enable";
2828
- readonly disable: "disable";
2829
- };
2830
- /**
2831
- * the type of account
2832
- */
2833
- export declare type HostingEmailSettingsBodyType = typeof HostingEmailSettingsBodyType[keyof typeof HostingEmailSettingsBodyType];
2834
- export declare const HostingEmailSettingsBodyType: {
2835
- readonly address: "address";
2836
- readonly system: "system";
2837
- };
2838
- /**
2839
- * Whether to toggle automatic plus-addressed folder creation on or off - ADDRESS or SYSTEM
2840
- */
2841
- export declare type HostingEmailSettingsBodyAutofolders = typeof HostingEmailSettingsBodyAutofolders[keyof typeof HostingEmailSettingsBodyAutofolders];
2842
- export declare const HostingEmailSettingsBodyAutofolders: {
2843
- readonly enable: "enable";
2844
- readonly disable: "disable";
2845
- };
2846
- /**
2847
- * Whether to suspend or unsuspend account_outgoing - ADDRESS ONLY
2848
- */
2849
- export declare type HostingEmailSettingsBodyAccountOutgoing = typeof HostingEmailSettingsBodyAccountOutgoing[keyof typeof HostingEmailSettingsBodyAccountOutgoing];
2850
- export declare const HostingEmailSettingsBodyAccountOutgoing: {
2851
- readonly hold: "hold";
2852
- readonly suspend: "suspend";
2853
- readonly unsuspend: "unsuspend";
2854
- };
2855
- /**
2856
- * Whether to suspend or unsuspend account_login - ADDRESS ONLY
2857
- */
2858
- export declare type HostingEmailSettingsBodyAccountLogin = typeof HostingEmailSettingsBodyAccountLogin[keyof typeof HostingEmailSettingsBodyAccountLogin];
2859
- export declare const HostingEmailSettingsBodyAccountLogin: {
2860
- readonly suspend: "suspend";
2861
- readonly unsuspend: "unsuspend";
2862
- };
2863
- /**
2864
- * Whether to suspend or unsuspend account_incoming - ADDRESS ONLY
2865
- */
2866
- export declare type HostingEmailSettingsBodyAccountIncoming = typeof HostingEmailSettingsBodyAccountIncoming[keyof typeof HostingEmailSettingsBodyAccountIncoming];
2867
- export declare const HostingEmailSettingsBodyAccountIncoming: {
2868
- readonly suspend: "suspend";
2869
- readonly unsuspend: "unsuspend";
2870
- };
2871
- export declare type HostingEmailSettingsBody = {
2872
- /** Whether to suspend or unsuspend account_incoming - ADDRESS ONLY */
2873
- account_incoming?: HostingEmailSettingsBodyAccountIncoming;
2874
- /** Whether to suspend or unsuspend account_login - ADDRESS ONLY */
2875
- account_login?: HostingEmailSettingsBodyAccountLogin;
2876
- /** Whether to suspend or unsuspend account_outgoing - ADDRESS ONLY */
2877
- account_outgoing?: HostingEmailSettingsBodyAccountOutgoing;
2878
- /** The email address to update settings on - ADDRESS ONLY */
2879
- address?: string;
2880
- /** Whether to toggle automatic plus-addressed folder creation on or off - ADDRESS or SYSTEM */
2881
- autofolders?: HostingEmailSettingsBodyAutofolders;
2882
- /** the type of account */
2883
- type: HostingEmailSettingsBodyType;
2884
- /** Whether to toggle utf8 folder usage on or off - SYSTEM ONLY */
2885
- utf8_folders?: HostingEmailSettingsBodyUtf8Folders;
2886
- };
2887
- export declare type HostingEmailForwarderDelete400 = {
2888
- /** Customer error code */
2889
- error?: string;
2890
- };
2891
- export declare type HostingEmailForwarderDelete200 = {
2892
- [key: string]: unknown;
2893
- };
2894
- export declare type HostingEmailForwarderDeleteParams = {
2895
- /**
2896
- * The source address or domain of the forwarder to be deleted
2897
- */
2898
- source: string;
2899
- /**
2900
- * The destination of the forwarder to be deleted
2901
- */
2902
- destination: string;
2903
- };
2904
- export declare type HostingEmailForwarderAdd512 = {
2905
- /** Customer error code */
2906
- error?: string;
2907
- };
2908
- export declare type HostingEmailForwarderAdd409 = {
2909
- /** Customer error code */
2910
- error?: string;
2911
- };
2912
- export declare type HostingEmailForwarderAdd403 = {
2913
- /** Customer error code */
2914
- error?: string;
2915
- };
2916
- export declare type HostingEmailForwarderAdd400 = {
2917
- /** Customer error code */
2918
- error?: string;
2919
- };
2920
- export declare type HostingEmailForwarderAdd200 = {
2921
- [key: string]: unknown;
2922
- };
2923
- /**
2924
- * The type of forwarder to add (defaults to 'account')
2925
- */
2926
- export declare type HostingEmailForwarderAddBodyType = typeof HostingEmailForwarderAddBodyType[keyof typeof HostingEmailForwarderAddBodyType];
2927
- export declare const HostingEmailForwarderAddBodyType: {
2928
- readonly account: "account";
2929
- readonly domain: "domain";
2930
- };
2931
- /**
2932
- * The type of forwarder destination (defaults to 'email')
2933
- */
2934
- export declare type HostingEmailForwarderAddBodyDestinationType = typeof HostingEmailForwarderAddBodyDestinationType[keyof typeof HostingEmailForwarderAddBodyDestinationType];
2935
- export declare const HostingEmailForwarderAddBodyDestinationType: {
2936
- readonly domain: "domain";
2937
- readonly discard: "discard";
2938
- readonly discard_with_error: "discard_with_error";
2939
- readonly email: "email";
2940
- readonly pipe: "pipe";
2941
- readonly system: "system";
2942
- };
2943
- export declare type HostingEmailForwarderAddBody = {
2944
- /** The forwarding destination - can be an email address, system username, script path, or error message string */
2945
- destination?: string;
2946
- /** The type of forwarder destination (defaults to 'email') */
2947
- destination_type: HostingEmailForwarderAddBodyDestinationType;
2948
- /** The source (email address or domain) of the forwarder being added */
2949
- source: string;
2950
- /** The type of forwarder to add (defaults to 'account') */
2951
- type: HostingEmailForwarderAddBodyType;
2952
- };
2953
- export declare type HostingEmailForwardersList200ForwardersItem = {
2954
- /** Where the email will be forwarded to */
2955
- destination?: string;
2956
- /** Where the email to be forwarded is coming from */
2957
- source?: string;
2958
- /**
2959
- * The type of forwarder
2960
- * @nullable
2961
- */
2962
- type?: string | null;
2963
- };
2964
- export declare type HostingEmailForwardersList200 = {
2965
- /** List of forwarders */
2966
- forwarders?: HostingEmailForwardersList200ForwardersItem[];
2967
- };
2968
- export declare type HostingEmailForwardersListType = typeof HostingEmailForwardersListType[keyof typeof HostingEmailForwardersListType];
2969
- export declare const HostingEmailForwardersListType: {
2970
- readonly account: "account";
2971
- readonly domain: "domain";
2972
- };
2973
- export declare type HostingEmailForwardersListParams = {
2974
- /**
2975
- * The type of forwarder list to query (default: account)
2976
- */
2977
- type: HostingEmailForwardersListType;
2978
- /**
2979
- * The domain to query forwarders by
2980
- */
2981
- domain?: string;
2982
- };
2983
- export declare type HostingEmailUpdate512 = {
2984
- /** Customer error code */
2985
- error?: string;
2986
- };
2987
- export declare type HostingEmailUpdate403 = {
2988
- /** Customer error code */
2989
- error?: string;
2990
- };
2991
- export declare type HostingEmailUpdate400 = {
2992
- /** Customer error code */
2993
- error?: string;
2994
- };
2995
- export declare type HostingEmailUpdate200 = {
2996
- [key: string]: unknown;
2997
- };
2998
- export declare type HostingEmailUpdateBody = {
2999
- /** The email address to update */
3000
- address: string;
3001
- /** The password for the email */
3002
- password?: string;
3003
- /** The quota for the email (optional) (default: 0 = unlimited) */
3004
- quota?: number;
3005
- };
3006
- /**
3007
- * List of suspensions that affect the entire user account
3008
- * @nullable
3009
- */
3010
- export declare type HostingEmailList200RowsItemSystemSuspensions = {
3011
- /** @nullable */
3012
- receive?: boolean | null;
3013
- /** @nullable */
3014
- relay?: boolean | null;
3015
- /** @nullable */
3016
- sendmail?: boolean | null;
3017
- } | null;
3018
- /**
3019
- * State of email box suspensions
3020
- * @nullable
3021
- */
3022
- export declare type HostingEmailList200RowsItemBoxSuspensions = {
3023
- /**
3024
- * Incoming email is rejected
3025
- * @nullable
3026
- */
3027
- incoming?: boolean | null;
3028
- /**
3029
- * Email authentication is disabled
3030
- * @nullable
3031
- */
3032
- login?: boolean | null;
3033
- /**
3034
- * Outgoing email is rejected
3035
- * @nullable
3036
- */
3037
- outgoing?: boolean | null;
3038
- /**
3039
- * Outgoing email is held in queue
3040
- * @nullable
3041
- */
3042
- outgoing_hold?: boolean | null;
3043
- } | null;
3044
- export declare type HostingEmailList200RowsItem = {
3045
- /** The email address */
3046
- address?: string;
3047
- /**
3048
- * Autocreate folders with plus addressing status
3049
- * @nullable
3050
- */
3051
- autofolders?: boolean | null;
3052
- /**
3053
- * State of email box suspensions
3054
- * @nullable
3055
- */
3056
- box_suspensions?: HostingEmailList200RowsItemBoxSuspensions;
3057
- /**
3058
- * The amount of disk space used by the email box
3059
- * @nullable
3060
- */
3061
- disk_used_kib?: number | null;
3062
- /**
3063
- * The percentage of disk space used by the email box
3064
- * @nullable
3065
- */
3066
- disk_used_percent?: number | null;
3067
- /**
3068
- * The email domain
3069
- * @nullable
3070
- */
3071
- domain?: string | null;
3072
- /**
3073
- * The number of files in the email
3074
- * @nullable
3075
- */
3076
- files?: number | null;
3077
- /**
3078
- * The maximum amount of disk space that may be used by the email
3079
- * @nullable
3080
- */
3081
- quota?: number | null;
3082
- /**
3083
- * List of suspensions that affect the entire user account
3084
- * @nullable
3085
- */
3086
- system_suspensions?: HostingEmailList200RowsItemSystemSuspensions;
3087
- /** The type of email */
3088
- type?: string;
3089
- /**
3090
- * If mail folders support utf8 encoding
3091
- * @nullable
3092
- */
3093
- utf8_folders?: boolean | null;
3094
- };
3095
- export declare type HostingEmailList200 = {
3096
- /** List of email resources */
3097
- rows?: HostingEmailList200RowsItem[];
3098
- };
3099
- export declare type HostingEmailDelete200 = {
3100
- [key: string]: unknown;
3101
- };
3102
- export declare type HostingEmailDeleteParams = {
3103
- address: string;
3104
- };
3105
- export declare type HostingEmailAdd512 = {
3106
- /** Customer error code */
3107
- error?: string;
3108
- };
3109
- export declare type HostingEmailAdd409 = {
3110
- /** Customer error code */
3111
- error?: string;
3112
- };
3113
- export declare type HostingEmailAdd403 = {
3114
- /** Customer error code */
3115
- error?: string;
3116
- };
3117
- export declare type HostingEmailAdd400 = {
3118
- /** Customer error code */
3119
- error?: string;
3120
- };
3121
- export declare type HostingEmailAdd200 = {
3122
- /** The address that was created */
3123
- address?: string;
3124
- };
3125
- /**
3126
- * The type of email to add (defaults to 'box')
3127
- */
3128
- export declare type HostingEmailAddBodyType = typeof HostingEmailAddBodyType[keyof typeof HostingEmailAddBodyType];
3129
- export declare const HostingEmailAddBodyType: {
3130
- readonly box: "box";
3131
- readonly domainalias: "domainalias";
3132
- readonly alias: "alias";
3133
- readonly forwarder: "forwarder";
3134
- readonly discard: "discard";
3135
- readonly pipe: "pipe";
3136
- readonly list: "list";
3137
- };
3138
- export declare type HostingEmailAddBody = {
3139
- /** The email address to add */
3140
- address: string;
3141
- /** The password for the email */
3142
- password: string;
3143
- /** The quota for the email (optional) (default: 0 = unlimited) */
3144
- quota?: number;
3145
- /** The type of email to add (defaults to 'box') */
3146
- type?: HostingEmailAddBodyType;
3147
- };
3148
- /**
3149
- * @nullable
3150
- */
3151
- export declare type HostingEcommerceInfo200 = {
3152
- addon_id?: number;
3153
- /** eCommerce addon back reference (a.k.a. prodInstId) */
3154
- back_ref?: string;
3155
- level?: string;
3156
- name?: string;
3157
- status?: string;
3158
- /** @nullable */
3159
- subtype?: string | null;
3160
- type?: string;
3161
- } | null;
3162
- export declare type HostingDomainsUnassign200 = {
3163
- queued?: boolean;
3164
- };
3165
- export declare type HostingDomainsUnassignBody = {
3166
- /** The domain id to be unassigned */
3167
- domain_id: number;
3168
- };
3169
- export declare type DomainDnsImport200 = {
3170
- success?: boolean;
3171
- };
3172
- export declare type DomainDnsImportBody = {
3173
- /** The file to upload */
3174
- file: Blob;
3175
- };
3176
- export declare type DomainDnsImportParams = {
3177
- domain: string;
3178
- };
3179
- export declare type DomainDnsExport200 = {
3180
- content?: string;
3181
- };
3182
- export declare type DomainDnsExportParams = {
3183
- domain: string;
3184
- };
3185
- export declare type Domains200DomainsItem = {
3186
- /** @nullable */
3187
- autogen_id?: string | null;
3188
- /**
3189
- * ssl exipry date
3190
- * @nullable
3191
- */
3192
- date_ssl_exp?: string | null;
3193
- docroot: string;
3194
- domain: string;
3195
- id: number;
3196
- /**
3197
- * ssl issuer
3198
- * @nullable
3199
- */
3200
- ssl_issuer?: string | null;
3201
- /** ssl status */
3202
- ssl_status?: string;
3203
- /** status */
3204
- status?: string;
3205
- type: string;
3206
- };
3207
- export declare type Domains200 = {
3208
- domains: Domains200DomainsItem[];
3209
- };
3210
- export declare type DomainsType = typeof DomainsType[keyof typeof DomainsType];
3211
- export declare const DomainsType: {
3212
- readonly addon: "addon";
3213
- readonly main: "main";
3214
- readonly parked: "parked";
3215
- readonly sub: "sub";
3216
- readonly unassigned: "unassigned";
3217
- };
3218
- export declare type DomainsParams = {
3219
- type?: DomainsType;
3220
- };
3221
- export declare type HostingDomainAvailability200 = {
3222
- /** @nullable */
3223
- assignable?: boolean | null;
3224
- /** @nullable */
3225
- assigned?: boolean | null;
3226
- /** @nullable */
3227
- assigned_to_this_product?: boolean | null;
3228
- /** @nullable */
3229
- can_assign?: boolean | null;
3230
- /** @nullable */
3231
- registered?: boolean | null;
3232
- };
3233
- export declare type HostingDomainAvailabilityParams = {
3234
- domain: string;
3235
- };
3236
- export declare type HostingDomainAssign200 = {
3237
- [key: string]: unknown;
3238
- };
3239
- export declare type HostingDomainAssignBody = {
3240
- /** The domain name to be assigned */
3241
- domain: string;
3242
- /** HAL site id that will be passed to FG for domain assignment. Must be passed if path isn't. */
3243
- site_id: string;
3244
- /** Skip domain pointer order */
3245
- skip_pointer?: boolean;
3246
- };
3247
- export declare type PrivacyUser200 = {
3248
- /** Success/failure status */
3249
- status?: number;
3250
- };
3251
- export declare type PrivacyUserBody = {
3252
- /** directory's path whose user needs to be removed */
3253
- docpath: string;
3254
- /** user names to delete */
3255
- htuser: string[];
3256
- };
3257
- export declare type EditPrivacy200 = {
3258
- /**
3259
- * docroot path
3260
- */
3261
- file?: string;
3262
- /** */
3263
- status?: string;
3264
- };
3265
- /**
3266
- * action name
3267
- */
3268
- export declare type EditPrivacyBodyAction = typeof EditPrivacyBodyAction[keyof typeof EditPrivacyBodyAction];
3269
- export declare const EditPrivacyBodyAction: {
3270
- readonly view: "view";
3271
- readonly enable: "enable";
3272
- readonly disable: "disable";
3273
- };
3274
- export declare type EditPrivacyBody = {
3275
- /** action name */
3276
- action?: EditPrivacyBodyAction;
3277
- /** directory that has to be protected */
3278
- docpath: string;
3279
- /** user to add for ppd */
3280
- htuser: string;
3281
- /** password that is required to lock the folder */
3282
- pass: string;
3283
- };
3284
- export declare type Privacy200 = {
3285
- /**
3286
- * docroot path
3287
- */
3288
- file?: string;
3289
- /** */
3290
- status?: string;
3291
- };
3292
- /**
3293
- * action name
3294
- */
3295
- export declare type PrivacyBodyAction = typeof PrivacyBodyAction[keyof typeof PrivacyBodyAction];
3296
- export declare const PrivacyBodyAction: {
3297
- readonly view: "view";
3298
- readonly enable: "enable";
3299
- readonly disable: "disable";
3300
- };
3301
- export declare type PrivacyBody = {
3302
- /** action name */
3303
- action?: PrivacyBodyAction;
3304
- /** directory that has to be protected */
3305
- docpath: string;
3306
- };
3307
- export declare type AddPrivacy200 = {
3308
- /**
3309
- * docroot path
3310
- */
3311
- file?: string;
3312
- /** */
3313
- status?: string;
3314
- };
3315
- /**
3316
- * action name
3317
- */
3318
- export declare type AddPrivacyBodyAction = typeof AddPrivacyBodyAction[keyof typeof AddPrivacyBodyAction];
3319
- export declare const AddPrivacyBodyAction: {
3320
- readonly view: "view";
3321
- readonly enable: "enable";
3322
- readonly disable: "disable";
3323
- };
3324
- export declare type AddPrivacyBody = {
3325
- /** action name */
3326
- action?: AddPrivacyBodyAction;
3327
- /** directory that has to be protected */
3328
- docpath: string;
3329
- /** user who can have an access to specific folder on their website */
3330
- htuser: string;
3331
- /** password that is required to lock the folder */
3332
- pass: string;
3333
- };
3334
- export declare type DirectoryPrivacy200DirectoryItem = {
3335
- /** @nullable */
3336
- directory_path?: string | null;
3337
- /** @nullable */
3338
- directory_users?: string[] | null;
3339
- };
3340
- export declare type DirectoryPrivacy200 = {
3341
- directory?: DirectoryPrivacy200DirectoryItem[];
3342
- };
3343
- export declare type DirectoryPrivacyParams = {
3344
- docpath?: string;
3345
- };
3346
- export declare type DbMultipleUserDatabase200 = {
3347
- [key: string]: unknown;
3348
- };
3349
- export declare type DbMultipleUserDatabaseBody = {
3350
- /** Database names */
3351
- db: string[];
3352
- /** Database usernames */
3353
- dbuser: string[];
3354
- };
3355
- export declare type DbUserRename200 = {
3356
- success?: number;
3357
- };
3358
- export declare type DbUserRenameBody = {
3359
- /** username mapped to DB */
3360
- dbuser: string;
3361
- /** updating username to new username in DB */
3362
- new_dbuser: string;
3363
- };
3364
- export declare type DbUserList200UsersItem = {
3365
- dblist?: string[];
3366
- shortuser?: string;
3367
- user?: string;
3368
- };
3369
- export declare type DbUserList200 = {
3370
- users?: DbUserList200UsersItem[];
3371
- };
3372
- export declare type DbUserDelete200 = {
3373
- dbuser?: string;
3374
- };
3375
- export declare type DbUserDeleteBody = {
3376
- /** The complete database username */
3377
- dbuser: string;
3378
- };
3379
- export declare type DbUserAdd200 = {
3380
- password?: string;
3381
- username?: string;
3382
- };
3383
- /**
3384
- * Set for wanting either mysql or postgres
3385
- */
3386
- export declare type DbUserAddBodyDbType = typeof DbUserAddBodyDbType[keyof typeof DbUserAddBodyDbType];
3387
- export declare const DbUserAddBodyDbType: {
3388
- readonly mysql: "mysql";
3389
- readonly postgres: "postgres";
3390
- };
3391
- export declare type DbUserAddBody = {
3392
- /** Database name. */
3393
- database?: string;
3394
- /** Set for wanting either mysql or postgres */
3395
- db_type?: DbUserAddBodyDbType;
3396
- /** username to be created for the DB */
3397
- dbuser: string;
3398
- /**
3399
- * Database password for this new user. If not provided one will be generated.
3400
- * @minLength 12
3401
- */
3402
- password?: string;
3403
- /** An array of user privileges. */
3404
- privileges?: string[];
3405
- /**
3406
- * The account type; eg, cg for codeguard, used for auto-generated usernames. Max 2 characters.
3407
- * @minLength 1
3408
- * @maxLength 2
3409
- */
3410
- type?: string;
3411
- };
3412
- export declare type DbUserPrivsSet200 = {
3413
- status?: number;
3414
- };
3415
- /**
3416
- * Type of database
3417
- */
3418
- export declare type DbUserPrivsSetBodyType = typeof DbUserPrivsSetBodyType[keyof typeof DbUserPrivsSetBodyType];
3419
- export declare const DbUserPrivsSetBodyType: {
3420
- readonly mysql: "mysql";
3421
- readonly postgres: "postgres";
3422
- };
3423
- export declare type DbUserPrivsSetBody = {
3424
- /** Database name. */
3425
- database?: string;
3426
- /** Database user names. */
3427
- dbusers?: string[];
3428
- /** An array of user privileges. */
3429
- privileges?: string[];
3430
- /** Type of database */
3431
- type?: DbUserPrivsSetBodyType;
3432
- };
3433
- export declare type DbUserPrivsGet200 = {
3434
- privileges?: string[];
3435
- };
3436
- export declare type DbUserPrivsGetParams = {
3437
- database: string;
3438
- dbuser: string;
3439
- };
3440
- export declare type DbUserPasswordSet200 = {
3441
- dbuser?: string;
3442
- };
3443
- export declare type DbUserPasswordSetBody = {
3444
- /** Database user name. */
3445
- dbuser: string;
3446
- /** Database password to be updated. */
3447
- password: string;
3448
- };
3449
- export declare type DbUsage200 = {
3450
- db_count?: number;
3451
- /** @nullable */
3452
- db_limit?: number | null;
3453
- };
3454
- export declare type RepairDatabase200TablesItem = {
3455
- status?: string;
3456
- table?: string;
3457
- };
3458
- export declare type RepairDatabase200 = {
3459
- tables?: RepairDatabase200TablesItem[];
3460
- };
3461
- export declare type RepairDatabaseBody = {
3462
- /** A valid database name. */
3463
- database: string;
3464
- };
3465
- export declare type DbCheckDatabase200TablesItem = {
3466
- status?: string;
3467
- table?: string;
3468
- };
3469
- export declare type DbCheckDatabase200 = {
3470
- tables?: DbCheckDatabase200TablesItem[];
3471
- };
3472
- /**
3473
- * Type of database
3474
- */
3475
- export declare type DbCheckDatabaseBodyType = typeof DbCheckDatabaseBodyType[keyof typeof DbCheckDatabaseBodyType];
3476
- export declare const DbCheckDatabaseBodyType: {
3477
- readonly mysql: "mysql";
3478
- readonly postgres: "postgres";
3479
- };
3480
- export declare type DbCheckDatabaseBody = {
3481
- /** A valid database name. */
3482
- database: string;
3483
- /** Type of database */
3484
- type?: DbCheckDatabaseBodyType;
3485
- };
3486
- export declare type HostingDbAuthorizedHostsDelete200 = {
3487
- success?: number;
3488
- };
3489
- export declare type HostingDbAuthorizedHostsDeleteBody = {
3490
- host: string;
3491
- };
3492
- export declare type HostingDbAuthorizedHostsUpdate200 = {
3493
- success?: number;
3494
- };
3495
- export declare type HostingDbAuthorizedHostsUpdateBody = {
3496
- host: string;
3497
- label?: string;
3498
- new_host?: string;
3499
- };
3500
- export declare type HostingDbAuthorizedHostsAdd200 = {
3501
- success?: number;
3502
- };
3503
- export declare type HostingDbAuthorizedHostsAddBody = {
3504
- host: string;
3505
- label?: string;
3506
- };
3507
- export declare type HostingDbAuthorizedHosts200RemoteIpsItem = {
3508
- host?: string;
3509
- label?: string;
3510
- };
3511
- export declare type HostingDbAuthorizedHosts200 = {
3512
- remote_ips?: HostingDbAuthorizedHosts200RemoteIpsItem[];
3513
- };
3514
- export declare type Db200 = {
3515
- dbname?: string;
3516
- status?: number;
3517
- type?: string;
3518
- };
3519
- /**
3520
- * Type of database
3521
- */
3522
- export declare type DbBodyType = typeof DbBodyType[keyof typeof DbBodyType];
3523
- export declare const DbBodyType: {
3524
- readonly mysql: "mysql";
3525
- readonly postgres: "postgres";
3526
- };
3527
- export declare type DbBody = {
3528
- /** The name of the database to delete.First 8 characters of account username will be prepended.ex: {username}_{dbname} */
3529
- dbname: string;
3530
- /** Type of database */
3531
- type?: DbBodyType;
3532
- };
3533
- export declare type DbAdd200 = {
3534
- dbname?: string;
3535
- status?: number;
3536
- type?: string;
3537
- };
3538
- /**
3539
- * Type of database to add
3540
- */
3541
- export declare type DbAddBodyType = typeof DbAddBodyType[keyof typeof DbAddBodyType];
3542
- export declare const DbAddBodyType: {
3543
- readonly mysql: "mysql";
3544
- readonly postgres: "postgres";
3545
- };
3546
- export declare type DbAddBody = {
3547
- /**
3548
- * The database name. Account username_ will be prepended. Max length is 54 characters
3549
- * @maxLength 54
3550
- */
3551
- dbname: string;
3552
- /** Type of database to add */
3553
- type?: DbAddBodyType;
3554
- };
3555
- export declare type CronLastRun200 = {
3556
- /** @nullable */
3557
- last_run?: string | null;
3558
- };
3559
- export declare type CronLastRunParams = {
3560
- command: string;
3561
- };
3562
- export declare type Cron200 = {
3563
- success?: boolean;
3564
- };
3565
- export declare type CronBody = {
3566
- /** unique key for cron that is being updated */
3567
- key: number;
3568
- };
3569
- export declare type UpdateCron200 = {
3570
- key?: number;
3571
- };
3572
- export declare type UpdateCronBody = {
3573
- /** command to run as a cron, needs to be a valid string */
3574
- command: string;
3575
- /** 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. */
3576
- day: string;
3577
- /** 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. */
3578
- hour: string;
3579
- /** unique key for cron that is being updated */
3580
- key: number;
3581
- /** 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. */
3582
- minute: string;
3583
- /** 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. */
3584
- month: string;
3585
- /** Type of command (command, variable, comment, blank, unparsed) */
3586
- type?: string;
3587
- /** 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. */
3588
- weekday: string;
3589
- };
3590
- export declare type AddCron400 = {
3591
- error?: string;
3592
- };
3593
- export declare type AddCron200 = {
3594
- key?: string;
3595
- };
3596
- export declare type AddCronBody = {
3597
- /**
3598
- * command to run as a cron, needs to be a valid string
3599
- * @minLength 1
3600
- */
3601
- command: string;
3602
- /** 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. */
3603
- day?: string;
3604
- /** 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. */
3605
- hour?: string;
3606
- /** 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. */
3607
- minute?: string;
3608
- /** 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. */
3609
- month?: string;
3610
- /** 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. */
3611
- weekday?: string;
3612
- };
3613
- export declare type ListCrons200RowsItem = {
3614
- command?: string;
3615
- day?: string;
3616
- email?: string;
3617
- hour?: string;
3618
- /** */
3619
- key?: number;
3620
- line?: string;
3621
- minute?: string;
3622
- month?: string;
3623
- type?: string;
3624
- weekday?: string;
3625
- };
3626
- export declare type ListCrons200 = {
3627
- rows?: ListCrons200RowsItem[];
3628
- };
3629
- export declare type HostingCapabilities200 = {
3630
- advanced_hosting?: boolean;
3631
- cbs_backups?: boolean;
3632
- cpanel?: boolean;
3633
- is_sitelock_migrated?: boolean;
3634
- reset_password?: boolean;
3635
- server_controls?: boolean;
3636
- sites?: boolean;
3637
- whm?: boolean;
3638
- };
3639
- export declare type HostingAdvancedSystemConsole200 = {
3640
- url?: string;
3641
- };
3642
- /**
3643
- * @nullable
3644
- */
3645
- export declare type HostingAdvancedSsoWhm200SslSetup = {
3646
- /** @nullable */
3647
- dns_updated?: number | null;
3648
- /** @nullable */
3649
- dns_zone_with_us?: number | null;
3650
- /** @nullable */
3651
- domain?: string | null;
3652
- /** @nullable */
3653
- required?: number | null;
3654
- /** @nullable */
3655
- server_hostname?: string | null;
3656
- /** @nullable */
3657
- server_ip?: string | null;
3658
- } | null;
3659
- export declare type HostingAdvancedSsoWhm200 = {
3660
- /** @nullable */
3661
- ssl_setup?: HostingAdvancedSsoWhm200SslSetup;
3662
- url?: string;
3663
- };
3664
- export declare type HostingAdvancedPassword200 = {
3665
- success?: boolean;
3666
- };
3667
- export declare type HostingAdvancedPasswordBody = {
3668
- /** The username to be updated */
3669
- account_username?: string;
3670
- /**
3671
- * The password to be updated to
3672
- * @minLength 6
3673
- */
3674
- password: string;
3675
- };
3676
- export declare type HostingAdvancedServerStatus200Actions = {
3677
- [key: string]: unknown;
3678
- };
3679
- export declare type HostingAdvancedServerStatus200 = {
3680
- actions?: HostingAdvancedServerStatus200Actions;
3681
- status?: string;
3682
- uptime?: string;
3683
- uptime_seconds?: number;
3684
- };
3685
- export declare type HostingAdvancedServerStatusBody = {
3686
- /** action to be performed */
3687
- action?: string;
3688
- };
3689
- export declare type HostingAdvancedServer200Ips = {
3690
- other_ips?: string[];
3691
- /** primary IP of server */
3692
- primary_ip?: string;
3693
- };
3694
- export declare type HostingAdvancedServer200Actions = {
3695
- [key: string]: unknown;
3696
- };
3697
- export declare type HostingAdvancedServer200 = {
3698
- actions?: HostingAdvancedServer200Actions;
3699
- /** hostname of server */
3700
- hostname?: string;
3701
- ips?: HostingAdvancedServer200Ips;
3702
- /** Operating system name */
3703
- os_name?: string;
3704
- /** Operating system version */
3705
- os_version?: string;
3706
- status?: string;
3707
- uptime?: string;
3708
- uptime_seconds?: number;
3709
- };
3710
- export declare type HostingAdvancedDomainServices200 = {
3711
- success?: number;
3712
- };
3713
- export declare type HostingAdvancedDomainServicesBody = {
3714
- /** the domain name to be configured */
3715
- domain: string;
3716
- };
3717
- export declare type HostingAdvancedDomainServicesCheck200 = {
3718
- /** 1 if domain services need to be configured, 0 if not */
3719
- configure_domain_services?: number;
3720
- /** Whether a user exists that HAL doesn't know about; should disable some functionality if 0 and configure_domain_services is 1 */
3721
- managed_cpanel_user_exists?: number;
3722
- };
3723
- export declare type HostingAdvancedDnsUpdate200 = {
3724
- [key: string]: unknown;
3725
- };
3726
- export declare type HostingAdvancedDnsUpdateBody = {
3727
- /** Domain name */
3728
- domain: string;
3729
- /** Server Hostname */
3730
- hostname: string;
3731
- /** Server IP */
3732
- server_ip: string;
3733
- };
3734
- export declare type HostingAdvancedDns200DnsItem = {
3735
- /** @nullable */
3736
- content?: string | null;
3737
- /** @nullable */
3738
- name?: string | null;
3739
- /** @nullable */
3740
- ttl?: number | null;
3741
- /** @nullable */
3742
- type?: string | null;
3743
- };
3744
- export declare type HostingAdvancedDns200 = {
3745
- dns?: HostingAdvancedDns200DnsItem[];
3746
- };
3747
- export declare type HostingAdvancedDnsParams = {
3748
- hostname: string;
3749
- domain: string;
3750
- dns_with_us?: number;
3751
- };
3752
- export declare type HostingAddons200RowsItemMeta = {
3753
- [key: string]: string | number | boolean;
3754
- };
3755
- export declare type HostingAddons200RowsItem = {
3756
- /** @nullable */
3757
- back_reference?: string | null;
3758
- id?: string;
3759
- meta?: HostingAddons200RowsItemMeta;
3760
- /** @nullable */
3761
- ssh_hostname?: string | null;
3762
- status?: string;
3763
- status_user?: string;
3764
- subtype?: string;
3765
- type?: string;
3766
- };
3767
- export declare type HostingAddons200 = {
3768
- rows?: HostingAddons200RowsItem[];
3769
- };
3770
- export declare type HostingAddonsParams = {
3771
- status?: string;
3772
- subtype?: string;
3773
- type?: string;
3774
- };
3775
- export declare type ActivityLog200ActivityItem = {
3776
- /** @nullable */
3777
- account_id?: string | null;
3778
- /** @nullable */
3779
- addon_id?: string | null;
3780
- data?: string;
3781
- date_entry?: string;
3782
- /** @nullable */
3783
- domain_id?: string | null;
3784
- event?: string;
3785
- site_id?: string;
3786
- status?: string;
3787
- tenant_id?: string;
3788
- };
3789
- export declare type ActivityLog200 = {
3790
- activity?: ActivityLog200ActivityItem[];
3791
- };
3792
- export declare type ActivityLogParams = {
3793
- days?: number;
3794
- };
3795
- export declare type HostingAccount200 = {
3796
- account_id?: string;
3797
- advanced?: boolean;
3798
- billing?: HostingAccount200Billing;
3799
- brand?: string;
3800
- id?: string;
3801
- panel?: string;
3802
- plan_key?: string;
3803
- platform?: string;
3804
- /** @nullable */
3805
- resources?: HostingAccount200Resources;
3806
- /** @nullable */
3807
- ssh_hostname?: string | null;
3808
- status?: string;
3809
- type?: string;
3810
- username?: string;
3811
- };
3812
- export declare type HostingAccount200ResourcesWorkers = {
3813
- /** @nullable */
3814
- available?: number | null;
3815
- /** @nullable */
3816
- total?: number | null;
3817
- /** @nullable */
3818
- used?: number | null;
3819
- };
3820
- export declare type HostingAccount200ResourcesStorage = {
3821
- /** @nullable */
3822
- available?: number | null;
3823
- /** @nullable */
3824
- total?: number | null;
3825
- unit?: string;
3826
- /** @nullable */
3827
- used?: number | null;
3828
- };
3829
- export declare type HostingAccount200ResourcesStagingWorkers = {
3830
- /** @nullable */
3831
- available?: number | null;
3832
- /** @nullable */
3833
- total?: number | null;
3834
- /** @nullable */
3835
- used?: number | null;
3836
- };
3837
- export declare type HostingAccount200ResourcesStagingStorage = {
3838
- /** @nullable */
3839
- available?: number | null;
3840
- /** @nullable */
3841
- total?: number | null;
3842
- unit?: string;
3843
- /** @nullable */
3844
- used?: number | null;
3845
- };
3846
- export declare type HostingAccount200ResourcesStaging = {
3847
- storage?: HostingAccount200ResourcesStagingStorage;
3848
- workers?: HostingAccount200ResourcesStagingWorkers;
3849
- };
3850
- /**
3851
- * @nullable
3852
- */
3853
- export declare type HostingAccount200Resources = {
3854
- staging?: HostingAccount200ResourcesStaging;
3855
- storage?: HostingAccount200ResourcesStorage;
3856
- workers?: HostingAccount200ResourcesWorkers;
3857
- } | null;
3858
- export declare type HostingAccount200Billing = {
3859
- prod_code?: string;
3860
- product_name?: string;
3861
- subbrand?: string;
3862
- };
3863
- export declare type DomainZoneeditorUrl200 = {
3864
- url: string;
3865
- };
3866
- export declare type DomainUnassign200 = {
3867
- [key: string]: unknown;
3868
- };
3869
- export declare type AccessLogs200LogsItem = {
3870
- /** @nullable */
3871
- date?: string | null;
3872
- /** @nullable */
3873
- device?: string | null;
3874
- /** @nullable */
3875
- host?: string | null;
3876
- /** @nullable */
3877
- ip?: string | null;
3878
- /** @nullable */
3879
- request?: string | null;
3880
- /** @nullable */
3881
- response_code?: number | null;
3882
- /** @nullable */
3883
- response_size?: number | null;
3884
- /** @nullable */
3885
- server_ip?: string | null;
3886
- };
3887
- export declare type AccessLogs200 = {
3888
- logs?: AccessLogs200LogsItem[];
3889
- };
3890
- export declare type AccessLogsType = typeof AccessLogsType[keyof typeof AccessLogsType];
3891
- export declare const AccessLogsType: {
3892
- readonly error: "error";
3893
- readonly all: "all";
3894
- };
3895
- export declare type AccessLogsParams = {
3896
- /**
3897
- * Access logs type
3898
- */
3899
- type?: AccessLogsType;
3900
- };
3901
- export declare type DomainDnszoneReset200 = {
3902
- [key: string]: unknown;
3903
- };
3904
- export declare type DomainDnseditorEdit200 = {
3905
- success?: number;
3906
- };
3907
- export declare type DomainDnseditorEditBody = {
3908
- /** It describes dns point value for each type of record */
3909
- content?: string;
3910
- /** Flag of each DNS record it has */
3911
- flag?: string;
3912
- /** name type of dns record */
3913
- name?: string;
3914
- /** actual cotent on which the records points to */
3915
- orig_content?: string;
3916
- /** actual name that records holds */
3917
- orig_name?: string;
3918
- /** Port of SRV DNS record */
3919
- port?: string;
3920
- /** Priority of each DNS record, Default priority would be set to one */
3921
- preference?: string;
3922
- /** Priority of each DNS record, Default priority would be set to one */
3923
- priority?: string;
3924
- /** protocal of DNS record */
3925
- protocol?: string;
3926
- /** Tag of each DNS record */
3927
- tag?: string;
3928
- /** Target of SRV DNS record example.domain.com */
3929
- target?: string;
3930
- /** manage domain DNS records (A, MX, CNAME, TXT and SRV Records) for individual services */
3931
- ttl?: string;
3932
- /** Add host records for your domain name, such as A Records, MX Records, or IPV6 (AAAA). Choose MANAGE to see the full list of supported records */
3933
- type?: string;
3934
- /** Weight of each DNS record it holds */
3935
- weight?: string;
3936
- };
3937
- export declare type DomainDnseditorAdd200 = {
3938
- success?: number;
3939
- };
3940
- export declare type DomainDnseditorAddBodyRecordsItem = {
3941
- /** It describes dns point value for each type of record */
3942
- content?: string;
3943
- /** mail server that domain of DNS record points to */
3944
- exchange?: string;
3945
- /** Flag of each DNS record it has */
3946
- flag?: string;
3947
- /** name type of dns record */
3948
- name?: string;
3949
- /** mail server that domain of DNS record points to */
3950
- nsdname?: string;
3951
- /** Port of SRV DNS record */
3952
- port?: string;
3953
- /** Priority of each DNS record, Default priority would be set to one */
3954
- priority?: string;
3955
- /** protocal of DNS record */
3956
- protocol?: string;
3957
- /** Tag of each DNS record */
3958
- tag?: string;
3959
- /** Target of SRV DNS record example.domain.com */
3960
- target?: string;
3961
- /** manage domain DNS records (A, MX, CNAME, TXT and SRV Records) for individual services */
3962
- ttl?: string;
3963
- /** Add host records for your domain name, such as A Records, MX Records, or IPV6 (AAAA). Choose MANAGE to see the full list of supported records */
3964
- type?: string;
3965
- /** mail server that domain of DNS record points to */
3966
- value?: string;
3967
- /** Weight of each DNS record it holds */
3968
- weight?: string;
3969
- };
3970
- export declare type DomainDnseditorAddBody = {
3971
- records?: DomainDnseditorAddBodyRecordsItem[];
3972
- };
3973
- export declare type DomainDnseditorList200DnsRecordsItem = {
3974
- /**
3975
- * It describes dns point value for each type of record
3976
- * @nullable
3977
- */
3978
- content?: string | null;
3979
- /**
3980
- * Flag of each DNS record it has
3981
- * @nullable
3982
- */
3983
- flag?: string | null;
3984
- /** name type of dns record with domain name */
3985
- name?: string;
3986
- /**
3987
- * Port of SRV DNS record
3988
- * @nullable
3989
- */
3990
- port?: string | null;
3991
- /**
3992
- * Priority of each DNS record, Default priority would be set to one
3993
- * @nullable
3994
- */
3995
- preference?: string | null;
3996
- /**
3997
- * Priority of each DNS record, Default priority would be set to one
3998
- * @nullable
3999
- */
4000
- priority?: string | null;
4001
- /**
4002
- * Tag of each DNS record
4003
- * @nullable
4004
- */
4005
- tag?: string | null;
4006
- /**
4007
- * Target of SRV DNS record example.domain.com
4008
- * @nullable
4009
- */
4010
- target?: string | null;
4011
- /** How long the DNS record is valid for */
4012
- ttl?: number;
4013
- /** manage domain DNS records (A, MX, CNAME, TXT and SRV Records) for individual services */
4014
- type?: string;
4015
- /**
4016
- * Tag value for CAA Record
4017
- * @nullable
4018
- */
4019
- value?: string | null;
4020
- /**
4021
- * Weight of each DNS record it holds
4022
- * @nullable
4023
- */
4024
- weight?: string | null;
4025
- };
4026
- export declare type DomainDnseditorList200 = {
4027
- dns_records?: DomainDnseditorList200DnsRecordsItem[];
4028
- };
4029
- export declare type DomainDnseditor200 = {
4030
- success?: number;
4031
- };
4032
- export declare type DomainDnseditorBodyRecordsItem = {
4033
- /** It describes dns point value for each type of record */
4034
- content?: string;
4035
- /** mail server that domain of DNS record points to */
4036
- exchange?: string;
4037
- /** Flag of each DNS record it has */
4038
- flag?: string;
4039
- /** name type of dns record */
4040
- name?: string;
4041
- /** mail server that domain of DNS record points to */
4042
- nsdname?: string;
4043
- /** Port of SRV DNS record */
4044
- port?: string;
4045
- /** Priority of each DNS record, Default priority would be set to one */
4046
- priority?: string;
4047
- /** protocal of DNS record */
4048
- protocol?: string;
4049
- /** Tag of each DNS record */
4050
- tag?: string;
4051
- /** Target of SRV DNS record example.domain.com */
4052
- target?: string;
4053
- /** manage domain DNS records (A, MX, CNAME, TXT and SRV Records) for individual services */
4054
- ttl?: string;
4055
- /** Add host records for your domain name, such as A Records, MX Records, or IPV6 (AAAA). Choose MANAGE to see the full list of supported records */
4056
- type?: string;
4057
- /** mail server that domain of DNS record points to */
4058
- value?: string;
4059
- /** Weight of each DNS record it holds */
4060
- weight?: string;
4061
- };
4062
- export declare type DomainDnseditorBody = {
4063
- records?: DomainDnseditorBodyRecordsItem[];
4064
- };
4065
- export declare type DomainCertUninstall200 = {
4066
- [key: string]: unknown;
4067
- };
4068
- export declare type DomainCertUpdate200 = {
4069
- [key: string]: unknown;
4070
- };
4071
- export declare type DomainCertUpdateBody = {
4072
- enable: boolean;
4073
- };
4074
- export declare type DomainCertInstall200 = {
4075
- [key: string]: unknown;
4076
- };
4077
- export declare type DomainCertInstallBody = {
4078
- /** cabundle */
4079
- cabundle?: string;
4080
- /** raw private key or path to private key on userbox */
4081
- crt: string;
4082
- /** private key */
4083
- key?: string;
4084
- };
4085
- export declare type DomainCerts200CertsItem = {
4086
- /** certificate id */
4087
- cert_id?: string;
4088
- /** domain name */
4089
- domain?: string;
4090
- /** exipry date */
4091
- expires_on?: string;
4092
- /** issued date */
4093
- issued_on?: string;
4094
- };
4095
- export declare type DomainCerts200 = {
4096
- certs?: DomainCerts200CertsItem[];
4097
- };
4098
- /**
4099
- * @nullable
4100
- */
4101
- export declare type DomainInfo200SetupProgress = {
4102
- /**
4103
- * Result of domain cdn validation (null=not started,0=started,1=succeeded,2=skipped)
4104
- * @nullable
4105
- */
4106
- validate_cdn?: number | null;
4107
- /**
4108
- * Most recent error logged during domain cdn validation. Remains set if validation tries run out. Gets reset by new validation job.
4109
- * @nullable
4110
- */
4111
- validate_cdn_error?: string | null;
4112
- /**
4113
- * Result of domain dns validation (null=not started,0=started,1=succeeded,2=skipped)
4114
- * @nullable
4115
- */
4116
- validate_dns?: number | null;
4117
- /**
4118
- * Whether dns_auto_repair was run on this domain (1=true)
4119
- * @nullable
4120
- */
4121
- validate_dns_auto_repair?: number | null;
4122
- /**
4123
- * Most recent error logged during domain dns validation. Remains set if validation tries run out. Gets reset by new validation job.
4124
- * @nullable
4125
- */
4126
- validate_dns_error?: string | null;
4127
- /**
4128
- * Most recent error logged during domain validation. Remains set if validation tries run out. Gets reset by new validation job.
4129
- * @nullable
4130
- */
4131
- validate_error?: string | null;
4132
- /**
4133
- * Result of domain ssl validation (null=not started,0=started,1=succeeded,2=skipped)
4134
- * @nullable
4135
- */
4136
- validate_ssl?: number | null;
4137
- /**
4138
- * Most recent error logged during domain ssl validation. Remains set if validation tries run out. Gets reset by new validation job.
4139
- * @nullable
4140
- */
4141
- validate_ssl_error?: string | null;
4142
- } | null;
4143
- export declare type DomainInfo200 = {
4144
- /** @nullable */
4145
- account_back_ref?: string | null;
4146
- /** @nullable */
4147
- authoritative?: boolean | null;
4148
- /** @nullable */
4149
- autogen_id?: number | null;
4150
- /** @nullable */
4151
- back_reference?: string | null;
4152
- base_domain?: string;
4153
- /** @nullable */
4154
- billing_account_id?: string | null;
4155
- /** @nullable */
4156
- billing_status?: string | null;
4157
- date_added?: string;
4158
- date_modified?: string;
4159
- /** @nullable */
4160
- date_ssl_exp?: string | null;
4161
- dns_status?: string;
4162
- /** @nullable */
4163
- docroot?: string | null;
4164
- domain?: string;
4165
- /** @nullable */
4166
- homedir?: string | null;
4167
- /** @nullable */
4168
- hosting_id?: number | null;
4169
- id?: number;
4170
- /**
4171
- * Whether the domain is internal to us, external, or cannot be determined
4172
- * @nullable
4173
- */
4174
- is_internal?: boolean | null;
4175
- /** @nullable */
4176
- nameservers?: string[] | null;
4177
- /** @nullable */
4178
- platform?: string | null;
4179
- /** @nullable */
4180
- platform_type?: string | null;
4181
- /** @nullable */
4182
- product_id?: string | null;
4183
- /** @nullable */
4184
- setup_progress?: DomainInfo200SetupProgress;
4185
- /** @nullable */
4186
- ssl_issuer?: string | null;
4187
- /** @nullable */
4188
- ssl_status?: string | null;
4189
- /** @nullable */
4190
- ssl_type?: string | null;
4191
- status?: string;
4192
- /** @nullable */
4193
- third_party_dns?: boolean | null;
4194
- type?: string;
4195
- };
4196
- export declare type WeeblySso200 = {
4197
- sso?: string;
4198
- };
4199
- export declare type WebzaiSso200 = {
4200
- sso?: string;
4201
- };
4202
- export declare type AddonsSpamexpertsSso200 = {
4203
- url?: string;
4204
- };
4205
- export declare type AddonsJetpackValidate200 = {
4206
- is_connected?: boolean;
4207
- };
4208
- export declare type AddonsInfo200 = {
4209
- id?: string;
4210
- };
4211
- export declare type AddonsCloudflare200 = {
4212
- status?: string;
4213
- };
4214
- /**
4215
- * @nullable
4216
- */
4217
- export declare type BackupMeta200CbsEventIsProcessing = {
4218
- action?: string;
4219
- type?: string;
4220
- } | null;
4221
- export declare type BackupMeta200CbsDownloadablesItem = {
4222
- /** @nullable */
4223
- id?: string | null;
4224
- /** @nullable */
4225
- time_req_completed?: string | null;
4226
- /** @nullable */
4227
- type?: string | null;
4228
- /** @nullable */
4229
- url?: string | null;
4230
- };
4231
- export declare type BackupMeta200 = {
4232
- /** @nullable */
4233
- cbs_downloadables?: BackupMeta200CbsDownloadablesItem[] | null;
4234
- /** @nullable */
4235
- cbs_event_is_processing?: BackupMeta200CbsEventIsProcessing;
4236
- /** @nullable */
4237
- cbs_last_restore_timestamp?: string | null;
4238
- /** @nullable */
4239
- client_tracking_id?: string | null;
4240
- };
4241
- export declare type BackupList200HomeItemBackupStatus = {
4242
- /** @nullable */
4243
- download_url?: string | null;
4244
- status?: string;
4245
- tracking_id?: number;
4246
- };
4247
- export declare type BackupList200HomeItem = {
4248
- backup_id?: string;
4249
- backup_status?: BackupList200HomeItemBackupStatus;
4250
- time_created?: string;
4251
- };
4252
- export declare type BackupList200 = {
4253
- home?: BackupList200HomeItem[];
4254
- };
4255
- export declare type BackupListBackupType = typeof BackupListBackupType[keyof typeof BackupListBackupType];
4256
- export declare const BackupListBackupType: {
4257
- readonly full: "full";
4258
- readonly home: "home";
4259
- readonly mysql: "mysql";
4260
- };
4261
- export declare type BackupListParams = {
4262
- backup_type: BackupListBackupType;
4263
- };
4264
- export declare type BackupStatus200 = {
4265
- /** @nullable */
4266
- download_url?: string | null;
4267
- /** @nullable */
4268
- message?: string | null;
4269
- status?: string;
4270
- };
4271
- export declare type BackupStatusParams = {
4272
- tracking_id: number;
4273
- };
4274
- export declare type BackupInitiate200 = {
4275
- message?: string;
4276
- tracking_id?: number;
4277
- };
4278
- /**
4279
- * The type of the backup
4280
- */
4281
- export declare type BackupInitiateBodyBackupType = typeof BackupInitiateBodyBackupType[keyof typeof BackupInitiateBodyBackupType];
4282
- export declare const BackupInitiateBodyBackupType: {
4283
- readonly home: "home";
4284
- readonly mysql: "mysql";
4285
- readonly full: "full";
4286
- };
4287
- export declare type BackupInitiateBody = {
4288
- /** The type of the backup */
4289
- backup_type: BackupInitiateBodyBackupType;
4290
- /** Backup Volume store ID to get the backup */
4291
- backup_volume_store_id: string;
4292
- };
4293
- export declare type AddonsSitelockSso200 = {
4294
- site_url?: string;
4295
- sitelock_id?: string;
4296
- url?: string;
4297
- };
4298
- export declare type CodeguardWebsiteBackupRestore200 = {
4299
- status?: string;
4300
- };
4301
- export declare type CodeguardWebsiteBackupRestoreBody = {
4302
- /** The commit id to restore the website from. */
4303
- commit_id?: string;
4304
- /** The id of the website the given database is associated with. */
4305
- website_id?: number;
4306
- };
4307
- export declare type CodeguardWebsiteBackupCreate200 = {
4308
- status?: string;
4309
- };
4310
- export declare type CodeguardWebsiteBackupCreateBody = {
4311
- /** The id for the website to create a backup for. This id can be obtained through a call to the website_list action. */
4312
- website_id?: number;
4313
- };
4314
- export declare type CodeguardWebsiteBackupList200BackupsItem = {
4315
- commit_id?: string;
4316
- event_time?: string;
4317
- modifications?: number;
4318
- new_content?: boolean;
4319
- };
4320
- export declare type CodeguardWebsiteBackupList200 = {
4321
- backups?: CodeguardWebsiteBackupList200BackupsItem[];
4322
- };
4323
- export declare type CodeguardWebsiteBackupListParams = {
4324
- website_id?: number;
4325
- };
4326
- export declare type CodeguardWebsiteList200WebsiteListItemWebsite = {
4327
- activated?: boolean;
4328
- id?: number;
4329
- url?: string;
4330
- };
4331
- export declare type CodeguardWebsiteList200WebsiteListItem = {
4332
- website?: CodeguardWebsiteList200WebsiteListItemWebsite;
4333
- };
4334
- export declare type CodeguardWebsiteList200 = {
4335
- website_list?: CodeguardWebsiteList200WebsiteListItem[];
4336
- };
4337
- export declare type CodeguardPlanInfo200SeatsItem = {
4338
- activated?: boolean;
4339
- url?: string;
4340
- website_id?: number;
4341
- };
4342
- export declare type CodeguardPlanInfo200 = {
4343
- back_reference?: string;
4344
- can_upgrade?: boolean;
4345
- /** @nullable */
4346
- disabled?: boolean | null;
4347
- /** @nullable */
4348
- over_quota?: boolean | null;
4349
- plan_name?: string;
4350
- seat_count?: number;
4351
- seat_limit?: number;
4352
- seats?: CodeguardPlanInfo200SeatsItem[];
4353
- size?: number;
4354
- size_limit?: number;
4355
- status?: string;
4356
- };
4357
- export declare type CodeguardLoginLink200 = {
4358
- link?: string;
4359
- };
4360
- export declare type CodeguardDatabaseBackupRestore200 = {
4361
- status?: string;
4362
- };
4363
- export declare type CodeguardDatabaseBackupRestoreBody = {
4364
- /** The commit_id for the backup to restore */
4365
- commit_id?: string;
4366
- /** The id for the database to create a new backup for. */
4367
- database_id?: number;
4368
- /** The id of the website the given database is associated with. */
4369
- website_id?: number;
4370
- };
4371
- export declare type CodeguardDatabaseBackupCreate200 = {
4372
- status?: string;
4373
- };
4374
- export declare type CodeguardDatabaseBackupCreateBody = {
4375
- /** The id for the database to create a new backup for. */
4376
- database_id?: number;
4377
- /** The id of the website the given database is associated with. */
4378
- website_id?: number;
4379
- };
4380
- export declare type CodeguardDatabaseBackupList200BackupsItem = {
4381
- commit_id?: string;
4382
- event_time?: string;
4383
- };
4384
- export declare type CodeguardDatabaseBackupList200 = {
4385
- backups?: CodeguardDatabaseBackupList200BackupsItem[];
4386
- };
4387
- export declare type CodeguardDatabaseBackupListParams = {
4388
- database_id?: number;
4389
- website_id?: number;
4390
- };
4391
- export declare type CodeguardDatabaseList200 = {
4392
- databases?: CodeguardDatabaseList200DatabasesItem[];
4393
- status?: number;
4394
- };
4395
- export declare type CodeguardDatabaseList200DatabasesItemDatabaseBackup = {
4396
- account?: string;
4397
- commit_id?: string;
4398
- id?: number;
4399
- website_id?: number;
4400
- };
4401
- export declare type CodeguardDatabaseList200DatabasesItem = {
4402
- database_backup?: CodeguardDatabaseList200DatabasesItemDatabaseBackup;
4403
- };
4404
- export declare type CodeguardBackupRestore200 = {
4405
- database_success?: boolean;
4406
- website_success?: boolean;
4407
- };
4408
- export declare type CodeguardBackupRestoreBody = {
4409
- /** The commit id to restore the database from. */
4410
- database_commit_id?: string;
4411
- /** The id of the database the given database is associated with. */
4412
- database_id?: number;
4413
- /** The commit id to restore the website from. */
4414
- website_commit_id?: string;
4415
- /** The id of the website the given database is associated with. */
4416
- website_id?: number;
4417
- };
4418
- export declare type CodeguardBackupDownload200 = {
4419
- status?: string;
4420
- };
4421
- export declare type CodeguardBackupDownloadBody = {
4422
- /** The commit id to restore the database from. */
4423
- database_commit_id?: string;
4424
- /** The commit id to restore the website from. */
4425
- website_commit_id?: string;
4426
- /** The id of the website the given database is associated with. */
4427
- website_id?: number;
4428
- };
4429
- export declare type CodeguardBackupCreate200 = {
4430
- database_success?: number;
4431
- status?: string;
4432
- website_success?: number;
4433
- };
4434
- export declare type CodeguardBackupCreateBody = {
4435
- /** The id of the database the given database is associated with. */
4436
- database_id?: number;
4437
- /** The id of the website the given database is associated with. */
4438
- website_id?: number;
4439
- };
4440
- export declare type CodeguardBackupList200BackupsItemDatabaseBackupsItem = {
4441
- commit_id?: string;
4442
- event_time?: string;
4443
- id?: number;
4444
- recommended?: boolean;
4445
- };
4446
- export declare type CodeguardBackupList200BackupsItem = {
4447
- database_backups?: CodeguardBackupList200BackupsItemDatabaseBackupsItem[];
4448
- event_time?: string;
4449
- website_commit_id?: string;
4450
- };
4451
- export declare type CodeguardBackupList200 = {
4452
- backups?: CodeguardBackupList200BackupsItem[];
4453
- };
4454
- export declare type CodeguardBackupListParams = {
4455
- website_id: number;
4456
- };
4457
- export declare type AccountPublicKeyDelete404 = {
4458
- error?: string;
4459
- };
4460
- export declare type AccountPublicKeyDelete200 = {
4461
- [key: string]: unknown;
4462
- };
4463
- export declare type AccountPublicKeyToggle409 = {
4464
- error?: string;
4465
- };
4466
- export declare type AccountPublicKeyToggle200 = {
4467
- /** Creates a background validation task. */
4468
- job_id?: number;
4469
- };
4470
- export declare type AccountPublicKeyToggleBody = {
4471
- /** boolean flag to enable or disable a public key */
4472
- enabled: boolean;
4473
- };
4474
- export declare type AccountPublicKey404 = {
4475
- error?: string;
4476
- };
4477
- export declare type AccountPublicKey200 = {
4478
- /**
4479
- * Public key last modified datetime stamp
4480
- * @nullable
4481
- */
4482
- date_modified?: string | null;
4483
- /** Public key ID */
4484
- id?: number;
4485
- /** Public key is active flag */
4486
- is_active?: boolean;
4487
- /** Public key nickname */
4488
- name?: string;
4489
- /** public key */
4490
- public_key?: string;
4491
- };
4492
- export declare type AccountPublicKeyCreate409 = {
4493
- error?: string;
4494
- };
4495
- export declare type AccountPublicKeyCreate200 = {
4496
- /**
4497
- * Public key last modified datetime stamp
4498
- * @nullable
4499
- */
4500
- date_modified?: string | null;
4501
- /** Public key ID */
4502
- id?: number;
4503
- /** Public key is active flag */
4504
- is_active?: boolean;
4505
- /** Public key nickname */
4506
- name?: string;
4507
- /** Public key */
4508
- public_key?: string;
4509
- };
4510
- export declare type AccountPublicKeyCreateBody = {
4511
- /** Public key flag toggle (default: true) */
4512
- is_active?: boolean;
4513
- /** Public key nickname */
4514
- name: string;
4515
- /** Public key */
4516
- public_key: string;
4517
- };
4518
- export declare type AccountPublicKeys200PublicKeysItem = {
4519
- /**
4520
- * Public key last modified datetime stamp
4521
- * @nullable
4522
- */
4523
- date_modified?: string | null;
4524
- /** Public key ID */
4525
- id?: number;
4526
- /** Public key is active flag */
4527
- is_active?: boolean;
4528
- /** Public key nickname */
4529
- name?: string;
4530
- public_key?: string;
4531
- };
4532
- export declare type AccountPublicKeys200 = {
4533
- public_keys?: AccountPublicKeys200PublicKeysItem[];
4534
- };
4535
- export declare type AccountHostingList200AccountsItem = {
4536
- /** Jarvis Account ID, HAL tenant_back_ref */
4537
- account_id?: string;
4538
- current_sites?: number;
4539
- feature_set?: string;
4540
- /** HAL Account ID */
4541
- hosting_id?: string;
4542
- max_sites?: string;
4543
- platform?: string;
4544
- /** HAL Account back_reference */
4545
- prod_inst_id?: string;
4546
- /** Returns preferred Data center location for their hosting plan */
4547
- region_desc?: string;
4548
- /** Returns type of accounts where the hosting plan's data center is located */
4549
- region_type?: string;
4550
- status?: string;
4551
- };
4552
- export declare type AccountHostingList200 = {
4553
- accounts?: AccountHostingList200AccountsItem[];
4554
- };
4555
- export declare type AccountEventList200EventsItem = {
4556
- /**
4557
- * ID of HAL Addon associated with this event
4558
- * @nullable
4559
- */
4560
- addon_id?: number | null;
4561
- /** How many times this event has triggered between date_first and date_last */
4562
- count?: number;
4563
- /** UTC timestamp of first occurrence of this event */
4564
- date_first?: string;
4565
- /** UTC timestamp of most recent occurrence of this event */
4566
- date_last?: string;
4567
- /**
4568
- * ID of HAL Domain associated with this event
4569
- * @nullable
4570
- */
4571
- domain_id?: number | null;
4572
- /** Name of the event this entry was triggered by */
4573
- event?: string;
4574
- /** ID of HAL Account associated with this event */
4575
- hosting_id?: number;
4576
- /**
4577
- * ID of HAL Site associated with this event
4578
- * @nullable
4579
- */
4580
- site_id?: number | null;
4581
- /** ID of HAL Tenant associated with this event */
4582
- tenant_id?: number;
4583
- };
4584
- export declare type AccountEventList200 = {
4585
- events?: AccountEventList200EventsItem[];
4586
- /** Date of most recent event update. Can pass back in when determining whether to query new data */
4587
- utc?: string;
4588
- };
4589
- export declare type AccountEventListParams = {
4590
- /**
4591
- * ID of the HAL Addon to query event info about
4592
- */
4593
- addon_id?: number;
4594
- /**
4595
- * ID of the HAL Domain to query event info about
4596
- */
4597
- domain_id?: number;
4598
- /**
4599
- * ID of the HAL Site to query event info about
4600
- */
4601
- site_id?: number;
4602
- /**
4603
- * Date-time to check for new events *after*; ISO format.
4604
- */
4605
- date_last?: string;
4606
- };
4607
- export interface FolderNode {
4608
- /** Child folders of the child folder */
4609
- children?: FolderNode[];
4610
- /** The name of the child folder */
4611
- name?: string;
4612
- }
4613
- /**
4614
- * @nullable
4615
- */
4616
- export declare type SiteInfoResponseModelV2Staging = {
4617
- /**
4618
- * Applies to staging site only; The id of the current site's parent site
4619
- * @nullable
4620
- */
4621
- parent_site_id?: number | null;
4622
- /**
4623
- * Applies to parent site only; The id of the former parent site of the current site
4624
- * @nullable
4625
- */
4626
- promoted_from?: number | null;
4627
- /**
4628
- * Applies to staging site only; The id of the parent site of the current site that is being promoted
4629
- * @nullable
4630
- */
4631
- promoting_from?: number | null;
4632
- /**
4633
- * Applies to staging site only; The derived status based on promotion ids and jobs
4634
- * @nullable
4635
- */
4636
- promotion_status?: string | null;
4637
- /** A list of staging sites of the current site */
4638
- sites?: number[];
4639
- } | null;
4640
- export declare type SiteInfoResponseModelV2ResourcesStorage = {
4641
- /** @nullable */
4642
- available?: number | null;
4643
- /** @nullable */
4644
- total?: number | null;
4645
- unit?: string;
4646
- /** @nullable */
4647
- used?: number | null;
4648
- };
4649
- /**
4650
- * @nullable
4651
- */
4652
- export declare type SiteInfoResponseModelV2Resources = {
4653
- storage?: SiteInfoResponseModelV2ResourcesStorage;
4654
- /** @nullable */
4655
- workers?: number | null;
4656
- } | null;
4657
- /**
4658
- * @nullable
4659
- */
4660
- export declare type SiteInfoResponseModelV2PendingUrlData = {
4661
- /**
4662
- * The root domain name
4663
- * @nullable
4664
- */
4665
- base_domain?: string | null;
4666
- /**
4667
- * The Fully Qualified Domain Name (FQDN)
4668
- * @nullable
4669
- */
4670
- domain?: string | null;
4671
- /**
4672
- * The current pending_url's HAL Domain ID
4673
- * @nullable
4674
- */
4675
- domain_id?: number | null;
4676
- /** @nullable */
4677
- error?: string | null;
4678
- /** Flag indicating whether the pending_url is temporary or not */
4679
- is_temp?: boolean;
4680
- /**
4681
- * Flag indicating whether the url_sync job has run out of attempts
4682
- * @nullable
4683
- */
4684
- job_failed?: boolean | null;
4685
- /** @nullable */
4686
- stage?: string | null;
4687
- /**
4688
- * Timestamp for when we will update the WP url, regardless of active sessions
4689
- * @nullable
4690
- */
4691
- wp_session?: string | null;
4692
- } | null;
4693
- /**
4694
- * @nullable
4695
- */
4696
- export declare type SiteInfoResponseModelV2Pagespeed = {
4697
- lastrun?: string;
4698
- performance?: string;
4699
- strategy?: string;
4700
- } | null;
4701
- /**
4702
- * Job ids for the site
4703
- * @nullable
4704
- */
4705
- export declare type SiteInfoResponseModelV2Jobs = {
4706
- [key: string]: unknown;
4707
- } | null;
4708
- export declare type SiteInfoResponseModelV2DomainPtrsItem = {
4709
- [key: string]: unknown;
4710
- };
4711
- export interface SiteInfoResponseModelV2 {
4712
- /** @nullable */
4713
- account_back_ref?: string | null;
4714
- account_id?: string;
4715
- /** @nullable */
4716
- base_domain?: string | null;
4717
- /**
4718
- * False if site was added by site scanner
4719
- * @nullable
4720
- */
4721
- confirmed?: boolean | null;
4722
- /** @nullable */
4723
- datacenter?: string | null;
4724
- date_added?: string;
4725
- date_modified?: string;
4726
- detected_type?: string;
4727
- /** @nullable */
4728
- docpath?: string | null;
4729
- /** @nullable */
4730
- docroot?: string | null;
4731
- /** @nullable */
4732
- domain?: string | null;
4733
- /** @nullable */
4734
- domain_ptrs?: SiteInfoResponseModelV2DomainPtrsItem[] | null;
4735
- edge_cache?: boolean;
4736
- /** @nullable */
4737
- handler_404?: string | null;
4738
- id?: string;
4739
- /** @nullable */
4740
- installed_id?: string | null;
4741
- /**
4742
- * True if docpath is public_html, otherwise False
4743
- * @nullable
4744
- */
4745
- is_primary?: boolean | null;
4746
- /**
4747
- * Job ids for the site
4748
- * @nullable
4749
- */
4750
- jobs?: SiteInfoResponseModelV2Jobs;
4751
- /** @nullable */
4752
- last_error?: string | null;
4753
- /** @nullable */
4754
- migration_id?: string | null;
4755
- /** @nullable */
4756
- name?: string | null;
4757
- /**
4758
- * Status of the site's onboarding
4759
- * @nullable
4760
- */
4761
- onboarding?: number | null;
4762
- /** @nullable */
4763
- pagespeed?: SiteInfoResponseModelV2Pagespeed;
4764
- /** @nullable */
4765
- path?: string | null;
4766
- /** @nullable */
4767
- pending_url?: string | null;
4768
- /** @nullable */
4769
- pending_url_data?: SiteInfoResponseModelV2PendingUrlData;
4770
- /**
4771
- * The Php Version. If unable to determine, it will be NULL
4772
- * @nullable
4773
- */
4774
- php_version?: string | null;
4775
- /** @nullable */
4776
- resources?: SiteInfoResponseModelV2Resources;
4777
- /** @nullable */
4778
- staging?: SiteInfoResponseModelV2Staging;
4779
- status?: string;
4780
- /** @nullable */
4781
- subtype?: string | null;
4782
- type?: string;
4783
- /** @nullable */
4784
- url?: string | null;
4785
- /** @nullable */
4786
- url_is_provisional?: boolean | null;
4787
- /** @nullable */
4788
- version?: string | null;
4789
- /**
4790
- * The WP Version
4791
- * @nullable
4792
- */
4793
- version_ptr?: string | null;
4794
- }
4795
- export interface SitesAutoupdatesResponse {
4796
- /** @nullable */
4797
- core?: boolean | null;
4798
- /** @nullable */
4799
- plugins?: boolean | null;
4800
- /** @nullable */
4801
- themes?: boolean | null;
4802
- }
4803
- export interface SSHUsersV2Response {
4804
- installed?: boolean;
4805
- is_active?: boolean;
4806
- /** @nullable */
4807
- job_id?: number | null;
4808
- /** @nullable */
4809
- public_key_id?: number | null;
4810
- /** @nullable */
4811
- ssh_hostname?: string | null;
4812
- user?: string;
4813
- }