@opusdns/api 0.67.0 → 0.68.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.67.0",
11
+ "version": "0.68.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 { AgreementType, AllocationMethodType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, 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, UserStatus, VerificationType, WalletCreditResponseStatus, ZoneSortField } from './schemas';
24
+ import { AgreementType, AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, 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, UserStatus, VerificationType, WalletCreditResponseStatus, ZoneSortField } from './schemas';
25
25
 
26
26
  /**
27
27
  * AgreementType. Auto-generated enum for AgreementType
@@ -127,6 +127,60 @@ export const ALLOCATION_METHOD_TYPE_VALUES = [
127
127
  'lottery'
128
128
  ] as const satisfies [string, ...string[]] | AllocationMethodType[];
129
129
 
130
+ /**
131
+ * AttributeType. Auto-generated enum for AttributeType
132
+ *
133
+ * @remarks
134
+ * This constant provides both object and array forms for the AttributeType enum.
135
+ * The object form allows key-value access, while the array form enables iteration and validation.
136
+ *
137
+ * @example
138
+ * ```typescript
139
+ * // Using the object form for key-value access
140
+ * const status = ATTRIBUTE_TYPE.SUCCESS;
141
+ *
142
+ * // Using the array form for iteration
143
+ * const allStatuses = ATTRIBUTE_TYPE_VALUES;
144
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
145
+ * ```
146
+ *
147
+ * @see {@link AttributeType} - The TypeScript type definition
148
+ */
149
+ export const ATTRIBUTE_TYPE = {
150
+ ENUM: "enum",
151
+ STRING: "string",
152
+ BOOLEAN: "boolean",
153
+ DATETIME: "datetime",
154
+ } as const satisfies Record<string, AttributeType>;
155
+
156
+ /**
157
+ * Array of all AttributeType enum values
158
+ *
159
+ * @remarks
160
+ * This constant provides a array containing all valid AttributeType enum values.
161
+ * Useful for iteration, validation, and generating dynamic UI components.
162
+ *
163
+ * @example
164
+ * ```typescript
165
+ * // Iterating through all values
166
+ * for (const value of ATTRIBUTE_TYPE_VALUES) {
167
+ * console.log(`Processing: ${value}`);
168
+ * }
169
+ *
170
+ * // Validation
171
+ * const isValid = ATTRIBUTE_TYPE_VALUES.includes(someValue);
172
+ * ```
173
+ *
174
+ * @see {@link AttributeType} - The TypeScript type definition
175
+ * @see {@link ATTRIBUTE_TYPE} - The object form of this enum
176
+ */
177
+ export const ATTRIBUTE_TYPE_VALUES = [
178
+ 'enum',
179
+ 'string',
180
+ 'boolean',
181
+ 'datetime'
182
+ ] as const satisfies [string, ...string[]] | AttributeType[];
183
+
130
184
  /**
131
185
  * BillingTransactionAction. Auto-generated enum for BillingTransactionAction
132
186
  *
@@ -36,10 +36,12 @@ import { BillingTransaction } from './schemas';
36
36
  import { Body_issue_organization_token_v1_auth_token_post } from './schemas';
37
37
  import { CheckoutSessionRequest } from './schemas';
38
38
  import { CheckoutSession } from './schemas';
39
+ import { ContactAttributeDefinition } from './schemas';
39
40
  import { ContactConfigBase } from './schemas';
40
41
  import { ContactCreate } from './schemas';
41
42
  import { ContactHandle } from './schemas';
42
43
  import { Contact } from './schemas';
44
+ import { ContactRoleAttributeRequirement } from './schemas';
43
45
  import { ContactSchema } from './schemas';
44
46
  import { ContactVerificationApi } from './schemas';
45
47
  import { ContactVerificationEmail } from './schemas';
@@ -132,6 +134,7 @@ import { RelationSet } from './schemas';
132
134
  import { ReservedDomainsBase } from './schemas';
133
135
  import { RgpOperations } from './schemas';
134
136
  import { SignupCreate } from './schemas';
137
+ import { Signup } from './schemas';
135
138
  import { SldLength } from './schemas';
136
139
  import { SpiceDbRelationshipUpdate } from './schemas';
137
140
  import { TermsOfServiceAccept } from './schemas';
@@ -980,6 +983,108 @@ export const KEYS_CHECKOUT_SESSION = [
980
983
  KEY_CHECKOUT_SESSION_SESSION_CLIENT_SECRET,
981
984
  ] as const satisfies (keyof CheckoutSession)[];
982
985
 
986
+ /**
987
+ * key property
988
+ *
989
+ * Unique identifier for the attribute
990
+ *
991
+ *
992
+ *
993
+ * @remarks
994
+ * This key constant provides type-safe access to the `key` property of ContactAttributeDefinition objects.
995
+ * Use this constant when you need to access properties dynamically or ensure type safety.
996
+ *
997
+ * @example
998
+ * ```typescript
999
+ * // Direct property access
1000
+ * const value = contactattributedefinition[KEY_CONTACT_ATTRIBUTE_DEFINITION_KEY];
1001
+ *
1002
+ * // Dynamic property access
1003
+ * const propertyName = KEY_CONTACT_ATTRIBUTE_DEFINITION_KEY;
1004
+ * const value = contactattributedefinition[propertyName];
1005
+ * ```
1006
+ *
1007
+ * @see {@link ContactAttributeDefinition} - The TypeScript type definition
1008
+ * @see {@link KEYS_CONTACT_ATTRIBUTE_DEFINITION} - Array of all keys for this type
1009
+ */
1010
+ export const KEY_CONTACT_ATTRIBUTE_DEFINITION_KEY = 'key' as keyof ContactAttributeDefinition;
1011
+ /**
1012
+ * type property
1013
+ *
1014
+ * Type of the attribute (e.g., 'enum', 'string', 'boolean')
1015
+ *
1016
+ *
1017
+ *
1018
+ * @remarks
1019
+ * This key constant provides type-safe access to the `type` property of ContactAttributeDefinition objects.
1020
+ * Use this constant when you need to access properties dynamically or ensure type safety.
1021
+ *
1022
+ * @example
1023
+ * ```typescript
1024
+ * // Direct property access
1025
+ * const value = contactattributedefinition[KEY_CONTACT_ATTRIBUTE_DEFINITION_TYPE];
1026
+ *
1027
+ * // Dynamic property access
1028
+ * const propertyName = KEY_CONTACT_ATTRIBUTE_DEFINITION_TYPE;
1029
+ * const value = contactattributedefinition[propertyName];
1030
+ * ```
1031
+ *
1032
+ * @see {@link ContactAttributeDefinition} - The TypeScript type definition
1033
+ * @see {@link KEYS_CONTACT_ATTRIBUTE_DEFINITION} - Array of all keys for this type
1034
+ */
1035
+ export const KEY_CONTACT_ATTRIBUTE_DEFINITION_TYPE = 'type' as keyof ContactAttributeDefinition;
1036
+ /**
1037
+ * Values
1038
+ *
1039
+ * Allowed values for enum types
1040
+ *
1041
+ *
1042
+ *
1043
+ * @remarks
1044
+ * This key constant provides type-safe access to the `values` property of ContactAttributeDefinition objects.
1045
+ * Use this constant when you need to access properties dynamically or ensure type safety.
1046
+ *
1047
+ * @example
1048
+ * ```typescript
1049
+ * // Direct property access
1050
+ * const value = contactattributedefinition[KEY_CONTACT_ATTRIBUTE_DEFINITION_VALUES];
1051
+ *
1052
+ * // Dynamic property access
1053
+ * const propertyName = KEY_CONTACT_ATTRIBUTE_DEFINITION_VALUES;
1054
+ * const value = contactattributedefinition[propertyName];
1055
+ * ```
1056
+ *
1057
+ * @see {@link ContactAttributeDefinition} - The TypeScript type definition
1058
+ * @see {@link KEYS_CONTACT_ATTRIBUTE_DEFINITION} - Array of all keys for this type
1059
+ */
1060
+ export const KEY_CONTACT_ATTRIBUTE_DEFINITION_VALUES = 'values' as keyof ContactAttributeDefinition;
1061
+
1062
+ /**
1063
+ * Array of all ContactAttributeDefinition property keys
1064
+ *
1065
+ * @remarks
1066
+ * This constant provides a readonly array containing all valid property keys for ContactAttributeDefinition objects.
1067
+ * Useful for iteration, validation, and generating dynamic UI components.
1068
+ *
1069
+ * @example
1070
+ * ```typescript
1071
+ * // Iterating through all keys
1072
+ * for (const key of KEYS_CONTACT_ATTRIBUTE_DEFINITION) {
1073
+ * console.log(`Property: ${key}, Value: ${contactattributedefinition[key]}`);
1074
+ * }
1075
+ *
1076
+ * // Validation
1077
+ * const isValidKey = KEYS_CONTACT_ATTRIBUTE_DEFINITION.includes(someKey);
1078
+ * ```
1079
+ *
1080
+ * @see {@link ContactAttributeDefinition} - The TypeScript type definition
1081
+ */
1082
+ export const KEYS_CONTACT_ATTRIBUTE_DEFINITION = [
1083
+ KEY_CONTACT_ATTRIBUTE_DEFINITION_KEY,
1084
+ KEY_CONTACT_ATTRIBUTE_DEFINITION_TYPE,
1085
+ KEY_CONTACT_ATTRIBUTE_DEFINITION_VALUES,
1086
+ ] as const satisfies (keyof ContactAttributeDefinition)[];
1087
+
983
1088
  /**
984
1089
  * Max
985
1090
  *
@@ -1903,6 +2008,83 @@ export const KEYS_CONTACT = [
1903
2008
  KEY_CONTACT_TITLE,
1904
2009
  ] as const satisfies (keyof Contact)[];
1905
2010
 
2011
+ /**
2012
+ * Attributes
2013
+ *
2014
+ * List of required attribute keys for this role
2015
+ *
2016
+ * @type {array}
2017
+ *
2018
+ *
2019
+ * @remarks
2020
+ * This key constant provides type-safe access to the `attributes` property of ContactRoleAttributeRequirement objects.
2021
+ * Use this constant when you need to access properties dynamically or ensure type safety.
2022
+ *
2023
+ * @example
2024
+ * ```typescript
2025
+ * // Direct property access
2026
+ * const value = contactroleattributerequirement[KEY_CONTACT_ROLE_ATTRIBUTE_REQUIREMENT_ATTRIBUTES];
2027
+ *
2028
+ * // Dynamic property access
2029
+ * const propertyName = KEY_CONTACT_ROLE_ATTRIBUTE_REQUIREMENT_ATTRIBUTES;
2030
+ * const value = contactroleattributerequirement[propertyName];
2031
+ * ```
2032
+ *
2033
+ * @see {@link ContactRoleAttributeRequirement} - The TypeScript type definition
2034
+ * @see {@link KEYS_CONTACT_ROLE_ATTRIBUTE_REQUIREMENT} - Array of all keys for this type
2035
+ */
2036
+ export const KEY_CONTACT_ROLE_ATTRIBUTE_REQUIREMENT_ATTRIBUTES = 'attributes' as keyof ContactRoleAttributeRequirement;
2037
+ /**
2038
+ * role property
2039
+ *
2040
+ * The role this requirement applies to
2041
+ *
2042
+ *
2043
+ *
2044
+ * @remarks
2045
+ * This key constant provides type-safe access to the `role` property of ContactRoleAttributeRequirement objects.
2046
+ * Use this constant when you need to access properties dynamically or ensure type safety.
2047
+ *
2048
+ * @example
2049
+ * ```typescript
2050
+ * // Direct property access
2051
+ * const value = contactroleattributerequirement[KEY_CONTACT_ROLE_ATTRIBUTE_REQUIREMENT_ROLE];
2052
+ *
2053
+ * // Dynamic property access
2054
+ * const propertyName = KEY_CONTACT_ROLE_ATTRIBUTE_REQUIREMENT_ROLE;
2055
+ * const value = contactroleattributerequirement[propertyName];
2056
+ * ```
2057
+ *
2058
+ * @see {@link ContactRoleAttributeRequirement} - The TypeScript type definition
2059
+ * @see {@link KEYS_CONTACT_ROLE_ATTRIBUTE_REQUIREMENT} - Array of all keys for this type
2060
+ */
2061
+ export const KEY_CONTACT_ROLE_ATTRIBUTE_REQUIREMENT_ROLE = 'role' as keyof ContactRoleAttributeRequirement;
2062
+
2063
+ /**
2064
+ * Array of all ContactRoleAttributeRequirement property keys
2065
+ *
2066
+ * @remarks
2067
+ * This constant provides a readonly array containing all valid property keys for ContactRoleAttributeRequirement objects.
2068
+ * Useful for iteration, validation, and generating dynamic UI components.
2069
+ *
2070
+ * @example
2071
+ * ```typescript
2072
+ * // Iterating through all keys
2073
+ * for (const key of KEYS_CONTACT_ROLE_ATTRIBUTE_REQUIREMENT) {
2074
+ * console.log(`Property: ${key}, Value: ${contactroleattributerequirement[key]}`);
2075
+ * }
2076
+ *
2077
+ * // Validation
2078
+ * const isValidKey = KEYS_CONTACT_ROLE_ATTRIBUTE_REQUIREMENT.includes(someKey);
2079
+ * ```
2080
+ *
2081
+ * @see {@link ContactRoleAttributeRequirement} - The TypeScript type definition
2082
+ */
2083
+ export const KEYS_CONTACT_ROLE_ATTRIBUTE_REQUIREMENT = [
2084
+ KEY_CONTACT_ROLE_ATTRIBUTE_REQUIREMENT_ATTRIBUTES,
2085
+ KEY_CONTACT_ROLE_ATTRIBUTE_REQUIREMENT_ROLE,
2086
+ ] as const satisfies (keyof ContactRoleAttributeRequirement)[];
2087
+
1906
2088
  /**
1907
2089
  * City
1908
2090
  *
@@ -3162,6 +3344,32 @@ export const KEY_CONTACTS_BASE_AUTHINFO_REQUIRED = 'authinfo_required' as keyof
3162
3344
  * @see {@link KEYS_CONTACTS_BASE} - Array of all keys for this type
3163
3345
  */
3164
3346
  export const KEY_CONTACTS_BASE_IS_THICK = 'is_thick' as keyof ContactsBase;
3347
+ /**
3348
+ * Possible Attributes
3349
+ *
3350
+ * List of possible attributes that can be set for this TLD
3351
+ *
3352
+ * @type {array}
3353
+ *
3354
+ *
3355
+ * @remarks
3356
+ * This key constant provides type-safe access to the `possible_attributes` property of ContactsBase objects.
3357
+ * Use this constant when you need to access properties dynamically or ensure type safety.
3358
+ *
3359
+ * @example
3360
+ * ```typescript
3361
+ * // Direct property access
3362
+ * const value = contactsbase[KEY_CONTACTS_BASE_POSSIBLE_ATTRIBUTES];
3363
+ *
3364
+ * // Dynamic property access
3365
+ * const propertyName = KEY_CONTACTS_BASE_POSSIBLE_ATTRIBUTES;
3366
+ * const value = contactsbase[propertyName];
3367
+ * ```
3368
+ *
3369
+ * @see {@link ContactsBase} - The TypeScript type definition
3370
+ * @see {@link KEYS_CONTACTS_BASE} - Array of all keys for this type
3371
+ */
3372
+ export const KEY_CONTACTS_BASE_POSSIBLE_ATTRIBUTES = 'possible_attributes' as keyof ContactsBase;
3165
3373
  /**
3166
3374
  * Privacy Proxy
3167
3375
  *
@@ -3212,6 +3420,32 @@ export const KEY_CONTACTS_BASE_PRIVACY_PROXY = 'privacy_proxy' as keyof Contacts
3212
3420
  * @see {@link KEYS_CONTACTS_BASE} - Array of all keys for this type
3213
3421
  */
3214
3422
  export const KEY_CONTACTS_BASE_REGISTRANT_CHANGE = 'registrant_change' as keyof ContactsBase;
3423
+ /**
3424
+ * Required Attributes
3425
+ *
3426
+ * List of attribute requirements by role
3427
+ *
3428
+ * @type {array}
3429
+ *
3430
+ *
3431
+ * @remarks
3432
+ * This key constant provides type-safe access to the `required_attributes` property of ContactsBase objects.
3433
+ * Use this constant when you need to access properties dynamically or ensure type safety.
3434
+ *
3435
+ * @example
3436
+ * ```typescript
3437
+ * // Direct property access
3438
+ * const value = contactsbase[KEY_CONTACTS_BASE_REQUIRED_ATTRIBUTES];
3439
+ *
3440
+ * // Dynamic property access
3441
+ * const propertyName = KEY_CONTACTS_BASE_REQUIRED_ATTRIBUTES;
3442
+ * const value = contactsbase[propertyName];
3443
+ * ```
3444
+ *
3445
+ * @see {@link ContactsBase} - The TypeScript type definition
3446
+ * @see {@link KEYS_CONTACTS_BASE} - Array of all keys for this type
3447
+ */
3448
+ export const KEY_CONTACTS_BASE_REQUIRED_ATTRIBUTES = 'required_attributes' as keyof ContactsBase;
3215
3449
  /**
3216
3450
  * Support Check
3217
3451
  *
@@ -3361,8 +3595,10 @@ export const KEY_CONTACTS_BASE_SUPPORTED_ROLES = 'supported_roles' as keyof Cont
3361
3595
  export const KEYS_CONTACTS_BASE = [
3362
3596
  KEY_CONTACTS_BASE_AUTHINFO_REQUIRED,
3363
3597
  KEY_CONTACTS_BASE_IS_THICK,
3598
+ KEY_CONTACTS_BASE_POSSIBLE_ATTRIBUTES,
3364
3599
  KEY_CONTACTS_BASE_PRIVACY_PROXY,
3365
3600
  KEY_CONTACTS_BASE_REGISTRANT_CHANGE,
3601
+ KEY_CONTACTS_BASE_REQUIRED_ATTRIBUTES,
3366
3602
  KEY_CONTACTS_BASE_SUPPORT_CHECK,
3367
3603
  KEY_CONTACTS_BASE_SUPPORT_CLIENT_CONTACT_ID,
3368
3604
  KEY_CONTACTS_BASE_SUPPORT_TRANSFER,
@@ -15822,6 +16058,80 @@ export const KEYS_SIGNUP_CREATE = [
15822
16058
  KEY_SIGNUP_CREATE_USER,
15823
16059
  ] as const satisfies (keyof SignupCreate)[];
15824
16060
 
16061
+ /**
16062
+ * organization property
16063
+ *
16064
+ *
16065
+ *
16066
+ *
16067
+ * @remarks
16068
+ * This key constant provides type-safe access to the `organization` property of Signup objects.
16069
+ * Use this constant when you need to access properties dynamically or ensure type safety.
16070
+ *
16071
+ * @example
16072
+ * ```typescript
16073
+ * // Direct property access
16074
+ * const value = signup[KEY_SIGNUP_ORGANIZATION];
16075
+ *
16076
+ * // Dynamic property access
16077
+ * const propertyName = KEY_SIGNUP_ORGANIZATION;
16078
+ * const value = signup[propertyName];
16079
+ * ```
16080
+ *
16081
+ * @see {@link Signup} - The TypeScript type definition
16082
+ * @see {@link KEYS_SIGNUP} - Array of all keys for this type
16083
+ */
16084
+ export const KEY_SIGNUP_ORGANIZATION = 'organization' as keyof Signup;
16085
+ /**
16086
+ * user property
16087
+ *
16088
+ *
16089
+ *
16090
+ *
16091
+ * @remarks
16092
+ * This key constant provides type-safe access to the `user` property of Signup objects.
16093
+ * Use this constant when you need to access properties dynamically or ensure type safety.
16094
+ *
16095
+ * @example
16096
+ * ```typescript
16097
+ * // Direct property access
16098
+ * const value = signup[KEY_SIGNUP_USER];
16099
+ *
16100
+ * // Dynamic property access
16101
+ * const propertyName = KEY_SIGNUP_USER;
16102
+ * const value = signup[propertyName];
16103
+ * ```
16104
+ *
16105
+ * @see {@link Signup} - The TypeScript type definition
16106
+ * @see {@link KEYS_SIGNUP} - Array of all keys for this type
16107
+ */
16108
+ export const KEY_SIGNUP_USER = 'user' as keyof Signup;
16109
+
16110
+ /**
16111
+ * Array of all Signup property keys
16112
+ *
16113
+ * @remarks
16114
+ * This constant provides a readonly array containing all valid property keys for Signup objects.
16115
+ * Useful for iteration, validation, and generating dynamic UI components.
16116
+ *
16117
+ * @example
16118
+ * ```typescript
16119
+ * // Iterating through all keys
16120
+ * for (const key of KEYS_SIGNUP) {
16121
+ * console.log(`Property: ${key}, Value: ${signup[key]}`);
16122
+ * }
16123
+ *
16124
+ * // Validation
16125
+ * const isValidKey = KEYS_SIGNUP.includes(someKey);
16126
+ * ```
16127
+ *
16128
+ * @see {@link Signup} - The TypeScript type definition
16129
+ */
16130
+ export const KEYS_SIGNUP = [
16131
+ KEY_SIGNUP_ORGANIZATION,
16132
+ KEY_SIGNUP_USER,
16133
+ ] as const satisfies (keyof Signup)[];
16134
+
15825
16135
  /**
15826
16136
  * Max
15827
16137
  *
@@ -34,7 +34,7 @@
34
34
 
35
35
  import { DomainDnssecDataArray, OrganizationAttribute2Array, CustomerCreditCardPaymentMethodArray, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
36
36
 
37
- import { Pagination_OrganizationCredential, Problem, HTTPValidationError, OrganizationCredentialCreated, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DnsZoneSummary, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, Pagination_EmailForwardAlias, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, CheckoutSession, WalletCreditResponseWithBalance, GetCurrentAvailablePlans, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
37
+ import { Pagination_OrganizationCredential, Problem, HTTPValidationError, OrganizationCredentialCreated, Signup, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DnsZoneSummary, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, Pagination_EmailForwardAlias, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, CheckoutSession, WalletCreditResponseWithBalance, GetCurrentAvailablePlans, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
38
38
 
39
39
  /**
40
40
  * Response types for GET AuthClientCredentials endpoint
@@ -310,12 +310,30 @@ export type POST_AuthLogout_Response_401 = Problem
310
310
  *
311
311
  * @path /v1/auth/signup
312
312
  *
313
+ * @see {@link POST_AuthSignup_Response_200} - 200 response type
313
314
  * @see {@link POST_AuthSignup_Response_409} - 409 response type
314
315
  * @see {@link POST_AuthSignup_Response_422} - 422 response type
315
316
  *
316
317
 
317
318
  */
318
- export type POST_AuthSignup_Response = POST_AuthSignup_Response_409 | POST_AuthSignup_Response_422;
319
+ export type POST_AuthSignup_Response = POST_AuthSignup_Response_200 | POST_AuthSignup_Response_409 | POST_AuthSignup_Response_422;
320
+
321
+ /**
322
+ * 200 response for POST AuthSignup endpoint
323
+ *
324
+ * @remarks
325
+ * This type defines the response structure for the 200 status code
326
+ * of the POST AuthSignup endpoint.
327
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
328
+ *
329
+
330
+ *
331
+ * @path /v1/auth/signup
332
+ *
333
+ * @see {@link POST_AuthSignup_Response} - The main response type definition
334
+ * @see {@link Signup} - The actual schema type definition
335
+ */
336
+ export type POST_AuthSignup_Response_200 = Signup
319
337
 
320
338
  /**
321
339
  * 409 response for POST AuthSignup endpoint
@@ -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, CustomerCreditCardPaymentMethod, 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, BillingTransaction, ContactSchema, DnsZone, Domain, EmailForwardAlias, EventResponse, OrganizationCredential, Organization, Period, Permission, PremiumAffectsType, Relation, UserAgreementAcceptance, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
24
+ import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, CustomerCreditCardPaymentMethod, TldResponseShort, RegistryHandleAttributeType, ContactAttributeDefinition, ContactRoleAttributeRequirement, 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, BillingTransaction, ContactSchema, DnsZone, Domain, EmailForwardAlias, EventResponse, OrganizationCredential, Organization, Period, Permission, PremiumAffectsType, Relation, UserAgreementAcceptance, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
25
25
 
26
26
  /**
27
27
  * DomainDnssecDataResponse
@@ -121,6 +121,48 @@ export type CustomerCreditCardPaymentMethodArray = CustomerCreditCardPaymentMeth
121
121
  * @see {@link TldResponseShort} - The individual TldResponseShort type definition
122
122
  */
123
123
  export type TldResponseShortArray = TldResponseShort[];
124
+ /**
125
+ * RegistryHandleAttributeType. Registry handle attribute types for type-safe attribute key access.
126
+ *
127
+ * @remarks
128
+ * Array type for RegistryHandleAttributeType objects. Used when the API returns a collection of RegistryHandleAttributeType instances.
129
+ *
130
+ * @example
131
+ * ```typescript
132
+ * const items: RegistryHandleAttributeTypeArray = await api.getRegistryHandleAttributeTypes();
133
+ * ```
134
+ *
135
+ * @see {@link RegistryHandleAttributeType} - The individual RegistryHandleAttributeType type definition
136
+ */
137
+ export type RegistryHandleAttributeTypeArray = RegistryHandleAttributeType[];
138
+ /**
139
+ * ContactAttributeDefinition. Definition of a possible attribute for a TLD.
140
+ *
141
+ * @remarks
142
+ * Array type for ContactAttributeDefinition objects. Used when the API returns a collection of ContactAttributeDefinition instances.
143
+ *
144
+ * @example
145
+ * ```typescript
146
+ * const items: ContactAttributeDefinitionArray = await api.getContactAttributeDefinitions();
147
+ * ```
148
+ *
149
+ * @see {@link ContactAttributeDefinition} - The individual ContactAttributeDefinition type definition
150
+ */
151
+ export type ContactAttributeDefinitionArray = ContactAttributeDefinition[];
152
+ /**
153
+ * ContactRoleAttributeRequirement. Attribute requirements for a specific contact role.
154
+ *
155
+ * @remarks
156
+ * Array type for ContactRoleAttributeRequirement objects. Used when the API returns a collection of ContactRoleAttributeRequirement instances.
157
+ *
158
+ * @example
159
+ * ```typescript
160
+ * const items: ContactRoleAttributeRequirementArray = await api.getContactRoleAttributeRequirements();
161
+ * ```
162
+ *
163
+ * @see {@link ContactRoleAttributeRequirement} - The individual ContactRoleAttributeRequirement type definition
164
+ */
165
+ export type ContactRoleAttributeRequirementArray = ContactRoleAttributeRequirement[];
124
166
  /**
125
167
  * PostalAddressType
126
168
  *
@@ -74,6 +74,22 @@ export type AllocationMethodType = components['schemas']['AllocationMethodType']
74
74
  * @see {@link components} - The OpenAPI components schema definition
75
75
  */
76
76
  export type AllowedNumberOfNameserverBase = components['schemas']['AllowedNumberOfNameserverBase'];
77
+ /**
78
+ * AttributeType
79
+ *
80
+ * @remarks
81
+ * Type alias for the `AttributeType` OpenAPI schema.
82
+ * This type represents attributetype data structures used in API requests and responses.
83
+ *
84
+ * @example
85
+ * ```typescript
86
+ * const response = await api.getAttributeType();
87
+ * const item: AttributeType = response.results;
88
+ * ```
89
+ *
90
+ * @see {@link components} - The OpenAPI components schema definition
91
+ */
92
+ export type AttributeType = components['schemas']['AttributeType'];
77
93
  /**
78
94
  * BillingMetadata
79
95
  *
@@ -234,6 +250,22 @@ export type CheckoutSessionRequest = components['schemas']['CheckoutSessionReque
234
250
  * @see {@link components} - The OpenAPI components schema definition
235
251
  */
236
252
  export type CheckoutSession = components['schemas']['CheckoutSessionResponse'];
253
+ /**
254
+ * ContactAttributeDefinition. Definition of a possible attribute for a TLD.
255
+ *
256
+ * @remarks
257
+ * Type alias for the `ContactAttributeDefinition` OpenAPI schema.
258
+ * This type represents contactattributedefinition data structures used in API requests and responses.
259
+ *
260
+ * @example
261
+ * ```typescript
262
+ * const response = await api.getContactAttributeDefinition();
263
+ * const item: ContactAttributeDefinition = response.results;
264
+ * ```
265
+ *
266
+ * @see {@link components} - The OpenAPI components schema definition
267
+ */
268
+ export type ContactAttributeDefinition = components['schemas']['ContactAttributeDefinition'];
237
269
  /**
238
270
  * ContactConfigBase
239
271
  *
@@ -314,6 +346,22 @@ export type ContactIdList = components['schemas']['ContactIdList'];
314
346
  * @see {@link components} - The OpenAPI components schema definition
315
347
  */
316
348
  export type Contact = components['schemas']['ContactResponse'];
349
+ /**
350
+ * ContactRoleAttributeRequirement. Attribute requirements for a specific contact role.
351
+ *
352
+ * @remarks
353
+ * Type alias for the `ContactRoleAttributeRequirement` OpenAPI schema.
354
+ * This type represents contactroleattributerequirement data structures used in API requests and responses.
355
+ *
356
+ * @example
357
+ * ```typescript
358
+ * const response = await api.getContactRoleAttributeRequirement();
359
+ * const item: ContactRoleAttributeRequirement = response.results;
360
+ * ```
361
+ *
362
+ * @see {@link components} - The OpenAPI components schema definition
363
+ */
364
+ export type ContactRoleAttributeRequirement = components['schemas']['ContactRoleAttributeRequirement'];
317
365
  /**
318
366
  * ContactRoleType
319
367
  *
@@ -2591,6 +2639,22 @@ export type RgpOperations = components['schemas']['RgpOperations'];
2591
2639
  * @see {@link components} - The OpenAPI components schema definition
2592
2640
  */
2593
2641
  export type SignupCreate = components['schemas']['SignupCreate'];
2642
+ /**
2643
+ * SignupResponse
2644
+ *
2645
+ * @remarks
2646
+ * Type alias for the `SignupResponse` OpenAPI schema.
2647
+ * This type represents signupresponse data structures used in API requests and responses.
2648
+ *
2649
+ * @example
2650
+ * ```typescript
2651
+ * const response = await api.getSignup();
2652
+ * const item: Signup = response.results;
2653
+ * ```
2654
+ *
2655
+ * @see {@link components} - The OpenAPI components schema definition
2656
+ */
2657
+ export type Signup = components['schemas']['SignupResponse'];
2594
2658
  /**
2595
2659
  * SldLength
2596
2660
  *
package/src/openapi.yaml CHANGED
@@ -30,6 +30,14 @@ components:
30
30
  - max
31
31
  title: AllowedNumberOfNameserverBase
32
32
  type: object
33
+ AttributeType:
34
+ enum:
35
+ - enum
36
+ - string
37
+ - boolean
38
+ - datetime
39
+ title: AttributeType
40
+ type: string
33
41
  BillingMetadata:
34
42
  properties:
35
43
  billing_model:
@@ -225,6 +233,28 @@ components:
225
233
  - session_client_secret
226
234
  title: CheckoutSessionResponse
227
235
  type: object
236
+ ContactAttributeDefinition:
237
+ description: Definition of a possible attribute for a TLD.
238
+ properties:
239
+ key:
240
+ $ref: '#/components/schemas/RegistryHandleAttributeType'
241
+ description: Unique identifier for the attribute
242
+ type:
243
+ $ref: '#/components/schemas/AttributeType'
244
+ description: Type of the attribute (e.g., 'enum', 'string', 'boolean')
245
+ values:
246
+ anyOf:
247
+ - items:
248
+ type: string
249
+ type: array
250
+ - type: 'null'
251
+ description: Allowed values for enum types
252
+ title: Values
253
+ required:
254
+ - key
255
+ - type
256
+ title: ContactAttributeDefinition
257
+ type: object
228
258
  ContactConfigBase:
229
259
  properties:
230
260
  max:
@@ -458,6 +488,23 @@ components:
458
488
  - disclose
459
489
  title: ContactResponse
460
490
  type: object
491
+ ContactRoleAttributeRequirement:
492
+ description: Attribute requirements for a specific contact role.
493
+ properties:
494
+ attributes:
495
+ description: List of required attribute keys for this role
496
+ items:
497
+ $ref: '#/components/schemas/RegistryHandleAttributeType'
498
+ title: Attributes
499
+ type: array
500
+ role:
501
+ $ref: '#/components/schemas/ContactRoleType'
502
+ description: The role this requirement applies to
503
+ required:
504
+ - role
505
+ - attributes
506
+ title: ContactRoleAttributeRequirement
507
+ type: object
461
508
  ContactRoleType:
462
509
  enum:
463
510
  - registrant
@@ -781,6 +828,12 @@ components:
781
828
  - type: 'null'
782
829
  description: Whether the registry supports thick contacts
783
830
  title: Is Thick
831
+ possible_attributes:
832
+ description: List of possible attributes that can be set for this TLD
833
+ items:
834
+ $ref: '#/components/schemas/ContactAttributeDefinition'
835
+ title: Possible Attributes
836
+ type: array
784
837
  privacy_proxy:
785
838
  anyOf:
786
839
  - type: boolean
@@ -792,6 +845,12 @@ components:
792
845
  - $ref: '#/components/schemas/RegistrantChangeType'
793
846
  - type: 'null'
794
847
  description: Whether the registrant can change through update or trade
848
+ required_attributes:
849
+ description: List of attribute requirements by role
850
+ items:
851
+ $ref: '#/components/schemas/ContactRoleAttributeRequirement'
852
+ title: Required Attributes
853
+ type: array
795
854
  support_check:
796
855
  anyOf:
797
856
  - type: boolean
@@ -4133,6 +4192,17 @@ components:
4133
4192
  - organization
4134
4193
  title: SignupCreate
4135
4194
  type: object
4195
+ SignupResponse:
4196
+ properties:
4197
+ organization:
4198
+ $ref: '#/components/schemas/Organization'
4199
+ user:
4200
+ $ref: '#/components/schemas/User'
4201
+ required:
4202
+ - user
4203
+ - organization
4204
+ title: SignupResponse
4205
+ type: object
4136
4206
  SldLength:
4137
4207
  properties:
4138
4208
  max:
@@ -5126,7 +5196,7 @@ info:
5126
5196
  '
5127
5197
  summary: OpusDNS - your gateway to a seamless domain management experience.
5128
5198
  title: OpusDNS API
5129
- version: 2025-09-29-070341
5199
+ version: 2025-09-29-070622
5130
5200
  x-logo:
5131
5201
  altText: OpusDNS API Reference
5132
5202
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -5323,10 +5393,7 @@ paths:
5323
5393
  content:
5324
5394
  application/json:
5325
5395
  schema:
5326
- anyOf:
5327
- - $ref: '#/components/schemas/OrganizationTokenResponse'
5328
- - $ref: '#/components/schemas/UserTokenResponse'
5329
- title: Response Signup V1 Auth Signup Post
5396
+ $ref: '#/components/schemas/SignupResponse'
5330
5397
  description: Successful Response
5331
5398
  '409':
5332
5399
  content:
package/src/schema.d.ts CHANGED
@@ -1236,6 +1236,11 @@ export interface components {
1236
1236
  */
1237
1237
  min: number;
1238
1238
  };
1239
+ /**
1240
+ * AttributeType
1241
+ * @enum {string}
1242
+ */
1243
+ AttributeType: "enum" | "string" | "boolean" | "datetime";
1239
1244
  /** BillingMetadata */
1240
1245
  BillingMetadata: {
1241
1246
  /**
@@ -1379,6 +1384,21 @@ export interface components {
1379
1384
  */
1380
1385
  session_client_secret: string;
1381
1386
  };
1387
+ /**
1388
+ * ContactAttributeDefinition
1389
+ * @description Definition of a possible attribute for a TLD.
1390
+ */
1391
+ ContactAttributeDefinition: {
1392
+ /** @description Unique identifier for the attribute */
1393
+ key: components["schemas"]["RegistryHandleAttributeType"];
1394
+ /** @description Type of the attribute (e.g., 'enum', 'string', 'boolean') */
1395
+ type: components["schemas"]["AttributeType"];
1396
+ /**
1397
+ * Values
1398
+ * @description Allowed values for enum types
1399
+ */
1400
+ values?: string[] | null;
1401
+ };
1382
1402
  /** ContactConfigBase */
1383
1403
  ContactConfigBase: {
1384
1404
  /**
@@ -1553,6 +1573,19 @@ export interface components {
1553
1573
  */
1554
1574
  title?: string | null;
1555
1575
  };
1576
+ /**
1577
+ * ContactRoleAttributeRequirement
1578
+ * @description Attribute requirements for a specific contact role.
1579
+ */
1580
+ ContactRoleAttributeRequirement: {
1581
+ /**
1582
+ * Attributes
1583
+ * @description List of required attribute keys for this role
1584
+ */
1585
+ attributes: components["schemas"]["RegistryHandleAttributeType"][];
1586
+ /** @description The role this requirement applies to */
1587
+ role: components["schemas"]["ContactRoleType"];
1588
+ };
1556
1589
  /**
1557
1590
  * ContactRoleType
1558
1591
  * @enum {string}
@@ -1805,6 +1838,11 @@ export interface components {
1805
1838
  * @description Whether the registry supports thick contacts
1806
1839
  */
1807
1840
  is_thick?: boolean | null;
1841
+ /**
1842
+ * Possible Attributes
1843
+ * @description List of possible attributes that can be set for this TLD
1844
+ */
1845
+ possible_attributes?: components["schemas"]["ContactAttributeDefinition"][];
1808
1846
  /**
1809
1847
  * Privacy Proxy
1810
1848
  * @description Whether a privacy service is allowed
@@ -1812,6 +1850,11 @@ export interface components {
1812
1850
  privacy_proxy?: boolean | null;
1813
1851
  /** @description Whether the registrant can change through update or trade */
1814
1852
  registrant_change?: components["schemas"]["RegistrantChangeType"] | null;
1853
+ /**
1854
+ * Required Attributes
1855
+ * @description List of attribute requirements by role
1856
+ */
1857
+ required_attributes?: components["schemas"]["ContactRoleAttributeRequirement"][];
1815
1858
  /**
1816
1859
  * Support Check
1817
1860
  * @description Whether the registry supports contact checks
@@ -3921,6 +3964,11 @@ export interface components {
3921
3964
  /** @description User signup to platform. */
3922
3965
  user: components["schemas"]["UserCreate"];
3923
3966
  };
3967
+ /** SignupResponse */
3968
+ SignupResponse: {
3969
+ organization: components["schemas"]["Organization"];
3970
+ user: components["schemas"]["User"];
3971
+ };
3924
3972
  /** SldLength */
3925
3973
  SldLength: {
3926
3974
  /**
@@ -4764,7 +4812,7 @@ export interface operations {
4764
4812
  [name: string]: unknown;
4765
4813
  };
4766
4814
  content: {
4767
- "application/json": components["schemas"]["OrganizationTokenResponse"] | components["schemas"]["UserTokenResponse"];
4815
+ "application/json": components["schemas"]["SignupResponse"];
4768
4816
  };
4769
4817
  };
4770
4818
  /** @description Conflict */