@opusdns/api 0.167.0 → 0.169.0

package/src/helpers/responses.d.ts

@@ -34,7 +34,7 @@
 
 import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
 
-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, EmailForwardMetrics, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_UserPublic, Pagination_Parking, ParkingMetrics, TldSpecification, UserPublic, UserPublicWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
+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, EmailForwardMetrics, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_UserPublic, ParkingMetrics, ParkingTotalMetrics, TldSpecification, UserPublic, UserPublicWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
 
 /**
  * Response types for GET ArchiveEmailForwardLogsAliasesByEmailForwardAliasId endpoint
@@ -8866,32 +8866,16 @@ export type GET_OrganizationsUsers_Response_422 = HTTPValidationError
 
  *
  * @path /v1/parking
+ * @param page (query) - Page number
+ * @param page_size (query) - Page size
  *
- * @see {@link GET_Parking_Response_200} - 200 response type
  * @see {@link GET_Parking_Response_401} - 401 response type
  * @see {@link GET_Parking_Response_403} - 403 response type
  * @see {@link GET_Parking_Response_422} - 422 response type
  *
 
  */
-export type GET_Parking_Response = GET_Parking_Response_200 | GET_Parking_Response_401 | GET_Parking_Response_403 | GET_Parking_Response_422;
-
-/**
- * 200 response for GET Parking endpoint
- *
- * @remarks
- * This type defines the response structure for the 200 status code
- * of the GET Parking endpoint.
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
- *
-
- *
- * @path /v1/parking
- *
- * @see {@link GET_Parking_Response} - The main response type definition
- * @see {@link Pagination_Parking} - The actual schema type definition
- */
-export type GET_Parking_Response_200 = Pagination_Parking
+export type GET_Parking_Response = GET_Parking_Response_401 | GET_Parking_Response_403 | GET_Parking_Response_422;
 
 /**
  * 401 response for GET Parking endpoint
@@ -8904,6 +8888,8 @@ export type GET_Parking_Response_200 = Pagination_Parking
 
  *
  * @path /v1/parking
+ * @param page (query) - Page number
+ * @param page_size (query) - Page size
  *
  * @see {@link GET_Parking_Response} - The main response type definition
  * @see {@link Problem} - The actual schema type definition
@@ -8921,6 +8907,8 @@ export type GET_Parking_Response_401 = Problem
 
  *
  * @path /v1/parking
+ * @param page (query) - Page number
+ * @param page_size (query) - Page size
  *
  * @see {@link GET_Parking_Response} - The main response type definition
  * @see {@link Problem} - The actual schema type definition
@@ -8938,6 +8926,8 @@ export type GET_Parking_Response_403 = Problem
 
  *
  * @path /v1/parking
+ * @param page (query) - Page number
+ * @param page_size (query) - Page size
  *
  * @see {@link GET_Parking_Response} - The main response type definition
  * @see {@link HTTPValidationError} - The actual schema type definition
@@ -8948,7 +8938,7 @@ export type GET_Parking_Response_422 = HTTPValidationError
  * Response types for GET ParkingByParkingIdMetrics endpoint
  *
  * Get metrics for a parking entry
- * Retrieves metrics for a specific parking entry by ID
+ * Retrieves metrics for a specific parking entry by ID.
  *
  * @remarks
  * This type defines all possible response structures for the GET ParkingByParkingIdMetrics endpoint.
@@ -9054,6 +9044,98 @@ export type GET_ParkingByParkingIdMetrics_Response_404 = Problem
  */
 export type GET_ParkingByParkingIdMetrics_Response_422 = HTTPValidationError
 
+/**
+ * Response types for GET ParkingMetrics endpoint
+ *
+ * Get total metrics for all parking entries
+ * Retrieves aggregated metrics for all parking entries of the organization.
+ *
+ * @remarks
+ * This type defines all possible response structures for the GET ParkingMetrics endpoint.
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
+ * Use this type to ensure type safety when handling API responses from this endpoint.
+ *
+
+ *
+ * @path /v1/parking/metrics
+ *
+ * @see {@link GET_ParkingMetrics_Response_200} - 200 response type
+ * @see {@link GET_ParkingMetrics_Response_401} - 401 response type
+ * @see {@link GET_ParkingMetrics_Response_403} - 403 response type
+ * @see {@link GET_ParkingMetrics_Response_422} - 422 response type
+ *
+
+ */
+export type GET_ParkingMetrics_Response = GET_ParkingMetrics_Response_200 | GET_ParkingMetrics_Response_401 | GET_ParkingMetrics_Response_403 | GET_ParkingMetrics_Response_422;
+
+/**
+ * 200 response for GET ParkingMetrics endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 200 status code
+ * of the GET ParkingMetrics endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/parking/metrics
+ *
+ * @see {@link GET_ParkingMetrics_Response} - The main response type definition
+ * @see {@link ParkingTotalMetrics} - The actual schema type definition
+ */
+export type GET_ParkingMetrics_Response_200 = ParkingTotalMetrics
+
+/**
+ * 401 response for GET ParkingMetrics endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 401 status code
+ * of the GET ParkingMetrics endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/parking/metrics
+ *
+ * @see {@link GET_ParkingMetrics_Response} - The main response type definition
+ * @see {@link Problem} - The actual schema type definition
+ */
+export type GET_ParkingMetrics_Response_401 = Problem
+
+/**
+ * 403 response for GET ParkingMetrics endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 403 status code
+ * of the GET ParkingMetrics endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/parking/metrics
+ *
+ * @see {@link GET_ParkingMetrics_Response} - The main response type definition
+ * @see {@link Problem} - The actual schema type definition
+ */
+export type GET_ParkingMetrics_Response_403 = Problem
+
+/**
+ * 422 response for GET ParkingMetrics endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 status code
+ * of the GET ParkingMetrics endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/parking/metrics
+ *
+ * @see {@link GET_ParkingMetrics_Response} - The main response type definition
+ * @see {@link HTTPValidationError} - The actual schema type definition
+ */
+export type GET_ParkingMetrics_Response_422 = HTTPValidationError
+
 /**
  * Response types for GET Tlds endpoint
  *

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, BrowserStatsBucket, GeoStatsBucket, TimeSeriesBucket, DomainForwardPatchOp, PlatformStatsBucket, HttpRedirectList, ReferrerStatsBucket, StatusCodeStatsBucket, UserAgentStatsBucket, VisitsByKeyBucket, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainHost, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAliasMetrics, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, DomainContactType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, ObjectLog, Organization, Parking, 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, EmailForwardAliasMetrics, 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
@@ -919,20 +919,6 @@ export type ObjectLogArray = ObjectLog[];
  * @see {@link Organization} - The individual Organization type definition
  */
 export type OrganizationArray = Organization[];
-/**
- * ParkingResponse
- *
- * @remarks
- * Array type for ParkingResponse objects. Used when the API returns a collection of ParkingResponse instances.
- *
- * @example
- * ```typescript
- * const items: ParkingArray = await api.getParkings();
- * ```
- *
- * @see {@link Parking} - The individual ParkingResponse type definition
- */
-export type ParkingArray = Parking[];
 /**
  * RequestHistory
  *

package/src/helpers/schemas.d.ts

@@ -3087,22 +3087,6 @@ export type Pagination_ObjectLog = components['schemas']['Pagination_ObjectLog_'
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type Pagination_Organization = components['schemas']['Pagination_Organization_'];
-/**
- * Pagination[ParkingResponse]
- *
- * @remarks
- * Type alias for the `Pagination_ParkingResponse_` OpenAPI schema.
- * This type represents pagination[parkingresponse] data structures used in API requests and responses.
- *
- * @example
- * ```typescript
- * const response = await api.getPagination_Parking();
- * const item: Pagination_Parking = response.results;
- * ```
- *
- * @see {@link components} - The OpenAPI components schema definition
- */
-export type Pagination_Parking = components['schemas']['Pagination_ParkingResponse_'];
 /**
  * Pagination[RequestHistory]
  *
@@ -3151,22 +3135,6 @@ export type Pagination_UserPublic = components['schemas']['Pagination_UserPublic
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type ParkingMetrics = components['schemas']['ParkingMetricsResponse'];
-/**
- * ParkingResponse
- *
- * @remarks
- * Type alias for the `ParkingResponse` OpenAPI schema.
- * This type represents parkingresponse data structures used in API requests and responses.
- *
- * @example
- * ```typescript
- * const response = await api.getParking();
- * const item: Parking = response.results;
- * ```
- *
- * @see {@link components} - The OpenAPI components schema definition
- */
-export type Parking = components['schemas']['ParkingResponse'];
 /**
  * ParkingSortField
  *
@@ -3199,6 +3167,22 @@ export type ParkingSortField = components['schemas']['ParkingSortField'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type ParkingStatistics = components['schemas']['ParkingStatistics'];
+/**
+ * ParkingTotalMetricsResponse
+ *
+ * @remarks
+ * Type alias for the `ParkingTotalMetricsResponse` OpenAPI schema.
+ * This type represents parkingtotalmetricsresponse data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getParkingTotalMetrics();
+ * const item: ParkingTotalMetrics = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type ParkingTotalMetrics = components['schemas']['ParkingTotalMetricsResponse'];
 /**
  * PasswordUpdate
  *

package/src/openapi.yaml

@@ -4869,20 +4869,6 @@ components:
       - pagination
       title: Pagination[Organization]
       type: object
-    Pagination_ParkingResponse_:
-      properties:
-        pagination:
-          $ref: '#/components/schemas/PaginationMetadata'
-        results:
-          items:
-            $ref: '#/components/schemas/ParkingResponse'
-          title: Results
-          type: array
-      required:
-      - results
-      - pagination
-      title: Pagination[ParkingResponse]
-      type: object
     Pagination_RequestHistory_:
       properties:
         pagination:
@@ -4913,82 +4899,24 @@ components:
       type: object
     ParkingMetricsResponse:
       properties:
-        parking_id:
-          description: Unique identifier for the parking entry
-          examples:
-          - parking_01h45ytscbebyvny4gc8cr8ma2
-          format: typeid
-          pattern: ^parking_[0-7][0-9a-hjkmnpq-tv-z]{25}$
-          title: Parking Id
-          type: string
-          x-typeid-prefix: parking
-        statistics:
+        metrics:
           $ref: '#/components/schemas/ParkingStatistics'
-          description: Statistics for the parking entry
-      required:
-      - parking_id
-      - statistics
-      title: ParkingMetricsResponse
-      type: object
-    ParkingResponse:
-      properties:
-        compliance_status:
-          anyOf:
-          - $ref: '#/components/schemas/ComplianceStatus'
-          - type: 'null'
-          description: The compliance status of the parking ad
-        content_language:
-          anyOf:
-          - type: string
-          - type: 'null'
-          description: The primary language code for the ad content
-          title: Content Language
-        content_url:
-          anyOf:
-          - type: string
-          - type: 'null'
-          description: The content URL for approved parking ads
-          title: Content Url
-        created_on:
-          description: When the parking entry was created
-          format: date-time
-          title: Created On
-          type: string
-        domain:
-          description: The domain name for the parking ad
-          title: Domain
-          type: string
-        enabled:
-          description: Whether parking is enabled
-          title: Enabled
-          type: boolean
-        note:
-          anyOf:
-          - type: string
-          - type: 'null'
-          description: Additional notes about the parking ad
-          title: Note
-        parking_id:
-          description: Unique identifier for the parking entry
-          examples:
-          - parking_01h45ytscbebyvny4gc8cr8ma2
-          format: typeid
-          pattern: ^parking_[0-7][0-9a-hjkmnpq-tv-z]{25}$
-          title: Parking Id
+          description: Metrics for the parking entry
+        renewal_cost:
+          description: Yearly renewal cost for the parked domain
+          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
+          title: Renewal Cost
           type: string
-          x-typeid-prefix: parking
-        updated_on:
-          description: When the parking entry was last updated
-          format: date-time
-          title: Updated On
+        revenue_progress:
+          description: Revenue progress percentage towards covering renewal cost
+          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
+          title: Revenue Progress
           type: string
       required:
-      - parking_id
-      - domain
-      - enabled
-      - created_on
-      - updated_on
-      title: ParkingResponse
+      - metrics
+      - renewal_cost
+      - revenue_progress
+      title: ParkingMetricsResponse
       type: object
     ParkingSortField:
       enum:
@@ -5003,11 +4931,6 @@ components:
           description: Number of conversions
           title: Conversions
           type: integer
-        profit:
-          description: Total profit
-          pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
-          title: Profit
-          type: string
         revenue:
           description: Total revenue
           pattern: ^(?!^[-+.]*$)[+-]?0*\d*\.?\d*$
@@ -5033,9 +4956,22 @@ components:
       - rpc
       - rpm
       - revenue
-      - profit
       title: ParkingStatistics
       type: object
+    ParkingTotalMetricsResponse:
+      properties:
+        total_count:
+          description: Total number of parking entries
+          title: Total Count
+          type: integer
+        total_metrics:
+          $ref: '#/components/schemas/ParkingStatistics'
+          description: Aggregated metrics for all parking entries
+      required:
+      - total_count
+      - total_metrics
+      title: ParkingTotalMetricsResponse
+      type: object
     PasswordUpdate:
       properties:
         new_password:
@@ -6824,7 +6760,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-01-22-170829
+  version: 2026-01-25-132304
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -14735,6 +14671,27 @@ paths:
       description: Retrieves a paginated list of parking entries for the organization
       operationId: list_parking_v1_parking_get
       parameters:
+      - description: Page number
+        in: query
+        name: page
+        required: false
+        schema:
+          default: 1
+          description: Page number
+          minimum: 1
+          title: Page
+          type: integer
+      - description: Page size
+        in: query
+        name: page_size
+        required: false
+        schema:
+          default: 10
+          description: Page size
+          maximum: 1000
+          minimum: 1
+          title: Page Size
+          type: integer
       - in: query
         name: sort_by
         required: false
@@ -14771,29 +14728,80 @@ paths:
           - $ref: '#/components/schemas/ComplianceStatus'
           - type: 'null'
           title: Compliance Status
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                additionalProperties: true
+                title: Response List Parking V1 Parking Get
+                type: object
+          description: Successful Response
+        '401':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_AUTHENTICATION
+                detail: Additional error context.
+                status: 401
+                title: Authentication Error
+                type: authentication
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Unauthorized
+        '403':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_PERMISSION_DENIED
+                detail: Insufficient permissions to perform this action
+                status: 403
+                title: Permission Denied
+                type: permission-denied
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Forbidden
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      - APIKeyHeader: []
+      summary: List parking entries
+      tags:
+      - parking
+  /v1/parking/metrics:
+    get:
+      description: Retrieves aggregated metrics for all parking entries of the organization.
+      operationId: get_total_parking_metrics_v1_parking_metrics_get
+      parameters:
       - in: query
-        name: page
+        name: start_time
         required: false
         schema:
-          default: 1
-          minimum: 1
-          title: Page
-          type: integer
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          title: Start Time
       - in: query
-        name: page_size
+        name: end_time
         required: false
         schema:
-          default: 10
-          maximum: 1000
-          minimum: 1
-          title: Page Size
-          type: integer
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          title: End Time
       responses:
         '200':
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/Pagination_ParkingResponse_'
+                $ref: '#/components/schemas/ParkingTotalMetricsResponse'
           description: Successful Response
         '401':
           content:
@@ -14828,12 +14836,12 @@ paths:
       security:
       - OAuth2PasswordBearer: []
       - APIKeyHeader: []
-      summary: List parking entries
+      summary: Get total metrics for all parking entries
       tags:
       - parking
   /v1/parking/{parking_id}/metrics:
     get:
-      description: Retrieves metrics for a specific parking entry by ID
+      description: Retrieves metrics for a specific parking entry by ID.
       operationId: get_parking_metrics_v1_parking__parking_id__metrics_get
       parameters:
       - in: path
@@ -14847,6 +14855,24 @@ paths:
           title: Parking Id
           type: string
           x-typeid-prefix: parking
+      - in: query
+        name: start_time
+        required: false
+        schema:
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          title: Start Time
+      - in: query
+        name: end_time
+        required: false
+        schema:
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          title: End Time
       responses:
         '200':
           content: