@opusdns/api 0.16.0 → 0.18.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
@@ -8,7 +8,7 @@
8
8
  "typescript": "^5.8.2"
9
9
  },
10
10
  "name": "@opusdns/api",
11
- "version": "0.16.0",
11
+ "version": "0.18.0",
12
12
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
13
13
  "main": "./src/index.ts",
14
14
  "module": "./src/index.ts",
@@ -870,6 +870,7 @@ export const DOMAIN_STATUS = {
870
870
  SERVER_UPDATE_PROHIBITED: "serverUpdateProhibited",
871
871
  SERVER_DELETE_PROHIBITED: "serverDeleteProhibited",
872
872
  SERVER_RENEW_PROHIBITED: "serverRenewProhibited",
873
+ SERVER_RESTORE_PROHIBITED: "serverRestoreProhibited",
873
874
  SERVER_HOLD: "serverHold",
874
875
  TRANSFER_PERIOD: "transferPeriod",
875
876
  RENEW_PERIOD: "renewPeriod",
@@ -918,6 +919,7 @@ export const DOMAIN_STATUS_VALUES = [
918
919
  'serverUpdateProhibited',
919
920
  'serverDeleteProhibited',
920
921
  'serverRenewProhibited',
922
+ 'serverRestoreProhibited',
921
923
  'serverHold',
922
924
  'transferPeriod',
923
925
  'renewPeriod',
@@ -119,6 +119,7 @@ import { RdapBase } from './schemas';
119
119
  import { RegistryLockBase } from './schemas';
120
120
  import { RelationSet } from './schemas';
121
121
  import { ReservedDomainsBase } from './schemas';
122
+ import { RgpOperations } from './schemas';
122
123
  import { SignupCreate } from './schemas';
123
124
  import { SldLength } from './schemas';
124
125
  import { SpiceDbRelationshipUpdate } from './schemas';
@@ -5791,6 +5792,31 @@ export const KEY_DOMAIN_LIFECYCLE_BASE_REGISTRY_AUTO_RENEW = 'registry_auto_rene
5791
5792
  * @see {@link KEYS_DOMAIN_LIFECYCLE_BASE} - Array of all keys for this type
5792
5793
  */
5793
5794
  export const KEY_DOMAIN_LIFECYCLE_BASE_RENEWAL_PERIODS = 'renewal_periods' as keyof DomainLifecycleBase;
5795
+ /**
5796
+ * rgp_operations property
5797
+ *
5798
+ * RGP operations supported by the registry
5799
+ *
5800
+ *
5801
+ *
5802
+ * @remarks
5803
+ * This key constant provides type-safe access to the `rgp_operations` property of DomainLifecycleBase objects.
5804
+ * Use this constant when you need to access properties dynamically or ensure type safety.
5805
+ *
5806
+ * @example
5807
+ * ```typescript
5808
+ * // Direct property access
5809
+ * const value = domainlifecyclebase[KEY_DOMAIN_LIFECYCLE_BASE_RGP_OPERATIONS];
5810
+ *
5811
+ * // Dynamic property access
5812
+ * const propertyName = KEY_DOMAIN_LIFECYCLE_BASE_RGP_OPERATIONS;
5813
+ * const value = domainlifecyclebase[propertyName];
5814
+ * ```
5815
+ *
5816
+ * @see {@link DomainLifecycleBase} - The TypeScript type definition
5817
+ * @see {@link KEYS_DOMAIN_LIFECYCLE_BASE} - Array of all keys for this type
5818
+ */
5819
+ export const KEY_DOMAIN_LIFECYCLE_BASE_RGP_OPERATIONS = 'rgp_operations' as keyof DomainLifecycleBase;
5794
5820
  /**
5795
5821
  * Sync After Operations
5796
5822
  *
@@ -5849,6 +5875,7 @@ export const KEYS_DOMAIN_LIFECYCLE_BASE = [
5849
5875
  KEY_DOMAIN_LIFECYCLE_BASE_REGISTRATION_PERIODS,
5850
5876
  KEY_DOMAIN_LIFECYCLE_BASE_REGISTRY_AUTO_RENEW,
5851
5877
  KEY_DOMAIN_LIFECYCLE_BASE_RENEWAL_PERIODS,
5878
+ KEY_DOMAIN_LIFECYCLE_BASE_RGP_OPERATIONS,
5852
5879
  KEY_DOMAIN_LIFECYCLE_BASE_SYNC_AFTER_OPERATIONS,
5853
5880
  ] as const satisfies (keyof DomainLifecycleBase)[];
5854
5881
 
@@ -14514,6 +14541,84 @@ export const KEYS_RESERVED_DOMAINS_BASE = [
14514
14541
  KEY_RESERVED_DOMAINS_BASE_URL,
14515
14542
  ] as const satisfies (keyof ReservedDomainsBase)[];
14516
14543
 
14544
+ /**
14545
+ * Report
14546
+ *
14547
+ * Whether registry supports RGP restore report
14548
+ *
14549
+ * @type {boolean}
14550
+ *
14551
+ *
14552
+ * @remarks
14553
+ * This key constant provides type-safe access to the `report` property of RgpOperations objects.
14554
+ * Use this constant when you need to access properties dynamically or ensure type safety.
14555
+ *
14556
+ * @example
14557
+ * ```typescript
14558
+ * // Direct property access
14559
+ * const value = rgpoperations[KEY_RGP_OPERATIONS_REPORT];
14560
+ *
14561
+ * // Dynamic property access
14562
+ * const propertyName = KEY_RGP_OPERATIONS_REPORT;
14563
+ * const value = rgpoperations[propertyName];
14564
+ * ```
14565
+ *
14566
+ * @see {@link RgpOperations} - The TypeScript type definition
14567
+ * @see {@link KEYS_RGP_OPERATIONS} - Array of all keys for this type
14568
+ */
14569
+ export const KEY_RGP_OPERATIONS_REPORT = 'report' as keyof RgpOperations;
14570
+ /**
14571
+ * Request
14572
+ *
14573
+ * Whether registry supports RGP restore request
14574
+ *
14575
+ * @type {boolean}
14576
+ *
14577
+ *
14578
+ * @remarks
14579
+ * This key constant provides type-safe access to the `request` property of RgpOperations objects.
14580
+ * Use this constant when you need to access properties dynamically or ensure type safety.
14581
+ *
14582
+ * @example
14583
+ * ```typescript
14584
+ * // Direct property access
14585
+ * const value = rgpoperations[KEY_RGP_OPERATIONS_REQUEST];
14586
+ *
14587
+ * // Dynamic property access
14588
+ * const propertyName = KEY_RGP_OPERATIONS_REQUEST;
14589
+ * const value = rgpoperations[propertyName];
14590
+ * ```
14591
+ *
14592
+ * @see {@link RgpOperations} - The TypeScript type definition
14593
+ * @see {@link KEYS_RGP_OPERATIONS} - Array of all keys for this type
14594
+ */
14595
+ export const KEY_RGP_OPERATIONS_REQUEST = 'request' as keyof RgpOperations;
14596
+
14597
+ /**
14598
+ * Array of all RgpOperations property keys
14599
+ *
14600
+ * @remarks
14601
+ * This constant provides a readonly array containing all valid property keys for RgpOperations objects.
14602
+ * Useful for iteration, validation, and generating dynamic UI components.
14603
+ *
14604
+ * @example
14605
+ * ```typescript
14606
+ * // Iterating through all keys
14607
+ * for (const key of KEYS_RGP_OPERATIONS) {
14608
+ * console.log(`Property: ${key}, Value: ${rgpoperations[key]}`);
14609
+ * }
14610
+ *
14611
+ * // Validation
14612
+ * const isValidKey = KEYS_RGP_OPERATIONS.includes(someKey);
14613
+ * ```
14614
+ *
14615
+ * @see {@link RgpOperations} - The TypeScript type definition
14616
+ */
14617
+ export const KEYS_RGP_OPERATIONS = [
14618
+ KEY_RGP_OPERATIONS_REPORT,
14619
+ KEY_RGP_OPERATIONS_REQUEST,
14620
+ ] as const satisfies (keyof RgpOperations)[];
14621
+
14517
14622
  /**
14518
14623
  * organization property
14519
14624
  *
@@ -2181,118 +2181,118 @@ export type PATCH_EmailForwardsZoneNameEnable_Request = {
2181
2181
  export type PATCH_EmailForwardsZoneNameEnable_Request_Path = PATCH_EmailForwardsZoneNameEnable_Request['parameters']['path'];
2182
2182
 
2183
2183
  /**
2184
- * Request type for GET Event endpoint
2184
+ * Request type for GET Events endpoint
2185
2185
  *
2186
2186
  * Get Events
2187
2187
  *
2188
2188
  * @remarks
2189
- * This type defines the complete request structure for the GET Event endpoint.
2189
+ * This type defines the complete request structure for the GET Events endpoint.
2190
2190
  * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
2191
2191
  * Use this type to ensure type safety when making API requests to this endpoint.
2192
2192
  *
2193
2193
  * @example
2194
2194
  * Use this type to ensure type safety when making API requests to this endpoint.
2195
2195
  *
2196
- * @path /v1/event
2196
+ * @path /v1/events
2197
2197
  *
2198
- * @see {@link GET_Event_Request_Query} - Query parameters type
2199
- * @see {@link GET_Event_Request_Path} - Path parameters type
2200
- * @see {@link GET_Event_Request_Body} - Request body type
2198
+ * @see {@link GET_Events_Request_Query} - Query parameters type
2199
+ * @see {@link GET_Events_Request_Path} - Path parameters type
2200
+ * @see {@link GET_Events_Request_Body} - Request body type
2201
2201
  */
2202
- export type GET_Event_Request = {
2202
+ export type GET_Events_Request = {
2203
2203
  parameters: {
2204
- query: operations['get_events_v1_event_get']['parameters']['query'];
2204
+ query: operations['get_events_v1_events_get']['parameters']['query'];
2205
2205
  };
2206
2206
  }
2207
2207
  /**
2208
- * Query parameters for GET /v1/event
2208
+ * Query parameters for GET /v1/events
2209
2209
  *
2210
2210
  * @remarks
2211
- * This type defines the query parameters for the GET /v1/event endpoint.
2211
+ * This type defines the query parameters for the GET /v1/events endpoint.
2212
2212
  * It provides type safety for all query parameters as defined in the OpenAPI specification.
2213
2213
  *
2214
2214
  * @example
2215
2215
  * Use this type to ensure type safety for query parameters.
2216
2216
  *
2217
- * @path /v1/event
2217
+ * @path /v1/events
2218
2218
  */
2219
- export type GET_Event_Request_Query = GET_Event_Request['parameters']['query'];
2219
+ export type GET_Events_Request_Query = GET_Events_Request['parameters']['query'];
2220
2220
 
2221
2221
  /**
2222
- * Request type for GET EventEventId endpoint
2222
+ * Request type for GET EventsEventId endpoint
2223
2223
  *
2224
2224
  * Get Event
2225
2225
  *
2226
2226
  * @remarks
2227
- * This type defines the complete request structure for the GET EventEventId endpoint.
2227
+ * This type defines the complete request structure for the GET EventsEventId endpoint.
2228
2228
  * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
2229
2229
  * Use this type to ensure type safety when making API requests to this endpoint.
2230
2230
  *
2231
2231
  * @example
2232
2232
  * Use this type to ensure type safety when making API requests to this endpoint.
2233
2233
  *
2234
- * @path /v1/event/{event_id}
2234
+ * @path /v1/events/{event_id}
2235
2235
  *
2236
- * @see {@link GET_EventEventId_Request_Query} - Query parameters type
2237
- * @see {@link GET_EventEventId_Request_Path} - Path parameters type
2238
- * @see {@link GET_EventEventId_Request_Body} - Request body type
2236
+ * @see {@link GET_EventsEventId_Request_Query} - Query parameters type
2237
+ * @see {@link GET_EventsEventId_Request_Path} - Path parameters type
2238
+ * @see {@link GET_EventsEventId_Request_Body} - Request body type
2239
2239
  */
2240
- export type GET_EventEventId_Request = {
2240
+ export type GET_EventsEventId_Request = {
2241
2241
  parameters: {
2242
- path: operations['get_event_v1_event__event_id__get']['parameters']['path'];
2242
+ path: operations['get_event_v1_events__event_id__get']['parameters']['path'];
2243
2243
  };
2244
2244
  }
2245
2245
  /**
2246
- * Path parameters for GET /v1/event/{event_id}
2246
+ * Path parameters for GET /v1/events/{event_id}
2247
2247
  *
2248
2248
  * @remarks
2249
- * This type defines the path parameters for the GET /v1/event/{event_id} endpoint.
2249
+ * This type defines the path parameters for the GET /v1/events/{event_id} endpoint.
2250
2250
  * It provides type safety for all path parameters as defined in the OpenAPI specification.
2251
2251
  *
2252
2252
  * @example
2253
2253
  * Use this type to ensure type safety for path parameters.
2254
2254
  *
2255
- * @path /v1/event/{event_id}
2255
+ * @path /v1/events/{event_id}
2256
2256
  */
2257
- export type GET_EventEventId_Request_Path = GET_EventEventId_Request['parameters']['path'];
2257
+ export type GET_EventsEventId_Request_Path = GET_EventsEventId_Request['parameters']['path'];
2258
2258
 
2259
2259
  /**
2260
- * Request type for PATCH EventEventId endpoint
2260
+ * Request type for PATCH EventsEventId endpoint
2261
2261
  *
2262
2262
  * Acknowledge Event
2263
2263
  *
2264
2264
  * @remarks
2265
- * This type defines the complete request structure for the PATCH EventEventId endpoint.
2265
+ * This type defines the complete request structure for the PATCH EventsEventId endpoint.
2266
2266
  * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
2267
2267
  * Use this type to ensure type safety when making API requests to this endpoint.
2268
2268
  *
2269
2269
  * @example
2270
2270
  * Use this type to ensure type safety when making API requests to this endpoint.
2271
2271
  *
2272
- * @path /v1/event/{event_id}
2272
+ * @path /v1/events/{event_id}
2273
2273
  *
2274
- * @see {@link PATCH_EventEventId_Request_Query} - Query parameters type
2275
- * @see {@link PATCH_EventEventId_Request_Path} - Path parameters type
2276
- * @see {@link PATCH_EventEventId_Request_Body} - Request body type
2274
+ * @see {@link PATCH_EventsEventId_Request_Query} - Query parameters type
2275
+ * @see {@link PATCH_EventsEventId_Request_Path} - Path parameters type
2276
+ * @see {@link PATCH_EventsEventId_Request_Body} - Request body type
2277
2277
  */
2278
- export type PATCH_EventEventId_Request = {
2278
+ export type PATCH_EventsEventId_Request = {
2279
2279
  parameters: {
2280
- path: operations['acknowledge_event_v1_event__event_id__patch']['parameters']['path'];
2280
+ path: operations['acknowledge_event_v1_events__event_id__patch']['parameters']['path'];
2281
2281
  };
2282
2282
  }
2283
2283
  /**
2284
- * Path parameters for PATCH /v1/event/{event_id}
2284
+ * Path parameters for PATCH /v1/events/{event_id}
2285
2285
  *
2286
2286
  * @remarks
2287
- * This type defines the path parameters for the PATCH /v1/event/{event_id} endpoint.
2287
+ * This type defines the path parameters for the PATCH /v1/events/{event_id} endpoint.
2288
2288
  * It provides type safety for all path parameters as defined in the OpenAPI specification.
2289
2289
  *
2290
2290
  * @example
2291
2291
  * Use this type to ensure type safety for path parameters.
2292
2292
  *
2293
- * @path /v1/event/{event_id}
2293
+ * @path /v1/events/{event_id}
2294
2294
  */
2295
- export type PATCH_EventEventId_Request_Path = PATCH_EventEventId_Request['parameters']['path'];
2295
+ export type PATCH_EventsEventId_Request_Path = PATCH_EventsEventId_Request['parameters']['path'];
2296
2296
 
2297
2297
  /**
2298
2298
  * Request type for GET Notifications endpoint
@@ -3374,241 +3374,241 @@ export type PATCH_EmailForwardsByZoneNameEnable_Response = PATCH_EmailForwardsBy
3374
3374
  export type PATCH_EmailForwardsByZoneNameEnable_Response_422 = HTTPValidationError
3375
3375
 
3376
3376
  /**
3377
- * Response types for GET Event endpoint
3377
+ * Response types for GET Events endpoint
3378
3378
  *
3379
3379
  * Get Events
3380
3380
  *
3381
3381
  * @remarks
3382
- * This type defines all possible response structures for the GET Event endpoint.
3382
+ * This type defines all possible response structures for the GET Events endpoint.
3383
3383
  * Each response code maps to a specific response type as defined in the OpenAPI specification.
3384
3384
  * Use this type to ensure type safety when handling API responses from this endpoint.
3385
3385
  *
3386
3386
 
3387
3387
  *
3388
- * @path /v1/event
3388
+ * @path /v1/events
3389
3389
  *
3390
- * @see {@link GET_Event_Response_200} - 200 response type
3391
- * @see {@link GET_Event_Response_401} - 401 response type
3392
- * @see {@link GET_Event_Response_422} - 422 response type
3390
+ * @see {@link GET_Events_Response_200} - 200 response type
3391
+ * @see {@link GET_Events_Response_401} - 401 response type
3392
+ * @see {@link GET_Events_Response_422} - 422 response type
3393
3393
  *
3394
3394
 
3395
3395
  */
3396
- export type GET_Event_Response = GET_Event_Response_200 | GET_Event_Response_401 | GET_Event_Response_422;
3396
+ export type GET_Events_Response = GET_Events_Response_200 | GET_Events_Response_401 | GET_Events_Response_422;
3397
3397
 
3398
3398
  /**
3399
- * 200 response for GET Event endpoint
3399
+ * 200 response for GET Events endpoint
3400
3400
  *
3401
3401
  * @remarks
3402
3402
  * This type defines the response structure for the 200 status code
3403
- * of the GET Event endpoint.
3403
+ * of the GET Events endpoint.
3404
3404
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3405
3405
  *
3406
3406
 
3407
3407
  *
3408
- * @path /v1/event
3408
+ * @path /v1/events
3409
3409
  *
3410
- * @see {@link GET_Event_Response} - The main response type definition
3410
+ * @see {@link GET_Events_Response} - The main response type definition
3411
3411
  * @see {@link Pagination_Event} - The actual schema type definition
3412
3412
  */
3413
- export type GET_Event_Response_200 = Pagination_Event
3413
+ export type GET_Events_Response_200 = Pagination_Event
3414
3414
 
3415
3415
  /**
3416
- * 401 response for GET Event endpoint
3416
+ * 401 response for GET Events endpoint
3417
3417
  *
3418
3418
  * @remarks
3419
3419
  * This type defines the response structure for the 401 status code
3420
- * of the GET Event endpoint.
3420
+ * of the GET Events endpoint.
3421
3421
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3422
3422
  *
3423
3423
 
3424
3424
  *
3425
- * @path /v1/event
3425
+ * @path /v1/events
3426
3426
  *
3427
- * @see {@link GET_Event_Response} - The main response type definition
3427
+ * @see {@link GET_Events_Response} - The main response type definition
3428
3428
  * @see {@link Problem} - The actual schema type definition
3429
3429
  */
3430
- export type GET_Event_Response_401 = Problem
3430
+ export type GET_Events_Response_401 = Problem
3431
3431
 
3432
3432
  /**
3433
- * 422 response for GET Event endpoint
3433
+ * 422 response for GET Events endpoint
3434
3434
  *
3435
3435
  * @remarks
3436
3436
  * This type defines the response structure for the 422 status code
3437
- * of the GET Event endpoint.
3437
+ * of the GET Events endpoint.
3438
3438
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3439
3439
  *
3440
3440
 
3441
3441
  *
3442
- * @path /v1/event
3442
+ * @path /v1/events
3443
3443
  *
3444
- * @see {@link GET_Event_Response} - The main response type definition
3444
+ * @see {@link GET_Events_Response} - The main response type definition
3445
3445
  * @see {@link HTTPValidationError} - The actual schema type definition
3446
3446
  */
3447
- export type GET_Event_Response_422 = HTTPValidationError
3447
+ export type GET_Events_Response_422 = HTTPValidationError
3448
3448
 
3449
3449
  /**
3450
- * Response types for GET EventByEventId endpoint
3450
+ * Response types for GET EventsByEventId endpoint
3451
3451
  *
3452
3452
  * Get Event
3453
3453
  *
3454
3454
  * @remarks
3455
- * This type defines all possible response structures for the GET EventByEventId endpoint.
3455
+ * This type defines all possible response structures for the GET EventsByEventId endpoint.
3456
3456
  * Each response code maps to a specific response type as defined in the OpenAPI specification.
3457
3457
  * Use this type to ensure type safety when handling API responses from this endpoint.
3458
3458
  *
3459
3459
 
3460
3460
  *
3461
- * @path /v1/event/{event_id}
3461
+ * @path /v1/events/{event_id}
3462
3462
  *
3463
- * @see {@link GET_EventByEventId_Response_200} - 200 response type
3464
- * @see {@link GET_EventByEventId_Response_401} - 401 response type
3465
- * @see {@link GET_EventByEventId_Response_404} - 404 response type
3466
- * @see {@link GET_EventByEventId_Response_422} - 422 response type
3463
+ * @see {@link GET_EventsByEventId_Response_200} - 200 response type
3464
+ * @see {@link GET_EventsByEventId_Response_401} - 401 response type
3465
+ * @see {@link GET_EventsByEventId_Response_404} - 404 response type
3466
+ * @see {@link GET_EventsByEventId_Response_422} - 422 response type
3467
3467
  *
3468
3468
 
3469
3469
  */
3470
- export type GET_EventByEventId_Response = GET_EventByEventId_Response_200 | GET_EventByEventId_Response_401 | GET_EventByEventId_Response_404 | GET_EventByEventId_Response_422;
3470
+ export type GET_EventsByEventId_Response = GET_EventsByEventId_Response_200 | GET_EventsByEventId_Response_401 | GET_EventsByEventId_Response_404 | GET_EventsByEventId_Response_422;
3471
3471
 
3472
3472
  /**
3473
- * 200 response for GET EventByEventId endpoint
3473
+ * 200 response for GET EventsByEventId endpoint
3474
3474
  *
3475
3475
  * @remarks
3476
3476
  * This type defines the response structure for the 200 status code
3477
- * of the GET EventByEventId endpoint.
3477
+ * of the GET EventsByEventId endpoint.
3478
3478
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3479
3479
  *
3480
3480
 
3481
3481
  *
3482
- * @path /v1/event/{event_id}
3482
+ * @path /v1/events/{event_id}
3483
3483
  *
3484
- * @see {@link GET_EventByEventId_Response} - The main response type definition
3484
+ * @see {@link GET_EventsByEventId_Response} - The main response type definition
3485
3485
  * @see {@link EventSchema} - The actual schema type definition
3486
3486
  */
3487
- export type GET_EventByEventId_Response_200 = EventSchema
3487
+ export type GET_EventsByEventId_Response_200 = EventSchema
3488
3488
 
3489
3489
  /**
3490
- * 401 response for GET EventByEventId endpoint
3490
+ * 401 response for GET EventsByEventId endpoint
3491
3491
  *
3492
3492
  * @remarks
3493
3493
  * This type defines the response structure for the 401 status code
3494
- * of the GET EventByEventId endpoint.
3494
+ * of the GET EventsByEventId endpoint.
3495
3495
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3496
3496
  *
3497
3497
 
3498
3498
  *
3499
- * @path /v1/event/{event_id}
3499
+ * @path /v1/events/{event_id}
3500
3500
  *
3501
- * @see {@link GET_EventByEventId_Response} - The main response type definition
3501
+ * @see {@link GET_EventsByEventId_Response} - The main response type definition
3502
3502
  * @see {@link Problem} - The actual schema type definition
3503
3503
  */
3504
- export type GET_EventByEventId_Response_401 = Problem
3504
+ export type GET_EventsByEventId_Response_401 = Problem
3505
3505
 
3506
3506
  /**
3507
- * 404 response for GET EventByEventId endpoint
3507
+ * 404 response for GET EventsByEventId endpoint
3508
3508
  *
3509
3509
  * @remarks
3510
3510
  * This type defines the response structure for the 404 status code
3511
- * of the GET EventByEventId endpoint.
3511
+ * of the GET EventsByEventId endpoint.
3512
3512
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3513
3513
  *
3514
3514
 
3515
3515
  *
3516
- * @path /v1/event/{event_id}
3516
+ * @path /v1/events/{event_id}
3517
3517
  *
3518
- * @see {@link GET_EventByEventId_Response} - The main response type definition
3518
+ * @see {@link GET_EventsByEventId_Response} - The main response type definition
3519
3519
  * @see {@link Problem} - The actual schema type definition
3520
3520
  */
3521
- export type GET_EventByEventId_Response_404 = Problem
3521
+ export type GET_EventsByEventId_Response_404 = Problem
3522
3522
 
3523
3523
  /**
3524
- * 422 response for GET EventByEventId endpoint
3524
+ * 422 response for GET EventsByEventId endpoint
3525
3525
  *
3526
3526
  * @remarks
3527
3527
  * This type defines the response structure for the 422 status code
3528
- * of the GET EventByEventId endpoint.
3528
+ * of the GET EventsByEventId endpoint.
3529
3529
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3530
3530
  *
3531
3531
 
3532
3532
  *
3533
- * @path /v1/event/{event_id}
3533
+ * @path /v1/events/{event_id}
3534
3534
  *
3535
- * @see {@link GET_EventByEventId_Response} - The main response type definition
3535
+ * @see {@link GET_EventsByEventId_Response} - The main response type definition
3536
3536
  * @see {@link HTTPValidationError} - The actual schema type definition
3537
3537
  */
3538
- export type GET_EventByEventId_Response_422 = HTTPValidationError
3538
+ export type GET_EventsByEventId_Response_422 = HTTPValidationError
3539
3539
 
3540
3540
  /**
3541
- * Response types for PATCH EventByEventId endpoint
3541
+ * Response types for PATCH EventsByEventId endpoint
3542
3542
  *
3543
3543
  * Acknowledge Event
3544
3544
  *
3545
3545
  * @remarks
3546
- * This type defines all possible response structures for the PATCH EventByEventId endpoint.
3546
+ * This type defines all possible response structures for the PATCH EventsByEventId endpoint.
3547
3547
  * Each response code maps to a specific response type as defined in the OpenAPI specification.
3548
3548
  * Use this type to ensure type safety when handling API responses from this endpoint.
3549
3549
  *
3550
3550
 
3551
3551
  *
3552
- * @path /v1/event/{event_id}
3552
+ * @path /v1/events/{event_id}
3553
3553
  *
3554
- * @see {@link PATCH_EventByEventId_Response_401} - 401 response type
3555
- * @see {@link PATCH_EventByEventId_Response_404} - 404 response type
3556
- * @see {@link PATCH_EventByEventId_Response_422} - 422 response type
3554
+ * @see {@link PATCH_EventsByEventId_Response_401} - 401 response type
3555
+ * @see {@link PATCH_EventsByEventId_Response_404} - 404 response type
3556
+ * @see {@link PATCH_EventsByEventId_Response_422} - 422 response type
3557
3557
  *
3558
3558
 
3559
3559
  */
3560
- export type PATCH_EventByEventId_Response = PATCH_EventByEventId_Response_401 | PATCH_EventByEventId_Response_404 | PATCH_EventByEventId_Response_422;
3560
+ export type PATCH_EventsByEventId_Response = PATCH_EventsByEventId_Response_401 | PATCH_EventsByEventId_Response_404 | PATCH_EventsByEventId_Response_422;
3561
3561
 
3562
3562
  /**
3563
- * 401 response for PATCH EventByEventId endpoint
3563
+ * 401 response for PATCH EventsByEventId endpoint
3564
3564
  *
3565
3565
  * @remarks
3566
3566
  * This type defines the response structure for the 401 status code
3567
- * of the PATCH EventByEventId endpoint.
3567
+ * of the PATCH EventsByEventId endpoint.
3568
3568
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3569
3569
  *
3570
3570
 
3571
3571
  *
3572
- * @path /v1/event/{event_id}
3572
+ * @path /v1/events/{event_id}
3573
3573
  *
3574
- * @see {@link PATCH_EventByEventId_Response} - The main response type definition
3574
+ * @see {@link PATCH_EventsByEventId_Response} - The main response type definition
3575
3575
  * @see {@link Problem} - The actual schema type definition
3576
3576
  */
3577
- export type PATCH_EventByEventId_Response_401 = Problem
3577
+ export type PATCH_EventsByEventId_Response_401 = Problem
3578
3578
 
3579
3579
  /**
3580
- * 404 response for PATCH EventByEventId endpoint
3580
+ * 404 response for PATCH EventsByEventId endpoint
3581
3581
  *
3582
3582
  * @remarks
3583
3583
  * This type defines the response structure for the 404 status code
3584
- * of the PATCH EventByEventId endpoint.
3584
+ * of the PATCH EventsByEventId endpoint.
3585
3585
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3586
3586
  *
3587
3587
 
3588
3588
  *
3589
- * @path /v1/event/{event_id}
3589
+ * @path /v1/events/{event_id}
3590
3590
  *
3591
- * @see {@link PATCH_EventByEventId_Response} - The main response type definition
3591
+ * @see {@link PATCH_EventsByEventId_Response} - The main response type definition
3592
3592
  * @see {@link Problem} - The actual schema type definition
3593
3593
  */
3594
- export type PATCH_EventByEventId_Response_404 = Problem
3594
+ export type PATCH_EventsByEventId_Response_404 = Problem
3595
3595
 
3596
3596
  /**
3597
- * 422 response for PATCH EventByEventId endpoint
3597
+ * 422 response for PATCH EventsByEventId endpoint
3598
3598
  *
3599
3599
  * @remarks
3600
3600
  * This type defines the response structure for the 422 status code
3601
- * of the PATCH EventByEventId endpoint.
3601
+ * of the PATCH EventsByEventId endpoint.
3602
3602
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
3603
3603
  *
3604
3604
 
3605
3605
  *
3606
- * @path /v1/event/{event_id}
3606
+ * @path /v1/events/{event_id}
3607
3607
  *
3608
- * @see {@link PATCH_EventByEventId_Response} - The main response type definition
3608
+ * @see {@link PATCH_EventsByEventId_Response} - The main response type definition
3609
3609
  * @see {@link HTTPValidationError} - The actual schema type definition
3610
3610
  */
3611
- export type PATCH_EventByEventId_Response_422 = HTTPValidationError
3611
+ export type PATCH_EventsByEventId_Response_422 = HTTPValidationError
3612
3612
 
3613
3613
  /**
3614
3614
  * Response types for GET Notifications endpoint
@@ -2282,6 +2282,22 @@ export type ReservedDomainsBase = components['schemas']['ReservedDomainsBase'];
2282
2282
  * @see {@link components} - The OpenAPI components schema definition
2283
2283
  */
2284
2284
  export type ReservedSourceType = components['schemas']['ReservedSourceType'];
2285
+ /**
2286
+ * RgpOperations
2287
+ *
2288
+ * @remarks
2289
+ * Type alias for the `RgpOperations` OpenAPI schema.
2290
+ * This type represents rgpoperations data structures used in API requests and responses.
2291
+ *
2292
+ * @example
2293
+ * ```typescript
2294
+ * const response = await api.getRgpOperations();
2295
+ * const item: RgpOperations = response.results;
2296
+ * ```
2297
+ *
2298
+ * @see {@link components} - The OpenAPI components schema definition
2299
+ */
2300
+ export type RgpOperations = components['schemas']['RgpOperations'];
2285
2301
  /**
2286
2302
  * SignupCreate
2287
2303
  *
package/src/openapi.yaml CHANGED
@@ -1395,6 +1395,11 @@ components:
1395
1395
  $ref: '#/components/schemas/PeriodList'
1396
1396
  description: List of allowed renewal periods (e.g., '1y' or ['1y', '2y',
1397
1397
  '5y'])
1398
+ rgp_operations:
1399
+ anyOf:
1400
+ - $ref: '#/components/schemas/RgpOperations'
1401
+ - type: 'null'
1402
+ description: RGP operations supported by the registry
1398
1403
  sync_after_operations:
1399
1404
  anyOf:
1400
1405
  - items:
@@ -1680,6 +1685,7 @@ components:
1680
1685
  - serverUpdateProhibited
1681
1686
  - serverDeleteProhibited
1682
1687
  - serverRenewProhibited
1688
+ - serverRestoreProhibited
1683
1689
  - serverHold
1684
1690
  - transferPeriod
1685
1691
  - renewPeriod
@@ -3782,6 +3788,20 @@ components:
3782
3788
  - manual
3783
3789
  title: ReservedSourceType
3784
3790
  type: string
3791
+ RgpOperations:
3792
+ properties:
3793
+ report:
3794
+ default: true
3795
+ description: Whether registry supports RGP restore report
3796
+ title: Report
3797
+ type: boolean
3798
+ request:
3799
+ default: true
3800
+ description: Whether registry supports RGP restore request
3801
+ title: Request
3802
+ type: boolean
3803
+ title: RgpOperations
3804
+ type: object
3785
3805
  SignupCreate:
3786
3806
  properties:
3787
3807
  organization:
@@ -4819,7 +4839,7 @@ info:
4819
4839
  '
4820
4840
  summary: OpusDNS - your gateway to a seamless domain management experience.
4821
4841
  title: OpusDNS API
4822
- version: 2025-08-04-073353
4842
+ version: 2025-08-13-193514
4823
4843
  x-logo:
4824
4844
  altText: OpusDNS API Reference
4825
4845
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -7529,9 +7549,9 @@ paths:
7529
7549
  summary: Enable Email Forward
7530
7550
  tags:
7531
7551
  - email_forward
7532
- /v1/event:
7552
+ /v1/events:
7533
7553
  get:
7534
- operationId: get_events_v1_event_get
7554
+ operationId: get_events_v1_events_get
7535
7555
  parameters:
7536
7556
  - in: query
7537
7557
  name: page
@@ -7580,9 +7600,9 @@ paths:
7580
7600
  summary: Get Events
7581
7601
  tags:
7582
7602
  - event
7583
- /v1/event/{event_id}:
7603
+ /v1/events/{event_id}:
7584
7604
  get:
7585
- operationId: get_event_v1_event__event_id__get
7605
+ operationId: get_event_v1_events__event_id__get
7586
7606
  parameters:
7587
7607
  - in: path
7588
7608
  name: event_id
@@ -7639,7 +7659,7 @@ paths:
7639
7659
  tags:
7640
7660
  - event
7641
7661
  patch:
7642
- operationId: acknowledge_event_v1_event__event_id__patch
7662
+ operationId: acknowledge_event_v1_events__event_id__patch
7643
7663
  parameters:
7644
7664
  - in: path
7645
7665
  name: event_id
package/src/schema.d.ts CHANGED
@@ -658,7 +658,7 @@ export interface paths {
658
658
  patch: operations["enable_email_forward_v1_email_forwards__zone_name__enable_patch"];
659
659
  trace?: never;
660
660
  };
661
- "/v1/event": {
661
+ "/v1/events": {
662
662
  parameters: {
663
663
  query?: never;
664
664
  header?: never;
@@ -666,7 +666,7 @@ export interface paths {
666
666
  cookie?: never;
667
667
  };
668
668
  /** Get Events */
669
- get: operations["get_events_v1_event_get"];
669
+ get: operations["get_events_v1_events_get"];
670
670
  put?: never;
671
671
  post?: never;
672
672
  delete?: never;
@@ -675,7 +675,7 @@ export interface paths {
675
675
  patch?: never;
676
676
  trace?: never;
677
677
  };
678
- "/v1/event/{event_id}": {
678
+ "/v1/events/{event_id}": {
679
679
  parameters: {
680
680
  query?: never;
681
681
  header?: never;
@@ -683,14 +683,14 @@ export interface paths {
683
683
  cookie?: never;
684
684
  };
685
685
  /** Get Event */
686
- get: operations["get_event_v1_event__event_id__get"];
686
+ get: operations["get_event_v1_events__event_id__get"];
687
687
  put?: never;
688
688
  post?: never;
689
689
  delete?: never;
690
690
  options?: never;
691
691
  head?: never;
692
692
  /** Acknowledge Event */
693
- patch: operations["acknowledge_event_v1_event__event_id__patch"];
693
+ patch: operations["acknowledge_event_v1_events__event_id__patch"];
694
694
  trace?: never;
695
695
  };
696
696
  "/v1/notifications": {
@@ -1984,6 +1984,8 @@ export interface components {
1984
1984
  registry_auto_renew?: boolean | null;
1985
1985
  /** @description List of allowed renewal periods (e.g., '1y' or ['1y', '2y', '5y']) */
1986
1986
  renewal_periods?: components["schemas"]["PeriodList"];
1987
+ /** @description RGP operations supported by the registry */
1988
+ rgp_operations?: components["schemas"]["RgpOperations"] | null;
1987
1989
  /**
1988
1990
  * Sync After Operations
1989
1991
  * @description Operations that trigger a sync with the registry
@@ -2173,7 +2175,7 @@ export interface components {
2173
2175
  * DomainStatus
2174
2176
  * @enum {string}
2175
2177
  */
2176
- DomainStatus: "ok" | "serverTransferProhibited" | "serverUpdateProhibited" | "serverDeleteProhibited" | "serverRenewProhibited" | "serverHold" | "transferPeriod" | "renewPeriod" | "redemptionPeriod" | "pendingUpdate" | "pendingTransfer" | "pendingRestore" | "pendingRenew" | "pendingDelete" | "pendingCreate" | "inactive" | "autoRenewPeriod" | "addPeriod" | "deleted" | "clientTransferProhibited" | "clientUpdateProhibited" | "clientDeleteProhibited" | "clientRenewProhibited" | "clientHold";
2178
+ DomainStatus: "ok" | "serverTransferProhibited" | "serverUpdateProhibited" | "serverDeleteProhibited" | "serverRenewProhibited" | "serverRestoreProhibited" | "serverHold" | "transferPeriod" | "renewPeriod" | "redemptionPeriod" | "pendingUpdate" | "pendingTransfer" | "pendingRestore" | "pendingRenew" | "pendingDelete" | "pendingCreate" | "inactive" | "autoRenewPeriod" | "addPeriod" | "deleted" | "clientTransferProhibited" | "clientUpdateProhibited" | "clientDeleteProhibited" | "clientRenewProhibited" | "clientHold";
2177
2179
  /** DomainStatusesBase */
2178
2180
  DomainStatusesBase: {
2179
2181
  /**
@@ -3557,6 +3559,21 @@ export interface components {
3557
3559
  * @enum {string}
3558
3560
  */
3559
3561
  ReservedSourceType: "API" | "CSV" | "manual";
3562
+ /** RgpOperations */
3563
+ RgpOperations: {
3564
+ /**
3565
+ * Report
3566
+ * @description Whether registry supports RGP restore report
3567
+ * @default true
3568
+ */
3569
+ report: boolean;
3570
+ /**
3571
+ * Request
3572
+ * @description Whether registry supports RGP restore request
3573
+ * @default true
3574
+ */
3575
+ request: boolean;
3576
+ };
3560
3577
  /** SignupCreate */
3561
3578
  SignupCreate: {
3562
3579
  /** @description Organization signup. */
@@ -6659,7 +6676,7 @@ export interface operations {
6659
6676
  };
6660
6677
  };
6661
6678
  };
6662
- get_events_v1_event_get: {
6679
+ get_events_v1_events_get: {
6663
6680
  parameters: {
6664
6681
  query?: {
6665
6682
  page?: number;
@@ -6707,7 +6724,7 @@ export interface operations {
6707
6724
  };
6708
6725
  };
6709
6726
  };
6710
- get_event_v1_event__event_id__get: {
6727
+ get_event_v1_events__event_id__get: {
6711
6728
  parameters: {
6712
6729
  query?: never;
6713
6730
  header?: never;
@@ -6771,7 +6788,7 @@ export interface operations {
6771
6788
  };
6772
6789
  };
6773
6790
  };
6774
- acknowledge_event_v1_event__event_id__patch: {
6791
+ acknowledge_event_v1_events__event_id__patch: {
6775
6792
  parameters: {
6776
6793
  query?: never;
6777
6794
  header?: never;