@opusdns/api 0.139.0 → 0.141.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/src/helpers/constants.ts +159 -1
- package/src/helpers/keys.ts +1398 -268
- package/src/helpers/requests.d.ts +388 -8
- package/src/helpers/responses.d.ts +559 -7
- package/src/helpers/schemas-arrays.d.ts +113 -1
- package/src/helpers/schemas.d.ts +326 -6
- package/src/openapi.yaml +764 -198
- package/src/schema.d.ts +629 -39
package/src/schema.d.ts
CHANGED
|
@@ -490,6 +490,159 @@ export interface paths {
|
|
|
490
490
|
patch: operations["patch_redirects_v1_domain_forwards_patch"];
|
|
491
491
|
trace?: never;
|
|
492
492
|
};
|
|
493
|
+
"/v1/domain-forwards/metrics": {
|
|
494
|
+
parameters: {
|
|
495
|
+
query?: never;
|
|
496
|
+
header?: never;
|
|
497
|
+
path?: never;
|
|
498
|
+
cookie?: never;
|
|
499
|
+
};
|
|
500
|
+
/** Metrics */
|
|
501
|
+
get: operations["metrics_v1_domain_forwards_metrics_get"];
|
|
502
|
+
put?: never;
|
|
503
|
+
post?: never;
|
|
504
|
+
delete?: never;
|
|
505
|
+
options?: never;
|
|
506
|
+
head?: never;
|
|
507
|
+
patch?: never;
|
|
508
|
+
trace?: never;
|
|
509
|
+
};
|
|
510
|
+
"/v1/domain-forwards/metrics/browser": {
|
|
511
|
+
parameters: {
|
|
512
|
+
query?: never;
|
|
513
|
+
header?: never;
|
|
514
|
+
path?: never;
|
|
515
|
+
cookie?: never;
|
|
516
|
+
};
|
|
517
|
+
/** Browser Stats */
|
|
518
|
+
get: operations["browser_stats_v1_domain_forwards_metrics_browser_get"];
|
|
519
|
+
put?: never;
|
|
520
|
+
post?: never;
|
|
521
|
+
delete?: never;
|
|
522
|
+
options?: never;
|
|
523
|
+
head?: never;
|
|
524
|
+
patch?: never;
|
|
525
|
+
trace?: never;
|
|
526
|
+
};
|
|
527
|
+
"/v1/domain-forwards/metrics/geo": {
|
|
528
|
+
parameters: {
|
|
529
|
+
query?: never;
|
|
530
|
+
header?: never;
|
|
531
|
+
path?: never;
|
|
532
|
+
cookie?: never;
|
|
533
|
+
};
|
|
534
|
+
/** Geo Stats */
|
|
535
|
+
get: operations["geo_stats_v1_domain_forwards_metrics_geo_get"];
|
|
536
|
+
put?: never;
|
|
537
|
+
post?: never;
|
|
538
|
+
delete?: never;
|
|
539
|
+
options?: never;
|
|
540
|
+
head?: never;
|
|
541
|
+
patch?: never;
|
|
542
|
+
trace?: never;
|
|
543
|
+
};
|
|
544
|
+
"/v1/domain-forwards/metrics/platform": {
|
|
545
|
+
parameters: {
|
|
546
|
+
query?: never;
|
|
547
|
+
header?: never;
|
|
548
|
+
path?: never;
|
|
549
|
+
cookie?: never;
|
|
550
|
+
};
|
|
551
|
+
/** Platform Stats */
|
|
552
|
+
get: operations["platform_stats_v1_domain_forwards_metrics_platform_get"];
|
|
553
|
+
put?: never;
|
|
554
|
+
post?: never;
|
|
555
|
+
delete?: never;
|
|
556
|
+
options?: never;
|
|
557
|
+
head?: never;
|
|
558
|
+
patch?: never;
|
|
559
|
+
trace?: never;
|
|
560
|
+
};
|
|
561
|
+
"/v1/domain-forwards/metrics/referrer": {
|
|
562
|
+
parameters: {
|
|
563
|
+
query?: never;
|
|
564
|
+
header?: never;
|
|
565
|
+
path?: never;
|
|
566
|
+
cookie?: never;
|
|
567
|
+
};
|
|
568
|
+
/** Referrer Stats */
|
|
569
|
+
get: operations["referrer_stats_v1_domain_forwards_metrics_referrer_get"];
|
|
570
|
+
put?: never;
|
|
571
|
+
post?: never;
|
|
572
|
+
delete?: never;
|
|
573
|
+
options?: never;
|
|
574
|
+
head?: never;
|
|
575
|
+
patch?: never;
|
|
576
|
+
trace?: never;
|
|
577
|
+
};
|
|
578
|
+
"/v1/domain-forwards/metrics/status-code": {
|
|
579
|
+
parameters: {
|
|
580
|
+
query?: never;
|
|
581
|
+
header?: never;
|
|
582
|
+
path?: never;
|
|
583
|
+
cookie?: never;
|
|
584
|
+
};
|
|
585
|
+
/** Status Code Stats */
|
|
586
|
+
get: operations["status_code_stats_v1_domain_forwards_metrics_status_code_get"];
|
|
587
|
+
put?: never;
|
|
588
|
+
post?: never;
|
|
589
|
+
delete?: never;
|
|
590
|
+
options?: never;
|
|
591
|
+
head?: never;
|
|
592
|
+
patch?: never;
|
|
593
|
+
trace?: never;
|
|
594
|
+
};
|
|
595
|
+
"/v1/domain-forwards/metrics/time-series": {
|
|
596
|
+
parameters: {
|
|
597
|
+
query?: never;
|
|
598
|
+
header?: never;
|
|
599
|
+
path?: never;
|
|
600
|
+
cookie?: never;
|
|
601
|
+
};
|
|
602
|
+
/** Time Series */
|
|
603
|
+
get: operations["time_series_v1_domain_forwards_metrics_time_series_get"];
|
|
604
|
+
put?: never;
|
|
605
|
+
post?: never;
|
|
606
|
+
delete?: never;
|
|
607
|
+
options?: never;
|
|
608
|
+
head?: never;
|
|
609
|
+
patch?: never;
|
|
610
|
+
trace?: never;
|
|
611
|
+
};
|
|
612
|
+
"/v1/domain-forwards/metrics/user-agent": {
|
|
613
|
+
parameters: {
|
|
614
|
+
query?: never;
|
|
615
|
+
header?: never;
|
|
616
|
+
path?: never;
|
|
617
|
+
cookie?: never;
|
|
618
|
+
};
|
|
619
|
+
/** User Agent Stats */
|
|
620
|
+
get: operations["user_agent_stats_v1_domain_forwards_metrics_user_agent_get"];
|
|
621
|
+
put?: never;
|
|
622
|
+
post?: never;
|
|
623
|
+
delete?: never;
|
|
624
|
+
options?: never;
|
|
625
|
+
head?: never;
|
|
626
|
+
patch?: never;
|
|
627
|
+
trace?: never;
|
|
628
|
+
};
|
|
629
|
+
"/v1/domain-forwards/metrics/visits-by-key": {
|
|
630
|
+
parameters: {
|
|
631
|
+
query?: never;
|
|
632
|
+
header?: never;
|
|
633
|
+
path?: never;
|
|
634
|
+
cookie?: never;
|
|
635
|
+
};
|
|
636
|
+
/** Visits By Key */
|
|
637
|
+
get: operations["visits_by_key_v1_domain_forwards_metrics_visits_by_key_get"];
|
|
638
|
+
put?: never;
|
|
639
|
+
post?: never;
|
|
640
|
+
delete?: never;
|
|
641
|
+
options?: never;
|
|
642
|
+
head?: never;
|
|
643
|
+
patch?: never;
|
|
644
|
+
trace?: never;
|
|
645
|
+
};
|
|
493
646
|
"/v1/domain-forwards/{hostname}": {
|
|
494
647
|
parameters: {
|
|
495
648
|
query?: never;
|
|
@@ -504,11 +657,10 @@ export interface paths {
|
|
|
504
657
|
get: operations["get_domain_forward_v1_domain_forwards__hostname__get"];
|
|
505
658
|
put?: never;
|
|
506
659
|
/**
|
|
507
|
-
* Create
|
|
508
|
-
* @
|
|
509
|
-
* @description **DEPRECATED**: Use POST /v1/domain-forwards instead. Creates a new domain forward configuration for the specified hostname.
|
|
660
|
+
* Create domain forward set
|
|
661
|
+
* @description Creates a new domain forward set for a specific protocol (HTTP or HTTPS). Raises an error if the set already exists.
|
|
510
662
|
*/
|
|
511
|
-
post: operations["
|
|
663
|
+
post: operations["create_domain_forward_set_v1_domain_forwards__hostname__post"];
|
|
512
664
|
/**
|
|
513
665
|
* Delete a domain forward
|
|
514
666
|
* @description Deletes the domain forward configuration for the specified hostname
|
|
@@ -577,10 +729,11 @@ export interface paths {
|
|
|
577
729
|
*/
|
|
578
730
|
put: operations["update_domain_forward_set_v1_domain_forwards__hostname___protocol__put"];
|
|
579
731
|
/**
|
|
580
|
-
* Create domain forward set
|
|
581
|
-
* @
|
|
732
|
+
* Create domain forward set (deprecated)
|
|
733
|
+
* @deprecated
|
|
734
|
+
* @description Deprecated: Use POST /{hostname} with protocol in body instead. Creates a new domain forward set for a specific protocol (HTTP or HTTPS).
|
|
582
735
|
*/
|
|
583
|
-
post: operations["
|
|
736
|
+
post: operations["create_domain_forward_set_deprecated_v1_domain_forwards__hostname___protocol__post"];
|
|
584
737
|
/**
|
|
585
738
|
* Delete domain forward set
|
|
586
739
|
* @description Deletes a domain forward set for a specific protocol (HTTP or HTTPS).
|
|
@@ -1721,6 +1874,15 @@ export interface components {
|
|
|
1721
1874
|
* @enum {string}
|
|
1722
1875
|
*/
|
|
1723
1876
|
BillingTransactionStatus: "pending" | "succeeded" | "failed" | "canceled";
|
|
1877
|
+
/** BrowserStatsBucket */
|
|
1878
|
+
BrowserStatsBucket: {
|
|
1879
|
+
/** Key */
|
|
1880
|
+
key: string;
|
|
1881
|
+
/** Total */
|
|
1882
|
+
total: number;
|
|
1883
|
+
/** Unique */
|
|
1884
|
+
unique: number;
|
|
1885
|
+
};
|
|
1724
1886
|
/**
|
|
1725
1887
|
* ContactAttributeDefinition
|
|
1726
1888
|
* @description Definition of a possible attribute for a TLD.
|
|
@@ -2658,8 +2820,11 @@ export interface components {
|
|
|
2658
2820
|
* Format: date-time
|
|
2659
2821
|
*/
|
|
2660
2822
|
updated_on: Date;
|
|
2661
|
-
|
|
2662
|
-
|
|
2823
|
+
};
|
|
2824
|
+
/** DomainForwardBrowserStatsResponse */
|
|
2825
|
+
DomainForwardBrowserStatsResponse: {
|
|
2826
|
+
/** Results */
|
|
2827
|
+
results: components["schemas"]["BrowserStatsBucket"][];
|
|
2663
2828
|
};
|
|
2664
2829
|
/** DomainForwardCreateRequest */
|
|
2665
2830
|
DomainForwardCreateRequest: {
|
|
@@ -2673,6 +2838,27 @@ export interface components {
|
|
|
2673
2838
|
http?: components["schemas"]["DomainForwardProtocolSetRequest"] | null;
|
|
2674
2839
|
https?: components["schemas"]["DomainForwardProtocolSetRequest"] | null;
|
|
2675
2840
|
};
|
|
2841
|
+
/** DomainForwardGeoStatsResponse */
|
|
2842
|
+
DomainForwardGeoStatsResponse: {
|
|
2843
|
+
/** Results */
|
|
2844
|
+
results: components["schemas"]["GeoStatsBucket"][];
|
|
2845
|
+
};
|
|
2846
|
+
/** DomainForwardMetricsResponse */
|
|
2847
|
+
DomainForwardMetricsResponse: {
|
|
2848
|
+
/** Configured Forwards */
|
|
2849
|
+
configured_forwards: number;
|
|
2850
|
+
/** Invoked Forwards */
|
|
2851
|
+
invoked_forwards: number;
|
|
2852
|
+
/** Total Visits */
|
|
2853
|
+
total_visits: number;
|
|
2854
|
+
/** Unique Visits */
|
|
2855
|
+
unique_visits: number;
|
|
2856
|
+
};
|
|
2857
|
+
/** DomainForwardMetricsTimeSeriesResponse */
|
|
2858
|
+
DomainForwardMetricsTimeSeriesResponse: {
|
|
2859
|
+
/** Results */
|
|
2860
|
+
results: components["schemas"]["TimeSeriesBucket"][];
|
|
2861
|
+
};
|
|
2676
2862
|
/** DomainForwardPatchOp */
|
|
2677
2863
|
DomainForwardPatchOp: {
|
|
2678
2864
|
op: components["schemas"]["PatchOp"];
|
|
@@ -2684,12 +2870,15 @@ export interface components {
|
|
|
2684
2870
|
/** Ops */
|
|
2685
2871
|
ops: components["schemas"]["DomainForwardPatchOp"][];
|
|
2686
2872
|
};
|
|
2873
|
+
/** DomainForwardPlatformStatsResponse */
|
|
2874
|
+
DomainForwardPlatformStatsResponse: {
|
|
2875
|
+
/** Results */
|
|
2876
|
+
results: components["schemas"]["PlatformStatsBucket"][];
|
|
2877
|
+
};
|
|
2687
2878
|
/** DomainForwardProtocolSetRequest */
|
|
2688
2879
|
DomainForwardProtocolSetRequest: {
|
|
2689
2880
|
/** Redirects */
|
|
2690
2881
|
redirects: (components["schemas"]["HttpRedirectRequest"] | components["schemas"]["WildcardHttpRedirectRequest"])[];
|
|
2691
|
-
/** Wildcard */
|
|
2692
|
-
wildcard?: boolean | null;
|
|
2693
2882
|
};
|
|
2694
2883
|
/** DomainForwardProtocolSetResponse */
|
|
2695
2884
|
DomainForwardProtocolSetResponse: {
|
|
@@ -2705,20 +2894,17 @@ export interface components {
|
|
|
2705
2894
|
* Format: date-time
|
|
2706
2895
|
*/
|
|
2707
2896
|
updated_on: Date;
|
|
2708
|
-
/** Wildcard */
|
|
2709
|
-
wildcard: boolean;
|
|
2710
2897
|
};
|
|
2711
|
-
/**
|
|
2712
|
-
|
|
2713
|
-
/**
|
|
2714
|
-
|
|
2715
|
-
|
|
2716
|
-
|
|
2717
|
-
|
|
2718
|
-
|
|
2719
|
-
|
|
2720
|
-
|
|
2721
|
-
wildcard?: boolean | null;
|
|
2898
|
+
/** DomainForwardReferrerStatsResponse */
|
|
2899
|
+
DomainForwardReferrerStatsResponse: {
|
|
2900
|
+
/** Results */
|
|
2901
|
+
results: components["schemas"]["ReferrerStatsBucket"][];
|
|
2902
|
+
};
|
|
2903
|
+
/** DomainForwardSetCreateRequest */
|
|
2904
|
+
DomainForwardSetCreateRequest: {
|
|
2905
|
+
protocol: components["schemas"]["HttpProtocol"];
|
|
2906
|
+
/** Redirects */
|
|
2907
|
+
redirects: (components["schemas"]["HttpRedirectRequest"] | components["schemas"]["WildcardHttpRedirectRequest"])[];
|
|
2722
2908
|
};
|
|
2723
2909
|
/** DomainForwardSetRequest */
|
|
2724
2910
|
DomainForwardSetRequest: {
|
|
@@ -2742,14 +2928,27 @@ export interface components {
|
|
|
2742
2928
|
* Format: date-time
|
|
2743
2929
|
*/
|
|
2744
2930
|
updated_on: Date;
|
|
2745
|
-
/** Wildcard */
|
|
2746
|
-
wildcard: boolean;
|
|
2747
2931
|
};
|
|
2748
2932
|
/**
|
|
2749
2933
|
* DomainForwardSortField
|
|
2750
2934
|
* @enum {string}
|
|
2751
2935
|
*/
|
|
2752
2936
|
DomainForwardSortField: "hostname" | "enabled" | "created_on" | "updated_on";
|
|
2937
|
+
/** DomainForwardStatusCodeStatsResponse */
|
|
2938
|
+
DomainForwardStatusCodeStatsResponse: {
|
|
2939
|
+
/** Results */
|
|
2940
|
+
results: components["schemas"]["StatusCodeStatsBucket"][];
|
|
2941
|
+
};
|
|
2942
|
+
/** DomainForwardUserAgentStatsResponse */
|
|
2943
|
+
DomainForwardUserAgentStatsResponse: {
|
|
2944
|
+
/** Results */
|
|
2945
|
+
results: components["schemas"]["UserAgentStatsBucket"][];
|
|
2946
|
+
};
|
|
2947
|
+
/** DomainForwardVisitsByKeyResponse */
|
|
2948
|
+
DomainForwardVisitsByKeyResponse: {
|
|
2949
|
+
/** Results */
|
|
2950
|
+
results: components["schemas"]["VisitsByKeyBucket"][];
|
|
2951
|
+
};
|
|
2753
2952
|
/** DomainForwardZone */
|
|
2754
2953
|
DomainForwardZone: {
|
|
2755
2954
|
/** Domain Forwards */
|
|
@@ -3638,6 +3837,13 @@ export interface components {
|
|
|
3638
3837
|
*/
|
|
3639
3838
|
start_date: Date;
|
|
3640
3839
|
};
|
|
3840
|
+
/** GeoStatsBucket */
|
|
3841
|
+
GeoStatsBucket: {
|
|
3842
|
+
/** Key */
|
|
3843
|
+
key: string;
|
|
3844
|
+
/** Total */
|
|
3845
|
+
total: number;
|
|
3846
|
+
};
|
|
3641
3847
|
/** GetPricesResponse */
|
|
3642
3848
|
GetPricesResponse: {
|
|
3643
3849
|
/**
|
|
@@ -4000,6 +4206,11 @@ export interface components {
|
|
|
4000
4206
|
* @enum {string}
|
|
4001
4207
|
*/
|
|
4002
4208
|
LocalPresenceRequirementType: "physical_address" | "business_entity";
|
|
4209
|
+
/**
|
|
4210
|
+
* MetricsGrouping
|
|
4211
|
+
* @enum {string}
|
|
4212
|
+
*/
|
|
4213
|
+
MetricsGrouping: "url" | "fqdn" | "domain" | "forward";
|
|
4003
4214
|
/** Nameserver */
|
|
4004
4215
|
Nameserver: {
|
|
4005
4216
|
/**
|
|
@@ -4689,6 +4900,15 @@ export interface components {
|
|
|
4689
4900
|
/** Permissions */
|
|
4690
4901
|
permissions?: components["schemas"]["Permission"][];
|
|
4691
4902
|
};
|
|
4903
|
+
/** PlatformStatsBucket */
|
|
4904
|
+
PlatformStatsBucket: {
|
|
4905
|
+
/** Key */
|
|
4906
|
+
key: string;
|
|
4907
|
+
/** Total */
|
|
4908
|
+
total: number;
|
|
4909
|
+
/** Unique */
|
|
4910
|
+
unique: number;
|
|
4911
|
+
};
|
|
4692
4912
|
/**
|
|
4693
4913
|
* PostTransferRequirements
|
|
4694
4914
|
* @enum {string}
|
|
@@ -4760,6 +4980,11 @@ export interface components {
|
|
|
4760
4980
|
/** Problem type */
|
|
4761
4981
|
type: string;
|
|
4762
4982
|
};
|
|
4983
|
+
/**
|
|
4984
|
+
* Protocol
|
|
4985
|
+
* @enum {string}
|
|
4986
|
+
*/
|
|
4987
|
+
Protocol: "http" | "https";
|
|
4763
4988
|
/** PublicAuthRequestForm */
|
|
4764
4989
|
PublicAuthRequestForm: {
|
|
4765
4990
|
/**
|
|
@@ -4793,6 +5018,15 @@ export interface components {
|
|
|
4793
5018
|
* @enum {integer}
|
|
4794
5019
|
*/
|
|
4795
5020
|
RedirectCode: 301 | 302 | 307 | 308;
|
|
5021
|
+
/** ReferrerStatsBucket */
|
|
5022
|
+
ReferrerStatsBucket: {
|
|
5023
|
+
/** Key */
|
|
5024
|
+
key: string;
|
|
5025
|
+
/** Total */
|
|
5026
|
+
total: number;
|
|
5027
|
+
/** Unique */
|
|
5028
|
+
unique: number;
|
|
5029
|
+
};
|
|
4796
5030
|
/**
|
|
4797
5031
|
* RegistrantChangeType
|
|
4798
5032
|
* @enum {string}
|
|
@@ -4985,6 +5219,13 @@ export interface components {
|
|
|
4985
5219
|
/** Remove */
|
|
4986
5220
|
remove?: components["schemas"]["Relation"][] | null;
|
|
4987
5221
|
};
|
|
5222
|
+
/** StatusCodeStatsBucket */
|
|
5223
|
+
StatusCodeStatsBucket: {
|
|
5224
|
+
/** Key */
|
|
5225
|
+
key: string;
|
|
5226
|
+
/** Total */
|
|
5227
|
+
total: number;
|
|
5228
|
+
};
|
|
4988
5229
|
/**
|
|
4989
5230
|
* SyncOperationType
|
|
4990
5231
|
* @enum {string}
|
|
@@ -4995,6 +5236,21 @@ export interface components {
|
|
|
4995
5236
|
* @enum {string}
|
|
4996
5237
|
*/
|
|
4997
5238
|
TLDType: "gTLD" | "ccTLD";
|
|
5239
|
+
/**
|
|
5240
|
+
* TimeRange
|
|
5241
|
+
* @enum {string}
|
|
5242
|
+
*/
|
|
5243
|
+
TimeRange: "1h" | "1d" | "7d" | "30d";
|
|
5244
|
+
/** TimeSeriesBucket */
|
|
5245
|
+
TimeSeriesBucket: {
|
|
5246
|
+
/**
|
|
5247
|
+
* Timestamp
|
|
5248
|
+
* Format: date-time
|
|
5249
|
+
*/
|
|
5250
|
+
timestamp: Date;
|
|
5251
|
+
/** Total */
|
|
5252
|
+
total: number;
|
|
5253
|
+
};
|
|
4998
5254
|
/** TldBase */
|
|
4999
5255
|
TldBase: {
|
|
5000
5256
|
/**
|
|
@@ -5255,6 +5511,15 @@ export interface components {
|
|
|
5255
5511
|
*/
|
|
5256
5512
|
username: string;
|
|
5257
5513
|
};
|
|
5514
|
+
/** UserAgentStatsBucket */
|
|
5515
|
+
UserAgentStatsBucket: {
|
|
5516
|
+
/** Key */
|
|
5517
|
+
key: string;
|
|
5518
|
+
/** Total */
|
|
5519
|
+
total: number;
|
|
5520
|
+
/** Unique */
|
|
5521
|
+
unique: number;
|
|
5522
|
+
};
|
|
5258
5523
|
/** UserAttributeBase */
|
|
5259
5524
|
UserAttributeBase: {
|
|
5260
5525
|
/**
|
|
@@ -5633,6 +5898,15 @@ export interface components {
|
|
|
5633
5898
|
* @enum {string}
|
|
5634
5899
|
*/
|
|
5635
5900
|
VerificationType: "api" | "email";
|
|
5901
|
+
/** VisitsByKeyBucket */
|
|
5902
|
+
VisitsByKeyBucket: {
|
|
5903
|
+
/** Key */
|
|
5904
|
+
key: string;
|
|
5905
|
+
/** Total */
|
|
5906
|
+
total: number;
|
|
5907
|
+
/** Unique */
|
|
5908
|
+
unique: number;
|
|
5909
|
+
};
|
|
5636
5910
|
/** WhoisBase */
|
|
5637
5911
|
WhoisBase: {
|
|
5638
5912
|
/**
|
|
@@ -7734,6 +8008,323 @@ export interface operations {
|
|
|
7734
8008
|
};
|
|
7735
8009
|
};
|
|
7736
8010
|
};
|
|
8011
|
+
metrics_v1_domain_forwards_metrics_get: {
|
|
8012
|
+
parameters: {
|
|
8013
|
+
query?: {
|
|
8014
|
+
hostname?: string | null;
|
|
8015
|
+
/** @description Filter by protocol: http or https */
|
|
8016
|
+
protocol?: components["schemas"]["Protocol"] | null;
|
|
8017
|
+
/** @description Time range: 1h, 1d, 7d, or 30d */
|
|
8018
|
+
time_range?: components["schemas"]["TimeRange"];
|
|
8019
|
+
};
|
|
8020
|
+
header?: never;
|
|
8021
|
+
path?: never;
|
|
8022
|
+
cookie?: never;
|
|
8023
|
+
};
|
|
8024
|
+
requestBody?: never;
|
|
8025
|
+
responses: {
|
|
8026
|
+
/** @description Successful Response */
|
|
8027
|
+
200: {
|
|
8028
|
+
headers: {
|
|
8029
|
+
[name: string]: unknown;
|
|
8030
|
+
};
|
|
8031
|
+
content: {
|
|
8032
|
+
"application/json": components["schemas"]["DomainForwardMetricsResponse"];
|
|
8033
|
+
};
|
|
8034
|
+
};
|
|
8035
|
+
/** @description Validation Error */
|
|
8036
|
+
422: {
|
|
8037
|
+
headers: {
|
|
8038
|
+
[name: string]: unknown;
|
|
8039
|
+
};
|
|
8040
|
+
content: {
|
|
8041
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
8042
|
+
};
|
|
8043
|
+
};
|
|
8044
|
+
};
|
|
8045
|
+
};
|
|
8046
|
+
browser_stats_v1_domain_forwards_metrics_browser_get: {
|
|
8047
|
+
parameters: {
|
|
8048
|
+
query?: {
|
|
8049
|
+
hostname?: string | null;
|
|
8050
|
+
/** @description Filter by protocol: http or https */
|
|
8051
|
+
protocol?: components["schemas"]["Protocol"] | null;
|
|
8052
|
+
/** @description Time range: 1h, 1d, 7d, or 30d */
|
|
8053
|
+
time_range?: components["schemas"]["TimeRange"];
|
|
8054
|
+
};
|
|
8055
|
+
header?: never;
|
|
8056
|
+
path?: never;
|
|
8057
|
+
cookie?: never;
|
|
8058
|
+
};
|
|
8059
|
+
requestBody?: never;
|
|
8060
|
+
responses: {
|
|
8061
|
+
/** @description Successful Response */
|
|
8062
|
+
200: {
|
|
8063
|
+
headers: {
|
|
8064
|
+
[name: string]: unknown;
|
|
8065
|
+
};
|
|
8066
|
+
content: {
|
|
8067
|
+
"application/json": components["schemas"]["DomainForwardBrowserStatsResponse"];
|
|
8068
|
+
};
|
|
8069
|
+
};
|
|
8070
|
+
/** @description Validation Error */
|
|
8071
|
+
422: {
|
|
8072
|
+
headers: {
|
|
8073
|
+
[name: string]: unknown;
|
|
8074
|
+
};
|
|
8075
|
+
content: {
|
|
8076
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
8077
|
+
};
|
|
8078
|
+
};
|
|
8079
|
+
};
|
|
8080
|
+
};
|
|
8081
|
+
geo_stats_v1_domain_forwards_metrics_geo_get: {
|
|
8082
|
+
parameters: {
|
|
8083
|
+
query?: {
|
|
8084
|
+
hostname?: string | null;
|
|
8085
|
+
/** @description Filter by protocol: http or https */
|
|
8086
|
+
protocol?: components["schemas"]["Protocol"] | null;
|
|
8087
|
+
/** @description Time range: 1h, 1d, 7d, or 30d */
|
|
8088
|
+
time_range?: components["schemas"]["TimeRange"];
|
|
8089
|
+
};
|
|
8090
|
+
header?: never;
|
|
8091
|
+
path?: never;
|
|
8092
|
+
cookie?: never;
|
|
8093
|
+
};
|
|
8094
|
+
requestBody?: never;
|
|
8095
|
+
responses: {
|
|
8096
|
+
/** @description Successful Response */
|
|
8097
|
+
200: {
|
|
8098
|
+
headers: {
|
|
8099
|
+
[name: string]: unknown;
|
|
8100
|
+
};
|
|
8101
|
+
content: {
|
|
8102
|
+
"application/json": components["schemas"]["DomainForwardGeoStatsResponse"];
|
|
8103
|
+
};
|
|
8104
|
+
};
|
|
8105
|
+
/** @description Validation Error */
|
|
8106
|
+
422: {
|
|
8107
|
+
headers: {
|
|
8108
|
+
[name: string]: unknown;
|
|
8109
|
+
};
|
|
8110
|
+
content: {
|
|
8111
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
8112
|
+
};
|
|
8113
|
+
};
|
|
8114
|
+
};
|
|
8115
|
+
};
|
|
8116
|
+
platform_stats_v1_domain_forwards_metrics_platform_get: {
|
|
8117
|
+
parameters: {
|
|
8118
|
+
query?: {
|
|
8119
|
+
hostname?: string | null;
|
|
8120
|
+
/** @description Filter by protocol: http or https */
|
|
8121
|
+
protocol?: components["schemas"]["Protocol"] | null;
|
|
8122
|
+
/** @description Time range: 1h, 1d, 7d, or 30d */
|
|
8123
|
+
time_range?: components["schemas"]["TimeRange"];
|
|
8124
|
+
};
|
|
8125
|
+
header?: never;
|
|
8126
|
+
path?: never;
|
|
8127
|
+
cookie?: never;
|
|
8128
|
+
};
|
|
8129
|
+
requestBody?: never;
|
|
8130
|
+
responses: {
|
|
8131
|
+
/** @description Successful Response */
|
|
8132
|
+
200: {
|
|
8133
|
+
headers: {
|
|
8134
|
+
[name: string]: unknown;
|
|
8135
|
+
};
|
|
8136
|
+
content: {
|
|
8137
|
+
"application/json": components["schemas"]["DomainForwardPlatformStatsResponse"];
|
|
8138
|
+
};
|
|
8139
|
+
};
|
|
8140
|
+
/** @description Validation Error */
|
|
8141
|
+
422: {
|
|
8142
|
+
headers: {
|
|
8143
|
+
[name: string]: unknown;
|
|
8144
|
+
};
|
|
8145
|
+
content: {
|
|
8146
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
8147
|
+
};
|
|
8148
|
+
};
|
|
8149
|
+
};
|
|
8150
|
+
};
|
|
8151
|
+
referrer_stats_v1_domain_forwards_metrics_referrer_get: {
|
|
8152
|
+
parameters: {
|
|
8153
|
+
query?: {
|
|
8154
|
+
hostname?: string | null;
|
|
8155
|
+
/** @description Filter by protocol: http or https */
|
|
8156
|
+
protocol?: components["schemas"]["Protocol"] | null;
|
|
8157
|
+
/** @description Time range: 1h, 1d, 7d, or 30d */
|
|
8158
|
+
time_range?: components["schemas"]["TimeRange"];
|
|
8159
|
+
};
|
|
8160
|
+
header?: never;
|
|
8161
|
+
path?: never;
|
|
8162
|
+
cookie?: never;
|
|
8163
|
+
};
|
|
8164
|
+
requestBody?: never;
|
|
8165
|
+
responses: {
|
|
8166
|
+
/** @description Successful Response */
|
|
8167
|
+
200: {
|
|
8168
|
+
headers: {
|
|
8169
|
+
[name: string]: unknown;
|
|
8170
|
+
};
|
|
8171
|
+
content: {
|
|
8172
|
+
"application/json": components["schemas"]["DomainForwardReferrerStatsResponse"];
|
|
8173
|
+
};
|
|
8174
|
+
};
|
|
8175
|
+
/** @description Validation Error */
|
|
8176
|
+
422: {
|
|
8177
|
+
headers: {
|
|
8178
|
+
[name: string]: unknown;
|
|
8179
|
+
};
|
|
8180
|
+
content: {
|
|
8181
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
8182
|
+
};
|
|
8183
|
+
};
|
|
8184
|
+
};
|
|
8185
|
+
};
|
|
8186
|
+
status_code_stats_v1_domain_forwards_metrics_status_code_get: {
|
|
8187
|
+
parameters: {
|
|
8188
|
+
query?: {
|
|
8189
|
+
hostname?: string | null;
|
|
8190
|
+
/** @description Filter by protocol: http or https */
|
|
8191
|
+
protocol?: components["schemas"]["Protocol"] | null;
|
|
8192
|
+
/** @description Time range: 1h, 1d, 7d, or 30d */
|
|
8193
|
+
time_range?: components["schemas"]["TimeRange"];
|
|
8194
|
+
};
|
|
8195
|
+
header?: never;
|
|
8196
|
+
path?: never;
|
|
8197
|
+
cookie?: never;
|
|
8198
|
+
};
|
|
8199
|
+
requestBody?: never;
|
|
8200
|
+
responses: {
|
|
8201
|
+
/** @description Successful Response */
|
|
8202
|
+
200: {
|
|
8203
|
+
headers: {
|
|
8204
|
+
[name: string]: unknown;
|
|
8205
|
+
};
|
|
8206
|
+
content: {
|
|
8207
|
+
"application/json": components["schemas"]["DomainForwardStatusCodeStatsResponse"];
|
|
8208
|
+
};
|
|
8209
|
+
};
|
|
8210
|
+
/** @description Validation Error */
|
|
8211
|
+
422: {
|
|
8212
|
+
headers: {
|
|
8213
|
+
[name: string]: unknown;
|
|
8214
|
+
};
|
|
8215
|
+
content: {
|
|
8216
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
8217
|
+
};
|
|
8218
|
+
};
|
|
8219
|
+
};
|
|
8220
|
+
};
|
|
8221
|
+
time_series_v1_domain_forwards_metrics_time_series_get: {
|
|
8222
|
+
parameters: {
|
|
8223
|
+
query?: {
|
|
8224
|
+
hostname?: string | null;
|
|
8225
|
+
/** @description Filter by protocol: http or https */
|
|
8226
|
+
protocol?: components["schemas"]["Protocol"] | null;
|
|
8227
|
+
/** @description Time range: 1h, 1d, 7d, or 30d */
|
|
8228
|
+
time_range?: components["schemas"]["TimeRange"];
|
|
8229
|
+
};
|
|
8230
|
+
header?: never;
|
|
8231
|
+
path?: never;
|
|
8232
|
+
cookie?: never;
|
|
8233
|
+
};
|
|
8234
|
+
requestBody?: never;
|
|
8235
|
+
responses: {
|
|
8236
|
+
/** @description Successful Response */
|
|
8237
|
+
200: {
|
|
8238
|
+
headers: {
|
|
8239
|
+
[name: string]: unknown;
|
|
8240
|
+
};
|
|
8241
|
+
content: {
|
|
8242
|
+
"application/json": components["schemas"]["DomainForwardMetricsTimeSeriesResponse"];
|
|
8243
|
+
};
|
|
8244
|
+
};
|
|
8245
|
+
/** @description Validation Error */
|
|
8246
|
+
422: {
|
|
8247
|
+
headers: {
|
|
8248
|
+
[name: string]: unknown;
|
|
8249
|
+
};
|
|
8250
|
+
content: {
|
|
8251
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
8252
|
+
};
|
|
8253
|
+
};
|
|
8254
|
+
};
|
|
8255
|
+
};
|
|
8256
|
+
user_agent_stats_v1_domain_forwards_metrics_user_agent_get: {
|
|
8257
|
+
parameters: {
|
|
8258
|
+
query?: {
|
|
8259
|
+
hostname?: string | null;
|
|
8260
|
+
/** @description Filter by protocol: http or https */
|
|
8261
|
+
protocol?: components["schemas"]["Protocol"] | null;
|
|
8262
|
+
/** @description Time range: 1h, 1d, 7d, or 30d */
|
|
8263
|
+
time_range?: components["schemas"]["TimeRange"];
|
|
8264
|
+
};
|
|
8265
|
+
header?: never;
|
|
8266
|
+
path?: never;
|
|
8267
|
+
cookie?: never;
|
|
8268
|
+
};
|
|
8269
|
+
requestBody?: never;
|
|
8270
|
+
responses: {
|
|
8271
|
+
/** @description Successful Response */
|
|
8272
|
+
200: {
|
|
8273
|
+
headers: {
|
|
8274
|
+
[name: string]: unknown;
|
|
8275
|
+
};
|
|
8276
|
+
content: {
|
|
8277
|
+
"application/json": components["schemas"]["DomainForwardUserAgentStatsResponse"];
|
|
8278
|
+
};
|
|
8279
|
+
};
|
|
8280
|
+
/** @description Validation Error */
|
|
8281
|
+
422: {
|
|
8282
|
+
headers: {
|
|
8283
|
+
[name: string]: unknown;
|
|
8284
|
+
};
|
|
8285
|
+
content: {
|
|
8286
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
8287
|
+
};
|
|
8288
|
+
};
|
|
8289
|
+
};
|
|
8290
|
+
};
|
|
8291
|
+
visits_by_key_v1_domain_forwards_metrics_visits_by_key_get: {
|
|
8292
|
+
parameters: {
|
|
8293
|
+
query?: {
|
|
8294
|
+
/** @description Grouping key: url, fqdn, domain, or forward */
|
|
8295
|
+
grouping?: components["schemas"]["MetricsGrouping"];
|
|
8296
|
+
hostname?: string | null;
|
|
8297
|
+
/** @description Filter by protocol: http or https */
|
|
8298
|
+
protocol?: components["schemas"]["Protocol"] | null;
|
|
8299
|
+
/** @description Time range: 1h, 1d, 7d, or 30d */
|
|
8300
|
+
time_range?: components["schemas"]["TimeRange"];
|
|
8301
|
+
};
|
|
8302
|
+
header?: never;
|
|
8303
|
+
path?: never;
|
|
8304
|
+
cookie?: never;
|
|
8305
|
+
};
|
|
8306
|
+
requestBody?: never;
|
|
8307
|
+
responses: {
|
|
8308
|
+
/** @description Successful Response */
|
|
8309
|
+
200: {
|
|
8310
|
+
headers: {
|
|
8311
|
+
[name: string]: unknown;
|
|
8312
|
+
};
|
|
8313
|
+
content: {
|
|
8314
|
+
"application/json": components["schemas"]["DomainForwardVisitsByKeyResponse"];
|
|
8315
|
+
};
|
|
8316
|
+
};
|
|
8317
|
+
/** @description Validation Error */
|
|
8318
|
+
422: {
|
|
8319
|
+
headers: {
|
|
8320
|
+
[name: string]: unknown;
|
|
8321
|
+
};
|
|
8322
|
+
content: {
|
|
8323
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
8324
|
+
};
|
|
8325
|
+
};
|
|
8326
|
+
};
|
|
8327
|
+
};
|
|
7737
8328
|
get_domain_forward_v1_domain_forwards__hostname__get: {
|
|
7738
8329
|
parameters: {
|
|
7739
8330
|
query?: never;
|
|
@@ -7814,7 +8405,7 @@ export interface operations {
|
|
|
7814
8405
|
};
|
|
7815
8406
|
};
|
|
7816
8407
|
};
|
|
7817
|
-
|
|
8408
|
+
create_domain_forward_set_v1_domain_forwards__hostname__post: {
|
|
7818
8409
|
parameters: {
|
|
7819
8410
|
query?: never;
|
|
7820
8411
|
header?: never;
|
|
@@ -7826,17 +8417,17 @@ export interface operations {
|
|
|
7826
8417
|
};
|
|
7827
8418
|
requestBody: {
|
|
7828
8419
|
content: {
|
|
7829
|
-
"application/json": components["schemas"]["
|
|
8420
|
+
"application/json": components["schemas"]["DomainForwardSetCreateRequest"];
|
|
7830
8421
|
};
|
|
7831
8422
|
};
|
|
7832
8423
|
responses: {
|
|
7833
|
-
/** @description
|
|
8424
|
+
/** @description Successful Response */
|
|
7834
8425
|
201: {
|
|
7835
8426
|
headers: {
|
|
7836
8427
|
[name: string]: unknown;
|
|
7837
8428
|
};
|
|
7838
8429
|
content: {
|
|
7839
|
-
"application/json": components["schemas"]["
|
|
8430
|
+
"application/json": components["schemas"]["DomainForwardSetResponse"];
|
|
7840
8431
|
};
|
|
7841
8432
|
};
|
|
7842
8433
|
/** @description Unauthorized */
|
|
@@ -7871,24 +8462,23 @@ export interface operations {
|
|
|
7871
8462
|
"application/problem+json": components["schemas"]["Problem"];
|
|
7872
8463
|
};
|
|
7873
8464
|
};
|
|
7874
|
-
/** @description
|
|
8465
|
+
/** @description Not Found */
|
|
7875
8466
|
404: {
|
|
7876
8467
|
headers: {
|
|
7877
8468
|
[name: string]: unknown;
|
|
7878
8469
|
};
|
|
7879
8470
|
content: {
|
|
7880
8471
|
/** @example {
|
|
7881
|
-
* "code": "
|
|
7882
|
-
* "detail": "
|
|
8472
|
+
* "code": "ERROR_DOMAIN_FORWARD_NOT_EXISTS",
|
|
8473
|
+
* "detail": "Domain forward not found for Additional error context.",
|
|
7883
8474
|
* "status": 404,
|
|
7884
|
-
* "title": "
|
|
7885
|
-
* "type": "
|
|
7886
|
-
* "zone_name": "Zone example.com. not found"
|
|
8475
|
+
* "title": "Domain Forward Error",
|
|
8476
|
+
* "type": "domain-forward-not-found"
|
|
7887
8477
|
* } */
|
|
7888
8478
|
"application/problem+json": components["schemas"]["Problem"];
|
|
7889
8479
|
};
|
|
7890
8480
|
};
|
|
7891
|
-
/** @description
|
|
8481
|
+
/** @description Conflict */
|
|
7892
8482
|
409: {
|
|
7893
8483
|
headers: {
|
|
7894
8484
|
[name: string]: unknown;
|
|
@@ -7896,7 +8486,7 @@ export interface operations {
|
|
|
7896
8486
|
content: {
|
|
7897
8487
|
/** @example {
|
|
7898
8488
|
* "code": "ERROR_DOMAIN_FORWARD_ALREADY_EXISTS",
|
|
7899
|
-
* "detail": "Domain forward already exists for
|
|
8489
|
+
* "detail": "Domain forward already exists for Additional error context.",
|
|
7900
8490
|
* "status": 409,
|
|
7901
8491
|
* "title": "Domain Forward Error",
|
|
7902
8492
|
* "type": "domain-forward-already-exists"
|
|
@@ -8299,7 +8889,7 @@ export interface operations {
|
|
|
8299
8889
|
};
|
|
8300
8890
|
};
|
|
8301
8891
|
};
|
|
8302
|
-
|
|
8892
|
+
create_domain_forward_set_deprecated_v1_domain_forwards__hostname___protocol__post: {
|
|
8303
8893
|
parameters: {
|
|
8304
8894
|
query?: never;
|
|
8305
8895
|
header?: never;
|