@newfold/huapi-js 2.1501.0 → 2.1503.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -10,7 +10,7 @@
10
10
  "tslib": "2.7.0"
11
11
  },
12
12
  "module": "dist/index.ts",
13
- "version": "2.1501.0",
13
+ "version": "2.1503.0",
14
14
  "sideEffects": false,
15
15
  "main": "./src/index.js",
16
16
  "types": "./src/index.d.ts",
package/src/index.js CHANGED
@@ -3,7 +3,7 @@
3
3
  * Do not edit manually.
4
4
  * Hosting UAPI
5
5
  * Hosting UAPI is an API to expose Hosting, Addons, and Site functionality to a customer-facing Front End such as (Account Manager).
6
- * OpenAPI spec version: 1.1501.0
6
+ * OpenAPI spec version: 1.1503.0
7
7
  */
8
8
  import { useInfiniteQuery, useMutation, useQuery } from '@tanstack/react-query';
9
9
  import axios from 'axios';
package/src/index.msw.js CHANGED
@@ -4,10 +4,11 @@ import { __awaiter } from "tslib";
4
4
  * Do not edit manually.
5
5
  * Hosting UAPI
6
6
  * Hosting UAPI is an API to expose Hosting, Addons, and Site functionality to a customer-facing Front End such as (Account Manager).
7
- * OpenAPI spec version: 1.1501.0
7
+ * OpenAPI spec version: 1.1503.0
8
8
  */
9
9
  import { faker } from '@faker-js/faker';
10
10
  import { HttpResponse, delay, http } from 'msw';
11
+ import { FilterAction, FilterRuleMatch, FilterRuleOpt, FilterRulePart } from './index.schemas';
11
12
  export const getAccountEventListResponseMock = (overrideResponse = {}) => (Object.assign({ events: faker.helpers.arrayElement([Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ addon_id: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.number.int({ min: undefined, max: undefined }), null]), undefined]), count: faker.helpers.arrayElement([faker.number.int({ min: undefined, max: undefined }), undefined]), date_first: faker.helpers.arrayElement([faker.word.sample(), undefined]), date_last: faker.helpers.arrayElement([faker.word.sample(), undefined]), domain_id: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.number.int({ min: undefined, max: undefined }), null]), undefined]), event: faker.helpers.arrayElement([faker.word.sample(), undefined]), hosting_id: faker.helpers.arrayElement([faker.number.int({ min: undefined, max: undefined }), undefined]), site_id: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.number.int({ min: undefined, max: undefined }), null]), undefined]), tenant_id: faker.helpers.arrayElement([faker.number.int({ min: undefined, max: undefined }), undefined]) })), undefined]), utc: faker.helpers.arrayElement([faker.word.sample(), undefined]) }, overrideResponse));
12
13
  export const getAccountFeaturesResponseMock = (overrideResponse = {}) => (Object.assign({ rows: faker.helpers.arrayElement([Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ back_reference: faker.helpers.arrayElement([faker.word.sample(), undefined]), feature_set: faker.helpers.arrayElement([faker.word.sample(), undefined]), info: faker.helpers.arrayElement([{ addon_back_ref: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), addon_id: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), addon_status: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), brand: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), brand_id: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), data_center: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), date_added: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), date_modified: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), feature_set: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), homedir: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), id: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), ip: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), limit_remote: faker.helpers.arrayElement([{ quota_kib: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]) }, undefined]), meta: faker.helpers.arrayElement([{ main_domain: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), prev_tenant: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]) }, undefined]), ns: faker.helpers.arrayElement([Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => (faker.word.sample())), undefined]), operating_system: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), platform: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), server_id: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), server_status: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), server_type: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), ssh_hostname: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), status: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), tenant_back_ref: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), tenant_id: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), type: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), username: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]) }, undefined]), limit: faker.helpers.arrayElement([{ disk_limit_gib: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), sites: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), workers: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.number.int({ min: undefined, max: undefined }), null]), undefined]) }, undefined]), package: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), panel: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), sites: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.number.int({ min: undefined, max: undefined }), null]), undefined]), used: faker.helpers.arrayElement([{ disk_usage: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), sites: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.number.int({ min: undefined, max: undefined }), null]), undefined]), sites_active: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.number.int({ min: undefined, max: undefined }), null]), undefined]), staging_sites: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.number.int({ min: undefined, max: undefined }), null]), undefined]), workers: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.number.int({ min: undefined, max: undefined }), null]), undefined]) }, undefined]) })), undefined]), total_count: faker.helpers.arrayElement([faker.number.int({ min: undefined, max: undefined }), undefined]) }, overrideResponse));
13
14
  export const getAccountHostingListResponseMock = (overrideResponse = {}) => (Object.assign({ accounts: faker.helpers.arrayElement([Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ account_id: faker.helpers.arrayElement([faker.word.sample(), undefined]), current_sites: faker.helpers.arrayElement([faker.number.int({ min: undefined, max: undefined }), undefined]), feature_set: faker.helpers.arrayElement([faker.word.sample(), undefined]), hosting_id: faker.helpers.arrayElement([faker.word.sample(), undefined]), max_sites: faker.helpers.arrayElement([faker.word.sample(), undefined]), platform: faker.helpers.arrayElement([faker.word.sample(), undefined]), prod_inst_id: faker.helpers.arrayElement([faker.word.sample(), undefined]), region_desc: faker.helpers.arrayElement([faker.word.sample(), undefined]), region_type: faker.helpers.arrayElement([faker.word.sample(), undefined]), status: faker.helpers.arrayElement([faker.word.sample(), undefined]) })), undefined]) }, overrideResponse));
@@ -112,7 +113,7 @@ export const getHostingEmailAutoresponderUpdateResponseMock = (overrideResponse
112
113
  export const getHostingEmailAutoresponderCreateResponseMock = (overrideResponse = {}) => (Object.assign({ success: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]) }, overrideResponse));
113
114
  export const getHostingEmailAutoresponderDeleteResponseMock = (overrideResponse = {}) => (Object.assign({ success: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]) }, overrideResponse));
114
115
  export const getHostingEmailAutoresponderListResponseMock = (overrideResponse = {}) => (Object.assign({ autoresponders: faker.helpers.arrayElement([Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ email: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]), subject: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]) })), undefined]) }, overrideResponse));
115
- export const getHostingEmailFiltersListResponseMock = (overrideResponse = {}) => (Object.assign({ count: faker.helpers.arrayElement([faker.number.int({ min: undefined, max: undefined }), undefined]), filters: faker.helpers.arrayElement([Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ actions: faker.helpers.arrayElement([Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ action: faker.helpers.arrayElement([faker.word.sample(), undefined]), dest: faker.helpers.arrayElement([faker.word.sample(), undefined]) })), undefined]), enabled: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), name: faker.helpers.arrayElement([faker.word.sample(), undefined]), rules: faker.helpers.arrayElement([Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ match: faker.helpers.arrayElement([faker.word.sample(), undefined]), opt: faker.helpers.arrayElement([faker.word.sample(), undefined]), part: faker.helpers.arrayElement([faker.word.sample(), undefined]), val: faker.helpers.arrayElement([faker.word.sample(), undefined]) })), undefined]), unescaped: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]) })), undefined]) }, overrideResponse));
116
+ export const getHostingEmailFiltersListResponseMock = (overrideResponse = {}) => (Object.assign({ count: faker.helpers.arrayElement([faker.number.int({ min: undefined, max: undefined }), undefined]), filters: faker.helpers.arrayElement([Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ actions: faker.helpers.arrayElement([Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ action: faker.helpers.arrayElement([faker.helpers.arrayElement(Object.values(FilterAction)), undefined]), dest: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]) })), undefined]), enabled: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]), name: faker.helpers.arrayElement([faker.word.sample(), undefined]), rules: faker.helpers.arrayElement([Array.from({ length: faker.number.int({ min: 1, max: 10 }) }, (_, i) => i + 1).map(() => ({ match: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.helpers.arrayElement(Object.values(FilterRuleMatch)), null]), undefined]), opt: faker.helpers.arrayElement([faker.helpers.arrayElement(Object.values(FilterRuleOpt)), undefined]), part: faker.helpers.arrayElement([faker.helpers.arrayElement(Object.values(FilterRulePart)), undefined]), val: faker.helpers.arrayElement([faker.helpers.arrayElement([faker.word.sample(), null]), undefined]) })), undefined]), unescaped: faker.helpers.arrayElement([faker.datatype.boolean(), undefined]) })), undefined]) }, overrideResponse));
116
117
  export const getHostingEmailFiltersAddResponseMock = (overrideResponse = {}) => (Object.assign({}, overrideResponse));
117
118
  export const getHostingEmailFiltersUpdateResponseMock = (overrideResponse = {}) => (Object.assign({}, overrideResponse));
118
119
  export const getHostingEmailFiltersDeleteResponseMock = (overrideResponse = {}) => (Object.assign({}, overrideResponse));
@@ -3,7 +3,7 @@
3
3
  * Do not edit manually.
4
4
  * Hosting UAPI
5
5
  * Hosting UAPI is an API to expose Hosting, Addons, and Site functionality to a customer-facing Front End such as (Account Manager).
6
- * OpenAPI spec version: 1.1501.0
6
+ * OpenAPI spec version: 1.1503.0
7
7
  */
8
8
  export declare type SshKeyListV4200RowsItem = {
9
9
  authorize?: boolean;
@@ -1333,6 +1333,9 @@ export declare type SiteQualityMetrics200AspectScores = {
1333
1333
  performance?: number;
1334
1334
  seo?: number;
1335
1335
  };
1336
+ export declare type SiteQualityMetrics200AspectDetails = {
1337
+ performance?: SiteQualityMetrics200AspectDetailsPerformance;
1338
+ };
1336
1339
  export declare type SiteQualityMetrics200 = {
1337
1340
  aspect_details: SiteQualityMetrics200AspectDetails;
1338
1341
  aspect_scores: SiteQualityMetrics200AspectScores;
@@ -1363,9 +1366,6 @@ export declare type SiteQualityMetrics200AspectDetailsPerformance = {
1363
1366
  'speed-index'?: SiteQualityMetrics200AspectDetailsPerformanceSpeedIndex;
1364
1367
  'total-blocking-time'?: SiteQualityMetrics200AspectDetailsPerformanceTotalBlockingTime;
1365
1368
  };
1366
- export declare type SiteQualityMetrics200AspectDetails = {
1367
- performance?: SiteQualityMetrics200AspectDetailsPerformance;
1368
- };
1369
1369
  export declare type SiteQualityMetricsStrategy = typeof SiteQualityMetricsStrategy[keyof typeof SiteQualityMetricsStrategy];
1370
1370
  export declare const SiteQualityMetricsStrategy: {
1371
1371
  readonly MOBILE: "MOBILE";
@@ -1466,25 +1466,6 @@ export declare type SitesPerformanceCachepurgeBody = {
1466
1466
  export declare type SitePendingDomainDelete200 = {
1467
1467
  [key: string]: unknown;
1468
1468
  };
1469
- export declare type SitesMetricDimensions200DimensionsWpAdminAjaxActionItemDimension = {
1470
- [key: string]: number;
1471
- };
1472
- export declare type SitesMetricDimensions200DimensionsWpAdminAjaxActionItem = {
1473
- dimension?: SitesMetricDimensions200DimensionsWpAdminAjaxActionItemDimension;
1474
- timestamp?: number;
1475
- };
1476
- export declare type SitesMetricDimensions200Dimensions = {
1477
- http_host?: SitesMetricDimensions200DimensionsHttpHostItem[];
1478
- http_status?: SitesMetricDimensions200DimensionsHttpStatusItem[];
1479
- http_verb?: SitesMetricDimensions200DimensionsHttpVerbItem[];
1480
- http_version?: SitesMetricDimensions200DimensionsHttpVersionItem[];
1481
- page_is_cached?: SitesMetricDimensions200DimensionsPageIsCachedItem[];
1482
- page_renderer?: SitesMetricDimensions200DimensionsPageRendererItem[];
1483
- visitor_asn?: SitesMetricDimensions200DimensionsVisitorAsnItem[];
1484
- visitor_country_code?: SitesMetricDimensions200DimensionsVisitorCountryCodeItem[];
1485
- visitor_is_crawler?: SitesMetricDimensions200DimensionsVisitorIsCrawlerItem[];
1486
- wp_admin_ajax_action?: SitesMetricDimensions200DimensionsWpAdminAjaxActionItem[];
1487
- };
1488
1469
  export declare type SitesMetricDimensions200 = {
1489
1470
  date_end?: string;
1490
1471
  date_start?: string;
@@ -1492,6 +1473,13 @@ export declare type SitesMetricDimensions200 = {
1492
1473
  elapsed?: number;
1493
1474
  metric?: string;
1494
1475
  };
1476
+ export declare type SitesMetricDimensions200DimensionsWpAdminAjaxActionItemDimension = {
1477
+ [key: string]: number;
1478
+ };
1479
+ export declare type SitesMetricDimensions200DimensionsWpAdminAjaxActionItem = {
1480
+ dimension?: SitesMetricDimensions200DimensionsWpAdminAjaxActionItemDimension;
1481
+ timestamp?: number;
1482
+ };
1495
1483
  export declare type SitesMetricDimensions200DimensionsVisitorIsCrawlerItemDimension = {
1496
1484
  [key: string]: number;
1497
1485
  };
@@ -1506,6 +1494,18 @@ export declare type SitesMetricDimensions200DimensionsVisitorCountryCodeItem = {
1506
1494
  dimension?: SitesMetricDimensions200DimensionsVisitorCountryCodeItemDimension;
1507
1495
  timestamp?: number;
1508
1496
  };
1497
+ export declare type SitesMetricDimensions200Dimensions = {
1498
+ http_host?: SitesMetricDimensions200DimensionsHttpHostItem[];
1499
+ http_status?: SitesMetricDimensions200DimensionsHttpStatusItem[];
1500
+ http_verb?: SitesMetricDimensions200DimensionsHttpVerbItem[];
1501
+ http_version?: SitesMetricDimensions200DimensionsHttpVersionItem[];
1502
+ page_is_cached?: SitesMetricDimensions200DimensionsPageIsCachedItem[];
1503
+ page_renderer?: SitesMetricDimensions200DimensionsPageRendererItem[];
1504
+ visitor_asn?: SitesMetricDimensions200DimensionsVisitorAsnItem[];
1505
+ visitor_country_code?: SitesMetricDimensions200DimensionsVisitorCountryCodeItem[];
1506
+ visitor_is_crawler?: SitesMetricDimensions200DimensionsVisitorIsCrawlerItem[];
1507
+ wp_admin_ajax_action?: SitesMetricDimensions200DimensionsWpAdminAjaxActionItem[];
1508
+ };
1509
1509
  export declare type SitesMetricDimensions200DimensionsVisitorAsnItemDimension = {
1510
1510
  [key: string]: number;
1511
1511
  };
@@ -1959,6 +1959,10 @@ export declare type SitesAtomicMetrics200Views = {
1959
1959
  last_n_days?: SitesAtomicMetrics200ViewsLastNDaysItem[];
1960
1960
  total_hits?: number;
1961
1961
  };
1962
+ export declare type SitesAtomicMetrics200 = {
1963
+ raw?: SitesAtomicMetrics200Raw;
1964
+ views?: SitesAtomicMetrics200Views;
1965
+ };
1962
1966
  export declare type SitesAtomicMetrics200RawPeriodsItemDimension = {
1963
1967
  [key: string]: string | number | number;
1964
1968
  };
@@ -1976,10 +1980,6 @@ export declare type SitesAtomicMetrics200Raw = {
1976
1980
  periods?: SitesAtomicMetrics200RawPeriodsItem[];
1977
1981
  resolution?: number;
1978
1982
  };
1979
- export declare type SitesAtomicMetrics200 = {
1980
- raw?: SitesAtomicMetrics200Raw;
1981
- views?: SitesAtomicMetrics200Views;
1982
- };
1983
1983
  export declare type SitesAtomicMetricsParams = {
1984
1984
  metric?: string[];
1985
1985
  dimension?: string[];
@@ -2215,17 +2215,6 @@ export declare type HostingVisitors200VisitorsItem = {
2215
2215
  unique_visitors?: number;
2216
2216
  visitors?: number;
2217
2217
  };
2218
- export declare type HostingVisitors200 = {
2219
- daily?: HostingVisitors200Daily;
2220
- is_linked_domain?: boolean;
2221
- linked_domain?: string;
2222
- total_bandwidth?: number;
2223
- total_hits?: number;
2224
- total_pages?: number;
2225
- total_unique_visitors?: number;
2226
- total_visitors?: number;
2227
- visitors?: HostingVisitors200VisitorsItem[];
2228
- };
2229
2218
  export declare type HostingVisitors200DailyTotal = {
2230
2219
  total_bandwidth?: number;
2231
2220
  total_hits?: number;
@@ -2245,6 +2234,17 @@ export declare type HostingVisitors200Daily = {
2245
2234
  data?: HostingVisitors200DailyDataItem[];
2246
2235
  total?: HostingVisitors200DailyTotal;
2247
2236
  };
2237
+ export declare type HostingVisitors200 = {
2238
+ daily?: HostingVisitors200Daily;
2239
+ is_linked_domain?: boolean;
2240
+ linked_domain?: string;
2241
+ total_bandwidth?: number;
2242
+ total_hits?: number;
2243
+ total_pages?: number;
2244
+ total_unique_visitors?: number;
2245
+ total_visitors?: number;
2246
+ visitors?: HostingVisitors200VisitorsItem[];
2247
+ };
2248
2248
  export declare type HostingVisitorsSource = typeof HostingVisitorsSource[keyof typeof HostingVisitorsSource];
2249
2249
  export declare const HostingVisitorsSource: {
2250
2250
  readonly http: "http";
@@ -3347,20 +3347,22 @@ export declare type HostingEmailFiltersUpdate200 = {
3347
3347
  [key: string]: unknown;
3348
3348
  };
3349
3349
  export declare type HostingEmailFiltersUpdateBodyRulesItem = {
3350
- /** The match type (e.g., contains, equals, regex) */
3351
- match?: string;
3352
- /** The match operation (e.g., or, and, not) */
3353
- opt?: string;
3354
- /** The part of the email to match against (e.g., header_from, header_subject, body) */
3355
- part?: string;
3356
- /** The value to match against */
3357
- val?: string;
3350
+ match?: FilterRuleMatch;
3351
+ opt?: FilterRuleOpt;
3352
+ part?: FilterRulePart;
3353
+ /**
3354
+ * The value to match against, not required for rule part 'error_message' or 'not_delivered'
3355
+ * @nullable
3356
+ */
3357
+ val?: string | null;
3358
3358
  };
3359
3359
  export declare type HostingEmailFiltersUpdateBodyActionsItem = {
3360
- /** The name of the action (e.g., move, copy, forward) */
3361
- action?: string;
3362
- /** The destination for the action (e.g., folder name, email address, script path, etc) */
3363
- dest?: string;
3360
+ action?: FilterAction;
3361
+ /**
3362
+ * The destination for the action (e.g., folder name, email address, script path, etc)
3363
+ * @nullable
3364
+ */
3365
+ dest?: string | null;
3364
3366
  };
3365
3367
  export declare type HostingEmailFiltersUpdateBody = {
3366
3368
  /** list of actions to be taken when the filter matches */
@@ -3378,20 +3380,22 @@ export declare type HostingEmailFiltersAdd200 = {
3378
3380
  [key: string]: unknown;
3379
3381
  };
3380
3382
  export declare type HostingEmailFiltersAddBodyRulesItem = {
3381
- /** The match type (e.g., contains, equals, regex) */
3382
- match?: string;
3383
- /** The match operation (e.g., or, and, not) */
3384
- opt?: string;
3385
- /** The part of the email to match against (e.g., header_from, header_subject, body) */
3386
- part?: string;
3387
- /** The value to match against */
3388
- val?: string;
3383
+ match?: FilterRuleMatch;
3384
+ opt?: FilterRuleOpt;
3385
+ part?: FilterRulePart;
3386
+ /**
3387
+ * The value to match against, not required for rule part 'error_message' or 'not_delivered'
3388
+ * @nullable
3389
+ */
3390
+ val?: string | null;
3389
3391
  };
3390
3392
  export declare type HostingEmailFiltersAddBodyActionsItem = {
3391
- /** The name of the action (e.g., move, copy, forward) */
3392
- action?: string;
3393
- /** The destination for the action (e.g., folder name, email address, script path, etc) */
3394
- dest?: string;
3393
+ action?: FilterAction;
3394
+ /**
3395
+ * The destination for the action (e.g., folder name, email address, script path, etc)
3396
+ * @nullable
3397
+ */
3398
+ dest?: string | null;
3395
3399
  };
3396
3400
  export declare type HostingEmailFiltersAddBody = {
3397
3401
  /** list of actions to be taken when the filter matches */
@@ -3403,27 +3407,23 @@ export declare type HostingEmailFiltersAddBody = {
3403
3407
  /** list of rules to be applied to the filter */
3404
3408
  rules?: HostingEmailFiltersAddBodyRulesItem[];
3405
3409
  };
3406
- export declare type HostingEmailFiltersList200 = {
3407
- /** The number of filters */
3408
- count?: number;
3409
- /** List of filters */
3410
- filters?: HostingEmailFiltersList200FiltersItem[];
3411
- };
3412
3410
  export declare type HostingEmailFiltersList200FiltersItemRulesItem = {
3413
- /** Match type (e.g., contains, equals) */
3414
- match?: string;
3415
- /** The match operation (or, and, not, etc) */
3416
- opt?: string;
3417
- /** The part to match against */
3418
- part?: string;
3419
- /** The value to match against */
3420
- val?: string;
3411
+ match?: FilterRuleMatch;
3412
+ opt?: FilterRuleOpt;
3413
+ part?: FilterRulePart;
3414
+ /**
3415
+ * The value to match against, not required for rule part 'error_message' or 'not_delivered'
3416
+ * @nullable
3417
+ */
3418
+ val?: string | null;
3421
3419
  };
3422
3420
  export declare type HostingEmailFiltersList200FiltersItemActionsItem = {
3423
- /** The name of the action (e.g., move, copy, forward) */
3424
- action?: string;
3425
- /** The destination for the action (e.g., folder name, email address, script path, etc) */
3426
- dest?: string;
3421
+ action?: FilterAction;
3422
+ /**
3423
+ * The destination for the action (e.g., folder name, email address, script path, etc)
3424
+ * @nullable
3425
+ */
3426
+ dest?: string | null;
3427
3427
  };
3428
3428
  export declare type HostingEmailFiltersList200FiltersItem = {
3429
3429
  /** Where the email will be forwarded to */
@@ -3437,6 +3437,12 @@ export declare type HostingEmailFiltersList200FiltersItem = {
3437
3437
  /** Whether the filter is unescaped */
3438
3438
  unescaped?: boolean;
3439
3439
  };
3440
+ export declare type HostingEmailFiltersList200 = {
3441
+ /** The number of filters */
3442
+ count?: number;
3443
+ /** List of filters */
3444
+ filters?: HostingEmailFiltersList200FiltersItem[];
3445
+ };
3440
3446
  export declare type HostingEmailFiltersListParams = {
3441
3447
  /**
3442
3448
  * The email account address to query filters by
@@ -4402,23 +4408,6 @@ export declare type ActivityLog200 = {
4402
4408
  export declare type ActivityLogParams = {
4403
4409
  days?: number;
4404
4410
  };
4405
- export declare type HostingAccount200 = {
4406
- account_id?: string;
4407
- advanced?: boolean;
4408
- billing?: HostingAccount200Billing;
4409
- brand?: string;
4410
- id?: string;
4411
- panel?: string;
4412
- plan_key?: string;
4413
- platform?: string;
4414
- /** @nullable */
4415
- resources?: HostingAccount200Resources;
4416
- /** @nullable */
4417
- ssh_hostname?: string | null;
4418
- status?: string;
4419
- type?: string;
4420
- username?: string;
4421
- };
4422
4411
  export declare type HostingAccount200ResourcesWorkers = {
4423
4412
  /** @nullable */
4424
4413
  available?: number | null;
@@ -4436,6 +4425,31 @@ export declare type HostingAccount200ResourcesStorage = {
4436
4425
  /** @nullable */
4437
4426
  used?: number | null;
4438
4427
  };
4428
+ /**
4429
+ * @nullable
4430
+ */
4431
+ export declare type HostingAccount200Resources = {
4432
+ staging?: HostingAccount200ResourcesStaging;
4433
+ storage?: HostingAccount200ResourcesStorage;
4434
+ workers?: HostingAccount200ResourcesWorkers;
4435
+ } | null;
4436
+ export declare type HostingAccount200 = {
4437
+ account_id?: string;
4438
+ advanced?: boolean;
4439
+ billing?: HostingAccount200Billing;
4440
+ brand?: string;
4441
+ id?: string;
4442
+ panel?: string;
4443
+ plan_key?: string;
4444
+ platform?: string;
4445
+ /** @nullable */
4446
+ resources?: HostingAccount200Resources;
4447
+ /** @nullable */
4448
+ ssh_hostname?: string | null;
4449
+ status?: string;
4450
+ type?: string;
4451
+ username?: string;
4452
+ };
4439
4453
  export declare type HostingAccount200ResourcesStagingWorkers = {
4440
4454
  /** @nullable */
4441
4455
  available?: number | null;
@@ -4457,14 +4471,6 @@ export declare type HostingAccount200ResourcesStaging = {
4457
4471
  storage?: HostingAccount200ResourcesStagingStorage;
4458
4472
  workers?: HostingAccount200ResourcesStagingWorkers;
4459
4473
  };
4460
- /**
4461
- * @nullable
4462
- */
4463
- export declare type HostingAccount200Resources = {
4464
- staging?: HostingAccount200ResourcesStaging;
4465
- storage?: HostingAccount200ResourcesStorage;
4466
- workers?: HostingAccount200ResourcesWorkers;
4467
- } | null;
4468
4474
  export declare type HostingAccount200Billing = {
4469
4475
  prod_code?: string;
4470
4476
  product_name?: string;
@@ -4837,10 +4843,6 @@ export declare type BackupMeta200Site = {
4837
4843
  /** @nullable */
4838
4844
  cbs_downloadables?: BackupMeta200SiteCbsDownloadablesItem[] | null;
4839
4845
  };
4840
- export declare type BackupMeta200 = {
4841
- account?: BackupMeta200Account;
4842
- site?: BackupMeta200Site;
4843
- };
4844
4846
  /**
4845
4847
  * @nullable
4846
4848
  */
@@ -4870,6 +4872,10 @@ export declare type BackupMeta200Account = {
4870
4872
  /** @nullable */
4871
4873
  cbs_last_restore_timestamp?: string | null;
4872
4874
  };
4875
+ export declare type BackupMeta200 = {
4876
+ account?: BackupMeta200Account;
4877
+ site?: BackupMeta200Site;
4878
+ };
4873
4879
  export declare type BackupMetaParams = {
4874
4880
  site_id?: number;
4875
4881
  };
@@ -5718,6 +5724,65 @@ export declare const AutoresponderCharset: {
5718
5724
  readonly 'windows-1252': "windows-1252";
5719
5725
  readonly 'windows-31j': "windows-31j";
5720
5726
  };
5727
+ /**
5728
+ * Conjunction for succeeding rule
5729
+ */
5730
+ export declare type FilterRuleOpt = typeof FilterRuleOpt[keyof typeof FilterRuleOpt];
5731
+ export declare const FilterRuleOpt: {
5732
+ readonly or: "or";
5733
+ readonly and: "and";
5734
+ };
5735
+ /**
5736
+ * The type of match to perform
5737
+ * @nullable
5738
+ */
5739
+ export declare type FilterRuleMatch = typeof FilterRuleMatch[keyof typeof FilterRuleMatch] | null;
5740
+ export declare const FilterRuleMatch: {
5741
+ readonly matches: "matches";
5742
+ readonly does_not_match: "does not match";
5743
+ readonly contains: "contains";
5744
+ readonly does_not_contain: "does not contain";
5745
+ readonly begins: "begins";
5746
+ readonly does_not_begin: "does not begin";
5747
+ readonly ends: "ends";
5748
+ readonly does_not_end: "does not end";
5749
+ readonly is_above: "is above";
5750
+ readonly is_not_above: "is not above";
5751
+ readonly is_below: "is below";
5752
+ readonly is_not_below: "is not below";
5753
+ readonly equals: "equals";
5754
+ };
5755
+ /**
5756
+ * The part of the email to match
5757
+ */
5758
+ export declare type FilterRulePart = typeof FilterRulePart[keyof typeof FilterRulePart];
5759
+ export declare const FilterRulePart: {
5760
+ readonly spam_bar: "spam_bar";
5761
+ readonly spam_score: "spam_score";
5762
+ readonly spam_status: "spam_status";
5763
+ readonly list_id: "list_id";
5764
+ readonly from: "from";
5765
+ readonly subject: "subject";
5766
+ readonly to: "to";
5767
+ readonly reply_to_or_to: "reply_to_or_to";
5768
+ readonly body: "body";
5769
+ readonly any_header: "any_header";
5770
+ readonly faa_to_or_cc: "faa_to_or_cc";
5771
+ readonly not_delivered: "not_delivered";
5772
+ readonly error_message: "error_message";
5773
+ };
5774
+ /**
5775
+ * The action to take for the filter
5776
+ */
5777
+ export declare type FilterAction = typeof FilterAction[keyof typeof FilterAction];
5778
+ export declare const FilterAction: {
5779
+ readonly fail: "fail";
5780
+ readonly finish: "finish";
5781
+ readonly deliver: "deliver";
5782
+ readonly pipe: "pipe";
5783
+ readonly save: "save";
5784
+ readonly blackhole: "blackhole";
5785
+ };
5721
5786
  export interface FolderNode {
5722
5787
  /** Child folders of the child folder */
5723
5788
  children?: FolderNode[];
@@ -552,6 +552,52 @@ export const AutoresponderCharset = {
552
552
  'windows-31j': 'windows-31j',
553
553
  };
554
554
  // eslint-disable-next-line @typescript-eslint/no-redeclare
555
+ export const FilterRuleOpt = {
556
+ or: 'or',
557
+ and: 'and',
558
+ };
559
+ // eslint-disable-next-line @typescript-eslint/no-redeclare
560
+ export const FilterRuleMatch = {
561
+ matches: 'matches',
562
+ does_not_match: 'does not match',
563
+ contains: 'contains',
564
+ does_not_contain: 'does not contain',
565
+ begins: 'begins',
566
+ does_not_begin: 'does not begin',
567
+ ends: 'ends',
568
+ does_not_end: 'does not end',
569
+ is_above: 'is above',
570
+ is_not_above: 'is not above',
571
+ is_below: 'is below',
572
+ is_not_below: 'is not below',
573
+ equals: 'equals',
574
+ };
575
+ // eslint-disable-next-line @typescript-eslint/no-redeclare
576
+ export const FilterRulePart = {
577
+ spam_bar: 'spam_bar',
578
+ spam_score: 'spam_score',
579
+ spam_status: 'spam_status',
580
+ list_id: 'list_id',
581
+ from: 'from',
582
+ subject: 'subject',
583
+ to: 'to',
584
+ reply_to_or_to: 'reply_to_or_to',
585
+ body: 'body',
586
+ any_header: 'any_header',
587
+ faa_to_or_cc: 'faa_to_or_cc',
588
+ not_delivered: 'not_delivered',
589
+ error_message: 'error_message',
590
+ };
591
+ // eslint-disable-next-line @typescript-eslint/no-redeclare
592
+ export const FilterAction = {
593
+ fail: 'fail',
594
+ finish: 'finish',
595
+ deliver: 'deliver',
596
+ pipe: 'pipe',
597
+ save: 'save',
598
+ blackhole: 'blackhole',
599
+ };
600
+ // eslint-disable-next-line @typescript-eslint/no-redeclare
555
601
  export const SpamCustomScoreSubtypes = {
556
602
  ACCESSDB: 'ACCESSDB',
557
603
  ACCT_PHISHING: 'ACCT_PHISHING',