@opusdns/api 0.34.0 → 0.36.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.34.0",
11
+ "version": "0.36.0",
12
12
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
13
13
  "main": "./src/index.ts",
14
14
  "module": "./src/index.ts",
@@ -21,7 +21,7 @@
21
21
  * ```
22
22
  */
23
23
 
24
- import { AllocationMethodType, BillingTransactionAction, BillingTransactionProductType, ContactRoleType, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainSortField, DomainStatus, EmailVerificationStatus, EventObjectType, EventSubtype, EventType, GrantType, LaunchPhaseType, LocalPresenceRequirementType, OrganizationCredentialStatus, OrganizationStatus, PatchOp, PeriodUnit, Permission, PlanRelation, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, RegistrantChangeType, Relation, RenewalMode, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TransferAckType, UserNotificationStatus, UserStatus, VerificationType, ZoneSortField } from './schemas';
24
+ import { AllocationMethodType, BillingTransactionAction, BillingTransactionProductType, ContactRoleType, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainSortField, DomainStatus, EmailVerificationStatus, EventObjectType, EventSubtype, EventType, GrantType, LaunchPhaseType, LocalPresenceRequirementType, OrganizationCredentialStatus, OrganizationStatus, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TransferAckType, UserNotificationStatus, UserStatus, VerificationType, ZoneSortField } from './schemas';
25
25
 
26
26
  /**
27
27
  * AllocationMethodType. Auto-generated enum for AllocationMethodType
@@ -1663,9 +1663,10 @@ export const PERMISSION = {
1663
1663
  BULK_RENEW_EXPIRE: "bulk_renew_expire",
1664
1664
  BULK_TRANSFER_TRADE: "bulk_transfer_trade",
1665
1665
  BULK_UPDATE: "bulk_update",
1666
+ CORPORATE_PLAN: "corporate_plan",
1666
1667
  CREATE: "create",
1667
1668
  DELETE: "delete",
1668
- ENTERPRISE: "enterprise",
1669
+ ENTERPRISE_PLAN: "enterprise_plan",
1669
1670
  HAS_ACCEPTED_TOS: "has_accepted_tos",
1670
1671
  MANAGE_API_KEYS: "manage_api_keys",
1671
1672
  MANAGE_BILLING: "manage_billing",
@@ -1680,10 +1681,9 @@ export const PERMISSION = {
1680
1681
  MANAGE_USER_RELATIONS: "manage_user_relations",
1681
1682
  MANAGE_USERS: "manage_users",
1682
1683
  PLAN_MANAGER: "plan_manager",
1683
- PREMIUM: "premium",
1684
- PREMIUM_RESELLER: "premium_reseller",
1684
+ PREMIUM_PLAN: "premium_plan",
1685
1685
  RENEW_EXPIRE: "renew_expire",
1686
- STARTER: "starter",
1686
+ STARTER_PLAN: "starter_plan",
1687
1687
  TRANSFER_TRADE: "transfer_trade",
1688
1688
  UPDATE: "update",
1689
1689
  VERIFY: "verify",
@@ -1719,9 +1719,10 @@ export const PERMISSION_VALUES = [
1719
1719
  'bulk_renew_expire',
1720
1720
  'bulk_transfer_trade',
1721
1721
  'bulk_update',
1722
+ 'corporate_plan',
1722
1723
  'create',
1723
1724
  'delete',
1724
- 'enterprise',
1725
+ 'enterprise_plan',
1725
1726
  'has_accepted_tos',
1726
1727
  'manage_api_keys',
1727
1728
  'manage_billing',
@@ -1736,10 +1737,9 @@ export const PERMISSION_VALUES = [
1736
1737
  'manage_user_relations',
1737
1738
  'manage_users',
1738
1739
  'plan_manager',
1739
- 'premium',
1740
- 'premium_reseller',
1740
+ 'premium_plan',
1741
1741
  'renew_expire',
1742
- 'starter',
1742
+ 'starter_plan',
1743
1743
  'transfer_trade',
1744
1744
  'update',
1745
1745
  'verify',
@@ -1747,60 +1747,6 @@ export const PERMISSION_VALUES = [
1747
1747
  'view_audit_logs'
1748
1748
  ] as const satisfies [string, ...string[]] | Permission[];
1749
1749
 
1750
- /**
1751
- * PlanRelation. Auto-generated enum for PlanRelation
1752
- *
1753
- * @remarks
1754
- * This constant provides both object and array forms for the PlanRelation enum.
1755
- * The object form allows key-value access, while the array form enables iteration and validation.
1756
- *
1757
- * @example
1758
- * ```typescript
1759
- * // Using the object form for key-value access
1760
- * const status = PLAN_RELATION.SUCCESS;
1761
- *
1762
- * // Using the array form for iteration
1763
- * const allStatuses = PLAN_RELATION_VALUES;
1764
- * console.log(`Available statuses: ${allStatuses.join(', ')}`);
1765
- * ```
1766
- *
1767
- * @see {@link PlanRelation} - The TypeScript type definition
1768
- */
1769
- export const PLAN_RELATION = {
1770
- BASIC_PLAN: "basic_plan",
1771
- ENTERPRISE_PLAN: "enterprise_plan",
1772
- PREMIUM_PLAN: "premium_plan",
1773
- STARTER_PLAN: "starter_plan",
1774
- } as const satisfies Record<string, PlanRelation>;
1775
-
1776
- /**
1777
- * Array of all PlanRelation enum values
1778
- *
1779
- * @remarks
1780
- * This constant provides a array containing all valid PlanRelation enum values.
1781
- * Useful for iteration, validation, and generating dynamic UI components.
1782
- *
1783
- * @example
1784
- * ```typescript
1785
- * // Iterating through all values
1786
- * for (const value of PLAN_RELATION_VALUES) {
1787
- * console.log(`Processing: ${value}`);
1788
- * }
1789
- *
1790
- * // Validation
1791
- * const isValid = PLAN_RELATION_VALUES.includes(someValue);
1792
- * ```
1793
- *
1794
- * @see {@link PlanRelation} - The TypeScript type definition
1795
- * @see {@link PLAN_RELATION} - The object form of this enum
1796
- */
1797
- export const PLAN_RELATION_VALUES = [
1798
- 'basic_plan',
1799
- 'enterprise_plan',
1800
- 'premium_plan',
1801
- 'starter_plan'
1802
- ] as const satisfies [string, ...string[]] | PlanRelation[];
1803
-
1804
1750
  /**
1805
1751
  * PostTransferRequirements. Auto-generated enum for PostTransferRequirements
1806
1752
  *
@@ -2055,6 +2001,54 @@ export const REGISTRANT_CHANGE_TYPE_VALUES = [
2055
2001
  'trade'
2056
2002
  ] as const satisfies [string, ...string[]] | RegistrantChangeType[];
2057
2003
 
2004
+ /**
2005
+ * RegistryHandleAttributeType. Registry handle attribute types for type-safe attribute key access.
2006
+ *
2007
+ * @remarks
2008
+ * This constant provides both object and array forms for the RegistryHandleAttributeType enum.
2009
+ * The object form allows key-value access, while the array form enables iteration and validation.
2010
+ *
2011
+ * @example
2012
+ * ```typescript
2013
+ * // Using the object form for key-value access
2014
+ * const status = REGISTRY_HANDLE_ATTRIBUTE_TYPE.SUCCESS;
2015
+ *
2016
+ * // Using the array form for iteration
2017
+ * const allStatuses = REGISTRY_HANDLE_ATTRIBUTE_TYPE_VALUES;
2018
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
2019
+ * ```
2020
+ *
2021
+ * @see {@link RegistryHandleAttributeType} - The TypeScript type definition
2022
+ */
2023
+ export const REGISTRY_HANDLE_ATTRIBUTE_TYPE = {
2024
+ AT-EXT-CONTACT:TYPE: "at-ext-contact:type",
2025
+ } as const satisfies Record<string, RegistryHandleAttributeType>;
2026
+
2027
+ /**
2028
+ * Array of all RegistryHandleAttributeType enum values
2029
+ *
2030
+ * @remarks
2031
+ * This constant provides a array containing all valid RegistryHandleAttributeType enum values.
2032
+ * Useful for iteration, validation, and generating dynamic UI components.
2033
+ *
2034
+ * @example
2035
+ * ```typescript
2036
+ * // Iterating through all values
2037
+ * for (const value of REGISTRY_HANDLE_ATTRIBUTE_TYPE_VALUES) {
2038
+ * console.log(`Processing: ${value}`);
2039
+ * }
2040
+ *
2041
+ * // Validation
2042
+ * const isValid = REGISTRY_HANDLE_ATTRIBUTE_TYPE_VALUES.includes(someValue);
2043
+ * ```
2044
+ *
2045
+ * @see {@link RegistryHandleAttributeType} - The TypeScript type definition
2046
+ * @see {@link REGISTRY_HANDLE_ATTRIBUTE_TYPE} - The object form of this enum
2047
+ */
2048
+ export const REGISTRY_HANDLE_ATTRIBUTE_TYPE_VALUES = [
2049
+ 'at-ext-contact:type'
2050
+ ] as const satisfies [string, ...string[]] | RegistryHandleAttributeType[];
2051
+
2058
2052
  /**
2059
2053
  * Relation. Auto-generated enum for Relation
2060
2054
  *
@@ -35,6 +35,7 @@ import { BillingPlan } from './schemas';
35
35
  import { Body_issue_organization_token_v1_auth_token_post } from './schemas';
36
36
  import { ContactConfigBase } from './schemas';
37
37
  import { ContactCreate } from './schemas';
38
+ import { ContactHandle } from './schemas';
38
39
  import { Contact } from './schemas';
39
40
  import { ContactSchema } from './schemas';
40
41
  import { ContactVerificationApi } from './schemas';
@@ -118,7 +119,6 @@ import { PasswordUpdate } from './schemas';
118
119
  import { Period } from './schemas';
119
120
  import { PermissionSet } from './schemas';
120
121
  import { PlanInfo } from './schemas';
121
- import { PlanUpdate } from './schemas';
122
122
  import { PremiumDomainsBase } from './schemas';
123
123
  import { PriceInfo } from './schemas';
124
124
  import { Problem } from './schemas';
@@ -1093,6 +1093,83 @@ export const KEYS_CONTACT_CREATE = [
1093
1093
  KEY_CONTACT_CREATE_TITLE,
1094
1094
  ] as const satisfies (keyof ContactCreate)[];
1095
1095
 
1096
+ /**
1097
+ * Attributes
1098
+ *
1099
+ * Additional attributes related to the contact
1100
+ *
1101
+ *
1102
+ *
1103
+ * @remarks
1104
+ * This key constant provides type-safe access to the `attributes` property of ContactHandle objects.
1105
+ * Use this constant when you need to access properties dynamically or ensure type safety.
1106
+ *
1107
+ * @example
1108
+ * ```typescript
1109
+ * // Direct property access
1110
+ * const value = contacthandle[KEY_CONTACT_HANDLE_ATTRIBUTES];
1111
+ *
1112
+ * // Dynamic property access
1113
+ * const propertyName = KEY_CONTACT_HANDLE_ATTRIBUTES;
1114
+ * const value = contacthandle[propertyName];
1115
+ * ```
1116
+ *
1117
+ * @see {@link ContactHandle} - The TypeScript type definition
1118
+ * @see {@link KEYS_CONTACT_HANDLE} - Array of all keys for this type
1119
+ */
1120
+ export const KEY_CONTACT_HANDLE_ATTRIBUTES = 'attributes' as keyof ContactHandle;
1121
+ /**
1122
+ * Contact Id
1123
+ *
1124
+ * The contact id of the contact
1125
+ *
1126
+ * @type {string}
1127
+ *
1128
+ *
1129
+ * @remarks
1130
+ * This key constant provides type-safe access to the `contact_id` property of ContactHandle objects.
1131
+ * Use this constant when you need to access properties dynamically or ensure type safety.
1132
+ *
1133
+ * @example
1134
+ * ```typescript
1135
+ * // Direct property access
1136
+ * const value = contacthandle[KEY_CONTACT_HANDLE_CONTACT_ID];
1137
+ *
1138
+ * // Dynamic property access
1139
+ * const propertyName = KEY_CONTACT_HANDLE_CONTACT_ID;
1140
+ * const value = contacthandle[propertyName];
1141
+ * ```
1142
+ *
1143
+ * @see {@link ContactHandle} - The TypeScript type definition
1144
+ * @see {@link KEYS_CONTACT_HANDLE} - Array of all keys for this type
1145
+ */
1146
+ export const KEY_CONTACT_HANDLE_CONTACT_ID = 'contact_id' as keyof ContactHandle;
1147
+
1148
+ /**
1149
+ * Array of all ContactHandle property keys
1150
+ *
1151
+ * @remarks
1152
+ * This constant provides a readonly array containing all valid property keys for ContactHandle objects.
1153
+ * Useful for iteration, validation, and generating dynamic UI components.
1154
+ *
1155
+ * @example
1156
+ * ```typescript
1157
+ * // Iterating through all keys
1158
+ * for (const key of KEYS_CONTACT_HANDLE) {
1159
+ * console.log(`Property: ${key}, Value: ${contacthandle[key]}`);
1160
+ * }
1161
+ *
1162
+ * // Validation
1163
+ * const isValidKey = KEYS_CONTACT_HANDLE.includes(someKey);
1164
+ * ```
1165
+ *
1166
+ * @see {@link ContactHandle} - The TypeScript type definition
1167
+ */
1168
+ export const KEYS_CONTACT_HANDLE = [
1169
+ KEY_CONTACT_HANDLE_ATTRIBUTES,
1170
+ KEY_CONTACT_HANDLE_CONTACT_ID,
1171
+ ] as const satisfies (keyof ContactHandle)[];
1172
+
1096
1173
  /**
1097
1174
  * City
1098
1175
  *
@@ -4983,7 +5060,7 @@ export const KEYS_DOMAIN_CONTACT = [
4983
5060
  */
4984
5061
  export const KEY_DOMAIN_CREATE_AUTH_CODE = 'auth_code' as keyof DomainCreate;
4985
5062
  /**
4986
- * contacts property
5063
+ * Contacts
4987
5064
  *
4988
5065
  * The contacts of the domain
4989
5066
  *
@@ -7700,7 +7777,7 @@ export const KEYS_DOMAIN_SUMMARY = [
7700
7777
  */
7701
7778
  export const KEY_DOMAIN_TRANSFER_IN_AUTH_CODE = 'auth_code' as keyof DomainTransferIn;
7702
7779
  /**
7703
- * contacts property
7780
+ * Contacts
7704
7781
  *
7705
7782
  * The contacts of the domain
7706
7783
  *
@@ -14711,55 +14788,6 @@ export const KEYS_PLAN_INFO = [
14711
14788
  KEY_PLAN_INFO_PLAN_TYPE,
14712
14789
  ] as const satisfies (keyof PlanInfo)[];
14713
14790
 
14714
- /**
14715
- * plan property
14716
- *
14717
- *
14718
- *
14719
- *
14720
- * @remarks
14721
- * This key constant provides type-safe access to the `plan` property of PlanUpdate objects.
14722
- * Use this constant when you need to access properties dynamically or ensure type safety.
14723
- *
14724
- * @example
14725
- * ```typescript
14726
- * // Direct property access
14727
- * const value = planupdate[KEY_PLAN_UPDATE_PLAN];
14728
- *
14729
- * // Dynamic property access
14730
- * const propertyName = KEY_PLAN_UPDATE_PLAN;
14731
- * const value = planupdate[propertyName];
14732
- * ```
14733
- *
14734
- * @see {@link PlanUpdate} - The TypeScript type definition
14735
- * @see {@link KEYS_PLAN_UPDATE} - Array of all keys for this type
14736
- */
14737
- export const KEY_PLAN_UPDATE_PLAN = 'plan' as keyof PlanUpdate;
14738
-
14739
- /**
14740
- * Array of all PlanUpdate property keys
14741
- *
14742
- * @remarks
14743
- * This constant provides a readonly array containing all valid property keys for PlanUpdate objects.
14744
- * Useful for iteration, validation, and generating dynamic UI components.
14745
- *
14746
- * @example
14747
- * ```typescript
14748
- * // Iterating through all keys
14749
- * for (const key of KEYS_PLAN_UPDATE) {
14750
- * console.log(`Property: ${key}, Value: ${planupdate[key]}`);
14751
- * }
14752
- *
14753
- * // Validation
14754
- * const isValidKey = KEYS_PLAN_UPDATE.includes(someKey);
14755
- * ```
14756
- *
14757
- * @see {@link PlanUpdate} - The TypeScript type definition
14758
- */
14759
- export const KEYS_PLAN_UPDATE = [
14760
- KEY_PLAN_UPDATE_PLAN,
14761
- ] as const satisfies (keyof PlanUpdate)[];
14762
-
14763
14791
  /**
14764
14792
  * Affects
14765
14793
  *
@@ -34,7 +34,7 @@ import { operations } from '../schema';
34
34
 
35
35
  import { DomainDnssecDataCreateArray, OrganizationAttributeUpdateArray } from './schemas-arrays.d';
36
36
 
37
- import { OrganizationCredentialExtra, SignupCreate, ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainCreate, DomainUpdate, DomainRenewRequest, DomainTransferIn, EmailForwardAlias, EmailForwardAliasUpdate, NotificationCreate, NotificationUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, PlanUpdate, UserCreate, StartPasswordReset, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
37
+ import { OrganizationCredentialExtra, SignupCreate, ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainCreate, DomainUpdate, DomainRenewRequest, DomainTransferIn, EmailForwardAlias, EmailForwardAliasUpdate, NotificationCreate, NotificationUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, UserCreate, StartPasswordReset, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
38
38
 
39
39
  /**
40
40
  * Request type for GET AuthClientCredentials endpoint
@@ -3215,58 +3215,6 @@ export type PATCH_OrganizationsOrganizationId_Request_Path = PATCH_Organizations
3215
3215
  */
3216
3216
  export type PATCH_OrganizationsOrganizationId_Request_Body = PATCH_OrganizationsOrganizationId_Request['requestBody'];
3217
3217
 
3218
- /**
3219
- * Request type for PATCH OrganizationsOrganizationIdPlan endpoint
3220
- *
3221
- * Change Plan
3222
- *
3223
- * @remarks
3224
- * This type defines the complete request structure for the PATCH OrganizationsOrganizationIdPlan endpoint.
3225
- * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
3226
- * Use this type to ensure type safety when making API requests to this endpoint.
3227
- *
3228
- * @example
3229
- * Use this type to ensure type safety when making API requests to this endpoint.
3230
- *
3231
- * @path /v1/organizations/{organization_id}/plan
3232
- *
3233
- * @see {@link PATCH_OrganizationsOrganizationIdPlan_Request_Query} - Query parameters type
3234
- * @see {@link PATCH_OrganizationsOrganizationIdPlan_Request_Path} - Path parameters type
3235
- * @see {@link PATCH_OrganizationsOrganizationIdPlan_Request_Body} - Request body type
3236
- */
3237
- export type PATCH_OrganizationsOrganizationIdPlan_Request = {
3238
- parameters: {
3239
- path: operations['change_plan_v1_organizations__organization_id__plan_patch']['parameters']['path'];
3240
- };
3241
- requestBody: PlanUpdate;
3242
- }
3243
- /**
3244
- * Path parameters for PATCH /v1/organizations/{organization_id}/plan
3245
- *
3246
- * @remarks
3247
- * This type defines the path parameters for the PATCH /v1/organizations/{organization_id}/plan endpoint.
3248
- * It provides type safety for all path parameters as defined in the OpenAPI specification.
3249
- *
3250
- * @example
3251
- * Use this type to ensure type safety for path parameters.
3252
- *
3253
- * @path /v1/organizations/{organization_id}/plan
3254
- */
3255
- export type PATCH_OrganizationsOrganizationIdPlan_Request_Path = PATCH_OrganizationsOrganizationIdPlan_Request['parameters']['path'];
3256
- /**
3257
- * Request body for PATCH /v1/organizations/{organization_id}/plan
3258
- *
3259
- * @remarks
3260
- * This type defines the request body structure for the PATCH /v1/organizations/{organization_id}/plan endpoint.
3261
- * It provides type safety for the request body as defined in the OpenAPI specification.
3262
- *
3263
- * @example
3264
- * Use this type to ensure type safety for request body structure.
3265
- *
3266
- * @path /v1/organizations/{organization_id}/plan
3267
- */
3268
- export type PATCH_OrganizationsOrganizationIdPlan_Request_Body = PATCH_OrganizationsOrganizationIdPlan_Request['requestBody'];
3269
-
3270
3218
  /**
3271
3219
  * Request type for GET OrganizationsOrganizationIdPlans endpoint
3272
3220
  *
@@ -4515,61 +4515,6 @@ export type PATCH_OrganizationsByOrganizationId_Response_200 = Organization
4515
4515
  */
4516
4516
  export type PATCH_OrganizationsByOrganizationId_Response_422 = HTTPValidationError
4517
4517
 
4518
- /**
4519
- * Response types for PATCH OrganizationsByOrganizationIdPlan endpoint
4520
- *
4521
- * Change Plan
4522
- *
4523
- * @remarks
4524
- * This type defines all possible response structures for the PATCH OrganizationsByOrganizationIdPlan endpoint.
4525
- * Each response code maps to a specific response type as defined in the OpenAPI specification.
4526
- * Use this type to ensure type safety when handling API responses from this endpoint.
4527
- *
4528
-
4529
- *
4530
- * @path /v1/organizations/{organization_id}/plan
4531
- *
4532
- * @see {@link PATCH_OrganizationsByOrganizationIdPlan_Response_200} - 200 response type
4533
- * @see {@link PATCH_OrganizationsByOrganizationIdPlan_Response_422} - 422 response type
4534
- *
4535
-
4536
- */
4537
- export type PATCH_OrganizationsByOrganizationIdPlan_Response = PATCH_OrganizationsByOrganizationIdPlan_Response_200 | PATCH_OrganizationsByOrganizationIdPlan_Response_422;
4538
-
4539
- /**
4540
- * 200 response for PATCH OrganizationsByOrganizationIdPlan endpoint
4541
- *
4542
- * @remarks
4543
- * This type defines the response structure for the 200 status code
4544
- * of the PATCH OrganizationsByOrganizationIdPlan endpoint.
4545
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4546
- *
4547
-
4548
- *
4549
- * @path /v1/organizations/{organization_id}/plan
4550
- *
4551
- * @see {@link PATCH_OrganizationsByOrganizationIdPlan_Response} - The main response type definition
4552
- * @see {@link OrganizationWithBillingData} - The actual schema type definition
4553
- */
4554
- export type PATCH_OrganizationsByOrganizationIdPlan_Response_200 = OrganizationWithBillingData
4555
-
4556
- /**
4557
- * 422 response for PATCH OrganizationsByOrganizationIdPlan endpoint
4558
- *
4559
- * @remarks
4560
- * This type defines the response structure for the 422 status code
4561
- * of the PATCH OrganizationsByOrganizationIdPlan endpoint.
4562
- * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4563
- *
4564
-
4565
- *
4566
- * @path /v1/organizations/{organization_id}/plan
4567
- *
4568
- * @see {@link PATCH_OrganizationsByOrganizationIdPlan_Response} - The main response type definition
4569
- * @see {@link HTTPValidationError} - The actual schema type definition
4570
- */
4571
- export type PATCH_OrganizationsByOrganizationIdPlan_Response_422 = HTTPValidationError
4572
-
4573
4518
  /**
4574
4519
  * Response types for GET OrganizationsByOrganizationIdPlans endpoint
4575
4520
  *
@@ -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, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, Nameserver, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, PlanInfo, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, ContactSchema, DnsZone, Domain, EmailForwardAlias, EventResponse, OrganizationCredential, Organization, UserNotificationSummary, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
24
+ import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, PlanInfo, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, ContactSchema, DnsZone, Domain, EmailForwardAlias, EventResponse, OrganizationCredential, Organization, UserNotificationSummary, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
25
25
 
26
26
  /**
27
27
  * DomainDnssecDataResponse
@@ -247,6 +247,20 @@ export type DnsRrsetPatchOpArray = DnsRrsetPatchOp[];
247
247
  * @see {@link DomainAvailabilityCheck} - The individual DomainAvailabilityResponse type definition
248
248
  */
249
249
  export type DomainAvailabilityCheckArray = DomainAvailabilityCheck[];
250
+ /**
251
+ * ContactHandle
252
+ *
253
+ * @remarks
254
+ * Array type for ContactHandle objects. Used when the API returns a collection of ContactHandle instances.
255
+ *
256
+ * @example
257
+ * ```typescript
258
+ * const items: ContactHandleArray = await api.getContactHandles();
259
+ * ```
260
+ *
261
+ * @see {@link ContactHandle} - The individual ContactHandle type definition
262
+ */
263
+ export type ContactHandleArray = ContactHandle[];
250
264
  /**
251
265
  * Nameserver
252
266
  *
@@ -170,6 +170,22 @@ export type ContactConfigBase = components['schemas']['ContactConfigBase'];
170
170
  * @see {@link components} - The OpenAPI components schema definition
171
171
  */
172
172
  export type ContactCreate = components['schemas']['ContactCreate'];
173
+ /**
174
+ * ContactHandle
175
+ *
176
+ * @remarks
177
+ * Type alias for the `ContactHandle` OpenAPI schema.
178
+ * This type represents contacthandle data structures used in API requests and responses.
179
+ *
180
+ * @example
181
+ * ```typescript
182
+ * const response = await api.getContactHandle();
183
+ * const item: ContactHandle = response.results;
184
+ * ```
185
+ *
186
+ * @see {@link components} - The OpenAPI components schema definition
187
+ */
188
+ export type ContactHandle = components['schemas']['ContactHandle'];
173
189
  /**
174
190
  * ContactIdList
175
191
  *
@@ -810,6 +826,22 @@ export type DomainCheck = components['schemas']['DomainCheckResponse'];
810
826
  * @see {@link components} - The OpenAPI components schema definition
811
827
  */
812
828
  export type DomainClientStatus = components['schemas']['DomainClientStatus'];
829
+ /**
830
+ * DomainContactHandles
831
+ *
832
+ * @remarks
833
+ * Type alias for the `DomainContactHandles` OpenAPI schema.
834
+ * This type represents domaincontacthandles data structures used in API requests and responses.
835
+ *
836
+ * @example
837
+ * ```typescript
838
+ * const response = await api.getDomainContactHandles();
839
+ * const item: DomainContactHandles = response.results;
840
+ * ```
841
+ *
842
+ * @see {@link components} - The OpenAPI components schema definition
843
+ */
844
+ export type DomainContactHandles = components['schemas']['DomainContactHandles'];
813
845
  /**
814
846
  * DomainContactResponse
815
847
  *
@@ -2154,38 +2186,6 @@ export type PermissionSet = components['schemas']['PermissionSet'];
2154
2186
  * @see {@link components} - The OpenAPI components schema definition
2155
2187
  */
2156
2188
  export type PlanInfo = components['schemas']['PlanInfo'];
2157
- /**
2158
- * PlanRelation
2159
- *
2160
- * @remarks
2161
- * Type alias for the `PlanRelation` OpenAPI schema.
2162
- * This type represents planrelation data structures used in API requests and responses.
2163
- *
2164
- * @example
2165
- * ```typescript
2166
- * const response = await api.getPlanRelation();
2167
- * const item: PlanRelation = response.results;
2168
- * ```
2169
- *
2170
- * @see {@link components} - The OpenAPI components schema definition
2171
- */
2172
- export type PlanRelation = components['schemas']['PlanRelation'];
2173
- /**
2174
- * PlanUpdate
2175
- *
2176
- * @remarks
2177
- * Type alias for the `PlanUpdate` OpenAPI schema.
2178
- * This type represents planupdate data structures used in API requests and responses.
2179
- *
2180
- * @example
2181
- * ```typescript
2182
- * const response = await api.getPlanUpdate();
2183
- * const item: PlanUpdate = response.results;
2184
- * ```
2185
- *
2186
- * @see {@link components} - The OpenAPI components schema definition
2187
- */
2188
- export type PlanUpdate = components['schemas']['PlanUpdate'];
2189
2189
  /**
2190
2190
  * PostTransferRequirements
2191
2191
  *
@@ -2330,6 +2330,22 @@ export type RdapBase = components['schemas']['RdapBase'];
2330
2330
  * @see {@link components} - The OpenAPI components schema definition
2331
2331
  */
2332
2332
  export type RegistrantChangeType = components['schemas']['RegistrantChangeType'];
2333
+ /**
2334
+ * RegistryHandleAttributeType. Registry handle attribute types for type-safe attribute key access.
2335
+ *
2336
+ * @remarks
2337
+ * Type alias for the `RegistryHandleAttributeType` OpenAPI schema.
2338
+ * This type represents registryhandleattributetype data structures used in API requests and responses.
2339
+ *
2340
+ * @example
2341
+ * ```typescript
2342
+ * const response = await api.getRegistryHandleAttributeType();
2343
+ * const item: RegistryHandleAttributeType = response.results;
2344
+ * ```
2345
+ *
2346
+ * @see {@link components} - The OpenAPI components schema definition
2347
+ */
2348
+ export type RegistryHandleAttributeType = components['schemas']['RegistryHandleAttributeType'];
2333
2349
  /**
2334
2350
  * RegistryLockBase
2335
2351
  *
package/src/openapi.yaml CHANGED
@@ -234,6 +234,31 @@ components:
234
234
  - disclose
235
235
  title: ContactCreate
236
236
  type: object
237
+ ContactHandle:
238
+ properties:
239
+ attributes:
240
+ anyOf:
241
+ - additionalProperties:
242
+ $ref: '#/components/schemas/JsonValue'
243
+ propertyNames:
244
+ $ref: '#/components/schemas/RegistryHandleAttributeType'
245
+ type: object
246
+ - type: 'null'
247
+ description: Additional attributes related to the contact
248
+ title: Attributes
249
+ contact_id:
250
+ description: The contact id of the contact
251
+ examples:
252
+ - contact_01h45ytscbebyvny4gc8cr8ma2
253
+ format: typeid
254
+ pattern: ^contact_[0-7][0-9a-hjkmnpq-tv-z]{25}$
255
+ title: Contact Id
256
+ type: string
257
+ x-typeid-prefix: contact
258
+ required:
259
+ - contact_id
260
+ title: ContactHandle
261
+ type: object
237
262
  ContactIdList:
238
263
  additionalProperties:
239
264
  examples:
@@ -1165,6 +1190,14 @@ components:
1165
1190
  - clientHold
1166
1191
  title: DomainClientStatus
1167
1192
  type: string
1193
+ DomainContactHandles:
1194
+ additionalProperties:
1195
+ items:
1196
+ $ref: '#/components/schemas/ContactHandle'
1197
+ type: array
1198
+ propertyNames:
1199
+ $ref: '#/components/schemas/DomainContactType'
1200
+ type: object
1168
1201
  DomainContactResponse:
1169
1202
  properties:
1170
1203
  contact_id:
@@ -1203,8 +1236,11 @@ components:
1203
1236
  description: The auth code used for the domain
1204
1237
  title: Auth Code
1205
1238
  contacts:
1206
- $ref: '#/components/schemas/ContactIdList'
1239
+ anyOf:
1240
+ - $ref: '#/components/schemas/DomainContactHandles'
1241
+ - $ref: '#/components/schemas/ContactIdList'
1207
1242
  description: The contacts of the domain
1243
+ title: Contacts
1208
1244
  name:
1209
1245
  description: The domain to be created
1210
1246
  title: Name
@@ -1874,8 +1910,11 @@ components:
1874
1910
  title: Auth Code
1875
1911
  type: string
1876
1912
  contacts:
1877
- $ref: '#/components/schemas/ContactIdList'
1913
+ anyOf:
1914
+ - $ref: '#/components/schemas/DomainContactHandles'
1915
+ - $ref: '#/components/schemas/ContactIdList'
1878
1916
  description: The contacts of the domain
1917
+ title: Contacts
1879
1918
  name:
1880
1919
  description: The domain to be created
1881
1920
  title: Name
@@ -1909,16 +1948,8 @@ components:
1909
1948
  title: Auth Code
1910
1949
  contacts:
1911
1950
  anyOf:
1912
- - additionalProperties:
1913
- examples:
1914
- - contact_01h45ytscbebyvny4gc8cr8ma2
1915
- format: typeid
1916
- pattern: ^contact_[0-7][0-9a-hjkmnpq-tv-z]{25}$
1917
- type: string
1918
- x-typeid-prefix: contact
1919
- propertyNames:
1920
- $ref: '#/components/schemas/DomainContactType'
1921
- type: object
1951
+ - $ref: '#/components/schemas/DomainContactHandles'
1952
+ - $ref: '#/components/schemas/ContactIdList'
1922
1953
  - type: 'null'
1923
1954
  description: The new contacts of the domain
1924
1955
  examples:
@@ -3678,9 +3709,10 @@ components:
3678
3709
  - bulk_renew_expire
3679
3710
  - bulk_transfer_trade
3680
3711
  - bulk_update
3712
+ - corporate_plan
3681
3713
  - create
3682
3714
  - delete
3683
- - enterprise
3715
+ - enterprise_plan
3684
3716
  - has_accepted_tos
3685
3717
  - manage_api_keys
3686
3718
  - manage_billing
@@ -3695,10 +3727,9 @@ components:
3695
3727
  - manage_user_relations
3696
3728
  - manage_users
3697
3729
  - plan_manager
3698
- - premium
3699
- - premium_reseller
3730
+ - premium_plan
3700
3731
  - renew_expire
3701
- - starter
3732
+ - starter_plan
3702
3733
  - transfer_trade
3703
3734
  - update
3704
3735
  - verify
@@ -3753,21 +3784,6 @@ components:
3753
3784
  - amount
3754
3785
  title: PlanInfo
3755
3786
  type: object
3756
- PlanRelation:
3757
- enum:
3758
- - basic_plan
3759
- - enterprise_plan
3760
- - premium_plan
3761
- - starter_plan
3762
- title: PlanRelation
3763
- type: string
3764
- PlanUpdate:
3765
- properties:
3766
- plan:
3767
- $ref: '#/components/schemas/PlanRelation'
3768
- default: basic_plan
3769
- title: PlanUpdate
3770
- type: object
3771
3787
  PostTransferRequirements:
3772
3788
  enum:
3773
3789
  - update_contacts
@@ -3886,6 +3902,12 @@ components:
3886
3902
  - trade
3887
3903
  title: RegistrantChangeType
3888
3904
  type: string
3905
+ RegistryHandleAttributeType:
3906
+ description: Registry handle attribute types for type-safe attribute key access.
3907
+ enum:
3908
+ - at-ext-contact:type
3909
+ title: RegistryHandleAttributeType
3910
+ type: string
3889
3911
  RegistryLockBase:
3890
3912
  properties:
3891
3913
  prevents:
@@ -5192,7 +5214,7 @@ info:
5192
5214
  '
5193
5215
  summary: OpusDNS - your gateway to a seamless domain management experience.
5194
5216
  title: OpusDNS API
5195
- version: 2025-09-10-192345
5217
+ version: 2025-09-11-090517
5196
5218
  x-logo:
5197
5219
  altText: OpusDNS API Reference
5198
5220
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -8926,45 +8948,6 @@ paths:
8926
8948
  summary: Update Organization
8927
8949
  tags:
8928
8950
  - organization
8929
- /v1/organizations/{organization_id}/plan:
8930
- patch:
8931
- operationId: change_plan_v1_organizations__organization_id__plan_patch
8932
- parameters:
8933
- - in: path
8934
- name: organization_id
8935
- required: true
8936
- schema:
8937
- examples:
8938
- - organization_01h45ytscbebyvny4gc8cr8ma2
8939
- format: typeid
8940
- pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
8941
- title: Organization Id
8942
- type: string
8943
- x-typeid-prefix: organization
8944
- requestBody:
8945
- content:
8946
- application/json:
8947
- schema:
8948
- $ref: '#/components/schemas/PlanUpdate'
8949
- required: true
8950
- responses:
8951
- '200':
8952
- content:
8953
- application/json:
8954
- schema:
8955
- $ref: '#/components/schemas/OrganizationWithBillingData'
8956
- description: Successful Response
8957
- '422':
8958
- content:
8959
- application/problem+json:
8960
- schema:
8961
- $ref: '#/components/schemas/HTTPValidationError'
8962
- description: Validation Error
8963
- security:
8964
- - OAuth2PasswordBearer: []
8965
- summary: Change Plan
8966
- tags:
8967
- - organization
8968
8951
  /v1/organizations/{organization_id}/plans:
8969
8952
  get:
8970
8953
  operationId: get_current_available_plans_v1_organizations__organization_id__plans_get
package/src/schema.d.ts CHANGED
@@ -940,23 +940,6 @@ export interface paths {
940
940
  patch: operations["update_organization_v1_organizations__organization_id__patch"];
941
941
  trace?: never;
942
942
  };
943
- "/v1/organizations/{organization_id}/plan": {
944
- parameters: {
945
- query?: never;
946
- header?: never;
947
- path?: never;
948
- cookie?: never;
949
- };
950
- get?: never;
951
- put?: never;
952
- post?: never;
953
- delete?: never;
954
- options?: never;
955
- head?: never;
956
- /** Change Plan */
957
- patch: operations["change_plan_v1_organizations__organization_id__plan_patch"];
958
- trace?: never;
959
- };
960
943
  "/v1/organizations/{organization_id}/plans": {
961
944
  parameters: {
962
945
  query?: never;
@@ -1385,6 +1368,22 @@ export interface components {
1385
1368
  */
1386
1369
  title?: string | null;
1387
1370
  };
1371
+ /** ContactHandle */
1372
+ ContactHandle: {
1373
+ /**
1374
+ * Attributes
1375
+ * @description Additional attributes related to the contact
1376
+ */
1377
+ attributes?: {
1378
+ [key: string]: components["schemas"]["JsonValue"];
1379
+ } | null;
1380
+ /**
1381
+ * Contact Id
1382
+ * Format: typeid
1383
+ * @description The contact id of the contact
1384
+ */
1385
+ contact_id: TypeID<"contact">;
1386
+ };
1388
1387
  ContactIdList: {
1389
1388
  [key: string]: TypeID<"contact">;
1390
1389
  };
@@ -1988,6 +1987,9 @@ export interface components {
1988
1987
  * @enum {string}
1989
1988
  */
1990
1989
  DomainClientStatus: "clientTransferProhibited" | "clientUpdateProhibited" | "clientDeleteProhibited" | "clientRenewProhibited" | "clientHold";
1990
+ DomainContactHandles: {
1991
+ [key: string]: components["schemas"]["ContactHandle"][];
1992
+ };
1991
1993
  /** DomainContactResponse */
1992
1994
  DomainContactResponse: {
1993
1995
  /**
@@ -2011,8 +2013,11 @@ export interface components {
2011
2013
  * @description The auth code used for the domain
2012
2014
  */
2013
2015
  auth_code?: string | null;
2014
- /** @description The contacts of the domain */
2015
- contacts: components["schemas"]["ContactIdList"];
2016
+ /**
2017
+ * Contacts
2018
+ * @description The contacts of the domain
2019
+ */
2020
+ contacts: components["schemas"]["DomainContactHandles"] | components["schemas"]["ContactIdList"];
2016
2021
  /**
2017
2022
  * Name
2018
2023
  * @description The domain to be created
@@ -2434,8 +2439,11 @@ export interface components {
2434
2439
  * @description The auth code for the domain
2435
2440
  */
2436
2441
  auth_code: string;
2437
- /** @description The contacts of the domain */
2438
- contacts: components["schemas"]["ContactIdList"];
2442
+ /**
2443
+ * Contacts
2444
+ * @description The contacts of the domain
2445
+ */
2446
+ contacts: components["schemas"]["DomainContactHandles"] | components["schemas"]["ContactIdList"];
2439
2447
  /**
2440
2448
  * Name
2441
2449
  * @description The domain to be created
@@ -2460,9 +2468,7 @@ export interface components {
2460
2468
  * Contacts
2461
2469
  * @description The new contacts of the domain
2462
2470
  */
2463
- contacts?: {
2464
- [key: string]: TypeID<"contact">;
2465
- } | null;
2471
+ contacts?: components["schemas"]["DomainContactHandles"] | components["schemas"]["ContactIdList"] | null;
2466
2472
  /**
2467
2473
  * Nameservers
2468
2474
  * @description The new name servers for the domain
@@ -3655,7 +3661,7 @@ export interface components {
3655
3661
  * Permission
3656
3662
  * @enum {string}
3657
3663
  */
3658
- Permission: "acknowledge" | "bulk_create" | "bulk_delete" | "bulk_renew_expire" | "bulk_transfer_trade" | "bulk_update" | "create" | "delete" | "enterprise" | "has_accepted_tos" | "manage_api_keys" | "manage_billing" | "manage_cms_content" | "manage_contacts" | "manage_dns_zones" | "manage_domains" | "manage_email_forwards" | "manage_opusdns_api_keys" | "manage_products" | "manage_reseller" | "manage_user_relations" | "manage_users" | "plan_manager" | "premium" | "premium_reseller" | "renew_expire" | "starter" | "transfer_trade" | "update" | "verify" | "view" | "view_audit_logs";
3664
+ Permission: "acknowledge" | "bulk_create" | "bulk_delete" | "bulk_renew_expire" | "bulk_transfer_trade" | "bulk_update" | "corporate_plan" | "create" | "delete" | "enterprise_plan" | "has_accepted_tos" | "manage_api_keys" | "manage_billing" | "manage_cms_content" | "manage_contacts" | "manage_dns_zones" | "manage_domains" | "manage_email_forwards" | "manage_opusdns_api_keys" | "manage_products" | "manage_reseller" | "manage_user_relations" | "manage_users" | "plan_manager" | "premium_plan" | "renew_expire" | "starter_plan" | "transfer_trade" | "update" | "verify" | "view" | "view_audit_logs";
3659
3665
  /** PermissionSet */
3660
3666
  PermissionSet: {
3661
3667
  /** Permissions */
@@ -3694,16 +3700,6 @@ export interface components {
3694
3700
  */
3695
3701
  plan_type?: string | null;
3696
3702
  };
3697
- /**
3698
- * PlanRelation
3699
- * @enum {string}
3700
- */
3701
- PlanRelation: "basic_plan" | "enterprise_plan" | "premium_plan" | "starter_plan";
3702
- /** PlanUpdate */
3703
- PlanUpdate: {
3704
- /** @default basic_plan */
3705
- plan: components["schemas"]["PlanRelation"];
3706
- };
3707
3703
  /**
3708
3704
  * PostTransferRequirements
3709
3705
  * @enum {string}
@@ -3776,6 +3772,12 @@ export interface components {
3776
3772
  * @enum {string}
3777
3773
  */
3778
3774
  RegistrantChangeType: "update" | "trade";
3775
+ /**
3776
+ * RegistryHandleAttributeType
3777
+ * @description Registry handle attribute types for type-safe attribute key access.
3778
+ * @enum {string}
3779
+ */
3780
+ RegistryHandleAttributeType: "at-ext-contact:type";
3779
3781
  /** RegistryLockBase */
3780
3782
  RegistryLockBase: {
3781
3783
  /**
@@ -8048,41 +8050,6 @@ export interface operations {
8048
8050
  };
8049
8051
  };
8050
8052
  };
8051
- change_plan_v1_organizations__organization_id__plan_patch: {
8052
- parameters: {
8053
- query?: never;
8054
- header?: never;
8055
- path: {
8056
- organization_id: TypeID<"organization">;
8057
- };
8058
- cookie?: never;
8059
- };
8060
- requestBody: {
8061
- content: {
8062
- "application/json": components["schemas"]["PlanUpdate"];
8063
- };
8064
- };
8065
- responses: {
8066
- /** @description Successful Response */
8067
- 200: {
8068
- headers: {
8069
- [name: string]: unknown;
8070
- };
8071
- content: {
8072
- "application/json": components["schemas"]["OrganizationWithBillingData"];
8073
- };
8074
- };
8075
- /** @description Validation Error */
8076
- 422: {
8077
- headers: {
8078
- [name: string]: unknown;
8079
- };
8080
- content: {
8081
- "application/problem+json": components["schemas"]["HTTPValidationError"];
8082
- };
8083
- };
8084
- };
8085
- };
8086
8053
  get_current_available_plans_v1_organizations__organization_id__plans_get: {
8087
8054
  parameters: {
8088
8055
  query?: never;