@opusdns/api 0.140.0 → 0.142.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.
@@ -34,7 +34,7 @@
34
34
 
35
35
  import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
36
36
 
37
- import { Pagination_EmailForwardLog, HTTPValidationError, Pagination_ObjectLog, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, EmailForwardZone, Pagination_DomainForwardZone, Pagination_EmailForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, RequestAuthcode2, Pagination_EmailForward, EmailForward, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_UserPublic, TldSpecification, UserPublic, UserPublicWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
37
+ import { Pagination_EmailForwardLog, HTTPValidationError, Pagination_ObjectLog, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, EmailForwardZone, Pagination_DomainForwardZone, Pagination_EmailForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainForwardMetrics, DomainForwardBrowserStats, DomainForwardGeoStats, DomainForwardPlatformStats, DomainForwardReferrerStats, DomainForwardStatusCodeStats, DomainForwardMetricsTimeSeries, DomainForwardUserAgentStats, DomainForwardVisitsByKey, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, RequestAuthcode2, Pagination_EmailForward, EmailForward, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_UserPublic, TldSpecification, UserPublic, UserPublicWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
38
38
 
39
39
  /**
40
40
  * Response types for GET ArchiveEmailForwardLogsAliasesByEmailForwardAliasId endpoint
@@ -3674,6 +3674,558 @@ export type PATCH_DomainForwardsByHostnameEnable_Response_403 = Problem
3674
3674
  */
3675
3675
  export type PATCH_DomainForwardsByHostnameEnable_Response_422 = HTTPValidationError
3676
3676
 
3677
+ /**
3678
+ * Response types for GET DomainForwardsMetrics endpoint
3679
+ *
3680
+ * Metrics
3681
+ *
3682
+ * @remarks
3683
+ * This type defines all possible response structures for the GET DomainForwardsMetrics endpoint.
3684
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
3685
+ * Use this type to ensure type safety when handling API responses from this endpoint.
3686
+ *
3687
+
3688
+ *
3689
+ * @path /v1/domain-forwards/metrics
3690
+ * @param protocol (query) - Filter by protocol: http or https
3691
+ * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
3692
+ *
3693
+ * @see {@link GET_DomainForwardsMetrics_Response_200} - 200 response type
3694
+ * @see {@link GET_DomainForwardsMetrics_Response_422} - 422 response type
3695
+ *
3696
+
3697
+ */
3698
+ export type GET_DomainForwardsMetrics_Response = GET_DomainForwardsMetrics_Response_200 | GET_DomainForwardsMetrics_Response_422;
3699
+
3700
+ /**
3701
+ * 200 response for GET DomainForwardsMetrics endpoint
3702
+ *
3703
+ * @remarks
3704
+ * This type defines the response structure for the 200 status code
3705
+ * of the GET DomainForwardsMetrics endpoint.
3706
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3707
+ *
3708
+
3709
+ *
3710
+ * @path /v1/domain-forwards/metrics
3711
+ * @param protocol (query) - Filter by protocol: http or https
3712
+ * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
3713
+ *
3714
+ * @see {@link GET_DomainForwardsMetrics_Response} - The main response type definition
3715
+ * @see {@link DomainForwardMetrics} - The actual schema type definition
3716
+ */
3717
+ export type GET_DomainForwardsMetrics_Response_200 = DomainForwardMetrics
3718
+
3719
+ /**
3720
+ * 422 response for GET DomainForwardsMetrics endpoint
3721
+ *
3722
+ * @remarks
3723
+ * This type defines the response structure for the 422 status code
3724
+ * of the GET DomainForwardsMetrics endpoint.
3725
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3726
+ *
3727
+
3728
+ *
3729
+ * @path /v1/domain-forwards/metrics
3730
+ * @param protocol (query) - Filter by protocol: http or https
3731
+ * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
3732
+ *
3733
+ * @see {@link GET_DomainForwardsMetrics_Response} - The main response type definition
3734
+ * @see {@link HTTPValidationError} - The actual schema type definition
3735
+ */
3736
+ export type GET_DomainForwardsMetrics_Response_422 = HTTPValidationError
3737
+
3738
+ /**
3739
+ * Response types for GET DomainForwardsMetricsBrowser endpoint
3740
+ *
3741
+ * Browser Stats
3742
+ *
3743
+ * @remarks
3744
+ * This type defines all possible response structures for the GET DomainForwardsMetricsBrowser endpoint.
3745
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
3746
+ * Use this type to ensure type safety when handling API responses from this endpoint.
3747
+ *
3748
+
3749
+ *
3750
+ * @path /v1/domain-forwards/metrics/browser
3751
+ * @param protocol (query) - Filter by protocol: http or https
3752
+ * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
3753
+ *
3754
+ * @see {@link GET_DomainForwardsMetricsBrowser_Response_200} - 200 response type
3755
+ * @see {@link GET_DomainForwardsMetricsBrowser_Response_422} - 422 response type
3756
+ *
3757
+
3758
+ */
3759
+ export type GET_DomainForwardsMetricsBrowser_Response = GET_DomainForwardsMetricsBrowser_Response_200 | GET_DomainForwardsMetricsBrowser_Response_422;
3760
+
3761
+ /**
3762
+ * 200 response for GET DomainForwardsMetricsBrowser endpoint
3763
+ *
3764
+ * @remarks
3765
+ * This type defines the response structure for the 200 status code
3766
+ * of the GET DomainForwardsMetricsBrowser endpoint.
3767
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3768
+ *
3769
+
3770
+ *
3771
+ * @path /v1/domain-forwards/metrics/browser
3772
+ * @param protocol (query) - Filter by protocol: http or https
3773
+ * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
3774
+ *
3775
+ * @see {@link GET_DomainForwardsMetricsBrowser_Response} - The main response type definition
3776
+ * @see {@link DomainForwardBrowserStats} - The actual schema type definition
3777
+ */
3778
+ export type GET_DomainForwardsMetricsBrowser_Response_200 = DomainForwardBrowserStats
3779
+
3780
+ /**
3781
+ * 422 response for GET DomainForwardsMetricsBrowser endpoint
3782
+ *
3783
+ * @remarks
3784
+ * This type defines the response structure for the 422 status code
3785
+ * of the GET DomainForwardsMetricsBrowser endpoint.
3786
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3787
+ *
3788
+
3789
+ *
3790
+ * @path /v1/domain-forwards/metrics/browser
3791
+ * @param protocol (query) - Filter by protocol: http or https
3792
+ * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
3793
+ *
3794
+ * @see {@link GET_DomainForwardsMetricsBrowser_Response} - The main response type definition
3795
+ * @see {@link HTTPValidationError} - The actual schema type definition
3796
+ */
3797
+ export type GET_DomainForwardsMetricsBrowser_Response_422 = HTTPValidationError
3798
+
3799
+ /**
3800
+ * Response types for GET DomainForwardsMetricsGeo endpoint
3801
+ *
3802
+ * Geo Stats
3803
+ *
3804
+ * @remarks
3805
+ * This type defines all possible response structures for the GET DomainForwardsMetricsGeo endpoint.
3806
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
3807
+ * Use this type to ensure type safety when handling API responses from this endpoint.
3808
+ *
3809
+
3810
+ *
3811
+ * @path /v1/domain-forwards/metrics/geo
3812
+ * @param protocol (query) - Filter by protocol: http or https
3813
+ * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
3814
+ *
3815
+ * @see {@link GET_DomainForwardsMetricsGeo_Response_200} - 200 response type
3816
+ * @see {@link GET_DomainForwardsMetricsGeo_Response_422} - 422 response type
3817
+ *
3818
+
3819
+ */
3820
+ export type GET_DomainForwardsMetricsGeo_Response = GET_DomainForwardsMetricsGeo_Response_200 | GET_DomainForwardsMetricsGeo_Response_422;
3821
+
3822
+ /**
3823
+ * 200 response for GET DomainForwardsMetricsGeo endpoint
3824
+ *
3825
+ * @remarks
3826
+ * This type defines the response structure for the 200 status code
3827
+ * of the GET DomainForwardsMetricsGeo endpoint.
3828
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3829
+ *
3830
+
3831
+ *
3832
+ * @path /v1/domain-forwards/metrics/geo
3833
+ * @param protocol (query) - Filter by protocol: http or https
3834
+ * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
3835
+ *
3836
+ * @see {@link GET_DomainForwardsMetricsGeo_Response} - The main response type definition
3837
+ * @see {@link DomainForwardGeoStats} - The actual schema type definition
3838
+ */
3839
+ export type GET_DomainForwardsMetricsGeo_Response_200 = DomainForwardGeoStats
3840
+
3841
+ /**
3842
+ * 422 response for GET DomainForwardsMetricsGeo endpoint
3843
+ *
3844
+ * @remarks
3845
+ * This type defines the response structure for the 422 status code
3846
+ * of the GET DomainForwardsMetricsGeo endpoint.
3847
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3848
+ *
3849
+
3850
+ *
3851
+ * @path /v1/domain-forwards/metrics/geo
3852
+ * @param protocol (query) - Filter by protocol: http or https
3853
+ * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
3854
+ *
3855
+ * @see {@link GET_DomainForwardsMetricsGeo_Response} - The main response type definition
3856
+ * @see {@link HTTPValidationError} - The actual schema type definition
3857
+ */
3858
+ export type GET_DomainForwardsMetricsGeo_Response_422 = HTTPValidationError
3859
+
3860
+ /**
3861
+ * Response types for GET DomainForwardsMetricsPlatform endpoint
3862
+ *
3863
+ * Platform Stats
3864
+ *
3865
+ * @remarks
3866
+ * This type defines all possible response structures for the GET DomainForwardsMetricsPlatform endpoint.
3867
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
3868
+ * Use this type to ensure type safety when handling API responses from this endpoint.
3869
+ *
3870
+
3871
+ *
3872
+ * @path /v1/domain-forwards/metrics/platform
3873
+ * @param protocol (query) - Filter by protocol: http or https
3874
+ * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
3875
+ *
3876
+ * @see {@link GET_DomainForwardsMetricsPlatform_Response_200} - 200 response type
3877
+ * @see {@link GET_DomainForwardsMetricsPlatform_Response_422} - 422 response type
3878
+ *
3879
+
3880
+ */
3881
+ export type GET_DomainForwardsMetricsPlatform_Response = GET_DomainForwardsMetricsPlatform_Response_200 | GET_DomainForwardsMetricsPlatform_Response_422;
3882
+
3883
+ /**
3884
+ * 200 response for GET DomainForwardsMetricsPlatform endpoint
3885
+ *
3886
+ * @remarks
3887
+ * This type defines the response structure for the 200 status code
3888
+ * of the GET DomainForwardsMetricsPlatform endpoint.
3889
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3890
+ *
3891
+
3892
+ *
3893
+ * @path /v1/domain-forwards/metrics/platform
3894
+ * @param protocol (query) - Filter by protocol: http or https
3895
+ * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
3896
+ *
3897
+ * @see {@link GET_DomainForwardsMetricsPlatform_Response} - The main response type definition
3898
+ * @see {@link DomainForwardPlatformStats} - The actual schema type definition
3899
+ */
3900
+ export type GET_DomainForwardsMetricsPlatform_Response_200 = DomainForwardPlatformStats
3901
+
3902
+ /**
3903
+ * 422 response for GET DomainForwardsMetricsPlatform endpoint
3904
+ *
3905
+ * @remarks
3906
+ * This type defines the response structure for the 422 status code
3907
+ * of the GET DomainForwardsMetricsPlatform endpoint.
3908
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3909
+ *
3910
+
3911
+ *
3912
+ * @path /v1/domain-forwards/metrics/platform
3913
+ * @param protocol (query) - Filter by protocol: http or https
3914
+ * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
3915
+ *
3916
+ * @see {@link GET_DomainForwardsMetricsPlatform_Response} - The main response type definition
3917
+ * @see {@link HTTPValidationError} - The actual schema type definition
3918
+ */
3919
+ export type GET_DomainForwardsMetricsPlatform_Response_422 = HTTPValidationError
3920
+
3921
+ /**
3922
+ * Response types for GET DomainForwardsMetricsReferrer endpoint
3923
+ *
3924
+ * Referrer Stats
3925
+ *
3926
+ * @remarks
3927
+ * This type defines all possible response structures for the GET DomainForwardsMetricsReferrer endpoint.
3928
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
3929
+ * Use this type to ensure type safety when handling API responses from this endpoint.
3930
+ *
3931
+
3932
+ *
3933
+ * @path /v1/domain-forwards/metrics/referrer
3934
+ * @param protocol (query) - Filter by protocol: http or https
3935
+ * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
3936
+ *
3937
+ * @see {@link GET_DomainForwardsMetricsReferrer_Response_200} - 200 response type
3938
+ * @see {@link GET_DomainForwardsMetricsReferrer_Response_422} - 422 response type
3939
+ *
3940
+
3941
+ */
3942
+ export type GET_DomainForwardsMetricsReferrer_Response = GET_DomainForwardsMetricsReferrer_Response_200 | GET_DomainForwardsMetricsReferrer_Response_422;
3943
+
3944
+ /**
3945
+ * 200 response for GET DomainForwardsMetricsReferrer endpoint
3946
+ *
3947
+ * @remarks
3948
+ * This type defines the response structure for the 200 status code
3949
+ * of the GET DomainForwardsMetricsReferrer endpoint.
3950
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3951
+ *
3952
+
3953
+ *
3954
+ * @path /v1/domain-forwards/metrics/referrer
3955
+ * @param protocol (query) - Filter by protocol: http or https
3956
+ * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
3957
+ *
3958
+ * @see {@link GET_DomainForwardsMetricsReferrer_Response} - The main response type definition
3959
+ * @see {@link DomainForwardReferrerStats} - The actual schema type definition
3960
+ */
3961
+ export type GET_DomainForwardsMetricsReferrer_Response_200 = DomainForwardReferrerStats
3962
+
3963
+ /**
3964
+ * 422 response for GET DomainForwardsMetricsReferrer endpoint
3965
+ *
3966
+ * @remarks
3967
+ * This type defines the response structure for the 422 status code
3968
+ * of the GET DomainForwardsMetricsReferrer endpoint.
3969
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3970
+ *
3971
+
3972
+ *
3973
+ * @path /v1/domain-forwards/metrics/referrer
3974
+ * @param protocol (query) - Filter by protocol: http or https
3975
+ * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
3976
+ *
3977
+ * @see {@link GET_DomainForwardsMetricsReferrer_Response} - The main response type definition
3978
+ * @see {@link HTTPValidationError} - The actual schema type definition
3979
+ */
3980
+ export type GET_DomainForwardsMetricsReferrer_Response_422 = HTTPValidationError
3981
+
3982
+ /**
3983
+ * Response types for GET DomainForwardsMetricsStatusCode endpoint
3984
+ *
3985
+ * Status Code Stats
3986
+ *
3987
+ * @remarks
3988
+ * This type defines all possible response structures for the GET DomainForwardsMetricsStatusCode endpoint.
3989
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
3990
+ * Use this type to ensure type safety when handling API responses from this endpoint.
3991
+ *
3992
+
3993
+ *
3994
+ * @path /v1/domain-forwards/metrics/status-code
3995
+ * @param protocol (query) - Filter by protocol: http or https
3996
+ * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
3997
+ *
3998
+ * @see {@link GET_DomainForwardsMetricsStatusCode_Response_200} - 200 response type
3999
+ * @see {@link GET_DomainForwardsMetricsStatusCode_Response_422} - 422 response type
4000
+ *
4001
+
4002
+ */
4003
+ export type GET_DomainForwardsMetricsStatusCode_Response = GET_DomainForwardsMetricsStatusCode_Response_200 | GET_DomainForwardsMetricsStatusCode_Response_422;
4004
+
4005
+ /**
4006
+ * 200 response for GET DomainForwardsMetricsStatusCode endpoint
4007
+ *
4008
+ * @remarks
4009
+ * This type defines the response structure for the 200 status code
4010
+ * of the GET DomainForwardsMetricsStatusCode endpoint.
4011
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4012
+ *
4013
+
4014
+ *
4015
+ * @path /v1/domain-forwards/metrics/status-code
4016
+ * @param protocol (query) - Filter by protocol: http or https
4017
+ * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
4018
+ *
4019
+ * @see {@link GET_DomainForwardsMetricsStatusCode_Response} - The main response type definition
4020
+ * @see {@link DomainForwardStatusCodeStats} - The actual schema type definition
4021
+ */
4022
+ export type GET_DomainForwardsMetricsStatusCode_Response_200 = DomainForwardStatusCodeStats
4023
+
4024
+ /**
4025
+ * 422 response for GET DomainForwardsMetricsStatusCode endpoint
4026
+ *
4027
+ * @remarks
4028
+ * This type defines the response structure for the 422 status code
4029
+ * of the GET DomainForwardsMetricsStatusCode endpoint.
4030
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4031
+ *
4032
+
4033
+ *
4034
+ * @path /v1/domain-forwards/metrics/status-code
4035
+ * @param protocol (query) - Filter by protocol: http or https
4036
+ * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
4037
+ *
4038
+ * @see {@link GET_DomainForwardsMetricsStatusCode_Response} - The main response type definition
4039
+ * @see {@link HTTPValidationError} - The actual schema type definition
4040
+ */
4041
+ export type GET_DomainForwardsMetricsStatusCode_Response_422 = HTTPValidationError
4042
+
4043
+ /**
4044
+ * Response types for GET DomainForwardsMetricsTimeSeries endpoint
4045
+ *
4046
+ * Time Series
4047
+ *
4048
+ * @remarks
4049
+ * This type defines all possible response structures for the GET DomainForwardsMetricsTimeSeries endpoint.
4050
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
4051
+ * Use this type to ensure type safety when handling API responses from this endpoint.
4052
+ *
4053
+
4054
+ *
4055
+ * @path /v1/domain-forwards/metrics/time-series
4056
+ * @param protocol (query) - Filter by protocol: http or https
4057
+ * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
4058
+ *
4059
+ * @see {@link GET_DomainForwardsMetricsTimeSeries_Response_200} - 200 response type
4060
+ * @see {@link GET_DomainForwardsMetricsTimeSeries_Response_422} - 422 response type
4061
+ *
4062
+
4063
+ */
4064
+ export type GET_DomainForwardsMetricsTimeSeries_Response = GET_DomainForwardsMetricsTimeSeries_Response_200 | GET_DomainForwardsMetricsTimeSeries_Response_422;
4065
+
4066
+ /**
4067
+ * 200 response for GET DomainForwardsMetricsTimeSeries endpoint
4068
+ *
4069
+ * @remarks
4070
+ * This type defines the response structure for the 200 status code
4071
+ * of the GET DomainForwardsMetricsTimeSeries endpoint.
4072
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4073
+ *
4074
+
4075
+ *
4076
+ * @path /v1/domain-forwards/metrics/time-series
4077
+ * @param protocol (query) - Filter by protocol: http or https
4078
+ * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
4079
+ *
4080
+ * @see {@link GET_DomainForwardsMetricsTimeSeries_Response} - The main response type definition
4081
+ * @see {@link DomainForwardMetricsTimeSeries} - The actual schema type definition
4082
+ */
4083
+ export type GET_DomainForwardsMetricsTimeSeries_Response_200 = DomainForwardMetricsTimeSeries
4084
+
4085
+ /**
4086
+ * 422 response for GET DomainForwardsMetricsTimeSeries endpoint
4087
+ *
4088
+ * @remarks
4089
+ * This type defines the response structure for the 422 status code
4090
+ * of the GET DomainForwardsMetricsTimeSeries endpoint.
4091
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4092
+ *
4093
+
4094
+ *
4095
+ * @path /v1/domain-forwards/metrics/time-series
4096
+ * @param protocol (query) - Filter by protocol: http or https
4097
+ * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
4098
+ *
4099
+ * @see {@link GET_DomainForwardsMetricsTimeSeries_Response} - The main response type definition
4100
+ * @see {@link HTTPValidationError} - The actual schema type definition
4101
+ */
4102
+ export type GET_DomainForwardsMetricsTimeSeries_Response_422 = HTTPValidationError
4103
+
4104
+ /**
4105
+ * Response types for GET DomainForwardsMetricsUserAgent endpoint
4106
+ *
4107
+ * User Agent Stats
4108
+ *
4109
+ * @remarks
4110
+ * This type defines all possible response structures for the GET DomainForwardsMetricsUserAgent endpoint.
4111
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
4112
+ * Use this type to ensure type safety when handling API responses from this endpoint.
4113
+ *
4114
+
4115
+ *
4116
+ * @path /v1/domain-forwards/metrics/user-agent
4117
+ * @param protocol (query) - Filter by protocol: http or https
4118
+ * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
4119
+ *
4120
+ * @see {@link GET_DomainForwardsMetricsUserAgent_Response_200} - 200 response type
4121
+ * @see {@link GET_DomainForwardsMetricsUserAgent_Response_422} - 422 response type
4122
+ *
4123
+
4124
+ */
4125
+ export type GET_DomainForwardsMetricsUserAgent_Response = GET_DomainForwardsMetricsUserAgent_Response_200 | GET_DomainForwardsMetricsUserAgent_Response_422;
4126
+
4127
+ /**
4128
+ * 200 response for GET DomainForwardsMetricsUserAgent endpoint
4129
+ *
4130
+ * @remarks
4131
+ * This type defines the response structure for the 200 status code
4132
+ * of the GET DomainForwardsMetricsUserAgent endpoint.
4133
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4134
+ *
4135
+
4136
+ *
4137
+ * @path /v1/domain-forwards/metrics/user-agent
4138
+ * @param protocol (query) - Filter by protocol: http or https
4139
+ * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
4140
+ *
4141
+ * @see {@link GET_DomainForwardsMetricsUserAgent_Response} - The main response type definition
4142
+ * @see {@link DomainForwardUserAgentStats} - The actual schema type definition
4143
+ */
4144
+ export type GET_DomainForwardsMetricsUserAgent_Response_200 = DomainForwardUserAgentStats
4145
+
4146
+ /**
4147
+ * 422 response for GET DomainForwardsMetricsUserAgent endpoint
4148
+ *
4149
+ * @remarks
4150
+ * This type defines the response structure for the 422 status code
4151
+ * of the GET DomainForwardsMetricsUserAgent endpoint.
4152
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4153
+ *
4154
+
4155
+ *
4156
+ * @path /v1/domain-forwards/metrics/user-agent
4157
+ * @param protocol (query) - Filter by protocol: http or https
4158
+ * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
4159
+ *
4160
+ * @see {@link GET_DomainForwardsMetricsUserAgent_Response} - The main response type definition
4161
+ * @see {@link HTTPValidationError} - The actual schema type definition
4162
+ */
4163
+ export type GET_DomainForwardsMetricsUserAgent_Response_422 = HTTPValidationError
4164
+
4165
+ /**
4166
+ * Response types for GET DomainForwardsMetricsVisitsByKey endpoint
4167
+ *
4168
+ * Visits By Key
4169
+ *
4170
+ * @remarks
4171
+ * This type defines all possible response structures for the GET DomainForwardsMetricsVisitsByKey endpoint.
4172
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
4173
+ * Use this type to ensure type safety when handling API responses from this endpoint.
4174
+ *
4175
+
4176
+ *
4177
+ * @path /v1/domain-forwards/metrics/visits-by-key
4178
+ * @param grouping (query) - Grouping key: url, fqdn, domain, or forward
4179
+ * @param protocol (query) - Filter by protocol: http or https
4180
+ * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
4181
+ *
4182
+ * @see {@link GET_DomainForwardsMetricsVisitsByKey_Response_200} - 200 response type
4183
+ * @see {@link GET_DomainForwardsMetricsVisitsByKey_Response_422} - 422 response type
4184
+ *
4185
+
4186
+ */
4187
+ export type GET_DomainForwardsMetricsVisitsByKey_Response = GET_DomainForwardsMetricsVisitsByKey_Response_200 | GET_DomainForwardsMetricsVisitsByKey_Response_422;
4188
+
4189
+ /**
4190
+ * 200 response for GET DomainForwardsMetricsVisitsByKey endpoint
4191
+ *
4192
+ * @remarks
4193
+ * This type defines the response structure for the 200 status code
4194
+ * of the GET DomainForwardsMetricsVisitsByKey endpoint.
4195
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4196
+ *
4197
+
4198
+ *
4199
+ * @path /v1/domain-forwards/metrics/visits-by-key
4200
+ * @param grouping (query) - Grouping key: url, fqdn, domain, or forward
4201
+ * @param protocol (query) - Filter by protocol: http or https
4202
+ * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
4203
+ *
4204
+ * @see {@link GET_DomainForwardsMetricsVisitsByKey_Response} - The main response type definition
4205
+ * @see {@link DomainForwardVisitsByKey} - The actual schema type definition
4206
+ */
4207
+ export type GET_DomainForwardsMetricsVisitsByKey_Response_200 = DomainForwardVisitsByKey
4208
+
4209
+ /**
4210
+ * 422 response for GET DomainForwardsMetricsVisitsByKey endpoint
4211
+ *
4212
+ * @remarks
4213
+ * This type defines the response structure for the 422 status code
4214
+ * of the GET DomainForwardsMetricsVisitsByKey endpoint.
4215
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4216
+ *
4217
+
4218
+ *
4219
+ * @path /v1/domain-forwards/metrics/visits-by-key
4220
+ * @param grouping (query) - Grouping key: url, fqdn, domain, or forward
4221
+ * @param protocol (query) - Filter by protocol: http or https
4222
+ * @param time_range (query) - Time range: 1h, 1d, 7d, or 30d
4223
+ *
4224
+ * @see {@link GET_DomainForwardsMetricsVisitsByKey_Response} - The main response type definition
4225
+ * @see {@link HTTPValidationError} - The actual schema type definition
4226
+ */
4227
+ export type GET_DomainForwardsMetricsVisitsByKey_Response_422 = HTTPValidationError
4228
+
3677
4229
  /**
3678
4230
  * Response types for GET DomainSearchSuggest endpoint
3679
4231
  *