@opusdns/api 0.169.0 → 0.170.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -3,7 +3,7 @@
3
3
  "@opusdns/api-spec-ts-generator": "^0.19.0"
4
4
  },
5
5
  "name": "@opusdns/api",
6
- "version": "0.169.0",
6
+ "version": "0.170.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -157,6 +157,7 @@ import { OrganizationUpdate } from './schemas';
157
157
  import { OrganizationWithBillingData } from './schemas';
158
158
  import { PaginationMetadata } from './schemas';
159
159
  import { ParkingMetrics } from './schemas';
160
+ import { Parking } from './schemas';
160
161
  import { ParkingStatistics } from './schemas';
161
162
  import { ParkingTotalMetrics } from './schemas';
162
163
  import { PasswordUpdate } from './schemas';
@@ -19327,6 +19328,269 @@ export const KEYS_PARKING_METRICS = [
19327
19328
  KEY_PARKING_METRICS_REVENUE_PROGRESS,
19328
19329
  ] as const satisfies (keyof ParkingMetrics)[];
19329
19330
 
19331
+ /**
19332
+ * compliance_status property
19333
+ *
19334
+ * The compliance status of the parking ad
19335
+ *
19336
+ *
19337
+ *
19338
+ * @remarks
19339
+ * This key constant provides type-safe access to the `compliance_status` property of Parking objects.
19340
+ * Use this constant when you need to access properties dynamically or ensure type safety.
19341
+ *
19342
+ * @example
19343
+ * ```typescript
19344
+ * // Direct property access
19345
+ * const value = parking[KEY_PARKING_COMPLIANCE_STATUS];
19346
+ *
19347
+ * // Dynamic property access
19348
+ * const propertyName = KEY_PARKING_COMPLIANCE_STATUS;
19349
+ * const value = parking[propertyName];
19350
+ * ```
19351
+ *
19352
+ * @see {@link Parking} - The TypeScript type definition
19353
+ * @see {@link KEYS_PARKING} - Array of all keys for this type
19354
+ */
19355
+ export const KEY_PARKING_COMPLIANCE_STATUS: keyof Parking = 'compliance_status';
19356
+ /**
19357
+ * Content Language
19358
+ *
19359
+ * The primary language code for the ad content
19360
+ *
19361
+ *
19362
+ *
19363
+ * @remarks
19364
+ * This key constant provides type-safe access to the `content_language` property of Parking objects.
19365
+ * Use this constant when you need to access properties dynamically or ensure type safety.
19366
+ *
19367
+ * @example
19368
+ * ```typescript
19369
+ * // Direct property access
19370
+ * const value = parking[KEY_PARKING_CONTENT_LANGUAGE];
19371
+ *
19372
+ * // Dynamic property access
19373
+ * const propertyName = KEY_PARKING_CONTENT_LANGUAGE;
19374
+ * const value = parking[propertyName];
19375
+ * ```
19376
+ *
19377
+ * @see {@link Parking} - The TypeScript type definition
19378
+ * @see {@link KEYS_PARKING} - Array of all keys for this type
19379
+ */
19380
+ export const KEY_PARKING_CONTENT_LANGUAGE: keyof Parking = 'content_language';
19381
+ /**
19382
+ * Content Url
19383
+ *
19384
+ * The content URL for approved parking ads
19385
+ *
19386
+ *
19387
+ *
19388
+ * @remarks
19389
+ * This key constant provides type-safe access to the `content_url` property of Parking objects.
19390
+ * Use this constant when you need to access properties dynamically or ensure type safety.
19391
+ *
19392
+ * @example
19393
+ * ```typescript
19394
+ * // Direct property access
19395
+ * const value = parking[KEY_PARKING_CONTENT_URL];
19396
+ *
19397
+ * // Dynamic property access
19398
+ * const propertyName = KEY_PARKING_CONTENT_URL;
19399
+ * const value = parking[propertyName];
19400
+ * ```
19401
+ *
19402
+ * @see {@link Parking} - The TypeScript type definition
19403
+ * @see {@link KEYS_PARKING} - Array of all keys for this type
19404
+ */
19405
+ export const KEY_PARKING_CONTENT_URL: keyof Parking = 'content_url';
19406
+ /**
19407
+ * Created On
19408
+ *
19409
+ * When the parking entry was created
19410
+ *
19411
+ * @type {string}
19412
+ *
19413
+ *
19414
+ * @remarks
19415
+ * This key constant provides type-safe access to the `created_on` property of Parking objects.
19416
+ * Use this constant when you need to access properties dynamically or ensure type safety.
19417
+ *
19418
+ * @example
19419
+ * ```typescript
19420
+ * // Direct property access
19421
+ * const value = parking[KEY_PARKING_CREATED_ON];
19422
+ *
19423
+ * // Dynamic property access
19424
+ * const propertyName = KEY_PARKING_CREATED_ON;
19425
+ * const value = parking[propertyName];
19426
+ * ```
19427
+ *
19428
+ * @see {@link Parking} - The TypeScript type definition
19429
+ * @see {@link KEYS_PARKING} - Array of all keys for this type
19430
+ */
19431
+ export const KEY_PARKING_CREATED_ON: keyof Parking = 'created_on';
19432
+ /**
19433
+ * Domain
19434
+ *
19435
+ * The domain name for the parking ad
19436
+ *
19437
+ * @type {string}
19438
+ *
19439
+ *
19440
+ * @remarks
19441
+ * This key constant provides type-safe access to the `domain` property of Parking objects.
19442
+ * Use this constant when you need to access properties dynamically or ensure type safety.
19443
+ *
19444
+ * @example
19445
+ * ```typescript
19446
+ * // Direct property access
19447
+ * const value = parking[KEY_PARKING_DOMAIN];
19448
+ *
19449
+ * // Dynamic property access
19450
+ * const propertyName = KEY_PARKING_DOMAIN;
19451
+ * const value = parking[propertyName];
19452
+ * ```
19453
+ *
19454
+ * @see {@link Parking} - The TypeScript type definition
19455
+ * @see {@link KEYS_PARKING} - Array of all keys for this type
19456
+ */
19457
+ export const KEY_PARKING_DOMAIN: keyof Parking = 'domain';
19458
+ /**
19459
+ * Enabled
19460
+ *
19461
+ * Whether parking is enabled
19462
+ *
19463
+ * @type {boolean}
19464
+ *
19465
+ *
19466
+ * @remarks
19467
+ * This key constant provides type-safe access to the `enabled` property of Parking objects.
19468
+ * Use this constant when you need to access properties dynamically or ensure type safety.
19469
+ *
19470
+ * @example
19471
+ * ```typescript
19472
+ * // Direct property access
19473
+ * const value = parking[KEY_PARKING_ENABLED];
19474
+ *
19475
+ * // Dynamic property access
19476
+ * const propertyName = KEY_PARKING_ENABLED;
19477
+ * const value = parking[propertyName];
19478
+ * ```
19479
+ *
19480
+ * @see {@link Parking} - The TypeScript type definition
19481
+ * @see {@link KEYS_PARKING} - Array of all keys for this type
19482
+ */
19483
+ export const KEY_PARKING_ENABLED: keyof Parking = 'enabled';
19484
+ /**
19485
+ * Note
19486
+ *
19487
+ * Additional notes about the parking ad
19488
+ *
19489
+ *
19490
+ *
19491
+ * @remarks
19492
+ * This key constant provides type-safe access to the `note` property of Parking objects.
19493
+ * Use this constant when you need to access properties dynamically or ensure type safety.
19494
+ *
19495
+ * @example
19496
+ * ```typescript
19497
+ * // Direct property access
19498
+ * const value = parking[KEY_PARKING_NOTE];
19499
+ *
19500
+ * // Dynamic property access
19501
+ * const propertyName = KEY_PARKING_NOTE;
19502
+ * const value = parking[propertyName];
19503
+ * ```
19504
+ *
19505
+ * @see {@link Parking} - The TypeScript type definition
19506
+ * @see {@link KEYS_PARKING} - Array of all keys for this type
19507
+ */
19508
+ export const KEY_PARKING_NOTE: keyof Parking = 'note';
19509
+ /**
19510
+ * Parking Id
19511
+ *
19512
+ * Unique identifier for the parking entry
19513
+ *
19514
+ * @type {string}
19515
+ *
19516
+ *
19517
+ * @remarks
19518
+ * This key constant provides type-safe access to the `parking_id` property of Parking objects.
19519
+ * Use this constant when you need to access properties dynamically or ensure type safety.
19520
+ *
19521
+ * @example
19522
+ * ```typescript
19523
+ * // Direct property access
19524
+ * const value = parking[KEY_PARKING_PARKING_ID];
19525
+ *
19526
+ * // Dynamic property access
19527
+ * const propertyName = KEY_PARKING_PARKING_ID;
19528
+ * const value = parking[propertyName];
19529
+ * ```
19530
+ *
19531
+ * @see {@link Parking} - The TypeScript type definition
19532
+ * @see {@link KEYS_PARKING} - Array of all keys for this type
19533
+ */
19534
+ export const KEY_PARKING_PARKING_ID: keyof Parking = 'parking_id';
19535
+ /**
19536
+ * Updated On
19537
+ *
19538
+ * When the parking entry was last updated
19539
+ *
19540
+ * @type {string}
19541
+ *
19542
+ *
19543
+ * @remarks
19544
+ * This key constant provides type-safe access to the `updated_on` property of Parking objects.
19545
+ * Use this constant when you need to access properties dynamically or ensure type safety.
19546
+ *
19547
+ * @example
19548
+ * ```typescript
19549
+ * // Direct property access
19550
+ * const value = parking[KEY_PARKING_UPDATED_ON];
19551
+ *
19552
+ * // Dynamic property access
19553
+ * const propertyName = KEY_PARKING_UPDATED_ON;
19554
+ * const value = parking[propertyName];
19555
+ * ```
19556
+ *
19557
+ * @see {@link Parking} - The TypeScript type definition
19558
+ * @see {@link KEYS_PARKING} - Array of all keys for this type
19559
+ */
19560
+ export const KEY_PARKING_UPDATED_ON: keyof Parking = 'updated_on';
19561
+
19562
+ /**
19563
+ * Array of all Parking property keys
19564
+ *
19565
+ * @remarks
19566
+ * This constant provides a readonly array containing all valid property keys for Parking objects.
19567
+ * Useful for iteration, validation, and generating dynamic UI components.
19568
+ *
19569
+ * @example
19570
+ * ```typescript
19571
+ * // Iterating through all keys
19572
+ * for (const key of KEYS_PARKING) {
19573
+ * console.log(`Property: ${key}, Value: ${parking[key]}`);
19574
+ * }
19575
+ *
19576
+ * // Validation
19577
+ * const isValidKey = KEYS_PARKING.includes(someKey);
19578
+ * ```
19579
+ *
19580
+ * @see {@link Parking} - The TypeScript type definition
19581
+ */
19582
+ export const KEYS_PARKING = [
19583
+ KEY_PARKING_COMPLIANCE_STATUS,
19584
+ KEY_PARKING_CONTENT_LANGUAGE,
19585
+ KEY_PARKING_CONTENT_URL,
19586
+ KEY_PARKING_CREATED_ON,
19587
+ KEY_PARKING_DOMAIN,
19588
+ KEY_PARKING_ENABLED,
19589
+ KEY_PARKING_NOTE,
19590
+ KEY_PARKING_PARKING_ID,
19591
+ KEY_PARKING_UPDATED_ON,
19592
+ ] as const satisfies (keyof Parking)[];
19593
+
19330
19594
  /**
19331
19595
  * Conversions
19332
19596
  *
@@ -4648,8 +4648,6 @@ export type GET_OrganizationsUsers_Request_Query = GET_OrganizationsUsers_Reques
4648
4648
  * Use this type to ensure type safety when making API requests to this endpoint.
4649
4649
  *
4650
4650
  * @path /v1/parking
4651
- * @param page (query) - Page number
4652
- * @param page_size (query) - Page size
4653
4651
  *
4654
4652
  * @see {@link GET_Parking_Request_Query} - Query parameters type
4655
4653
  * @see {@link GET_Parking_Request_Path} - Path parameters type
@@ -4671,8 +4669,6 @@ export type GET_Parking_Request = {
4671
4669
  * Use this type to ensure type safety for query parameters.
4672
4670
  *
4673
4671
  * @path /v1/parking
4674
- * @param page (query) - Page number
4675
- * @param page_size (query) - Page size
4676
4672
  */
4677
4673
  export type GET_Parking_Request_Query = GET_Parking_Request['parameters']['query'];
4678
4674
 
@@ -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, 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';
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, EmailForwardMetrics, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_UserPublic, Pagination_Parking, ParkingMetrics, ParkingTotalMetrics, TldSpecification, UserPublic, UserPublicWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
38
38
 
39
39
  /**
40
40
  * Response types for GET ArchiveEmailForwardLogsAliasesByEmailForwardAliasId endpoint
@@ -8866,16 +8866,32 @@ export type GET_OrganizationsUsers_Response_422 = HTTPValidationError
8866
8866
 
8867
8867
  *
8868
8868
  * @path /v1/parking
8869
- * @param page (query) - Page number
8870
- * @param page_size (query) - Page size
8871
8869
  *
8870
+ * @see {@link GET_Parking_Response_200} - 200 response type
8872
8871
  * @see {@link GET_Parking_Response_401} - 401 response type
8873
8872
  * @see {@link GET_Parking_Response_403} - 403 response type
8874
8873
  * @see {@link GET_Parking_Response_422} - 422 response type
8875
8874
  *
8876
8875
 
8877
8876
  */
8878
- export type GET_Parking_Response = GET_Parking_Response_401 | GET_Parking_Response_403 | GET_Parking_Response_422;
8877
+ export type GET_Parking_Response = GET_Parking_Response_200 | GET_Parking_Response_401 | GET_Parking_Response_403 | GET_Parking_Response_422;
8878
+
8879
+ /**
8880
+ * 200 response for GET Parking endpoint
8881
+ *
8882
+ * @remarks
8883
+ * This type defines the response structure for the 200 status code
8884
+ * of the GET Parking endpoint.
8885
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
8886
+ *
8887
+
8888
+ *
8889
+ * @path /v1/parking
8890
+ *
8891
+ * @see {@link GET_Parking_Response} - The main response type definition
8892
+ * @see {@link Pagination_Parking} - The actual schema type definition
8893
+ */
8894
+ export type GET_Parking_Response_200 = Pagination_Parking
8879
8895
 
8880
8896
  /**
8881
8897
  * 401 response for GET Parking endpoint
@@ -8888,8 +8904,6 @@ export type GET_Parking_Response = GET_Parking_Response_401 | GET_Parking_Respon
8888
8904
 
8889
8905
  *
8890
8906
  * @path /v1/parking
8891
- * @param page (query) - Page number
8892
- * @param page_size (query) - Page size
8893
8907
  *
8894
8908
  * @see {@link GET_Parking_Response} - The main response type definition
8895
8909
  * @see {@link Problem} - The actual schema type definition
@@ -8907,8 +8921,6 @@ export type GET_Parking_Response_401 = Problem
8907
8921
 
8908
8922
  *
8909
8923
  * @path /v1/parking
8910
- * @param page (query) - Page number
8911
- * @param page_size (query) - Page size
8912
8924
  *
8913
8925
  * @see {@link GET_Parking_Response} - The main response type definition
8914
8926
  * @see {@link Problem} - The actual schema type definition
@@ -8926,8 +8938,6 @@ export type GET_Parking_Response_403 = Problem
8926
8938
 
8927
8939
  *
8928
8940
  * @path /v1/parking
8929
- * @param page (query) - Page number
8930
- * @param page_size (query) - Page size
8931
8941
  *
8932
8942
  * @see {@link GET_Parking_Response} - The main response type definition
8933
8943
  * @see {@link HTTPValidationError} - The actual schema type definition
@@ -21,7 +21,7 @@
21
21
  * This file is auto-generated from the OpenAPI specification.
22
22
  * Do not edit manually.
23
23
  */
24
- 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';
24
+ 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';
25
25
 
26
26
  /**
27
27
  * DomainDnssecDataResponse
@@ -919,6 +919,20 @@ export type ObjectLogArray = ObjectLog[];
919
919
  * @see {@link Organization} - The individual Organization type definition
920
920
  */
921
921
  export type OrganizationArray = Organization[];
922
+ /**
923
+ * ParkingResponse
924
+ *
925
+ * @remarks
926
+ * Array type for ParkingResponse objects. Used when the API returns a collection of ParkingResponse instances.
927
+ *
928
+ * @example
929
+ * ```typescript
930
+ * const items: ParkingArray = await api.getParkings();
931
+ * ```
932
+ *
933
+ * @see {@link Parking} - The individual ParkingResponse type definition
934
+ */
935
+ export type ParkingArray = Parking[];
922
936
  /**
923
937
  * RequestHistory
924
938
  *
@@ -3087,6 +3087,22 @@ export type Pagination_ObjectLog = components['schemas']['Pagination_ObjectLog_'
3087
3087
  * @see {@link components} - The OpenAPI components schema definition
3088
3088
  */
3089
3089
  export type Pagination_Organization = components['schemas']['Pagination_Organization_'];
3090
+ /**
3091
+ * Pagination[ParkingResponse]
3092
+ *
3093
+ * @remarks
3094
+ * Type alias for the `Pagination_ParkingResponse_` OpenAPI schema.
3095
+ * This type represents pagination[parkingresponse] data structures used in API requests and responses.
3096
+ *
3097
+ * @example
3098
+ * ```typescript
3099
+ * const response = await api.getPagination_Parking();
3100
+ * const item: Pagination_Parking = response.results;
3101
+ * ```
3102
+ *
3103
+ * @see {@link components} - The OpenAPI components schema definition
3104
+ */
3105
+ export type Pagination_Parking = components['schemas']['Pagination_ParkingResponse_'];
3090
3106
  /**
3091
3107
  * Pagination[RequestHistory]
3092
3108
  *
@@ -3135,6 +3151,22 @@ export type Pagination_UserPublic = components['schemas']['Pagination_UserPublic
3135
3151
  * @see {@link components} - The OpenAPI components schema definition
3136
3152
  */
3137
3153
  export type ParkingMetrics = components['schemas']['ParkingMetricsResponse'];
3154
+ /**
3155
+ * ParkingResponse
3156
+ *
3157
+ * @remarks
3158
+ * Type alias for the `ParkingResponse` OpenAPI schema.
3159
+ * This type represents parkingresponse data structures used in API requests and responses.
3160
+ *
3161
+ * @example
3162
+ * ```typescript
3163
+ * const response = await api.getParking();
3164
+ * const item: Parking = response.results;
3165
+ * ```
3166
+ *
3167
+ * @see {@link components} - The OpenAPI components schema definition
3168
+ */
3169
+ export type Parking = components['schemas']['ParkingResponse'];
3138
3170
  /**
3139
3171
  * ParkingSortField
3140
3172
  *
package/src/openapi.yaml CHANGED
@@ -4869,6 +4869,20 @@ components:
4869
4869
  - pagination
4870
4870
  title: Pagination[Organization]
4871
4871
  type: object
4872
+ Pagination_ParkingResponse_:
4873
+ properties:
4874
+ pagination:
4875
+ $ref: '#/components/schemas/PaginationMetadata'
4876
+ results:
4877
+ items:
4878
+ $ref: '#/components/schemas/ParkingResponse'
4879
+ title: Results
4880
+ type: array
4881
+ required:
4882
+ - results
4883
+ - pagination
4884
+ title: Pagination[ParkingResponse]
4885
+ type: object
4872
4886
  Pagination_RequestHistory_:
4873
4887
  properties:
4874
4888
  pagination:
@@ -4918,6 +4932,66 @@ components:
4918
4932
  - revenue_progress
4919
4933
  title: ParkingMetricsResponse
4920
4934
  type: object
4935
+ ParkingResponse:
4936
+ properties:
4937
+ compliance_status:
4938
+ anyOf:
4939
+ - $ref: '#/components/schemas/ComplianceStatus'
4940
+ - type: 'null'
4941
+ description: The compliance status of the parking ad
4942
+ content_language:
4943
+ anyOf:
4944
+ - type: string
4945
+ - type: 'null'
4946
+ description: The primary language code for the ad content
4947
+ title: Content Language
4948
+ content_url:
4949
+ anyOf:
4950
+ - type: string
4951
+ - type: 'null'
4952
+ description: The content URL for approved parking ads
4953
+ title: Content Url
4954
+ created_on:
4955
+ description: When the parking entry was created
4956
+ format: date-time
4957
+ title: Created On
4958
+ type: string
4959
+ domain:
4960
+ description: The domain name for the parking ad
4961
+ title: Domain
4962
+ type: string
4963
+ enabled:
4964
+ description: Whether parking is enabled
4965
+ title: Enabled
4966
+ type: boolean
4967
+ note:
4968
+ anyOf:
4969
+ - type: string
4970
+ - type: 'null'
4971
+ description: Additional notes about the parking ad
4972
+ title: Note
4973
+ parking_id:
4974
+ description: Unique identifier for the parking entry
4975
+ examples:
4976
+ - parking_01h45ytscbebyvny4gc8cr8ma2
4977
+ format: typeid
4978
+ pattern: ^parking_[0-7][0-9a-hjkmnpq-tv-z]{25}$
4979
+ title: Parking Id
4980
+ type: string
4981
+ x-typeid-prefix: parking
4982
+ updated_on:
4983
+ description: When the parking entry was last updated
4984
+ format: date-time
4985
+ title: Updated On
4986
+ type: string
4987
+ required:
4988
+ - parking_id
4989
+ - domain
4990
+ - enabled
4991
+ - created_on
4992
+ - updated_on
4993
+ title: ParkingResponse
4994
+ type: object
4921
4995
  ParkingSortField:
4922
4996
  enum:
4923
4997
  - domain
@@ -6760,7 +6834,7 @@ info:
6760
6834
  '
6761
6835
  summary: OpusDNS - your gateway to a seamless domain management experience.
6762
6836
  title: OpusDNS API
6763
- version: 2026-01-25-132304
6837
+ version: 2026-01-26-081410
6764
6838
  x-logo:
6765
6839
  altText: OpusDNS API Reference
6766
6840
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -14671,23 +14745,19 @@ paths:
14671
14745
  description: Retrieves a paginated list of parking entries for the organization
14672
14746
  operationId: list_parking_v1_parking_get
14673
14747
  parameters:
14674
- - description: Page number
14675
- in: query
14748
+ - in: query
14676
14749
  name: page
14677
14750
  required: false
14678
14751
  schema:
14679
14752
  default: 1
14680
- description: Page number
14681
14753
  minimum: 1
14682
14754
  title: Page
14683
14755
  type: integer
14684
- - description: Page size
14685
- in: query
14756
+ - in: query
14686
14757
  name: page_size
14687
14758
  required: false
14688
14759
  schema:
14689
14760
  default: 10
14690
- description: Page size
14691
14761
  maximum: 1000
14692
14762
  minimum: 1
14693
14763
  title: Page Size
@@ -14733,9 +14803,7 @@ paths:
14733
14803
  content:
14734
14804
  application/json:
14735
14805
  schema:
14736
- additionalProperties: true
14737
- title: Response List Parking V1 Parking Get
14738
- type: object
14806
+ $ref: '#/components/schemas/Pagination_ParkingResponse_'
14739
14807
  description: Successful Response
14740
14808
  '401':
14741
14809
  content:
package/src/schema.d.ts CHANGED
@@ -5041,6 +5041,12 @@ export interface components {
5041
5041
  /** Results */
5042
5042
  results: components["schemas"]["Organization"][];
5043
5043
  };
5044
+ /** Pagination[ParkingResponse] */
5045
+ Pagination_ParkingResponse_: {
5046
+ pagination: components["schemas"]["PaginationMetadata"];
5047
+ /** Results */
5048
+ results: components["schemas"]["ParkingResponse"][];
5049
+ };
5044
5050
  /** Pagination[RequestHistory] */
5045
5051
  Pagination_RequestHistory_: {
5046
5052
  pagination: components["schemas"]["PaginationMetadata"];
@@ -5068,6 +5074,55 @@ export interface components {
5068
5074
  */
5069
5075
  revenue_progress: string;
5070
5076
  };
5077
+ /** ParkingResponse */
5078
+ ParkingResponse: {
5079
+ /** @description The compliance status of the parking ad */
5080
+ compliance_status?: components["schemas"]["ComplianceStatus"] | null;
5081
+ /**
5082
+ * Content Language
5083
+ * @description The primary language code for the ad content
5084
+ */
5085
+ content_language?: string | null;
5086
+ /**
5087
+ * Content Url
5088
+ * @description The content URL for approved parking ads
5089
+ */
5090
+ content_url?: string | null;
5091
+ /**
5092
+ * Created On
5093
+ * Format: date-time
5094
+ * @description When the parking entry was created
5095
+ */
5096
+ created_on: Date;
5097
+ /**
5098
+ * Domain
5099
+ * @description The domain name for the parking ad
5100
+ */
5101
+ domain: string;
5102
+ /**
5103
+ * Enabled
5104
+ * @description Whether parking is enabled
5105
+ */
5106
+ enabled: boolean;
5107
+ /**
5108
+ * Note
5109
+ * @description Additional notes about the parking ad
5110
+ */
5111
+ note?: string | null;
5112
+ /**
5113
+ * Parking Id
5114
+ * Format: typeid
5115
+ * @description Unique identifier for the parking entry
5116
+ * @example parking_01h45ytscbebyvny4gc8cr8ma2
5117
+ */
5118
+ parking_id: TypeId<"parking">;
5119
+ /**
5120
+ * Updated On
5121
+ * Format: date-time
5122
+ * @description When the parking entry was last updated
5123
+ */
5124
+ updated_on: Date;
5125
+ };
5071
5126
  /**
5072
5127
  * ParkingSortField
5073
5128
  * @enum {string}
@@ -12703,9 +12758,7 @@ export interface operations {
12703
12758
  list_parking_v1_parking_get: {
12704
12759
  parameters: {
12705
12760
  query?: {
12706
- /** @description Page number */
12707
12761
  page?: number;
12708
- /** @description Page size */
12709
12762
  page_size?: number;
12710
12763
  sort_by?: components["schemas"]["ParkingSortField"];
12711
12764
  sort_order?: components["schemas"]["SortOrder"];
@@ -12725,9 +12778,7 @@ export interface operations {
12725
12778
  [name: string]: unknown;
12726
12779
  };
12727
12780
  content: {
12728
- "application/json": {
12729
- [key: string]: unknown;
12730
- };
12781
+ "application/json": components["schemas"]["Pagination_ParkingResponse_"];
12731
12782
  };
12732
12783
  };
12733
12784
  /** @description Unauthorized */