@opusdns/api 0.160.0 → 0.161.0

package/package.json

@@ -3,7 +3,7 @@
     "@opusdns/api-spec-ts-generator": "^0.19.0"
   },
   "name": "@opusdns/api",
-  "version": "0.160.0",
+  "version": "0.161.0",
   "description": "TypeScript types for the OpusDNS OpenAPI specification",
   "main": "./src/index.ts",
   "module": "./src/index.ts",

package/src/helpers/constants.ts

@@ -21,7 +21,7 @@
  * ```
  */
 
-import { AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainSortField, DomainStatus, EmailForwardLogSortField, EmailForwardLogStatus, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, GrantType, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, LaunchPhaseType, LocalPresenceRequirementType, MetricsGrouping, ObjectEventType, ObjectLogSortField, OrganizationStatus, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, Protocol, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TimeRange, TransferAckType, UserStatus, VerificationType, ZoneSortField } from './schemas';
+import { AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ComplianceStatus, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainSortField, DomainStatus, EmailForwardLogSortField, EmailForwardLogStatus, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, GrantType, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, LaunchPhaseType, LocalPresenceRequirementType, MetricsGrouping, ObjectEventType, ObjectLogSortField, OrganizationStatus, ParkingSortField, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, Protocol, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TimeRange, TransferAckType, UserStatus, VerificationType, ZoneSortField } from './schemas';
 
 /**
  * AllocationMethodType. Auto-generated enum for AllocationMethodType
@@ -359,6 +359,60 @@ export const BILLING_TRANSACTION_STATUS_VALUES = [
   'canceled'
 ] as const satisfies [string, ...string[]] | BillingTransactionStatus[];
 
+/**
+ * ComplianceStatus. Auto-generated enum for ComplianceStatus
+ *
+ * @remarks
+ * This constant provides both object and array forms for the ComplianceStatus enum.
+ * The object form allows key-value access, while the array form enables iteration and validation.
+ *
+ * @example
+ * ```typescript
+ * // Using the object form for key-value access
+ * const status = COMPLIANCE_STATUS.SUCCESS;
+ * 
+ * // Using the array form for iteration
+ * const allStatuses = COMPLIANCE_STATUS_VALUES;
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
+ * ```
+ *
+ * @see {@link ComplianceStatus} - The TypeScript type definition
+ */
+export const COMPLIANCE_STATUS = {
+  PREPARING: "preparing",
+  PENDING: "pending",
+  APPROVED: "approved",
+  DISAPPROVED: "disapproved",
+} as const satisfies Record<string, ComplianceStatus>;
+
+/**
+ * Array of all ComplianceStatus enum values
+ *
+ * @remarks
+ * This constant provides a array containing all valid ComplianceStatus enum values.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all values
+ * for (const value of COMPLIANCE_STATUS_VALUES) {
+ *   console.log(`Processing: ${value}`);
+ * }
+ * 
+ * // Validation
+ * const isValid = COMPLIANCE_STATUS_VALUES.includes(someValue);
+ * ```
+ *
+ * @see {@link ComplianceStatus} - The TypeScript type definition
+ * @see {@link COMPLIANCE_STATUS} - The object form of this enum
+ */
+export const COMPLIANCE_STATUS_VALUES = [
+  'preparing',
+  'pending',
+  'approved',
+  'disapproved'
+] as const satisfies [string, ...string[]] | ComplianceStatus[];
+
 /**
  * ContactSortField. Auto-generated enum for ContactSortField
  *
@@ -2497,6 +2551,58 @@ export const ORGANIZATION_STATUS_VALUES = [
   'inactive'
 ] as const satisfies [string, ...string[]] | OrganizationStatus[];
 
+/**
+ * ParkingSortField. Auto-generated enum for ParkingSortField
+ *
+ * @remarks
+ * This constant provides both object and array forms for the ParkingSortField enum.
+ * The object form allows key-value access, while the array form enables iteration and validation.
+ *
+ * @example
+ * ```typescript
+ * // Using the object form for key-value access
+ * const status = PARKING_SORT_FIELD.SUCCESS;
+ * 
+ * // Using the array form for iteration
+ * const allStatuses = PARKING_SORT_FIELD_VALUES;
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
+ * ```
+ *
+ * @see {@link ParkingSortField} - The TypeScript type definition
+ */
+export const PARKING_SORT_FIELD = {
+  DOMAIN: "domain",
+  CREATED_ON: "created_on",
+  UPDATED_ON: "updated_on",
+} as const satisfies Record<string, ParkingSortField>;
+
+/**
+ * Array of all ParkingSortField enum values
+ *
+ * @remarks
+ * This constant provides a array containing all valid ParkingSortField enum values.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all values
+ * for (const value of PARKING_SORT_FIELD_VALUES) {
+ *   console.log(`Processing: ${value}`);
+ * }
+ * 
+ * // Validation
+ * const isValid = PARKING_SORT_FIELD_VALUES.includes(someValue);
+ * ```
+ *
+ * @see {@link ParkingSortField} - The TypeScript type definition
+ * @see {@link PARKING_SORT_FIELD} - The object form of this enum
+ */
+export const PARKING_SORT_FIELD_VALUES = [
+  'domain',
+  'created_on',
+  'updated_on'
+] as const satisfies [string, ...string[]] | ParkingSortField[];
+
 /**
  * PatchOp. Auto-generated enum for PatchOp
  *

package/src/helpers/keys.ts

@@ -156,6 +156,7 @@ import { OrganizationToken } from './schemas';
 import { OrganizationUpdate } from './schemas';
 import { OrganizationWithBillingData } from './schemas';
 import { PaginationMetadata } from './schemas';
+import { Parking } from './schemas';
 import { PasswordUpdate } from './schemas';
 import { Period } from './schemas';
 import { PermissionSet } from './schemas';
@@ -19193,6 +19194,269 @@ export const KEYS_PAGINATION_METADATA = [
   KEY_PAGINATION_METADATA_TOTAL_PAGES,
 ] as const satisfies (keyof PaginationMetadata)[];
 
+/**
+ * compliance_status property
+ *
+ * The compliance status of the parking ad
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `compliance_status` property of Parking objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = parking[KEY_PARKING_COMPLIANCE_STATUS];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_PARKING_COMPLIANCE_STATUS;
+ * const value = parking[propertyName];
+ * ```
+ *
+ * @see {@link Parking} - The TypeScript type definition
+ * @see {@link KEYS_PARKING} - Array of all keys for this type
+ */
+export const KEY_PARKING_COMPLIANCE_STATUS: keyof Parking = 'compliance_status';
+/**
+ * Content Language
+ *
+ * The primary language code for the ad content
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `content_language` property of Parking objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = parking[KEY_PARKING_CONTENT_LANGUAGE];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_PARKING_CONTENT_LANGUAGE;
+ * const value = parking[propertyName];
+ * ```
+ *
+ * @see {@link Parking} - The TypeScript type definition
+ * @see {@link KEYS_PARKING} - Array of all keys for this type
+ */
+export const KEY_PARKING_CONTENT_LANGUAGE: keyof Parking = 'content_language';
+/**
+ * Content Url
+ *
+ * The content URL for approved parking ads
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `content_url` property of Parking objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = parking[KEY_PARKING_CONTENT_URL];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_PARKING_CONTENT_URL;
+ * const value = parking[propertyName];
+ * ```
+ *
+ * @see {@link Parking} - The TypeScript type definition
+ * @see {@link KEYS_PARKING} - Array of all keys for this type
+ */
+export const KEY_PARKING_CONTENT_URL: keyof Parking = 'content_url';
+/**
+ * Created On
+ *
+ * When the parking entry was created
+ *
+ * @type {string}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `created_on` property of Parking objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = parking[KEY_PARKING_CREATED_ON];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_PARKING_CREATED_ON;
+ * const value = parking[propertyName];
+ * ```
+ *
+ * @see {@link Parking} - The TypeScript type definition
+ * @see {@link KEYS_PARKING} - Array of all keys for this type
+ */
+export const KEY_PARKING_CREATED_ON: keyof Parking = 'created_on';
+/**
+ * Domain
+ *
+ * The domain name for the parking ad
+ *
+ * @type {string}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `domain` property of Parking objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = parking[KEY_PARKING_DOMAIN];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_PARKING_DOMAIN;
+ * const value = parking[propertyName];
+ * ```
+ *
+ * @see {@link Parking} - The TypeScript type definition
+ * @see {@link KEYS_PARKING} - Array of all keys for this type
+ */
+export const KEY_PARKING_DOMAIN: keyof Parking = 'domain';
+/**
+ * Enabled
+ *
+ * Whether parking is enabled
+ *
+ * @type {boolean}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `enabled` property of Parking objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = parking[KEY_PARKING_ENABLED];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_PARKING_ENABLED;
+ * const value = parking[propertyName];
+ * ```
+ *
+ * @see {@link Parking} - The TypeScript type definition
+ * @see {@link KEYS_PARKING} - Array of all keys for this type
+ */
+export const KEY_PARKING_ENABLED: keyof Parking = 'enabled';
+/**
+ * Note
+ *
+ * Additional notes about the parking ad
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `note` property of Parking objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = parking[KEY_PARKING_NOTE];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_PARKING_NOTE;
+ * const value = parking[propertyName];
+ * ```
+ *
+ * @see {@link Parking} - The TypeScript type definition
+ * @see {@link KEYS_PARKING} - Array of all keys for this type
+ */
+export const KEY_PARKING_NOTE: keyof Parking = 'note';
+/**
+ * Parking Id
+ *
+ * Unique identifier for the parking entry
+ *
+ * @type {string}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `parking_id` property of Parking objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = parking[KEY_PARKING_PARKING_ID];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_PARKING_PARKING_ID;
+ * const value = parking[propertyName];
+ * ```
+ *
+ * @see {@link Parking} - The TypeScript type definition
+ * @see {@link KEYS_PARKING} - Array of all keys for this type
+ */
+export const KEY_PARKING_PARKING_ID: keyof Parking = 'parking_id';
+/**
+ * Updated On
+ *
+ * When the parking entry was last updated
+ *
+ * @type {string}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `updated_on` property of Parking objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = parking[KEY_PARKING_UPDATED_ON];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_PARKING_UPDATED_ON;
+ * const value = parking[propertyName];
+ * ```
+ *
+ * @see {@link Parking} - The TypeScript type definition
+ * @see {@link KEYS_PARKING} - Array of all keys for this type
+ */
+export const KEY_PARKING_UPDATED_ON: keyof Parking = 'updated_on';
+
+/**
+ * Array of all Parking property keys
+ *
+ * @remarks
+ * This constant provides a readonly array containing all valid property keys for Parking objects.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all keys
+ * for (const key of KEYS_PARKING) {
+ *   console.log(`Property: ${key}, Value: ${parking[key]}`);
+ * }
+ * 
+ * // Validation
+ * const isValidKey = KEYS_PARKING.includes(someKey);
+ * ```
+ *
+ * @see {@link Parking} - The TypeScript type definition
+ */
+export const KEYS_PARKING = [
+  KEY_PARKING_COMPLIANCE_STATUS,
+  KEY_PARKING_CONTENT_LANGUAGE,
+  KEY_PARKING_CONTENT_URL,
+  KEY_PARKING_CREATED_ON,
+  KEY_PARKING_DOMAIN,
+  KEY_PARKING_ENABLED,
+  KEY_PARKING_NOTE,
+  KEY_PARKING_PARKING_ID,
+  KEY_PARKING_UPDATED_ON,
+] as const satisfies (keyof Parking)[];
+
 /**
  * New Password
  *

package/src/helpers/requests.d.ts

@@ -4633,6 +4633,45 @@ export type GET_OrganizationsUsers_Request = {
  */
 export type GET_OrganizationsUsers_Request_Query = GET_OrganizationsUsers_Request['parameters']['query'];
 
+/**
+ * Request type for GET Parking endpoint
+ *
+ * List parking entries
+ * Retrieves a paginated list of parking entries for the organization
+ *
+ * @remarks
+ * This type defines the complete request structure for the GET Parking endpoint.
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @example
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @path /v1/parking
+ *
+ * @see {@link GET_Parking_Request_Query} - Query parameters type
+ * @see {@link GET_Parking_Request_Path} - Path parameters type
+ * @see {@link GET_Parking_Request_Body} - Request body type
+ */
+export type GET_Parking_Request = {
+  parameters: {
+    query: operations['list_parking_v1_parking_get']['parameters']['query'];
+  };
+}
+/**
+ * Query parameters for GET /v1/parking
+ *
+ * @remarks
+ * This type defines the query parameters for the GET /v1/parking endpoint.
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
+ *
+ * @example
+ * Use this type to ensure type safety for query parameters.
+ *
+ * @path /v1/parking
+ */
+export type GET_Parking_Request_Query = GET_Parking_Request['parameters']['query'];
+
 /**
  * Request type for GET Tlds endpoint
  *

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, 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, Pagination_Parking, TldSpecification, UserPublic, UserPublicWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
 
 /**
  * Response types for GET ArchiveEmailForwardLogsAliasesByEmailForwardAliasId endpoint
@@ -8852,6 +8852,98 @@ export type GET_OrganizationsUsers_Response_403 = Problem
  */
 export type GET_OrganizationsUsers_Response_422 = HTTPValidationError
 
+/**
+ * Response types for GET Parking endpoint
+ *
+ * List parking entries
+ * Retrieves a paginated list of parking entries for the organization
+ *
+ * @remarks
+ * This type defines all possible response structures for the GET Parking 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
+ *
+ * @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
+
+/**
+ * 401 response for GET Parking endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 401 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 Problem} - The actual schema type definition
+ */
+export type GET_Parking_Response_401 = Problem
+
+/**
+ * 403 response for GET Parking endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 403 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 Problem} - The actual schema type definition
+ */
+export type GET_Parking_Response_403 = Problem
+
+/**
+ * 422 response for GET Parking endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 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 HTTPValidationError} - The actual schema type definition
+ */
+export type GET_Parking_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, 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, Parking, RequestHistory, UserPublic, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
 
 /**
  * DomainDnssecDataResponse
@@ -919,6 +919,20 @@ 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

@@ -202,6 +202,22 @@ export type BillingTransactionStatus = components['schemas']['BillingTransaction
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type BrowserStatsBucket = components['schemas']['BrowserStatsBucket'];
+/**
+ * ComplianceStatus
+ *
+ * @remarks
+ * Type alias for the `ComplianceStatus` OpenAPI schema.
+ * This type represents compliancestatus data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getComplianceStatus();
+ * const item: ComplianceStatus = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type ComplianceStatus = components['schemas']['ComplianceStatus'];
 /**
  * ContactAttributeDefinition. Definition of a possible attribute for a TLD.
  *
@@ -3071,6 +3087,22 @@ 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]
  *
@@ -3103,6 +3135,38 @@ export type Pagination_RequestHistory = components['schemas']['Pagination_Reques
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type Pagination_UserPublic = components['schemas']['Pagination_UserPublic_'];
+/**
+ * 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
+ *
+ * @remarks
+ * Type alias for the `ParkingSortField` OpenAPI schema.
+ * This type represents parkingsortfield data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getParkingSortField();
+ * const item: ParkingSortField = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type ParkingSortField = components['schemas']['ParkingSortField'];
 /**
  * PasswordUpdate
  *

package/src/openapi.yaml

@@ -223,6 +223,14 @@ components:
       - unique
       title: BrowserStatsBucket
       type: object
+    ComplianceStatus:
+      enum:
+      - preparing
+      - pending
+      - approved
+      - disapproved
+      title: ComplianceStatus
+      type: string
     ContactAttributeDefinition:
       description: Definition of a possible attribute for a TLD.
       properties:
@@ -4850,6 +4858,20 @@ 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:
@@ -4878,6 +4900,73 @@ components:
       - pagination
       title: Pagination[UserPublic]
       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
+          type: string
+          x-typeid-prefix: parking
+        updated_on:
+          description: When the parking entry was last updated
+          format: date-time
+          title: Updated On
+          type: string
+      required:
+      - parking_id
+      - domain
+      - enabled
+      - created_on
+      - updated_on
+      title: ParkingResponse
+      type: object
+    ParkingSortField:
+      enum:
+      - domain
+      - created_on
+      - updated_on
+      title: ParkingSortField
+      type: string
     PasswordUpdate:
       properties:
         new_password:
@@ -6659,7 +6748,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-01-19-102149
+  version: 2026-01-20-080953
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -14458,6 +14547,106 @@ paths:
       summary: Get a specific transaction
       tags:
       - organization
+  /v1/parking:
+    get:
+      description: Retrieves a paginated list of parking entries for the organization
+      operationId: list_parking_v1_parking_get
+      parameters:
+      - in: query
+        name: sort_by
+        required: false
+        schema:
+          $ref: '#/components/schemas/ParkingSortField'
+          default: created_on
+      - in: query
+        name: sort_order
+        required: false
+        schema:
+          $ref: '#/components/schemas/SortOrder'
+          default: desc
+      - in: query
+        name: search
+        required: false
+        schema:
+          anyOf:
+          - type: string
+          - type: 'null'
+          title: Search
+      - in: query
+        name: enabled
+        required: false
+        schema:
+          anyOf:
+          - type: boolean
+          - type: 'null'
+          title: Enabled
+      - in: query
+        name: compliance_status
+        required: false
+        schema:
+          anyOf:
+          - $ref: '#/components/schemas/ComplianceStatus'
+          - type: 'null'
+          title: Compliance Status
+      - in: query
+        name: page
+        required: false
+        schema:
+          default: 1
+          minimum: 1
+          title: Page
+          type: integer
+      - in: query
+        name: page_size
+        required: false
+        schema:
+          default: 10
+          maximum: 1000
+          minimum: 1
+          title: Page Size
+          type: integer
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Pagination_ParkingResponse_'
+          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: []
+      summary: List parking entries
+      tags:
+      - parking
   /v1/tlds/:
     get:
       description: Retrieves a list of TLD Specifications we have support for

package/src/schema.d.ts

@@ -1548,6 +1548,26 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/parking": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        /**
+         * List parking entries
+         * @description Retrieves a paginated list of parking entries for the organization
+         */
+        get: operations["list_parking_v1_parking_get"];
+        put?: never;
+        post?: never;
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/tlds/": {
         parameters: {
             query?: never;
@@ -1903,6 +1923,11 @@ export interface components {
             /** Unique */
             unique: number;
         };
+        /**
+         * ComplianceStatus
+         * @enum {string}
+         */
+        ComplianceStatus: "preparing" | "pending" | "approved" | "disapproved";
         /**
          * ContactAttributeDefinition
          * @description Definition of a possible attribute for a TLD.
@@ -4970,6 +4995,12 @@ export interface components {
             /** Results */
             results: components["schemas"]["Organization"][];
         };
+        /** Pagination[ParkingResponse] */
+        Pagination_ParkingResponse_: {
+            pagination: components["schemas"]["PaginationMetadata"];
+            /** Results */
+            results: components["schemas"]["ParkingResponse"][];
+        };
         /** Pagination[RequestHistory] */
         Pagination_RequestHistory_: {
             pagination: components["schemas"]["PaginationMetadata"];
@@ -4982,6 +5013,60 @@ export interface components {
             /** Results */
             results: components["schemas"]["UserPublic"][];
         };
+        /** ParkingResponse */
+        ParkingResponse: {
+            /** @description The compliance status of the parking ad */
+            compliance_status?: components["schemas"]["ComplianceStatus"] | null;
+            /**
+             * Content Language
+             * @description The primary language code for the ad content
+             */
+            content_language?: string | null;
+            /**
+             * Content Url
+             * @description The content URL for approved parking ads
+             */
+            content_url?: string | null;
+            /**
+             * Created On
+             * Format: date-time
+             * @description When the parking entry was created
+             */
+            created_on: Date;
+            /**
+             * Domain
+             * @description The domain name for the parking ad
+             */
+            domain: string;
+            /**
+             * Enabled
+             * @description Whether parking is enabled
+             */
+            enabled: boolean;
+            /**
+             * Note
+             * @description Additional notes about the parking ad
+             */
+            note?: string | null;
+            /**
+             * Parking Id
+             * Format: typeid
+             * @description Unique identifier for the parking entry
+             * @example parking_01h45ytscbebyvny4gc8cr8ma2
+             */
+            parking_id: TypeId<"parking">;
+            /**
+             * Updated On
+             * Format: date-time
+             * @description When the parking entry was last updated
+             */
+            updated_on: Date;
+        };
+        /**
+         * ParkingSortField
+         * @enum {string}
+         */
+        ParkingSortField: "domain" | "created_on" | "updated_on";
         /** PasswordUpdate */
         PasswordUpdate: {
             /**
@@ -12565,6 +12650,75 @@ export interface operations {
             };
         };
     };
+    list_parking_v1_parking_get: {
+        parameters: {
+            query?: {
+                sort_by?: components["schemas"]["ParkingSortField"];
+                sort_order?: components["schemas"]["SortOrder"];
+                search?: string | null;
+                enabled?: boolean | null;
+                compliance_status?: components["schemas"]["ComplianceStatus"] | null;
+                page?: number;
+                page_size?: number;
+            };
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody?: never;
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["Pagination_ParkingResponse_"];
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /** @example {
+                     *       "code": "ERROR_AUTHENTICATION",
+                     *       "detail": "Additional error context.",
+                     *       "status": 401,
+                     *       "title": "Authentication Error",
+                     *       "type": "authentication"
+                     *     } */
+                    "application/problem+json": components["schemas"]["Problem"];
+                };
+            };
+            /** @description Forbidden */
+            403: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /** @example {
+                     *       "code": "ERROR_PERMISSION_DENIED",
+                     *       "detail": "Insufficient permissions to perform this action",
+                     *       "status": 403,
+                     *       "title": "Permission Denied",
+                     *       "type": "permission-denied"
+                     *     } */
+                    "application/problem+json": components["schemas"]["Problem"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
     get_tld_specifications_v1_tlds__get: {
         parameters: {
             query?: {