@newfold/huapi-js 2.0.0-alpha.1 → 2.2.0-beta.2

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,2886 +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.1037.0
7
- */
8
- export declare type SitesListV3200 = {
9
- items?: SitesListV3200ItemsItem[];
10
- /** page size */
11
- limit?: number;
12
- /** current page number */
13
- page?: number;
14
- /** total number of pages */
15
- pages?: number;
16
- /** total number of sites returned */
17
- total?: number;
18
- };
19
- export declare type SitesListV3200ItemsItemResourcesStorage = {
20
- /** @nullable */
21
- available?: number | null;
22
- /** @nullable */
23
- total?: number | null;
24
- unit?: string;
25
- /** @nullable */
26
- used?: number | null;
27
- };
28
- export declare type SitesListV3200ItemsItemResources = {
29
- storage?: SitesListV3200ItemsItemResourcesStorage;
30
- /** @nullable */
31
- workers?: number | null;
32
- };
33
- /**
34
- * @nullable
35
- */
36
- export declare type SitesListV3200ItemsItemPendingUrlData = {
37
- /**
38
- * The root domain name
39
- * @nullable
40
- */
41
- base_domain?: string | null;
42
- /**
43
- * The Fully Qualified Domain Name (FQDN)
44
- * @nullable
45
- */
46
- domain?: string | null;
47
- /** @nullable */
48
- error?: string | null;
49
- /** Flag indicating whether the pending_url is temporary or not */
50
- is_temp?: boolean;
51
- /** @nullable */
52
- stage?: string | null;
53
- /**
54
- * Timestamp for when we will update the WP url, regardless of active sessions
55
- * @nullable
56
- */
57
- wp_session?: string | null;
58
- } | null;
59
- export declare type SitesListV3200ItemsItem = {
60
- /** @nullable */
61
- account_back_ref?: string | null;
62
- account_id?: string;
63
- /** @nullable */
64
- base_domain?: string | null;
65
- /**
66
- * False if site was added by site scanner
67
- * @nullable
68
- */
69
- confirmed?: boolean | null;
70
- /** @nullable */
71
- datacenter?: string | null;
72
- date_added?: string;
73
- date_modified?: string;
74
- detected_type?: string;
75
- /** @nullable */
76
- docroot?: string | null;
77
- /** @nullable */
78
- domain?: string | null;
79
- edge_cache?: boolean;
80
- id?: string;
81
- /** @nullable */
82
- installed_id?: string | null;
83
- /** True if docpath is public_html, otherwise False */
84
- is_primary?: boolean;
85
- /** @nullable */
86
- last_error?: string | null;
87
- /** @nullable */
88
- migration_id?: string | null;
89
- /** @nullable */
90
- name?: string | null;
91
- path?: string;
92
- /** @nullable */
93
- pending_url?: string | null;
94
- /** @nullable */
95
- pending_url_data?: SitesListV3200ItemsItemPendingUrlData;
96
- /**
97
- * The Php Version. If unable to determine, it will be NULL
98
- * @nullable
99
- */
100
- php_version?: string | null;
101
- resources?: SitesListV3200ItemsItemResources;
102
- status?: string;
103
- subtype?: string;
104
- type?: string;
105
- /** @nullable */
106
- url?: string | null;
107
- /** @nullable */
108
- url_is_provisional?: boolean | null;
109
- /** @nullable */
110
- version?: string | null;
111
- /**
112
- * The WP Version
113
- * @nullable
114
- */
115
- version_ptr?: string | null;
116
- };
117
- export declare type SitesListV3Params = {
118
- limit?: number;
119
- page?: number;
120
- search?: string;
121
- };
122
- export declare type SitesSshUserListV2200 = {
123
- users?: SSHUsersV2Response[];
124
- };
125
- export declare type SitesSecuritySitelockV2200 = {
126
- /** @nullable */
127
- addon_id?: number | null;
128
- /** @nullable */
129
- billing_code?: string | null;
130
- /** @nullable */
131
- domain_name?: string | null;
132
- domains?: string[];
133
- /** @nullable */
134
- has_cdn?: boolean | null;
135
- is_migrated?: boolean;
136
- message?: string;
137
- /** @nullable */
138
- plan?: string | null;
139
- /** @nullable */
140
- platform_id?: string | null;
141
- /**
142
- * Sitelock can be attached directly to a site, or it will fallback and return the sitelock for entire hosting account
143
- * @nullable
144
- */
145
- scope?: string | null;
146
- /** @nullable */
147
- source?: string | null;
148
- success?: number;
149
- upgrade_levels?: string[];
150
- };
151
- export declare type SitesSecuritySitelockV2Source = (typeof SitesSecuritySitelockV2Source)[keyof typeof SitesSecuritySitelockV2Source];
152
- export declare const SitesSecuritySitelockV2Source: {
153
- readonly hal: "hal";
154
- readonly fg: "fg";
155
- readonly halfg: "halfg";
156
- };
157
- export declare type SitesSecuritySitelockV2Params = {
158
- /**
159
- * fetch the sitelock data based on source(fg/hal)
160
- */
161
- source?: SitesSecuritySitelockV2Source;
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
- date_added?: string;
219
- date_modified?: string;
220
- /** @nullable */
221
- date_ssl_exp?: string | null;
222
- dns_status?: string;
223
- /** @nullable */
224
- docroot?: string | null;
225
- domain?: string;
226
- /** @nullable */
227
- homedir?: string | null;
228
- /** @nullable */
229
- hosting_id?: number | null;
230
- id?: number;
231
- /** @nullable */
232
- setup_progress?: SitesDomainsV2200DomainsItemSetupProgress;
233
- /** @nullable */
234
- ssl_issuer?: string | null;
235
- /** @nullable */
236
- ssl_status?: string | null;
237
- /** @nullable */
238
- ssl_type?: string | null;
239
- status?: string;
240
- type?: string;
241
- };
242
- export declare type SitesDomainsV2200 = {
243
- domains?: SitesDomainsV2200DomainsItem[];
244
- limit?: number;
245
- page?: number;
246
- total?: number;
247
- };
248
- export declare type SitesDomainsV2Params = {
249
- scan?: boolean;
250
- };
251
- export declare type SitesListV2200 = {
252
- items?: SitesListV2200ItemsItem[];
253
- /** page size */
254
- limit?: number;
255
- /** current page number */
256
- page?: number;
257
- /** total number of pages */
258
- pages?: number;
259
- /** total number of sites returned */
260
- total?: number;
261
- };
262
- export declare type SitesListV2200ItemsItemResourcesStorage = {
263
- /** @nullable */
264
- available?: number | null;
265
- /** @nullable */
266
- total?: number | null;
267
- unit?: string;
268
- /** @nullable */
269
- used?: number | null;
270
- };
271
- export declare type SitesListV2200ItemsItemResources = {
272
- storage?: SitesListV2200ItemsItemResourcesStorage;
273
- /** @nullable */
274
- workers?: number | null;
275
- };
276
- /**
277
- * @nullable
278
- */
279
- export declare type SitesListV2200ItemsItemPendingUrlData = {
280
- /**
281
- * The root domain name
282
- * @nullable
283
- */
284
- base_domain?: string | null;
285
- /**
286
- * The Fully Qualified Domain Name (FQDN)
287
- * @nullable
288
- */
289
- domain?: string | null;
290
- /**
291
- * The current pending_url's HAL Domain ID
292
- * @nullable
293
- */
294
- domain_id?: number | null;
295
- /** @nullable */
296
- error?: string | null;
297
- /** Flag indicating whether the pending_url is temporary or not */
298
- is_temp?: boolean;
299
- /**
300
- * Flag indicating whether the url_sync job has run out of attempts
301
- * @nullable
302
- */
303
- job_failed?: boolean | null;
304
- /** @nullable */
305
- stage?: string | null;
306
- /**
307
- * Timestamp for when we will update the WP url, regardless of active sessions
308
- * @nullable
309
- */
310
- wp_session?: string | null;
311
- } | null;
312
- /**
313
- * Job ids for the site
314
- * @nullable
315
- */
316
- export declare type SitesListV2200ItemsItemJobs = {
317
- [key: string]: unknown;
318
- } | null;
319
- export declare type SitesListV2200ItemsItem = {
320
- /** @nullable */
321
- account_back_ref?: string | null;
322
- account_id?: string;
323
- /** @nullable */
324
- base_domain?: string | null;
325
- /**
326
- * False if site was added by site scanner
327
- * @nullable
328
- */
329
- confirmed?: boolean | null;
330
- /** @nullable */
331
- datacenter?: string | null;
332
- date_added?: string;
333
- date_modified?: string;
334
- detected_type?: string;
335
- /** @nullable */
336
- docroot?: string | null;
337
- /** @nullable */
338
- domain?: string | null;
339
- edge_cache?: boolean;
340
- handler_404?: string;
341
- id?: number;
342
- /** @nullable */
343
- installed_id?: string | null;
344
- /** True if docpath is public_html, otherwise False */
345
- is_primary?: boolean;
346
- /**
347
- * Job ids for the site
348
- * @nullable
349
- */
350
- jobs?: SitesListV2200ItemsItemJobs;
351
- /** @nullable */
352
- last_error?: string | null;
353
- /** @nullable */
354
- migration_id?: string | null;
355
- /** @nullable */
356
- name?: string | null;
357
- path?: string;
358
- /** @nullable */
359
- pending_url?: string | null;
360
- /** @nullable */
361
- pending_url_data?: SitesListV2200ItemsItemPendingUrlData;
362
- /**
363
- * The Php Version. If unable to determine, it will be NULL
364
- * @nullable
365
- */
366
- php_version?: string | null;
367
- resources?: SitesListV2200ItemsItemResources;
368
- status?: string;
369
- subtype?: string;
370
- type?: string;
371
- /** @nullable */
372
- url?: string | null;
373
- /** @nullable */
374
- url_is_provisional?: boolean | null;
375
- /** @nullable */
376
- version?: string | null;
377
- /**
378
- * The WP Version
379
- * @nullable
380
- */
381
- version_ptr?: string | null;
382
- };
383
- export declare type SshKeyListV2200RowsItem = {
384
- key?: string;
385
- mtime?: string;
386
- name?: string;
387
- type?: string;
388
- };
389
- export declare type SshKeyListV2200 = {
390
- rows?: SshKeyListV2200RowsItem[];
391
- };
392
- export declare type SshKeyImportV2200 = {
393
- /** @nullable */
394
- private_key_name?: string | null;
395
- /** @nullable */
396
- public_key_name?: string | null;
397
- };
398
- export declare type SshKeyImportV2Body = {
399
- /** The SSH key's filename */
400
- name: string;
401
- /** A note to log alongside the secure_action_log entry. */
402
- note?: string;
403
- /**
404
- * The SSH key's password. Must be four or more secure characters.
405
- * @minLength 4
406
- */
407
- pass?: string;
408
- /** A Valid SSH private key */
409
- privkey?: string;
410
- /** A Valid SSH public key */
411
- pubkey?: string;
412
- /** The entity that initiated the GAP call */
413
- source?: string;
414
- };
415
- export declare type HostingSitesV2200ItemsItemResourcesStorage = {
416
- /** @nullable */
417
- available?: number | null;
418
- /** @nullable */
419
- total?: number | null;
420
- unit?: string;
421
- /** @nullable */
422
- used?: number | null;
423
- };
424
- export declare type HostingSitesV2200ItemsItemResources = {
425
- storage?: HostingSitesV2200ItemsItemResourcesStorage;
426
- /** @nullable */
427
- workers?: number | null;
428
- };
429
- /**
430
- * @nullable
431
- */
432
- export declare type HostingSitesV2200ItemsItemPendingUrlData = {
433
- /**
434
- * The root domain name
435
- * @nullable
436
- */
437
- base_domain?: string | null;
438
- /**
439
- * The Fully Qualified Domain Name (FQDN)
440
- * @nullable
441
- */
442
- domain?: string | null;
443
- /**
444
- * The current pending_url's HAL Domain ID
445
- * @nullable
446
- */
447
- domain_id?: number | null;
448
- /** @nullable */
449
- error?: string | null;
450
- /** Flag indicating whether the pending_url is temporary or not */
451
- is_temp?: boolean;
452
- /**
453
- * Flag indicating whether the url_sync job has run out of attempts
454
- * @nullable
455
- */
456
- job_failed?: boolean | null;
457
- /** @nullable */
458
- stage?: string | null;
459
- /**
460
- * Timestamp for when we will update the WP url, regardless of active sessions
461
- * @nullable
462
- */
463
- wp_session?: string | null;
464
- } | null;
465
- /**
466
- * Job ids for the site
467
- * @nullable
468
- */
469
- export declare type HostingSitesV2200ItemsItemJobs = {
470
- [key: string]: unknown;
471
- } | null;
472
- export declare type HostingSitesV2200ItemsItem = {
473
- /** @nullable */
474
- account_back_ref?: string | null;
475
- account_id?: string;
476
- /** @nullable */
477
- base_domain?: string | null;
478
- /**
479
- * False if site was added by site scanner
480
- * @nullable
481
- */
482
- confirmed?: boolean | null;
483
- /** @nullable */
484
- datacenter?: string | null;
485
- date_added?: string;
486
- date_modified?: string;
487
- detected_type?: string;
488
- /** @nullable */
489
- docroot?: string | null;
490
- /** @nullable */
491
- domain?: string | null;
492
- edge_cache?: boolean;
493
- handler_404?: string;
494
- id?: number;
495
- /** @nullable */
496
- installed_id?: string | null;
497
- /** True if docpath is public_html, otherwise False */
498
- is_primary?: boolean;
499
- /**
500
- * Job ids for the site
501
- * @nullable
502
- */
503
- jobs?: HostingSitesV2200ItemsItemJobs;
504
- /** @nullable */
505
- last_error?: string | null;
506
- /** @nullable */
507
- migration_id?: string | null;
508
- /** @nullable */
509
- name?: string | null;
510
- path?: string;
511
- /** @nullable */
512
- pending_url?: string | null;
513
- /** @nullable */
514
- pending_url_data?: HostingSitesV2200ItemsItemPendingUrlData;
515
- /**
516
- * The Php Version. If unable to determine, it will be NULL
517
- * @nullable
518
- */
519
- php_version?: string | null;
520
- resources?: HostingSitesV2200ItemsItemResources;
521
- status?: string;
522
- subtype?: string;
523
- type?: string;
524
- /** @nullable */
525
- url?: string | null;
526
- /** @nullable */
527
- url_is_provisional?: boolean | null;
528
- /** @nullable */
529
- version?: string | null;
530
- /**
531
- * The WP Version
532
- * @nullable
533
- */
534
- version_ptr?: string | null;
535
- };
536
- export declare type HostingSitesV2200 = {
537
- /**
538
- * Remaining number of sites the customer can create. Max sites - used sites. Null means 'unlimited'.
539
- * @nullable
540
- */
541
- available_sites?: number | null;
542
- items?: HostingSitesV2200ItemsItem[];
543
- /** page size */
544
- limit?: number;
545
- /**
546
- * Maximum number of sites the customer can have. Null means 'unlimited'.
547
- * @nullable
548
- */
549
- max_sites?: number | null;
550
- /** current page number */
551
- page?: number;
552
- /** total number of pages */
553
- pages?: number;
554
- /** total number of sites returned */
555
- total?: number;
556
- /** 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. */
557
- used_sites?: number;
558
- };
559
- export declare type HostingSitesV2Params = {
560
- limit?: number;
561
- page?: number;
562
- search?: string;
563
- };
564
- export declare type HostingNameserversV2200HostsItem = {
565
- host?: string;
566
- ips?: string[];
567
- };
568
- export declare type HostingNameserversV2200 = {
569
- brand: string;
570
- hosts: HostingNameserversV2200HostsItem[];
571
- id: number;
572
- is_default?: string;
573
- };
574
- export declare type AddonsSitelockSsoV2200 = {
575
- /** @nullable */
576
- site_url?: string | null;
577
- sitelock_id?: string;
578
- url?: string;
579
- };
580
- export declare type AddonsSitelockSsoV2Params = {
581
- /**
582
- * fetch the sso data based on source(fg/hal)
583
- */
584
- source?: string;
585
- };
586
- export declare type SitesVersion200 = {
587
- current?: string;
588
- latest?: string;
589
- update?: boolean;
590
- };
591
- export declare type SiteUsers200UsersItemMeta = {
592
- maestro_web_pro?: string;
593
- maestro_wpp_identifier?: string;
594
- };
595
- export declare type SiteUsers200UsersItem = {
596
- display_name?: string;
597
- id: number;
598
- meta?: SiteUsers200UsersItemMeta;
599
- post_count?: number;
600
- role: string;
601
- user_email: string;
602
- user_id: number;
603
- user_login: string;
604
- user_nicename: string;
605
- };
606
- export declare type SiteUsers200 = {
607
- users: SiteUsers200UsersItem[];
608
- };
609
- export declare type SiteStatus200 = {
610
- /** @nullable */
611
- cloudflare_ready?: boolean | null;
612
- pending_url?: string;
613
- url?: string;
614
- };
615
- export declare type SitesSso200OtherItem = {
616
- added?: string;
617
- addon_id?: number;
618
- domain?: string;
619
- subtype?: string;
620
- type?: string;
621
- };
622
- export declare type SitesSso200 = {
623
- /** @nullable */
624
- other?: SitesSso200OtherItem[] | null;
625
- /** @nullable */
626
- sso?: string | null;
627
- /** @nullable */
628
- type?: string | null;
629
- };
630
- export declare type SitesSsoBounceName = (typeof SitesSsoBounceName)[keyof typeof SitesSsoBounceName];
631
- export declare const SitesSsoBounceName: {
632
- readonly jetpackbackup: "jetpackbackup";
633
- readonly jetpackdashboard: "jetpackdashboard";
634
- readonly staging: "staging";
635
- readonly updatecore: "updatecore";
636
- readonly password: "password";
637
- readonly profile: "profile";
638
- readonly plugins: "plugins";
639
- readonly themes: "themes";
640
- readonly phpmyadmin: "phpmyadmin";
641
- readonly filemanager: "filemanager";
642
- readonly store: "store";
643
- readonly wpmigration: "wpmigration";
644
- readonly mypluginsandtools: "mypluginsandtools";
645
- };
646
- export declare type SitesSsoParams = {
647
- addon_id?: string;
648
- bounce_name?: SitesSsoBounceName;
649
- user_email?: string;
650
- user_id?: string;
651
- };
652
- export declare type SitesSsl200 = {
653
- domain?: string;
654
- domain_dns_status?: string;
655
- /** @nullable */
656
- expiration?: string | null;
657
- /** @nullable */
658
- issuer?: string | null;
659
- /** @nullable */
660
- product?: string | null;
661
- /** @nullable */
662
- provider?: string | null;
663
- status?: string;
664
- /** @nullable */
665
- type?: string | null;
666
- upgradeable?: boolean;
667
- };
668
- export declare type SitesSshUserUpdate200 = {
669
- [key: string]: unknown;
670
- };
671
- export declare type SitesSshUserUpdateBody = {
672
- /** optional flag to generate public key */
673
- generate_pubkey?: boolean;
674
- /** optional password */
675
- pass?: string;
676
- /** optional public key */
677
- pubkey?: string;
678
- /** username of user */
679
- ssh_user: string;
680
- };
681
- export declare type SitesSshUserDelete200 = {
682
- [key: string]: unknown;
683
- };
684
- export declare type SitesSshUserDeleteBody = {
685
- /** 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. */
686
- public_key_id?: number;
687
- /** SSH User Name. Optional for global user and required for non-global user. */
688
- ssh_user?: string;
689
- };
690
- export declare type SitesSshUserCreate200 = {
691
- /**
692
- * optional private key
693
- * @nullable
694
- */
695
- private_key?: string | null;
696
- /**
697
- * optional public key
698
- * @nullable
699
- */
700
- public_key?: string | null;
701
- /**
702
- * global site public key id
703
- * @nullable
704
- */
705
- public_key_id?: number | null;
706
- };
707
- export declare type SitesSshUserCreateBody = {
708
- /** optional auto-generate key pair flag */
709
- generate_pubkey?: boolean;
710
- /** Pass as true to create as a global public key */
711
- is_global?: boolean;
712
- /** optional password */
713
- pass?: string;
714
- /** optional public key */
715
- pubkey?: string;
716
- /** username of user */
717
- ssh_user: string;
718
- };
719
- export declare type SitesSshUserList200 = {
720
- users?: string[];
721
- };
722
- export declare type SitesSettingsPhpVersions200 = {
723
- default?: string;
724
- deprecated?: string[];
725
- latest?: string;
726
- versions?: string[];
727
- };
728
- export declare type SitesSettingsPhpVersionUpdate200 = {
729
- success?: number;
730
- };
731
- export declare type SitesSettingsPhpVersionUpdateBody = {
732
- force?: boolean;
733
- /**
734
- * The version should match the pattern i.e. PHP 8.0
735
- * @pattern ^(PHP) ([0-9]+.[0-9])$
736
- */
737
- php_version: string;
738
- };
739
- export declare type SitesSettingsDebugToggle200 = {
740
- success?: number;
741
- };
742
- export declare type SitesSettingsDebugToggleBody = {
743
- enable?: boolean;
744
- };
745
- export declare type SitesSettingsDebug200 = {
746
- status?: number;
747
- };
748
- export declare type SitesSettingsComingSoonToggle200 = {
749
- success?: number;
750
- };
751
- export declare type SitesSettingsComingSoonToggleBody = {
752
- enable?: boolean;
753
- };
754
- export declare type SitesSettingsComingSoon200 = {
755
- enable?: boolean;
756
- };
757
- export declare type SitesSecuritySslStatus200 = {
758
- domain?: string;
759
- message?: string;
760
- product?: string;
761
- provider?: string;
762
- ssl_status?: string;
763
- upgradeable?: boolean;
764
- };
765
- export declare type SitesSecuritySslStatusParams = {
766
- /**
767
- * scans hal domains to get updated ssl information
768
- */
769
- domain_scan?: boolean;
770
- };
771
- export declare type SitesSecuritySslAcme200 = {
772
- message?: string;
773
- success?: number;
774
- };
775
- export declare type SitesSecuritySitelock200 = {
776
- addon_id?: number;
777
- billing_code?: string;
778
- has_cdn?: boolean;
779
- message?: string;
780
- plan?: string;
781
- platform_id?: string;
782
- /** Sitelock can be attached directly to a site, or it will fallback and return the sitelock for entire hosting account */
783
- scope?: string;
784
- success?: number;
785
- upgrade_levels?: string[];
786
- };
787
- export declare type SitesSecurityHttpsEnableDisableSsl200 = {
788
- message?: string;
789
- redirection_status?: number;
790
- success?: number;
791
- };
792
- export declare type SitesSecurityHttpsEnableDisableSslBody = {
793
- /** enable or disable */
794
- forced_redirection?: string;
795
- };
796
- export declare type SitesSecurityHttpsRedirectionStatus200 = {
797
- message?: string;
798
- redirection_status?: number;
799
- success?: number;
800
- };
801
- export declare type SitesSecurityResetCoreFiles200 = {
802
- results?: string;
803
- success?: number;
804
- };
805
- export declare type SitesSecurityCheckCore200 = {
806
- results?: string;
807
- success?: number;
808
- };
809
- export declare type SitesSecurityBundle200 = {
810
- eligible?: boolean;
811
- };
812
- export declare type ResetSite200 = {
813
- previous_status: string;
814
- status: string;
815
- };
816
- export declare type ResetSiteBody = {
817
- /** Site subtype to morph to */
818
- subtype?: string;
819
- /** Site type to morph to */
820
- type?: string;
821
- };
822
- export declare type SitePluginsUpdate200 = {
823
- success: boolean;
824
- };
825
- export declare type SitePluginsUpdateBody = {
826
- /** The plugin id */
827
- id: string;
828
- };
829
- export declare type SitePluginsToggle200 = {
830
- success: boolean;
831
- };
832
- export declare type SitePluginsToggleBody = {
833
- /** activate or deactivate the plugin */
834
- activate: boolean;
835
- /** The plugin id */
836
- id: string;
837
- };
838
- export declare type SitePluginsAutoupdate200 = {
839
- success: boolean;
840
- };
841
- export declare type SitePluginsAutoupdateBody = {
842
- enable: boolean;
843
- };
844
- export declare type SitePluginUpdate200 = {
845
- id: string;
846
- status: string;
847
- };
848
- export declare type SitePluginUpdateBody = {
849
- /** activate or deactivate the plugin */
850
- activate: boolean;
851
- /** The plugin id */
852
- id: string;
853
- };
854
- export declare type SitePlugins200PluginsItem = {
855
- id: string;
856
- status: string;
857
- title: string;
858
- update: boolean;
859
- version?: string;
860
- };
861
- export declare type SitePlugins200 = {
862
- auto_update: boolean;
863
- plugins: SitePlugins200PluginsItem[];
864
- subtype: string;
865
- };
866
- export declare type SitePluginsParams = {
867
- plugin_id?: string;
868
- };
869
- export declare type CreatePhpInfo200 = {
870
- /** html file content */
871
- html?: string;
872
- };
873
- export declare type SitesPerformanceEndurancePageCache200 = {
874
- result?: string;
875
- status?: string;
876
- };
877
- export declare type SitesPerformanceEnduranceCacheLevel200Options = {
878
- [key: string]: unknown;
879
- };
880
- export declare type SitesPerformanceEnduranceCacheLevel200 = {
881
- options?: SitesPerformanceEnduranceCacheLevel200Options;
882
- };
883
- export declare type SitesPerformanceEnduranceCacheLevelBody = {
884
- /** @maximum 3 */
885
- endurance_cache_level?: number;
886
- };
887
- export declare type SitesPerformanceEnduranceCacheLevelStatus200 = {
888
- endurance_cache_level?: number;
889
- };
890
- export declare type SitesPerformanceEdgecache200 = {
891
- [key: string]: unknown;
892
- };
893
- export declare type SitesPerformanceEdgecacheBody = {
894
- /** Pass either 0 or 1 */
895
- edge_cache: number;
896
- };
897
- export declare type SitesPerformanceCachepurge200 = {
898
- success?: boolean;
899
- };
900
- export declare type SitesPerformanceCachepurgeBody = {
901
- /** */
902
- assets?: string[];
903
- /** Pass either 0, basic, premium, india or hostgator */
904
- cf?: string;
905
- /** Pass either 0 or 1 */
906
- epc?: number;
907
- /** */
908
- hosts: string[];
909
- };
910
- export declare type SitePendingDomainDelete200 = {
911
- [key: string]: unknown;
912
- };
913
- export declare type SitesMetricDimensions200 = {
914
- date_end?: string;
915
- date_start?: string;
916
- dimensions?: SitesMetricDimensions200Dimensions;
917
- elapsed?: number;
918
- metric?: string;
919
- };
920
- export declare type SitesMetricDimensions200DimensionsWpAdminAjaxActionItemDimension = {
921
- [key: string]: number;
922
- };
923
- export declare type SitesMetricDimensions200DimensionsWpAdminAjaxActionItem = {
924
- dimension?: SitesMetricDimensions200DimensionsWpAdminAjaxActionItemDimension;
925
- timestamp?: number;
926
- };
927
- export declare type SitesMetricDimensions200DimensionsVisitorIsCrawlerItemDimension = {
928
- [key: string]: number;
929
- };
930
- export declare type SitesMetricDimensions200DimensionsVisitorIsCrawlerItem = {
931
- dimension?: SitesMetricDimensions200DimensionsVisitorIsCrawlerItemDimension;
932
- timestamp?: number;
933
- };
934
- export declare type SitesMetricDimensions200DimensionsVisitorCountryCodeItemDimension = {
935
- [key: string]: number;
936
- };
937
- export declare type SitesMetricDimensions200DimensionsVisitorCountryCodeItem = {
938
- dimension?: SitesMetricDimensions200DimensionsVisitorCountryCodeItemDimension;
939
- timestamp?: number;
940
- };
941
- export declare type SitesMetricDimensions200DimensionsVisitorAsnItemDimension = {
942
- [key: string]: number;
943
- };
944
- export declare type SitesMetricDimensions200DimensionsVisitorAsnItem = {
945
- dimension?: SitesMetricDimensions200DimensionsVisitorAsnItemDimension;
946
- timestamp?: number;
947
- };
948
- export declare type SitesMetricDimensions200DimensionsPageRendererItemDimension = {
949
- [key: string]: number;
950
- };
951
- export declare type SitesMetricDimensions200DimensionsPageRendererItem = {
952
- dimension?: SitesMetricDimensions200DimensionsPageRendererItemDimension;
953
- timestamp?: number;
954
- };
955
- export declare type SitesMetricDimensions200DimensionsPageIsCachedItemDimension = {
956
- [key: string]: number;
957
- };
958
- export declare type SitesMetricDimensions200DimensionsPageIsCachedItem = {
959
- dimension?: SitesMetricDimensions200DimensionsPageIsCachedItemDimension;
960
- timestamp?: number;
961
- };
962
- export declare type SitesMetricDimensions200DimensionsHttpVersionItemDimension = {
963
- [key: string]: number;
964
- };
965
- export declare type SitesMetricDimensions200DimensionsHttpVersionItem = {
966
- dimension?: SitesMetricDimensions200DimensionsHttpVersionItemDimension;
967
- timestamp?: number;
968
- };
969
- export declare type SitesMetricDimensions200DimensionsHttpVerbItemDimension = {
970
- [key: string]: number;
971
- };
972
- export declare type SitesMetricDimensions200DimensionsHttpVerbItem = {
973
- dimension?: SitesMetricDimensions200DimensionsHttpVerbItemDimension;
974
- timestamp?: number;
975
- };
976
- export declare type SitesMetricDimensions200DimensionsHttpStatusItemDimension = {
977
- [key: string]: number;
978
- };
979
- export declare type SitesMetricDimensions200DimensionsHttpStatusItem = {
980
- dimension?: SitesMetricDimensions200DimensionsHttpStatusItemDimension;
981
- timestamp?: number;
982
- };
983
- export declare type SitesMetricDimensions200DimensionsHttpHostItemDimension = {
984
- [key: string]: number;
985
- };
986
- export declare type SitesMetricDimensions200DimensionsHttpHostItem = {
987
- dimension?: SitesMetricDimensions200DimensionsHttpHostItemDimension;
988
- timestamp?: number;
989
- };
990
- export declare type SitesMetricDimensions200Dimensions = {
991
- http_host?: SitesMetricDimensions200DimensionsHttpHostItem[];
992
- http_status?: SitesMetricDimensions200DimensionsHttpStatusItem[];
993
- http_verb?: SitesMetricDimensions200DimensionsHttpVerbItem[];
994
- http_version?: SitesMetricDimensions200DimensionsHttpVersionItem[];
995
- page_is_cached?: SitesMetricDimensions200DimensionsPageIsCachedItem[];
996
- page_renderer?: SitesMetricDimensions200DimensionsPageRendererItem[];
997
- visitor_asn?: SitesMetricDimensions200DimensionsVisitorAsnItem[];
998
- visitor_country_code?: SitesMetricDimensions200DimensionsVisitorCountryCodeItem[];
999
- visitor_is_crawler?: SitesMetricDimensions200DimensionsVisitorIsCrawlerItem[];
1000
- wp_admin_ajax_action?: SitesMetricDimensions200DimensionsWpAdminAjaxActionItem[];
1001
- };
1002
- export declare type SitesMetricDimensionsParams = {
1003
- start?: string;
1004
- end?: string;
1005
- };
1006
- export declare type SitesMetricsDimensionAveraged200Metrics = {
1007
- requests_persec?: number[];
1008
- response_bytes_average?: number[];
1009
- response_bytes_persec?: number[];
1010
- response_time_average?: number[];
1011
- };
1012
- export declare type SitesMetricsDimensionAveraged200 = {
1013
- date_end?: string;
1014
- date_start?: string;
1015
- dimension?: string;
1016
- elapsed?: number;
1017
- metrics?: SitesMetricsDimensionAveraged200Metrics;
1018
- unit?: string;
1019
- };
1020
- export declare type SitesMetricsDimensionAveragedParams = {
1021
- start?: string;
1022
- end?: string;
1023
- };
1024
- export declare type SiteMalwareStatus200 = {
1025
- /**
1026
- * malware status given by jetpack protect addon
1027
- * @nullable
1028
- */
1029
- malware_status?: string | null;
1030
- /**
1031
- * scanner state
1032
- * @nullable
1033
- */
1034
- scanner_state?: string | null;
1035
- };
1036
- export declare type SitesErrorLogsDownloadSort = (typeof SitesErrorLogsDownloadSort)[keyof typeof SitesErrorLogsDownloadSort];
1037
- export declare const SitesErrorLogsDownloadSort: {
1038
- readonly asc: "asc";
1039
- readonly desc: "desc";
1040
- };
1041
- export declare type SitesErrorLogsDownloadParams = {
1042
- /**
1043
- * Start time. Can be a unix time, a timestamp, or a {n}[dhm] format. Default is -1 day.
1044
- */
1045
- start?: string;
1046
- /**
1047
- * End time. Can be a unix time, a timestamp, now, or a {n}[dhm] format. Default is now.
1048
- */
1049
- end?: string;
1050
- sort?: SitesErrorLogsDownloadSort;
1051
- /**
1052
- * Items to filter on. Supported filters include: severity
1053
- */
1054
- filter?: {
1055
- severity?: string[];
1056
- };
1057
- };
1058
- export declare type SitesErrorLogs200LogsItem = {
1059
- datetime?: string;
1060
- epoch?: number;
1061
- file?: string;
1062
- kind?: string;
1063
- line?: number;
1064
- message?: string;
1065
- name?: string;
1066
- severity?: string;
1067
- };
1068
- export declare type SitesErrorLogs200 = {
1069
- datetime_end?: string;
1070
- datetime_start?: string;
1071
- logs?: SitesErrorLogs200LogsItem[];
1072
- /** @nullable */
1073
- page_id?: string | null;
1074
- total?: number;
1075
- };
1076
- export declare type SitesErrorLogsSort = (typeof SitesErrorLogsSort)[keyof typeof SitesErrorLogsSort];
1077
- export declare const SitesErrorLogsSort: {
1078
- readonly asc: "asc";
1079
- readonly desc: "desc";
1080
- };
1081
- export declare type SitesErrorLogsParams = {
1082
- /**
1083
- * Start time. Can be a unix time, a timestamp, or a {n}[dhm] format. Default is -1 day.
1084
- */
1085
- start?: string;
1086
- /**
1087
- * End time. Can be a unix time, a timestamp, now, or a {n}[dhm] format. Default is now.
1088
- */
1089
- end?: string;
1090
- /**
1091
- * max number of logs to return (default: 25)
1092
- */
1093
- limit?: number;
1094
- page_id?: string;
1095
- sort?: SitesErrorLogsSort;
1096
- /**
1097
- * Items to filter on. Supported filters include: severity
1098
- */
1099
- filter?: {
1100
- severity?: string[];
1101
- };
1102
- };
1103
- export declare type SitesAccessLogsDownloadSort = (typeof SitesAccessLogsDownloadSort)[keyof typeof SitesAccessLogsDownloadSort];
1104
- export declare const SitesAccessLogsDownloadSort: {
1105
- readonly asc: "asc";
1106
- readonly desc: "desc";
1107
- };
1108
- export declare type SitesAccessLogsDownloadParams = {
1109
- /**
1110
- * Start time. Can be a unix time, a timestamp, or a {n}[dhm] format.
1111
- */
1112
- start?: string;
1113
- /**
1114
- * End time. Can be a unix time, a timestamp, now, or a {n}[dhm] format.
1115
- */
1116
- end?: string;
1117
- sort?: SitesAccessLogsDownloadSort;
1118
- /**
1119
- * Items to filter on. Supported filters include: cached, renderer, request_type, status, user_ip
1120
- */
1121
- filter?: {
1122
- cached?: string[];
1123
- renderer?: string[];
1124
- request_type?: string[];
1125
- status?: number[];
1126
- user_ip?: string[];
1127
- };
1128
- };
1129
- export declare type SitesAccessLogs200LogsItem = {
1130
- body_bytes_sent?: number;
1131
- cached?: string;
1132
- datetime?: string;
1133
- epoch?: number;
1134
- http_host?: string;
1135
- http_referrer?: string;
1136
- http_user_agent?: string;
1137
- http_x_forwarded_for?: string;
1138
- renderer?: string;
1139
- request_completion?: string;
1140
- request_time?: number;
1141
- request_type?: string;
1142
- request_url?: string;
1143
- scheme?: string;
1144
- status?: number;
1145
- type?: string;
1146
- user_ip?: string;
1147
- };
1148
- export declare type SitesAccessLogs200 = {
1149
- datetime_end?: string;
1150
- datetime_start?: string;
1151
- logs?: SitesAccessLogs200LogsItem[];
1152
- /** @nullable */
1153
- page_id?: string | null;
1154
- total?: number;
1155
- };
1156
- export declare type SitesAccessLogsSort = (typeof SitesAccessLogsSort)[keyof typeof SitesAccessLogsSort];
1157
- export declare const SitesAccessLogsSort: {
1158
- readonly asc: "asc";
1159
- readonly desc: "desc";
1160
- };
1161
- export declare type SitesAccessLogsParams = {
1162
- /**
1163
- * Start time. Can be a unix time, a timestamp, or a {n}[dhm] format.
1164
- */
1165
- start?: string;
1166
- /**
1167
- * End time. Can be a unix time, a timestamp, now, or a {n}[dhm] format.
1168
- */
1169
- end?: string;
1170
- /**
1171
- * max number of logs to return (default: 25)
1172
- */
1173
- limit?: number;
1174
- page_id?: string;
1175
- sort?: SitesAccessLogsSort;
1176
- /**
1177
- * Items to filter on. Supported filters include: cached, renderer, request_type, status, user_ip
1178
- */
1179
- filter?: {
1180
- cached?: string[];
1181
- renderer?: string[];
1182
- request_type?: string[];
1183
- status?: number[];
1184
- user_ip?: string[];
1185
- };
1186
- };
1187
- export declare type AddSiteIpaddress200 = {
1188
- success?: number;
1189
- };
1190
- export declare type AddSiteIpaddressBody = {
1191
- /** ip to block for the site */
1192
- blocked_ip: string;
1193
- };
1194
- export declare type SiteIpaddress200 = {
1195
- success?: number;
1196
- };
1197
- export declare type SiteIpaddressBody = {
1198
- /** ip to block for the site */
1199
- blocked_ip: string;
1200
- };
1201
- export declare type SiteIpaddressList200Item = {
1202
- beginning_ip?: string;
1203
- ending_ip?: string;
1204
- server_setting?: string;
1205
- };
1206
- export declare type SitesDomainsCreate200 = {
1207
- id?: number;
1208
- status?: string;
1209
- };
1210
- export declare type SitesDomainsCreateBody = {
1211
- /** The new domain to be added */
1212
- domain: string;
1213
- };
1214
- export declare type SitesDomainUrl200 = {
1215
- success?: boolean;
1216
- };
1217
- export declare type SitesDomainUrlBody = {
1218
- force?: boolean;
1219
- /** Option to create the temporary domain */
1220
- temp_domain?: boolean;
1221
- /** Optional to unassign the domain after switching to temporary domain */
1222
- unassign_domain?: boolean;
1223
- /** URL of the site to be updated */
1224
- url?: string;
1225
- };
1226
- export declare type SitesDomain200Wanted = {
1227
- a?: string[];
1228
- ns?: string[];
1229
- };
1230
- export declare type SitesDomain200Detected = {
1231
- a?: string[];
1232
- ns?: string[];
1233
- };
1234
- export declare type SitesDomain200 = {
1235
- a_match?: boolean;
1236
- connected?: boolean;
1237
- detected?: SitesDomain200Detected;
1238
- nameserver_match?: boolean;
1239
- wanted?: SitesDomain200Wanted;
1240
- };
1241
- export declare type SitesDomainParams = {
1242
- domain?: string;
1243
- };
1244
- export declare type SitesDns200RecordsItem = {
1245
- name?: string;
1246
- type?: string;
1247
- value?: string;
1248
- };
1249
- export declare type SitesDns200 = {
1250
- records?: SitesDns200RecordsItem[];
1251
- source?: string;
1252
- success?: boolean;
1253
- };
1254
- export declare type SitesDnsParams = {
1255
- type?: string;
1256
- };
1257
- export declare type SitesDatabasePasswordsync200 = {
1258
- [key: string]: unknown;
1259
- };
1260
- export declare type SitesDatabaseInfo200 = {
1261
- /** @nullable */
1262
- charset?: string | null;
1263
- /** @nullable */
1264
- collation?: string | null;
1265
- };
1266
- export declare type SiteAddonCloudflare400 = {
1267
- error?: string;
1268
- };
1269
- export declare type SiteAddonCloudflare200 = {
1270
- addon_id?: number;
1271
- };
1272
- export declare type BackupsJetpackBackup200 = {
1273
- [key: string]: unknown;
1274
- };
1275
- export declare type JetpackBackupStatus200 = {
1276
- /** @nullable */
1277
- addon_back_reference?: string | null;
1278
- addon_exists?: boolean;
1279
- /** @nullable */
1280
- addon_id?: string | null;
1281
- can_upgrade?: boolean;
1282
- has_active_addon?: boolean;
1283
- has_active_plugin?: boolean;
1284
- /** @nullable */
1285
- next_url?: string | null;
1286
- pending_upgrade?: boolean;
1287
- /** @nullable */
1288
- plan_name?: string | null;
1289
- plugin_exists?: boolean;
1290
- /** @nullable */
1291
- status?: string | null;
1292
- };
1293
- export declare type SitesBackupsDetails200Jetpack = {
1294
- /** @nullable */
1295
- addon_back_reference?: string | null;
1296
- addon_exists?: boolean;
1297
- /** @nullable */
1298
- addon_id?: string | null;
1299
- can_upgrade?: boolean;
1300
- has_active_addon?: boolean;
1301
- has_active_plugin?: boolean;
1302
- /** @nullable */
1303
- last_backup_date?: string | null;
1304
- /** @nullable */
1305
- next_url?: string | null;
1306
- pending_upgrade?: boolean;
1307
- /** @nullable */
1308
- plan_name?: string | null;
1309
- plugin_exists?: boolean;
1310
- /** @nullable */
1311
- status?: string | null;
1312
- };
1313
- export declare type SitesBackupsDetails200Codeguard = {
1314
- activated?: boolean;
1315
- addon_id?: string;
1316
- /** @nullable */
1317
- database_id?: string | null;
1318
- /** @nullable */
1319
- plan_name?: string | null;
1320
- seats_available?: number;
1321
- seats_count?: number;
1322
- status?: boolean;
1323
- /** @nullable */
1324
- url?: string | null;
1325
- /** @nullable */
1326
- website_id?: string | null;
1327
- };
1328
- export declare type SitesBackupsDetails200 = {
1329
- codeguard?: SitesBackupsDetails200Codeguard;
1330
- jetpack?: SitesBackupsDetails200Jetpack;
1331
- };
1332
- export declare type SitesBackupsCodeguard200 = {
1333
- database_id?: number;
1334
- success?: number;
1335
- website_id?: number;
1336
- };
1337
- export declare type SitesHasBackups200 = {
1338
- has_backups?: boolean;
1339
- };
1340
- export declare type SitesBackups200 = {
1341
- has_backups?: boolean;
1342
- };
1343
- /**
1344
- * autoupdate type
1345
- */
1346
- export declare type SitesAutoupdatesUpdateBodyType = (typeof SitesAutoupdatesUpdateBodyType)[keyof typeof SitesAutoupdatesUpdateBodyType];
1347
- export declare const SitesAutoupdatesUpdateBodyType: {
1348
- readonly core: "core";
1349
- readonly plugins: "plugins";
1350
- readonly themes: "themes";
1351
- };
1352
- export declare type SitesAutoupdatesUpdateBody = {
1353
- /** true to enable, false for disable */
1354
- enabled: boolean;
1355
- /** autoupdate type */
1356
- type: SitesAutoupdatesUpdateBodyType;
1357
- };
1358
- export declare type Site200 = {
1359
- success: boolean;
1360
- };
1361
- export declare type SiteUpdate400 = {
1362
- error?: string;
1363
- };
1364
- export declare type SiteUpdate200 = {
1365
- success: boolean;
1366
- };
1367
- /**
1368
- * WP version
1369
- */
1370
- export declare type SiteUpdateBodyVersionPtr = (typeof SiteUpdateBodyVersionPtr)[keyof typeof SiteUpdateBodyVersionPtr];
1371
- export declare const SiteUpdateBodyVersionPtr: {
1372
- readonly latest: "latest";
1373
- readonly previous: "previous";
1374
- readonly beta: "beta";
1375
- };
1376
- export declare type SiteUpdateBody = {
1377
- /** Disk space in GiB */
1378
- disk_limit_gib?: number;
1379
- /** domain for the site to be added */
1380
- domain?: string;
1381
- /** toggle between wordpress/lightweight for non-existent static file */
1382
- handler_404?: boolean;
1383
- /** filesystem path that follows the domain in the url */
1384
- path?: string;
1385
- /** Skip FG domain checks for HAL domain */
1386
- skip_fg_checks?: boolean;
1387
- /** title of the site to be updated */
1388
- title?: string;
1389
- /** WP version */
1390
- version_ptr?: SiteUpdateBodyVersionPtr;
1391
- /** Number of PHP workers */
1392
- workers?: number;
1393
- };
1394
- export declare type SitesInfo200ResourcesStorage = {
1395
- /** @nullable */
1396
- available?: number | null;
1397
- /** @nullable */
1398
- total?: number | null;
1399
- unit?: string;
1400
- /** @nullable */
1401
- used?: number | null;
1402
- };
1403
- export declare type SitesInfo200Resources = {
1404
- storage?: SitesInfo200ResourcesStorage;
1405
- /** @nullable */
1406
- workers?: number | null;
1407
- };
1408
- /**
1409
- * @nullable
1410
- */
1411
- export declare type SitesInfo200PendingUrlData = {
1412
- /**
1413
- * The root domain name
1414
- * @nullable
1415
- */
1416
- base_domain?: string | null;
1417
- /**
1418
- * The Fully Qualified Domain Name (FQDN)
1419
- * @nullable
1420
- */
1421
- domain?: string | null;
1422
- /**
1423
- * The current pending_url's HAL Domain ID
1424
- * @nullable
1425
- */
1426
- domain_id?: number | null;
1427
- /** @nullable */
1428
- error?: string | null;
1429
- /** Flag indicating whether the pending_url is temporary or not */
1430
- is_temp?: boolean;
1431
- /**
1432
- * Flag indicating whether the url_sync job has run out of attempts
1433
- * @nullable
1434
- */
1435
- job_failed?: boolean | null;
1436
- /** @nullable */
1437
- stage?: string | null;
1438
- /**
1439
- * Timestamp for when we will update the WP url, regardless of active sessions
1440
- * @nullable
1441
- */
1442
- wp_session?: string | null;
1443
- } | null;
1444
- /**
1445
- * Job ids for the site
1446
- * @nullable
1447
- */
1448
- export declare type SitesInfo200Jobs = {
1449
- [key: string]: unknown;
1450
- } | null;
1451
- export declare type SitesInfo200 = {
1452
- /** @nullable */
1453
- account_back_ref?: string | null;
1454
- account_id?: string;
1455
- /** @nullable */
1456
- base_domain?: string | null;
1457
- /**
1458
- * False if site was added by site scanner
1459
- * @nullable
1460
- */
1461
- confirmed?: boolean | null;
1462
- /** @nullable */
1463
- datacenter?: string | null;
1464
- date_added?: string;
1465
- date_modified?: string;
1466
- detected_type?: string;
1467
- /** @nullable */
1468
- docroot?: string | null;
1469
- /** @nullable */
1470
- domain?: string | null;
1471
- edge_cache?: boolean;
1472
- /** @nullable */
1473
- handler_404?: string | null;
1474
- id?: number;
1475
- /** @nullable */
1476
- installed_id?: string | null;
1477
- /** True if docpath is public_html, otherwise False */
1478
- is_primary?: boolean;
1479
- /**
1480
- * Job ids for the site
1481
- * @nullable
1482
- */
1483
- jobs?: SitesInfo200Jobs;
1484
- /** @nullable */
1485
- last_error?: string | null;
1486
- /** @nullable */
1487
- migration_id?: string | null;
1488
- /** @nullable */
1489
- name?: string | null;
1490
- path?: string;
1491
- /** @nullable */
1492
- pending_url?: string | null;
1493
- /** @nullable */
1494
- pending_url_data?: SitesInfo200PendingUrlData;
1495
- /**
1496
- * The Php Version. If unable to determine, it will be NULL
1497
- * @nullable
1498
- */
1499
- php_version?: string | null;
1500
- resources?: SitesInfo200Resources;
1501
- status?: string;
1502
- subtype?: string;
1503
- type?: string;
1504
- /** @nullable */
1505
- url?: string | null;
1506
- /** @nullable */
1507
- url_is_provisional?: boolean | null;
1508
- /** @nullable */
1509
- version?: string | null;
1510
- /**
1511
- * The WP Version
1512
- * @nullable
1513
- */
1514
- version_ptr?: string | null;
1515
- };
1516
- export declare type SitesList200ItemsItem = {
1517
- docroot?: string;
1518
- id?: string;
1519
- name?: string;
1520
- status?: string;
1521
- url?: string;
1522
- };
1523
- export declare type SitesList200 = {
1524
- items?: SitesList200ItemsItem[];
1525
- };
1526
- export declare type Sso200 = {
1527
- url: string;
1528
- };
1529
- export declare type SsoApp = (typeof SsoApp)[keyof typeof SsoApp];
1530
- export declare const SsoApp: {
1531
- readonly phpmyadmin: "phpmyadmin";
1532
- readonly filemanager: "filemanager";
1533
- readonly cronjobs: "cronjobs";
1534
- readonly accesslogs: "accesslogs";
1535
- readonly errorlogs: "errorlogs";
1536
- readonly domainredirects: "domainredirects";
1537
- readonly sshkeys: "sshkeys";
1538
- readonly ftp: "ftp";
1539
- readonly sslsigningrequests: "sslsigningrequests";
1540
- readonly ssluploadcert: "ssluploadcert";
1541
- readonly sslviewlogs: "sslviewlogs";
1542
- readonly emailaccounts: "emailaccounts";
1543
- readonly emailforwarders: "emailforwarders";
1544
- readonly emailfilters: "emailfilters";
1545
- readonly emailglobalfilters: "emailglobalfilters";
1546
- readonly emailspamfilters: "emailspamfilters";
1547
- readonly emailautoresponders: "emailautoresponders";
1548
- readonly emailrouting: "emailrouting";
1549
- readonly softaculous: "softaculous";
1550
- readonly mysql: "mysql";
1551
- readonly zoneeditor: "zoneeditor";
1552
- };
1553
- export declare type SsoParams = {
1554
- app?: SsoApp;
1555
- dir?: string;
1556
- domain?: string;
1557
- };
1558
- export declare type SshKeyGenerate200 = {
1559
- key_name?: string;
1560
- private_key_path?: string;
1561
- public_key_path?: string;
1562
- };
1563
- /**
1564
- * The SSH key's encryption method for authentication (rsa or dsa). Defaults to rsa.
1565
- */
1566
- export declare type SshKeyGenerateBodyEncType = (typeof SshKeyGenerateBodyEncType)[keyof typeof SshKeyGenerateBodyEncType];
1567
- export declare const SshKeyGenerateBodyEncType: {
1568
- readonly rsa: "rsa";
1569
- readonly dsa: "dsa";
1570
- readonly ed25519: "ed25519";
1571
- readonly ecdsa: "ecdsa";
1572
- };
1573
- /**
1574
- * A positive integer of 1024 or more. Defaults to 2048 bits.
1575
- */
1576
- export declare type SshKeyGenerateBodyBits = (typeof SshKeyGenerateBodyBits)[keyof typeof SshKeyGenerateBodyBits];
1577
- export declare const SshKeyGenerateBodyBits: {
1578
- readonly NUMBER_1024: 1024;
1579
- readonly NUMBER_2048: 2048;
1580
- readonly NUMBER_4096: 4096;
1581
- };
1582
- export declare type SshKeyGenerateBody = {
1583
- /** A positive integer of 1024 or more. Defaults to 2048 bits. */
1584
- bits?: SshKeyGenerateBodyBits;
1585
- /** The SSH key's encryption method for authentication (rsa or dsa). Defaults to rsa. */
1586
- enc_type?: SshKeyGenerateBodyEncType;
1587
- /** The SSH key's filename */
1588
- name: string;
1589
- /** A note to log alongside the secure_action_log entry. */
1590
- note?: string;
1591
- /**
1592
- * The SSH key's password. Must be four or more secure characters.
1593
- * @minLength 4
1594
- */
1595
- pass?: string;
1596
- /** The entity that initiated the GAP call */
1597
- source?: string;
1598
- };
1599
- export declare type SshKey200 = {
1600
- deleted?: number;
1601
- key_name?: string;
1602
- };
1603
- export declare type SshKeyBody = {
1604
- name: string;
1605
- note?: string;
1606
- source?: string;
1607
- };
1608
- export declare type SshKeyList200KeysItem = {
1609
- file?: string;
1610
- haspub?: number;
1611
- key?: string;
1612
- name?: string;
1613
- };
1614
- export declare type SshKeyList200 = {
1615
- keys?: SshKeyList200KeysItem[];
1616
- };
1617
- export declare type SshKeyImport200 = {
1618
- key_name?: string;
1619
- };
1620
- export declare type SshKeyImportBody = {
1621
- /** The SSH key's filename */
1622
- name: string;
1623
- /** A note to log alongside the secure_action_log entry. */
1624
- note?: string;
1625
- /**
1626
- * The SSH key's password. Must be four or more secure characters.
1627
- * @minLength 4
1628
- */
1629
- pass?: string;
1630
- /** A Valid SSH private key */
1631
- privkey?: string;
1632
- /** A Valid SSH public key */
1633
- pubkey?: string;
1634
- /** The entity that initiated the GAP call */
1635
- source?: string;
1636
- };
1637
- export declare type SshKeyFetch200 = {
1638
- key?: string;
1639
- key_name?: string;
1640
- type?: string;
1641
- };
1642
- export declare type SshKeyFetchPrivate = (typeof SshKeyFetchPrivate)[keyof typeof SshKeyFetchPrivate];
1643
- export declare const SshKeyFetchPrivate: {
1644
- readonly NUMBER_0: "0";
1645
- readonly NUMBER_1: "1";
1646
- };
1647
- export declare type SshKeyFetchParams = {
1648
- name: string;
1649
- private?: SshKeyFetchPrivate;
1650
- };
1651
- export declare type HostingSshInfo200 = {
1652
- credential?: string;
1653
- status?: string;
1654
- success?: boolean;
1655
- };
1656
- export declare type SitesBatch200 = {
1657
- success?: boolean;
1658
- };
1659
- export declare type SitesBatchBodySitesItem = {
1660
- /** Disk space in GiB */
1661
- disk_limit_gib?: number;
1662
- /** site_id of the site to be updated */
1663
- site_id?: number;
1664
- /** Number of PHP workers */
1665
- workers?: number;
1666
- };
1667
- export declare type SitesBatchBody = {
1668
- sites?: SitesBatchBodySitesItem[];
1669
- };
1670
- export declare type HostingSiteAdd200 = {
1671
- id?: number;
1672
- status?: string;
1673
- success: boolean;
1674
- };
1675
- /**
1676
- * Datacenter to host site in.
1677
- */
1678
- export declare type HostingSiteAddBodyDatacenter = (typeof HostingSiteAddBodyDatacenter)[keyof typeof HostingSiteAddBodyDatacenter];
1679
- export declare const HostingSiteAddBodyDatacenter: {
1680
- readonly 'Amsterdam,_Netherlands': "Amsterdam, Netherlands";
1681
- readonly 'Ashburn,_Virginia': "Ashburn, Virginia";
1682
- readonly 'Dallas,_Texas': "Dallas, Texas";
1683
- readonly 'Los_Angeles,_California': "Los Angeles, California";
1684
- };
1685
- export declare type HostingSiteAddBody = {
1686
- /** Admin email for the site user */
1687
- admin_email?: string;
1688
- /** Admin user for the site */
1689
- admin_user?: string;
1690
- /** HAL site id to clone */
1691
- clone_site_id?: number;
1692
- /** Datacenter to host site in. */
1693
- datacenter?: HostingSiteAddBodyDatacenter;
1694
- /** Disk space in GiB */
1695
- disk_limit_gib?: number;
1696
- /** domain for the site to be added */
1697
- domain?: string;
1698
- /** toggle between wordpress/lightweight for non-existent static file */
1699
- handler_404?: boolean;
1700
- /** Migrate an existing wordpress site */
1701
- migration_id?: string;
1702
- /** Installation Path */
1703
- path?: string;
1704
- /** flag indicating whether this site is for a self serve wp migration or not */
1705
- ss_wp_mig?: boolean;
1706
- /** Site Subtype */
1707
- subtype: string;
1708
- /** title of the site to be added */
1709
- title?: string;
1710
- /** Number of PHP workers */
1711
- workers?: number;
1712
- };
1713
- export declare type HostingShellInfo200 = {
1714
- enabled?: boolean;
1715
- };
1716
- export declare type HostingShellToggle200 = {
1717
- enabled?: boolean;
1718
- };
1719
- export declare type HostingShellToggleBody = {
1720
- /** boolean flag to enable or disable hosting shell */
1721
- enabled: boolean;
1722
- };
1723
- export declare type HostingResellerSsoWhm200 = {
1724
- url?: string;
1725
- };
1726
- export declare type AddHostingRedirects200 = {
1727
- success?: number;
1728
- };
1729
- export declare type AddHostingRedirectsBody = {
1730
- /** domain to redirect */
1731
- domain: string;
1732
- /** 3 (default) indicates redirect with or without www,2-Do Not Redirect www,1 only redirect with www */
1733
- redirect_www?: number;
1734
- /** path or or sub directory */
1735
- src?: string;
1736
- /** Permanent-301 notifies the visitors browser to update its records, Temporary-302 does not update browser bookmark */
1737
- type?: string;
1738
- /** destination url */
1739
- url: string;
1740
- /** redirects all files within a directory to the same filename in the redirected directory */
1741
- wildcard?: number;
1742
- };
1743
- export declare type HostingRedirect200 = {
1744
- success?: number;
1745
- };
1746
- export declare type HostingRedirectBody = {
1747
- /** domain to redirect */
1748
- domain: string;
1749
- /** docroot pointing to directory of redirect. If undefined cpanel looks up this field */
1750
- redirect?: string;
1751
- /** path or or sub directory */
1752
- src?: string;
1753
- };
1754
- export declare type HostingRedirects200Item = {
1755
- docroot?: string;
1756
- domain?: string;
1757
- http_status_code?: number;
1758
- redirect_www?: boolean;
1759
- src?: string;
1760
- type?: string;
1761
- url?: string;
1762
- wildcard?: boolean;
1763
- };
1764
- export declare type HostingOnboardingDataUpdate200 = {
1765
- completed?: boolean;
1766
- };
1767
- export declare type HostingOnboardingDataUpdateBody = {
1768
- completed?: boolean;
1769
- };
1770
- export declare type HostingOnboardingData200 = {
1771
- /** @nullable */
1772
- completed?: boolean | null;
1773
- };
1774
- export declare type HostingNameservers200 = {
1775
- nameservers: string[];
1776
- };
1777
- export declare type HostingMigrationSiteScanStatus200 = {
1778
- callback_url?: string;
1779
- transferable?: boolean;
1780
- };
1781
- export declare type HostingMigrationSiteScanStatusParams = {
1782
- /**
1783
- * valid domain, URI format is preferred
1784
- */
1785
- prospect_url: string;
1786
- };
1787
- export declare type HostingMigrationInfo200 = {
1788
- domain?: string;
1789
- feasible?: string;
1790
- hostname?: string;
1791
- incoming_domain?: string;
1792
- is_valid_migration_id?: boolean;
1793
- migration_id?: string;
1794
- site_url?: string;
1795
- };
1796
- export declare type HostingMigrationInfoParams = {
1797
- migration_id: string;
1798
- };
1799
- export declare type HostingMigrationsEvent200 = {
1800
- success?: boolean;
1801
- };
1802
- export declare type HostingMigrationsEventBodyEventName = (typeof HostingMigrationsEventBodyEventName)[keyof typeof HostingMigrationsEventBodyEventName];
1803
- export declare const HostingMigrationsEventBodyEventName: {
1804
- readonly inReview: "inReview";
1805
- readonly approved: "approved";
1806
- readonly disapproved: "disapproved";
1807
- readonly propagationComplete: "propagationComplete";
1808
- readonly propagationTimeout: "propagationTimeout";
1809
- readonly transferComplete: "transferComplete";
1810
- readonly failedCreate: "failedCreate";
1811
- };
1812
- export declare type HostingMigrationsEventBody = {
1813
- event_name: HostingMigrationsEventBodyEventName;
1814
- /** The migration id that corresponds to CWM */
1815
- migration_id: string;
1816
- };
1817
- export declare type HostingMigrationsCheck200 = {
1818
- description?: string;
1819
- transferable?: boolean;
1820
- };
1821
- export declare type HostingMigrationsCheckParams = {
1822
- /**
1823
- * Migration ID to be checked if already used to migrate site on the hosting account
1824
- */
1825
- migration_id: string;
1826
- };
1827
- export declare type HostingMigrations200 = {
1828
- success?: boolean;
1829
- };
1830
- export declare type HostingMigrationsBody = {
1831
- /** The migration id that corresponds to CWM */
1832
- migration_id: string;
1833
- };
1834
- export declare type HostingMigrationStatus200RowsItem = {
1835
- id?: string;
1836
- status?: string;
1837
- subtype?: string;
1838
- type?: string;
1839
- };
1840
- export declare type HostingMigrationStatus200 = {
1841
- rows?: HostingMigrationStatus200RowsItem[];
1842
- };
1843
- export declare type HostingLead400 = {
1844
- [key: string]: unknown;
1845
- };
1846
- export declare type HostingLead200ResponseItemData = {
1847
- leadId?: string;
1848
- message?: string;
1849
- };
1850
- export declare type HostingLead200ResponseItem = {
1851
- clientRequestId?: string;
1852
- data?: HostingLead200ResponseItemData;
1853
- errors?: string;
1854
- messageId?: string;
1855
- providerApplicationName?: string;
1856
- status?: string;
1857
- };
1858
- /**
1859
- * @nullable
1860
- */
1861
- export declare type HostingLead200 = {
1862
- response?: HostingLead200ResponseItem[];
1863
- } | null;
1864
- export declare type HostingLeadParams = {
1865
- phone?: string;
1866
- };
1867
- export declare type HostingInfoDiskUsage200 = {
1868
- /** @nullable */
1869
- disklastupdated?: string | null;
1870
- disklimit?: string;
1871
- diskused?: string;
1872
- /** @nullable */
1873
- fileslimit?: number | null;
1874
- /** @nullable */
1875
- filesused?: number | null;
1876
- };
1877
- export declare type HostingInfo200 = {
1878
- ip?: string;
1879
- };
1880
- export declare type HostingFtp200 = {
1881
- status?: number;
1882
- /** Username */
1883
- user?: string;
1884
- };
1885
- export declare type HostingFtpBody = {
1886
- /** 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. */
1887
- destroy?: boolean;
1888
- /** Optional: A note to log alongside the secure_action_log entry. */
1889
- note?: string;
1890
- /** Optional: The entity that initiated the GAP call, eg. i_cluster, admin_user, script, cron, addon_$type($id) */
1891
- source?: string;
1892
- /** Username for FTP account to delete. */
1893
- user: string;
1894
- };
1895
- export declare type HostingFtpUpdate200 = {
1896
- status?: number;
1897
- };
1898
- /**
1899
- * Must pass either password or quota.
1900
- */
1901
- export declare type HostingFtpUpdateBodyUserTypeSet = (typeof HostingFtpUpdateBodyUserTypeSet)[keyof typeof HostingFtpUpdateBodyUserTypeSet];
1902
- export declare const HostingFtpUpdateBodyUserTypeSet: {
1903
- readonly password: "password";
1904
- readonly quota: "quota";
1905
- };
1906
- export declare type HostingFtpUpdateBody = {
1907
- /** Update password for user */
1908
- password?: string;
1909
- /** Update quota for user. Quota value should be greater than or equal to 0. */
1910
- quota?: number;
1911
- /** Username for FTP account. */
1912
- user: string;
1913
- /** Must pass either password or quota. */
1914
- user_type_set?: HostingFtpUpdateBodyUserTypeSet;
1915
- };
1916
- export declare type HostingFtpAdd200 = {
1917
- pass?: string;
1918
- user?: string;
1919
- };
1920
- export declare type HostingFtpAddBody = {
1921
- /** 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. */
1922
- domain?: string;
1923
- /** Path to FTP folder. Default is /. (will be relative from homedir) */
1924
- folder?: string;
1925
- /** Optional: A note to log alongside the secure_action_log entry. */
1926
- note?: string;
1927
- /** Optional password. One will be generated if not included */
1928
- pass?: string;
1929
- /** Optional: The entity that initiated the GAP call, eg. i_cluster, admin_user, script, cron, addon_$type($id) */
1930
- source?: string;
1931
- /** Text to prepended in random username generation. */
1932
- type?: string;
1933
- /** Optional username. If not included then type is required and will generate a random username. Good for temp ftp user. Do not append domain. */
1934
- user: string;
1935
- user_type_set?: string;
1936
- };
1937
- export declare type HostingFtpList200SpecialFtpAccountsItem = {
1938
- account?: string;
1939
- domain?: string;
1940
- homedir?: string;
1941
- type?: string;
1942
- user?: string;
1943
- };
1944
- export declare type HostingFtpList200FtpAccountsItem = {
1945
- account?: string;
1946
- domain?: string;
1947
- homedir?: string;
1948
- type?: string;
1949
- user?: string;
1950
- };
1951
- export declare type HostingFtpList200 = {
1952
- ftp_accounts?: HostingFtpList200FtpAccountsItem[];
1953
- server_name?: string;
1954
- special_ftp_accounts?: HostingFtpList200SpecialFtpAccountsItem[];
1955
- };
1956
- /**
1957
- * @nullable
1958
- */
1959
- export declare type HostingEcommerceInfo200 = {
1960
- addon_id?: number;
1961
- /** eCommerce addon back reference (a.k.a. prodInstId) */
1962
- back_ref?: string;
1963
- level?: string;
1964
- name?: string;
1965
- status?: string;
1966
- /** @nullable */
1967
- subtype?: string | null;
1968
- type?: string;
1969
- } | null;
1970
- export declare type HostingDomainsUnassign200 = {
1971
- queued?: boolean;
1972
- };
1973
- export declare type HostingDomainsUnassignBody = {
1974
- /** The domain id to be unassigned */
1975
- domain_id: number;
1976
- };
1977
- export declare type Domains200DomainsItem = {
1978
- /**
1979
- * ssl exipry date
1980
- * @nullable
1981
- */
1982
- date_ssl_exp?: string | null;
1983
- docroot: string;
1984
- domain: string;
1985
- id: number;
1986
- /**
1987
- * ssl issuer
1988
- * @nullable
1989
- */
1990
- ssl_issuer?: string | null;
1991
- /** ssl status */
1992
- ssl_status?: string;
1993
- /** status */
1994
- status?: string;
1995
- type: string;
1996
- };
1997
- export declare type Domains200 = {
1998
- domains: Domains200DomainsItem[];
1999
- };
2000
- export declare type DomainsType = (typeof DomainsType)[keyof typeof DomainsType];
2001
- export declare const DomainsType: {
2002
- readonly addon: "addon";
2003
- readonly main: "main";
2004
- readonly parked: "parked";
2005
- readonly sub: "sub";
2006
- readonly unassigned: "unassigned";
2007
- };
2008
- export declare type DomainsParams = {
2009
- type?: DomainsType;
2010
- };
2011
- export declare type DbUserRename200 = {
2012
- success?: number;
2013
- };
2014
- export declare type DbUserRenameBody = {
2015
- /** username mapped to DB */
2016
- dbuser: string;
2017
- /** updating username to new username in DB */
2018
- new_dbuser: string;
2019
- };
2020
- export declare type DbUserList200UsersItem = {
2021
- dblist?: string[];
2022
- shortuser?: string;
2023
- user?: string;
2024
- };
2025
- export declare type DbUserList200 = {
2026
- users?: DbUserList200UsersItem[];
2027
- };
2028
- export declare type DbUserDelete200 = {
2029
- dbuser?: string;
2030
- };
2031
- export declare type DbUserDeleteBody = {
2032
- /** The complete database username */
2033
- dbuser: string;
2034
- };
2035
- export declare type DbUserAdd200 = {
2036
- password?: string;
2037
- username?: string;
2038
- };
2039
- /**
2040
- * Set for wanting either mysql or postgres
2041
- */
2042
- export declare type DbUserAddBodyDbType = (typeof DbUserAddBodyDbType)[keyof typeof DbUserAddBodyDbType];
2043
- export declare const DbUserAddBodyDbType: {
2044
- readonly mysql: "mysql";
2045
- readonly postgres: "postgres";
2046
- };
2047
- export declare type DbUserAddBody = {
2048
- /** Database name. */
2049
- database?: string;
2050
- /** Set for wanting either mysql or postgres */
2051
- db_type?: DbUserAddBodyDbType;
2052
- /** username to be created for the DB */
2053
- dbuser: string;
2054
- /**
2055
- * Database password for this new user. If not provided one will be generated.
2056
- * @minLength 12
2057
- */
2058
- password?: string;
2059
- /** An array of user privileges. */
2060
- privileges?: string[];
2061
- /**
2062
- * The account type; eg, cg for codeguard, used for auto-generated usernames. Max 2 characters.
2063
- * @minLength 1
2064
- * @maxLength 2
2065
- */
2066
- type?: string;
2067
- };
2068
- export declare type DbUserPrivsSet200 = {
2069
- status?: number;
2070
- };
2071
- /**
2072
- * Type of database
2073
- */
2074
- export declare type DbUserPrivsSetBodyType = (typeof DbUserPrivsSetBodyType)[keyof typeof DbUserPrivsSetBodyType];
2075
- export declare const DbUserPrivsSetBodyType: {
2076
- readonly mysql: "mysql";
2077
- readonly postgres: "postgres";
2078
- };
2079
- export declare type DbUserPrivsSetBody = {
2080
- /** Database name. */
2081
- database?: string;
2082
- /** Database user names. */
2083
- dbusers?: string[];
2084
- /** An array of user privileges. */
2085
- privileges?: string[];
2086
- /** Type of database */
2087
- type?: DbUserPrivsSetBodyType;
2088
- };
2089
- export declare type DbUserPrivsGet200 = {
2090
- privileges?: string[];
2091
- };
2092
- export declare type DbUserPrivsGetParams = {
2093
- database: string;
2094
- dbuser: string;
2095
- };
2096
- export declare type DbUserPasswordSet200 = {
2097
- dbuser?: string;
2098
- };
2099
- export declare type DbUserPasswordSetBody = {
2100
- /** Database user name. */
2101
- dbuser: string;
2102
- /** Database password to be updated. */
2103
- password: string;
2104
- };
2105
- export declare type DbUsage200 = {
2106
- db_count?: number;
2107
- /** @nullable */
2108
- db_limit?: number | null;
2109
- };
2110
- export declare type DbCheckDatabase200 = {
2111
- database?: string;
2112
- };
2113
- /**
2114
- * Type of database
2115
- */
2116
- export declare type DbCheckDatabaseBodyType = (typeof DbCheckDatabaseBodyType)[keyof typeof DbCheckDatabaseBodyType];
2117
- export declare const DbCheckDatabaseBodyType: {
2118
- readonly mysql: "mysql";
2119
- readonly postgres: "postgres";
2120
- };
2121
- export declare type DbCheckDatabaseBody = {
2122
- /** A valid database name. */
2123
- database: string;
2124
- /** Type of database */
2125
- type?: DbCheckDatabaseBodyType;
2126
- };
2127
- export declare type DbList200DatabasesItemUserlistItem = {
2128
- db?: string;
2129
- user?: string;
2130
- };
2131
- export declare type DbList200DatabasesItem = {
2132
- db?: string;
2133
- sitename?: string;
2134
- size?: string;
2135
- sizemeg?: string;
2136
- usercount?: number;
2137
- userlist?: DbList200DatabasesItemUserlistItem[];
2138
- };
2139
- export declare type DbList200 = {
2140
- databases?: DbList200DatabasesItem[];
2141
- status?: boolean;
2142
- };
2143
- export declare type Db200 = {
2144
- dbname?: string;
2145
- status?: number;
2146
- type?: string;
2147
- };
2148
- /**
2149
- * Type of database
2150
- */
2151
- export declare type DbBodyType = (typeof DbBodyType)[keyof typeof DbBodyType];
2152
- export declare const DbBodyType: {
2153
- readonly mysql: "mysql";
2154
- readonly postgres: "postgres";
2155
- };
2156
- export declare type DbBody = {
2157
- /** The name of the database to delete.First 8 characters of account username will be prepended.ex: {username}_{dbname} */
2158
- dbname: string;
2159
- /** Type of database */
2160
- type?: DbBodyType;
2161
- };
2162
- export declare type DbAdd200 = {
2163
- dbname?: string;
2164
- status?: number;
2165
- type?: string;
2166
- };
2167
- /**
2168
- * Type of database to add
2169
- */
2170
- export declare type DbAddBodyType = (typeof DbAddBodyType)[keyof typeof DbAddBodyType];
2171
- export declare const DbAddBodyType: {
2172
- readonly mysql: "mysql";
2173
- readonly postgres: "postgres";
2174
- };
2175
- export declare type DbAddBody = {
2176
- /**
2177
- * The database name. Account username_ will be prepended. Max length is 54 characters
2178
- * @maxLength 54
2179
- */
2180
- dbname: string;
2181
- /** Type of database to add */
2182
- type?: DbAddBodyType;
2183
- };
2184
- export declare type Cron200 = {
2185
- success?: boolean;
2186
- };
2187
- export declare type CronBody = {
2188
- /** unique key for cron that is being updated */
2189
- key: number;
2190
- };
2191
- export declare type UpdateCron200 = {
2192
- key?: number;
2193
- };
2194
- export declare type UpdateCronBody = {
2195
- /** command to run as a cron, needs to be a valid string */
2196
- command: string;
2197
- /** 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. */
2198
- day: string;
2199
- /** 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. */
2200
- hour: string;
2201
- /** unique key for cron that is being updated */
2202
- key: number;
2203
- /** 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. */
2204
- minute: string;
2205
- /** 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. */
2206
- month: string;
2207
- /** Type of command (command, variable, comment, blank, unparsed) */
2208
- type?: string;
2209
- /** 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. */
2210
- weekday: string;
2211
- };
2212
- export declare type AddCron400 = {
2213
- error?: string;
2214
- };
2215
- export declare type AddCron200 = {
2216
- key?: string;
2217
- };
2218
- export declare type AddCronBody = {
2219
- /**
2220
- * command to run as a cron, needs to be a valid string
2221
- * @minLength 1
2222
- */
2223
- command: string;
2224
- /** 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. */
2225
- day?: string;
2226
- /** 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. */
2227
- hour?: string;
2228
- /** 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. */
2229
- minute?: string;
2230
- /** 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. */
2231
- month?: string;
2232
- /** 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. */
2233
- weekday?: string;
2234
- };
2235
- export declare type ListCrons200RowsItem = {
2236
- command?: string;
2237
- day?: string;
2238
- email?: string;
2239
- hour?: string;
2240
- /** */
2241
- key?: number;
2242
- line?: string;
2243
- minute?: string;
2244
- month?: string;
2245
- type?: string;
2246
- weekday?: string;
2247
- };
2248
- export declare type ListCrons200 = {
2249
- rows?: ListCrons200RowsItem[];
2250
- };
2251
- export declare type AddonCloudflare200 = {
2252
- addon_id?: number;
2253
- status?: string;
2254
- };
2255
- export declare type AddonCloudflareBody = {
2256
- /** The domain. */
2257
- domain: string;
2258
- };
2259
- export declare type HostingCapabilities200 = {
2260
- advanced_hosting?: boolean;
2261
- cpanel?: boolean;
2262
- is_sitelock_migrated?: boolean;
2263
- reset_password?: boolean;
2264
- server_controls?: boolean;
2265
- sites?: boolean;
2266
- whm?: boolean;
2267
- };
2268
- export declare type HostingAdvancedSystemConsole200 = {
2269
- url?: string;
2270
- };
2271
- export declare type HostingAdvancedSsoWhm200 = {
2272
- url?: string;
2273
- };
2274
- export declare type HostingAdvancedPassword200 = {
2275
- success?: boolean;
2276
- };
2277
- export declare type HostingAdvancedPasswordBody = {
2278
- /** The username to be updated */
2279
- account_username?: string;
2280
- /**
2281
- * The password to be updated to
2282
- * @minLength 6
2283
- */
2284
- password: string;
2285
- };
2286
- export declare type HostingAdvancedServerStatus200Actions = {
2287
- [key: string]: unknown;
2288
- };
2289
- export declare type HostingAdvancedServerStatus200 = {
2290
- actions?: HostingAdvancedServerStatus200Actions;
2291
- status?: string;
2292
- uptime?: string;
2293
- uptime_seconds?: number;
2294
- };
2295
- export declare type HostingAdvancedServerStatusBody = {
2296
- /** action to be performed */
2297
- action?: string;
2298
- };
2299
- export declare type HostingAdvancedServer200Ips = {
2300
- other_ips?: string[];
2301
- /** primary IP of server */
2302
- primary_ip?: string;
2303
- };
2304
- export declare type HostingAdvancedServer200Actions = {
2305
- [key: string]: unknown;
2306
- };
2307
- export declare type HostingAdvancedServer200 = {
2308
- actions?: HostingAdvancedServer200Actions;
2309
- /** hostname of server */
2310
- hostname?: string;
2311
- ips?: HostingAdvancedServer200Ips;
2312
- /** Operating system name */
2313
- os_name?: string;
2314
- /** Operating system version */
2315
- os_version?: string;
2316
- status?: string;
2317
- uptime?: string;
2318
- uptime_seconds?: number;
2319
- };
2320
- export declare type HostingAdvancedDomainServices200 = {
2321
- success?: number;
2322
- };
2323
- export declare type HostingAdvancedDomainServicesBody = {
2324
- /** the domain name to be configured */
2325
- domain: string;
2326
- };
2327
- export declare type HostingAdvancedDomainServicesCheck200 = {
2328
- configure_domain_services?: number;
2329
- };
2330
- export declare type HostingAddons200RowsItemMeta = {
2331
- [key: string]: string | number | boolean;
2332
- };
2333
- export declare type HostingAddons200RowsItem = {
2334
- /** @nullable */
2335
- back_reference?: string | null;
2336
- id?: string;
2337
- meta?: HostingAddons200RowsItemMeta;
2338
- status?: string;
2339
- status_user?: string;
2340
- subtype?: string;
2341
- type?: string;
2342
- };
2343
- export declare type HostingAddons200 = {
2344
- rows?: HostingAddons200RowsItem[];
2345
- };
2346
- export declare type HostingAddonsParams = {
2347
- status?: string;
2348
- subtype?: string;
2349
- type?: string;
2350
- };
2351
- export declare type HostingAccount200ResourcesWorkers = {
2352
- /** @nullable */
2353
- available?: number | null;
2354
- /** @nullable */
2355
- total?: number | null;
2356
- /** @nullable */
2357
- used?: number | null;
2358
- };
2359
- export declare type HostingAccount200ResourcesStorage = {
2360
- /** @nullable */
2361
- available?: number | null;
2362
- /** @nullable */
2363
- total?: number | null;
2364
- unit?: string;
2365
- /** @nullable */
2366
- used?: number | null;
2367
- };
2368
- /**
2369
- * @nullable
2370
- */
2371
- export declare type HostingAccount200Resources = {
2372
- storage?: HostingAccount200ResourcesStorage;
2373
- workers?: HostingAccount200ResourcesWorkers;
2374
- } | null;
2375
- export declare type HostingAccount200Billing = {
2376
- product_name?: string;
2377
- };
2378
- export declare type HostingAccount200 = {
2379
- account_id?: string;
2380
- advanced?: boolean;
2381
- billing?: HostingAccount200Billing;
2382
- brand?: string;
2383
- id?: string;
2384
- panel?: string;
2385
- plan_key?: string;
2386
- platform?: string;
2387
- /** @nullable */
2388
- resources?: HostingAccount200Resources;
2389
- status?: string;
2390
- type?: string;
2391
- username?: string;
2392
- };
2393
- export declare type DomainUnassign200 = {
2394
- [key: string]: unknown;
2395
- };
2396
- export declare type DomainCertUninstall200 = {
2397
- [key: string]: unknown;
2398
- };
2399
- export declare type DomainCertUpdate200 = {
2400
- [key: string]: unknown;
2401
- };
2402
- export declare type DomainCertUpdateBody = {
2403
- enable: boolean;
2404
- };
2405
- export declare type DomainCertInstall200 = {
2406
- [key: string]: unknown;
2407
- };
2408
- export declare type DomainCertInstallBody = {
2409
- /** cabundle */
2410
- cabundle?: string;
2411
- /** raw private key or path to private key on userbox */
2412
- crt: string;
2413
- /** private key */
2414
- key?: string;
2415
- };
2416
- export declare type DomainCerts200CertsItem = {
2417
- /** certificate id */
2418
- cert_id?: string;
2419
- /** domain name */
2420
- domain?: string;
2421
- /** exipry date */
2422
- expires_on?: string;
2423
- /** issued date */
2424
- issued_on?: string;
2425
- };
2426
- export declare type DomainCerts200 = {
2427
- certs?: DomainCerts200CertsItem[];
2428
- };
2429
- /**
2430
- * @nullable
2431
- */
2432
- export declare type DomainInfo200SetupProgress = {
2433
- /**
2434
- * Result of domain cdn validation (null=not started,0=started,1=succeeded,2=skipped)
2435
- * @nullable
2436
- */
2437
- validate_cdn?: number | null;
2438
- /**
2439
- * Most recent error logged during domain cdn validation. Remains set if validation tries run out. Gets reset by new validation job.
2440
- * @nullable
2441
- */
2442
- validate_cdn_error?: string | null;
2443
- /**
2444
- * Result of domain dns validation (null=not started,0=started,1=succeeded,2=skipped)
2445
- * @nullable
2446
- */
2447
- validate_dns?: number | null;
2448
- /**
2449
- * Whether dns_auto_repair was run on this domain (1=true)
2450
- * @nullable
2451
- */
2452
- validate_dns_auto_repair?: number | null;
2453
- /**
2454
- * Most recent error logged during domain dns validation. Remains set if validation tries run out. Gets reset by new validation job.
2455
- * @nullable
2456
- */
2457
- validate_dns_error?: string | null;
2458
- /**
2459
- * Most recent error logged during domain validation. Remains set if validation tries run out. Gets reset by new validation job.
2460
- * @nullable
2461
- */
2462
- validate_error?: string | null;
2463
- /**
2464
- * Result of domain ssl validation (null=not started,0=started,1=succeeded,2=skipped)
2465
- * @nullable
2466
- */
2467
- validate_ssl?: number | null;
2468
- /**
2469
- * Most recent error logged during domain ssl validation. Remains set if validation tries run out. Gets reset by new validation job.
2470
- * @nullable
2471
- */
2472
- validate_ssl_error?: string | null;
2473
- } | null;
2474
- export declare type DomainInfo200 = {
2475
- /** @nullable */
2476
- account_back_ref?: string | null;
2477
- /** @nullable */
2478
- authoritative?: boolean | null;
2479
- /** @nullable */
2480
- autogen_id?: number | null;
2481
- /** @nullable */
2482
- back_reference?: string | null;
2483
- base_domain?: string;
2484
- date_added?: string;
2485
- date_modified?: string;
2486
- /** @nullable */
2487
- date_ssl_exp?: string | null;
2488
- dns_status?: string;
2489
- /** @nullable */
2490
- docroot?: string | null;
2491
- domain?: string;
2492
- /** @nullable */
2493
- homedir?: string | null;
2494
- /** @nullable */
2495
- hosting_id?: number | null;
2496
- id?: number;
2497
- /** @nullable */
2498
- setup_progress?: DomainInfo200SetupProgress;
2499
- /** @nullable */
2500
- ssl_issuer?: string | null;
2501
- /** @nullable */
2502
- ssl_status?: string | null;
2503
- /** @nullable */
2504
- ssl_type?: string | null;
2505
- status?: string;
2506
- type?: string;
2507
- };
2508
- export declare type WeeblySso200 = {
2509
- sso?: string;
2510
- };
2511
- export declare type WebzaiSso200 = {
2512
- sso?: string;
2513
- };
2514
- export declare type AddonsSpamexpertsSso200 = {
2515
- url?: string;
2516
- };
2517
- export declare type AddonsInfo200 = {
2518
- id?: string;
2519
- };
2520
- export declare type AddonsCloudflare200 = {
2521
- status?: string;
2522
- };
2523
- export declare type BackupList200HomeItemBackupStatus = {
2524
- /** @nullable */
2525
- download_url?: string | null;
2526
- status?: string;
2527
- tracking_id?: number;
2528
- };
2529
- export declare type BackupList200HomeItem = {
2530
- backup_id?: string;
2531
- backup_status?: BackupList200HomeItemBackupStatus;
2532
- time_created?: string;
2533
- };
2534
- export declare type BackupList200 = {
2535
- home?: BackupList200HomeItem[];
2536
- };
2537
- export declare type BackupListBackupType = (typeof BackupListBackupType)[keyof typeof BackupListBackupType];
2538
- export declare const BackupListBackupType: {
2539
- readonly full: "full";
2540
- readonly home: "home";
2541
- readonly mysql: "mysql";
2542
- };
2543
- export declare type BackupListParams = {
2544
- backup_type: BackupListBackupType;
2545
- };
2546
- export declare type BackupStatus200 = {
2547
- /** @nullable */
2548
- download_url?: string | null;
2549
- /** @nullable */
2550
- message?: string | null;
2551
- status?: string;
2552
- };
2553
- export declare type BackupStatusParams = {
2554
- tracking_id: number;
2555
- };
2556
- export declare type BackupInitiate200 = {
2557
- message?: string;
2558
- tracking_id?: number;
2559
- };
2560
- /**
2561
- * The type of the backup
2562
- */
2563
- export declare type BackupInitiateBodyBackupType = (typeof BackupInitiateBodyBackupType)[keyof typeof BackupInitiateBodyBackupType];
2564
- export declare const BackupInitiateBodyBackupType: {
2565
- readonly home: "home";
2566
- readonly mysql: "mysql";
2567
- readonly full: "full";
2568
- };
2569
- export declare type BackupInitiateBody = {
2570
- /** The type of the backup */
2571
- backup_type: BackupInitiateBodyBackupType;
2572
- /** Backup Volume store ID to get the backup */
2573
- backup_volume_store_id: string;
2574
- };
2575
- export declare type AddonsSitelockSso200 = {
2576
- site_url?: string;
2577
- sitelock_id?: string;
2578
- url?: string;
2579
- };
2580
- export declare type CodeguardWebsiteBackupRestore200 = {
2581
- status?: string;
2582
- };
2583
- export declare type CodeguardWebsiteBackupRestoreBody = {
2584
- /** The commit id to restore the website from. */
2585
- commit_id?: string;
2586
- /** The id of the website the given database is associated with. */
2587
- website_id?: number;
2588
- };
2589
- export declare type CodeguardWebsiteBackupCreate200 = {
2590
- status?: string;
2591
- };
2592
- export declare type CodeguardWebsiteBackupCreateBody = {
2593
- /** The id for the website to create a backup for. This id can be obtained through a call to the website_list action. */
2594
- website_id?: number;
2595
- };
2596
- export declare type CodeguardWebsiteBackupList200BackupsItem = {
2597
- commit_id?: string;
2598
- event_time?: string;
2599
- modifications?: number;
2600
- new_content?: boolean;
2601
- };
2602
- export declare type CodeguardWebsiteBackupList200 = {
2603
- backups?: CodeguardWebsiteBackupList200BackupsItem[];
2604
- };
2605
- export declare type CodeguardWebsiteBackupListParams = {
2606
- website_id?: number;
2607
- };
2608
- export declare type CodeguardWebsiteList200WebsiteListItemWebsite = {
2609
- activated?: boolean;
2610
- id?: number;
2611
- url?: string;
2612
- };
2613
- export declare type CodeguardWebsiteList200WebsiteListItem = {
2614
- website?: CodeguardWebsiteList200WebsiteListItemWebsite;
2615
- };
2616
- export declare type CodeguardWebsiteList200 = {
2617
- website_list?: CodeguardWebsiteList200WebsiteListItem[];
2618
- };
2619
- export declare type CodeguardPlanInfo200SeatsItem = {
2620
- activated?: boolean;
2621
- url?: string;
2622
- website_id?: number;
2623
- };
2624
- export declare type CodeguardPlanInfo200 = {
2625
- back_reference?: string;
2626
- can_upgrade?: boolean;
2627
- plan_name?: string;
2628
- seat_count?: number;
2629
- seat_limit?: number;
2630
- seats?: CodeguardPlanInfo200SeatsItem[];
2631
- size?: number;
2632
- size_limit?: number;
2633
- status?: string;
2634
- };
2635
- export declare type CodeguardLoginLink200 = {
2636
- link?: string;
2637
- };
2638
- export declare type CodeguardDatabaseBackupRestore200 = {
2639
- status?: string;
2640
- };
2641
- export declare type CodeguardDatabaseBackupRestoreBody = {
2642
- /** The commit_id for the backup to restore */
2643
- commit_id?: string;
2644
- /** The id for the database to create a new backup for. */
2645
- database_id?: number;
2646
- /** The id of the website the given database is associated with. */
2647
- website_id?: number;
2648
- };
2649
- export declare type CodeguardDatabaseBackupCreate200 = {
2650
- status?: string;
2651
- };
2652
- export declare type CodeguardDatabaseBackupCreateBody = {
2653
- /** The id for the database to create a new backup for. */
2654
- database_id?: number;
2655
- /** The id of the website the given database is associated with. */
2656
- website_id?: number;
2657
- };
2658
- export declare type CodeguardDatabaseBackupList200BackupsItem = {
2659
- commit_id?: string;
2660
- event_time?: string;
2661
- };
2662
- export declare type CodeguardDatabaseBackupList200 = {
2663
- backups?: CodeguardDatabaseBackupList200BackupsItem[];
2664
- };
2665
- export declare type CodeguardDatabaseBackupListParams = {
2666
- database_id?: number;
2667
- website_id?: number;
2668
- };
2669
- export declare type CodeguardDatabaseList200DatabasesItemDatabaseBackup = {
2670
- account?: string;
2671
- commit_id?: string;
2672
- id?: number;
2673
- website_id?: number;
2674
- };
2675
- export declare type CodeguardDatabaseList200DatabasesItem = {
2676
- database_backup?: CodeguardDatabaseList200DatabasesItemDatabaseBackup;
2677
- };
2678
- export declare type CodeguardDatabaseList200 = {
2679
- databases?: CodeguardDatabaseList200DatabasesItem[];
2680
- status?: number;
2681
- };
2682
- export declare type CodeguardBackupRestore200 = {
2683
- database_success?: boolean;
2684
- website_success?: boolean;
2685
- };
2686
- export declare type CodeguardBackupRestoreBody = {
2687
- /** The commit id to restore the database from. */
2688
- database_commit_id?: string;
2689
- /** The id of the database the given database is associated with. */
2690
- database_id?: number;
2691
- /** The commit id to restore the website from. */
2692
- website_commit_id?: string;
2693
- /** The id of the website the given database is associated with. */
2694
- website_id?: number;
2695
- };
2696
- export declare type CodeguardBackupDownload200 = {
2697
- status?: string;
2698
- };
2699
- export declare type CodeguardBackupDownloadBody = {
2700
- /** The commit id to restore the database from. */
2701
- database_commit_id?: string;
2702
- /** The commit id to restore the website from. */
2703
- website_commit_id?: string;
2704
- /** The id of the website the given database is associated with. */
2705
- website_id?: number;
2706
- };
2707
- export declare type CodeguardBackupCreate200 = {
2708
- database_success?: number;
2709
- status?: string;
2710
- website_success?: number;
2711
- };
2712
- export declare type CodeguardBackupCreateBody = {
2713
- /** The id of the database the given database is associated with. */
2714
- database_id?: number;
2715
- /** The id of the website the given database is associated with. */
2716
- website_id?: number;
2717
- };
2718
- export declare type CodeguardBackupList200BackupsItemDatabaseBackupsItem = {
2719
- commit_id?: string;
2720
- event_time?: string;
2721
- id?: number;
2722
- recommended?: boolean;
2723
- };
2724
- export declare type CodeguardBackupList200BackupsItem = {
2725
- database_backups?: CodeguardBackupList200BackupsItemDatabaseBackupsItem[];
2726
- event_time?: string;
2727
- website_commit_id?: string;
2728
- };
2729
- export declare type CodeguardBackupList200 = {
2730
- backups?: CodeguardBackupList200BackupsItem[];
2731
- };
2732
- export declare type CodeguardBackupListParams = {
2733
- website_id: number;
2734
- };
2735
- export declare type AccountPublicKeyDelete404 = {
2736
- error?: string;
2737
- };
2738
- export declare type AccountPublicKeyDelete200 = {
2739
- [key: string]: unknown;
2740
- };
2741
- export declare type AccountPublicKey404 = {
2742
- error?: string;
2743
- };
2744
- export declare type AccountPublicKey200 = {
2745
- /**
2746
- * Public key last modified datetime stamp
2747
- * @nullable
2748
- */
2749
- date_modified?: string | null;
2750
- /** Public key ID */
2751
- id?: number;
2752
- /** Public key is active flag */
2753
- is_active?: boolean;
2754
- /** Public key nickname */
2755
- name?: string;
2756
- /** public key */
2757
- public_key?: string;
2758
- };
2759
- export declare type AccountPublicKeyCreate409 = {
2760
- error?: string;
2761
- };
2762
- export declare type AccountPublicKeyCreate200 = {
2763
- /**
2764
- * Public key last modified datetime stamp
2765
- * @nullable
2766
- */
2767
- date_modified?: string | null;
2768
- /** Public key ID */
2769
- id?: number;
2770
- /** Public key is active flag */
2771
- is_active?: boolean;
2772
- /** Public key nickname */
2773
- name?: string;
2774
- /** Public key */
2775
- public_key?: string;
2776
- };
2777
- export declare type AccountPublicKeyCreateBody = {
2778
- /** Public key flag toggle (default: true) */
2779
- is_active?: boolean;
2780
- /** Public key nickname */
2781
- name: string;
2782
- /** Public key */
2783
- public_key: string;
2784
- };
2785
- export declare type AccountPublicKeys200PublicKeysItem = {
2786
- /**
2787
- * Public key last modified datetime stamp
2788
- * @nullable
2789
- */
2790
- date_modified?: string | null;
2791
- /** Public key ID */
2792
- id?: number;
2793
- /** Public key is active flag */
2794
- is_active?: boolean;
2795
- /** Public key nickname */
2796
- name?: string;
2797
- public_key?: string;
2798
- };
2799
- export declare type AccountPublicKeys200 = {
2800
- public_keys?: AccountPublicKeys200PublicKeysItem[];
2801
- };
2802
- export declare type AccountHostingList200AccountsItem = {
2803
- /** Jarvis Account ID, HAL tenant_back_ref */
2804
- account_id?: string;
2805
- current_sites?: number;
2806
- feature_set?: string;
2807
- /** HAL Account ID */
2808
- hosting_id?: string;
2809
- max_sites?: string;
2810
- platform?: string;
2811
- /** HAL Account back_reference */
2812
- prod_inst_id?: string;
2813
- status?: string;
2814
- };
2815
- export declare type AccountHostingList200 = {
2816
- accounts?: AccountHostingList200AccountsItem[];
2817
- };
2818
- export declare type AccountEventList200EventsItem = {
2819
- /**
2820
- * ID of HAL Addon associated with this event
2821
- * @nullable
2822
- */
2823
- addon_id?: number | null;
2824
- /** How many times this event has triggered between date_first and date_last */
2825
- count?: number;
2826
- /** UTC timestamp of first occurrence of this event */
2827
- date_first?: string;
2828
- /** UTC timestamp of most recent occurrence of this event */
2829
- date_last?: string;
2830
- /**
2831
- * ID of HAL Domain associated with this event
2832
- * @nullable
2833
- */
2834
- domain_id?: number | null;
2835
- /** Name of the event this entry was triggered by */
2836
- event?: string;
2837
- /** ID of HAL Account associated with this event */
2838
- hosting_id?: number;
2839
- /**
2840
- * ID of HAL Site associated with this event
2841
- * @nullable
2842
- */
2843
- site_id?: number | null;
2844
- /** ID of HAL Tenant associated with this event */
2845
- tenant_id?: number;
2846
- };
2847
- export declare type AccountEventList200 = {
2848
- events?: AccountEventList200EventsItem[];
2849
- /** Date of most recent event update. Can pass back in when determining whether to query new data */
2850
- utc?: string;
2851
- };
2852
- export declare type AccountEventListParams = {
2853
- /**
2854
- * ID of the HAL Addon to query event info about
2855
- */
2856
- addon_id?: number;
2857
- /**
2858
- * ID of the HAL Domain to query event info about
2859
- */
2860
- domain_id?: number;
2861
- /**
2862
- * ID of the HAL Site to query event info about
2863
- */
2864
- site_id?: number;
2865
- /**
2866
- * Date-time to check for new events *after*; ISO format.
2867
- */
2868
- date_last?: string;
2869
- };
2870
- export interface SitesAutoupdatesResponse {
2871
- /** @nullable */
2872
- core?: boolean | null;
2873
- /** @nullable */
2874
- plugins?: boolean | null;
2875
- /** @nullable */
2876
- themes?: boolean | null;
2877
- }
2878
- export interface SSHUsersV2Response {
2879
- installed?: boolean;
2880
- is_active?: boolean;
2881
- /** @nullable */
2882
- job_id?: number | null;
2883
- /** @nullable */
2884
- public_key_id?: number | null;
2885
- user?: string;
2886
- }