@opusdns/api 0.17.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.17.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
  *
@@ -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-07-211955
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
package/src/schema.d.ts CHANGED
@@ -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. */