@opusdns/api 0.140.0 → 0.142.0

package/src/helpers/schemas-arrays.d.ts

@@ -21,7 +21,7 @@
  * This file is auto-generated from the OpenAPI specification.
  * Do not edit manually.
  */
-import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, RegistryHandleAttributeType, ContactAttributeDefinition, ContactRoleAttributeRequirement, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, DomainForwardPatchOp, HttpRedirectList, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, DomainContactType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, ObjectLog, Organization, RequestHistory, UserPublic, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
+import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, RegistryHandleAttributeType, ContactAttributeDefinition, ContactRoleAttributeRequirement, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, BrowserStatsBucket, GeoStatsBucket, TimeSeriesBucket, DomainForwardPatchOp, PlatformStatsBucket, HttpRedirectList, ReferrerStatsBucket, StatusCodeStatsBucket, UserAgentStatsBucket, VisitsByKeyBucket, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, DomainContactType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, ObjectLog, Organization, RequestHistory, UserPublic, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
 
 /**
  * DomainDnssecDataResponse
@@ -317,6 +317,48 @@ export type ContactHandleArray = ContactHandle[];
  * @see {@link Nameserver} - The individual Nameserver type definition
  */
 export type NameserverArray = Nameserver[];
+/**
+ * BrowserStatsBucket
+ *
+ * @remarks
+ * Array type for BrowserStatsBucket objects. Used when the API returns a collection of BrowserStatsBucket instances.
+ *
+ * @example
+ * ```typescript
+ * const items: BrowserStatsBucketArray = await api.getBrowserStatsBuckets();
+ * ```
+ *
+ * @see {@link BrowserStatsBucket} - The individual BrowserStatsBucket type definition
+ */
+export type BrowserStatsBucketArray = BrowserStatsBucket[];
+/**
+ * GeoStatsBucket
+ *
+ * @remarks
+ * Array type for GeoStatsBucket objects. Used when the API returns a collection of GeoStatsBucket instances.
+ *
+ * @example
+ * ```typescript
+ * const items: GeoStatsBucketArray = await api.getGeoStatsBuckets();
+ * ```
+ *
+ * @see {@link GeoStatsBucket} - The individual GeoStatsBucket type definition
+ */
+export type GeoStatsBucketArray = GeoStatsBucket[];
+/**
+ * TimeSeriesBucket
+ *
+ * @remarks
+ * Array type for TimeSeriesBucket objects. Used when the API returns a collection of TimeSeriesBucket instances.
+ *
+ * @example
+ * ```typescript
+ * const items: TimeSeriesBucketArray = await api.getTimeSeriesBuckets();
+ * ```
+ *
+ * @see {@link TimeSeriesBucket} - The individual TimeSeriesBucket type definition
+ */
+export type TimeSeriesBucketArray = TimeSeriesBucket[];
 /**
  * DomainForwardPatchOp
  *
@@ -331,6 +373,20 @@ export type NameserverArray = Nameserver[];
  * @see {@link DomainForwardPatchOp} - The individual DomainForwardPatchOp type definition
  */
 export type DomainForwardPatchOpArray = DomainForwardPatchOp[];
+/**
+ * PlatformStatsBucket
+ *
+ * @remarks
+ * Array type for PlatformStatsBucket objects. Used when the API returns a collection of PlatformStatsBucket instances.
+ *
+ * @example
+ * ```typescript
+ * const items: PlatformStatsBucketArray = await api.getPlatformStatsBuckets();
+ * ```
+ *
+ * @see {@link PlatformStatsBucket} - The individual PlatformStatsBucket type definition
+ */
+export type PlatformStatsBucketArray = PlatformStatsBucket[];
 /**
  * HttpRedirectListResponse
  *
@@ -345,6 +401,62 @@ export type DomainForwardPatchOpArray = DomainForwardPatchOp[];
  * @see {@link HttpRedirectList} - The individual HttpRedirectListResponse type definition
  */
 export type HttpRedirectListArray = HttpRedirectList[];
+/**
+ * ReferrerStatsBucket
+ *
+ * @remarks
+ * Array type for ReferrerStatsBucket objects. Used when the API returns a collection of ReferrerStatsBucket instances.
+ *
+ * @example
+ * ```typescript
+ * const items: ReferrerStatsBucketArray = await api.getReferrerStatsBuckets();
+ * ```
+ *
+ * @see {@link ReferrerStatsBucket} - The individual ReferrerStatsBucket type definition
+ */
+export type ReferrerStatsBucketArray = ReferrerStatsBucket[];
+/**
+ * StatusCodeStatsBucket
+ *
+ * @remarks
+ * Array type for StatusCodeStatsBucket objects. Used when the API returns a collection of StatusCodeStatsBucket instances.
+ *
+ * @example
+ * ```typescript
+ * const items: StatusCodeStatsBucketArray = await api.getStatusCodeStatsBuckets();
+ * ```
+ *
+ * @see {@link StatusCodeStatsBucket} - The individual StatusCodeStatsBucket type definition
+ */
+export type StatusCodeStatsBucketArray = StatusCodeStatsBucket[];
+/**
+ * UserAgentStatsBucket
+ *
+ * @remarks
+ * Array type for UserAgentStatsBucket objects. Used when the API returns a collection of UserAgentStatsBucket instances.
+ *
+ * @example
+ * ```typescript
+ * const items: UserAgentStatsBucketArray = await api.getUserAgentStatsBuckets();
+ * ```
+ *
+ * @see {@link UserAgentStatsBucket} - The individual UserAgentStatsBucket type definition
+ */
+export type UserAgentStatsBucketArray = UserAgentStatsBucket[];
+/**
+ * VisitsByKeyBucket
+ *
+ * @remarks
+ * Array type for VisitsByKeyBucket objects. Used when the API returns a collection of VisitsByKeyBucket instances.
+ *
+ * @example
+ * ```typescript
+ * const items: VisitsByKeyBucketArray = await api.getVisitsByKeyBuckets();
+ * ```
+ *
+ * @see {@link VisitsByKeyBucket} - The individual VisitsByKeyBucket type definition
+ */
+export type VisitsByKeyBucketArray = VisitsByKeyBucket[];
 /**
  * DomainForward
  *

package/src/helpers/schemas.d.ts

@@ -186,6 +186,22 @@ export type BillingTransactionSortField = components['schemas']['BillingTransact
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type BillingTransactionStatus = components['schemas']['BillingTransactionStatus'];
+/**
+ * BrowserStatsBucket
+ *
+ * @remarks
+ * Type alias for the `BrowserStatsBucket` OpenAPI schema.
+ * This type represents browserstatsbucket data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getBrowserStatsBucket();
+ * const item: BrowserStatsBucket = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type BrowserStatsBucket = components['schemas']['BrowserStatsBucket'];
 /**
  * ContactAttributeDefinition. Definition of a possible attribute for a TLD.
  *
@@ -1034,6 +1050,22 @@ export type DomainDnssecData = components['schemas']['DomainDnssecDataResponse']
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type DomainForward = components['schemas']['DomainForward'];
+/**
+ * DomainForwardBrowserStatsResponse
+ *
+ * @remarks
+ * Type alias for the `DomainForwardBrowserStatsResponse` OpenAPI schema.
+ * This type represents domainforwardbrowserstatsresponse data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getDomainForwardBrowserStats();
+ * const item: DomainForwardBrowserStats = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type DomainForwardBrowserStats = components['schemas']['DomainForwardBrowserStatsResponse'];
 /**
  * DomainForwardCreateRequest
  *
@@ -1050,6 +1082,54 @@ export type DomainForward = components['schemas']['DomainForward'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type DomainForwardCreateRequest = components['schemas']['DomainForwardCreateRequest'];
+/**
+ * DomainForwardGeoStatsResponse
+ *
+ * @remarks
+ * Type alias for the `DomainForwardGeoStatsResponse` OpenAPI schema.
+ * This type represents domainforwardgeostatsresponse data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getDomainForwardGeoStats();
+ * const item: DomainForwardGeoStats = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type DomainForwardGeoStats = components['schemas']['DomainForwardGeoStatsResponse'];
+/**
+ * DomainForwardMetricsResponse
+ *
+ * @remarks
+ * Type alias for the `DomainForwardMetricsResponse` OpenAPI schema.
+ * This type represents domainforwardmetricsresponse data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getDomainForwardMetrics();
+ * const item: DomainForwardMetrics = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type DomainForwardMetrics = components['schemas']['DomainForwardMetricsResponse'];
+/**
+ * DomainForwardMetricsTimeSeriesResponse
+ *
+ * @remarks
+ * Type alias for the `DomainForwardMetricsTimeSeriesResponse` OpenAPI schema.
+ * This type represents domainforwardmetricstimeseriesresponse data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getDomainForwardMetricsTimeSeries();
+ * const item: DomainForwardMetricsTimeSeries = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type DomainForwardMetricsTimeSeries = components['schemas']['DomainForwardMetricsTimeSeriesResponse'];
 /**
  * DomainForwardPatchOp
  *
@@ -1082,6 +1162,22 @@ export type DomainForwardPatchOp = components['schemas']['DomainForwardPatchOp']
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type DomainForwardPatchOps = components['schemas']['DomainForwardPatchOps'];
+/**
+ * DomainForwardPlatformStatsResponse
+ *
+ * @remarks
+ * Type alias for the `DomainForwardPlatformStatsResponse` OpenAPI schema.
+ * This type represents domainforwardplatformstatsresponse data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getDomainForwardPlatformStats();
+ * const item: DomainForwardPlatformStats = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type DomainForwardPlatformStats = components['schemas']['DomainForwardPlatformStatsResponse'];
 /**
  * DomainForwardProtocolSetRequest
  *
@@ -1114,6 +1210,22 @@ export type DomainForwardProtocolSetRequest = components['schemas']['DomainForwa
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type DomainForwardProtocolSet = components['schemas']['DomainForwardProtocolSetResponse'];
+/**
+ * DomainForwardReferrerStatsResponse
+ *
+ * @remarks
+ * Type alias for the `DomainForwardReferrerStatsResponse` OpenAPI schema.
+ * This type represents domainforwardreferrerstatsresponse data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getDomainForwardReferrerStats();
+ * const item: DomainForwardReferrerStats = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type DomainForwardReferrerStats = components['schemas']['DomainForwardReferrerStatsResponse'];
 /**
  * DomainForwardSetCreateRequest
  *
@@ -1178,6 +1290,54 @@ export type DomainForwardSet = components['schemas']['DomainForwardSetResponse']
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type DomainForwardSortField = components['schemas']['DomainForwardSortField'];
+/**
+ * DomainForwardStatusCodeStatsResponse
+ *
+ * @remarks
+ * Type alias for the `DomainForwardStatusCodeStatsResponse` OpenAPI schema.
+ * This type represents domainforwardstatuscodestatsresponse data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getDomainForwardStatusCodeStats();
+ * const item: DomainForwardStatusCodeStats = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type DomainForwardStatusCodeStats = components['schemas']['DomainForwardStatusCodeStatsResponse'];
+/**
+ * DomainForwardUserAgentStatsResponse
+ *
+ * @remarks
+ * Type alias for the `DomainForwardUserAgentStatsResponse` OpenAPI schema.
+ * This type represents domainforwarduseragentstatsresponse data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getDomainForwardUserAgentStats();
+ * const item: DomainForwardUserAgentStats = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type DomainForwardUserAgentStats = components['schemas']['DomainForwardUserAgentStatsResponse'];
+/**
+ * DomainForwardVisitsByKeyResponse
+ *
+ * @remarks
+ * Type alias for the `DomainForwardVisitsByKeyResponse` OpenAPI schema.
+ * This type represents domainforwardvisitsbykeyresponse data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getDomainForwardVisitsByKey();
+ * const item: DomainForwardVisitsByKey = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type DomainForwardVisitsByKey = components['schemas']['DomainForwardVisitsByKeyResponse'];
 /**
  * DomainForwardZone
  *
@@ -1962,6 +2122,22 @@ export type EventType = components['schemas']['EventType'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type GeneralAvailabilityBase = components['schemas']['GeneralAvailabilityBase'];
+/**
+ * GeoStatsBucket
+ *
+ * @remarks
+ * Type alias for the `GeoStatsBucket` OpenAPI schema.
+ * This type represents geostatsbucket data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getGeoStatsBucket();
+ * const item: GeoStatsBucket = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type GeoStatsBucket = components['schemas']['GeoStatsBucket'];
 /**
  * GetPricesResponse
  *
@@ -2351,6 +2527,22 @@ export type LocalPresenceBase = components['schemas']['LocalPresenceBase'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type LocalPresenceRequirementType = components['schemas']['LocalPresenceRequirementType'];
+/**
+ * MetricsGrouping
+ *
+ * @remarks
+ * Type alias for the `MetricsGrouping` OpenAPI schema.
+ * This type represents metricsgrouping data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getMetricsGrouping();
+ * const item: MetricsGrouping = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type MetricsGrouping = components['schemas']['MetricsGrouping'];
 /**
  * Nameserver
  *
@@ -2943,6 +3135,22 @@ export type Permission = components['schemas']['Permission'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type PermissionSet = components['schemas']['PermissionSet'];
+/**
+ * PlatformStatsBucket
+ *
+ * @remarks
+ * Type alias for the `PlatformStatsBucket` OpenAPI schema.
+ * This type represents platformstatsbucket data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getPlatformStatsBucket();
+ * const item: PlatformStatsBucket = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type PlatformStatsBucket = components['schemas']['PlatformStatsBucket'];
 /**
  * PostTransferRequirements
  *
@@ -3071,6 +3279,22 @@ export type PricingPeriod = components['schemas']['PricingPeriod'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type Problem = components['schemas']['Problem'];
+/**
+ * Protocol
+ *
+ * @remarks
+ * Type alias for the `Protocol` OpenAPI schema.
+ * This type represents protocol data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getProtocol();
+ * const item: Protocol = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type Protocol = components['schemas']['Protocol'];
 /**
  * PublicAuthRequestForm
  *
@@ -3119,6 +3343,22 @@ export type RdapBase = components['schemas']['RdapBase'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type RedirectCode = components['schemas']['RedirectCode'];
+/**
+ * ReferrerStatsBucket
+ *
+ * @remarks
+ * Type alias for the `ReferrerStatsBucket` OpenAPI schema.
+ * This type represents referrerstatsbucket data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getReferrerStatsBucket();
+ * const item: ReferrerStatsBucket = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type ReferrerStatsBucket = components['schemas']['ReferrerStatsBucket'];
 /**
  * RegistrantChangeType
  *
@@ -3359,6 +3599,22 @@ export type SortOrder = components['schemas']['SortOrder'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type SpiceDbRelationshipUpdate = components['schemas']['SpiceDbRelationshipUpdate'];
+/**
+ * StatusCodeStatsBucket
+ *
+ * @remarks
+ * Type alias for the `StatusCodeStatsBucket` OpenAPI schema.
+ * This type represents statuscodestatsbucket data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getStatusCodeStatsBucket();
+ * const item: StatusCodeStatsBucket = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type StatusCodeStatsBucket = components['schemas']['StatusCodeStatsBucket'];
 /**
  * SyncOperationType
  *
@@ -3391,6 +3647,38 @@ export type SyncOperationType = components['schemas']['SyncOperationType'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type TLDType = components['schemas']['TLDType'];
+/**
+ * TimeRange
+ *
+ * @remarks
+ * Type alias for the `TimeRange` OpenAPI schema.
+ * This type represents timerange data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getTimeRange();
+ * const item: TimeRange = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type TimeRange = components['schemas']['TimeRange'];
+/**
+ * TimeSeriesBucket
+ *
+ * @remarks
+ * Type alias for the `TimeSeriesBucket` OpenAPI schema.
+ * This type represents timeseriesbucket data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getTimeSeriesBucket();
+ * const item: TimeSeriesBucket = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type TimeSeriesBucket = components['schemas']['TimeSeriesBucket'];
 /**
  * TldBase
  *
@@ -3535,6 +3823,22 @@ export type TransferPoliciesBase = components['schemas']['TransferPoliciesBase']
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type User = components['schemas']['User'];
+/**
+ * UserAgentStatsBucket
+ *
+ * @remarks
+ * Type alias for the `UserAgentStatsBucket` OpenAPI schema.
+ * This type represents useragentstatsbucket data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getUserAgentStatsBucket();
+ * const item: UserAgentStatsBucket = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type UserAgentStatsBucket = components['schemas']['UserAgentStatsBucket'];
 /**
  * UserAttributeBase
  *
@@ -3711,6 +4015,22 @@ export type ValidationError = components['schemas']['ValidationError'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type VerificationType = components['schemas']['VerificationType'];
+/**
+ * VisitsByKeyBucket
+ *
+ * @remarks
+ * Type alias for the `VisitsByKeyBucket` OpenAPI schema.
+ * This type represents visitsbykeybucket data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getVisitsByKeyBucket();
+ * const item: VisitsByKeyBucket = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type VisitsByKeyBucket = components['schemas']['VisitsByKeyBucket'];
 /**
  * WhoisBase
  *