@opusdns/api 0.76.0 → 0.78.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.76.0",
11
+ "version": "0.78.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, 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';
24
+ import { AgreementType, AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ContactRoleType, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, 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
@@ -957,6 +957,54 @@ export const DNSSEC_STATUS_VALUES = [
957
957
  'disabled'
958
958
  ] as const satisfies [string, ...string[]] | DnssecStatus[];
959
959
 
960
+ /**
961
+ * DomainAttributeKey. Auto-generated enum for DomainAttributeKey
962
+ *
963
+ * @remarks
964
+ * This constant provides both object and array forms for the DomainAttributeKey enum.
965
+ * The object form allows key-value access, while the array form enables iteration and validation.
966
+ *
967
+ * @example
968
+ * ```typescript
969
+ * // Using the object form for key-value access
970
+ * const status = DOMAIN_ATTRIBUTE_KEY.SUCCESS;
971
+ *
972
+ * // Using the array form for iteration
973
+ * const allStatuses = DOMAIN_ATTRIBUTE_KEY_VALUES;
974
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
975
+ * ```
976
+ *
977
+ * @see {@link DomainAttributeKey} - The TypeScript type definition
978
+ */
979
+ export const DOMAIN_ATTRIBUTE_KEY = {
980
+ AUTO_RENEW_PERIOD: "auto_renew_period",
981
+ } as const satisfies Record<string, DomainAttributeKey>;
982
+
983
+ /**
984
+ * Array of all DomainAttributeKey enum values
985
+ *
986
+ * @remarks
987
+ * This constant provides a array containing all valid DomainAttributeKey enum values.
988
+ * Useful for iteration, validation, and generating dynamic UI components.
989
+ *
990
+ * @example
991
+ * ```typescript
992
+ * // Iterating through all values
993
+ * for (const value of DOMAIN_ATTRIBUTE_KEY_VALUES) {
994
+ * console.log(`Processing: ${value}`);
995
+ * }
996
+ *
997
+ * // Validation
998
+ * const isValid = DOMAIN_ATTRIBUTE_KEY_VALUES.includes(someValue);
999
+ * ```
1000
+ *
1001
+ * @see {@link DomainAttributeKey} - The TypeScript type definition
1002
+ * @see {@link DOMAIN_ATTRIBUTE_KEY} - The object form of this enum
1003
+ */
1004
+ export const DOMAIN_ATTRIBUTE_KEY_VALUES = [
1005
+ 'auto_renew_period'
1006
+ ] as const satisfies [string, ...string[]] | DomainAttributeKey[];
1007
+
960
1008
  /**
961
1009
  * DomainAvailabilityStatus. Auto-generated enum for DomainAvailabilityStatus
962
1010
  *
@@ -6110,7 +6110,7 @@ export const KEY_DOMAIN_CREATE_NAMESERVERS = 'nameservers' as keyof DomainCreate
6110
6110
  /**
6111
6111
  * period property
6112
6112
  *
6113
- * How long the domain should be registered for
6113
+ * The registration period of the domain
6114
6114
  *
6115
6115
  *
6116
6116
  *
@@ -8959,6 +8959,31 @@ export const KEYS_DOMAIN_SUMMARY = [
8959
8959
  KEY_DOMAIN_SUMMARY_ORGANIZATION_ID,
8960
8960
  ] as const satisfies (keyof DomainSummary)[];
8961
8961
 
8962
+ /**
8963
+ * Attributes
8964
+ *
8965
+ * Additional attributes of the domain
8966
+ *
8967
+ *
8968
+ *
8969
+ * @remarks
8970
+ * This key constant provides type-safe access to the `attributes` property of DomainTransferIn objects.
8971
+ * Use this constant when you need to access properties dynamically or ensure type safety.
8972
+ *
8973
+ * @example
8974
+ * ```typescript
8975
+ * // Direct property access
8976
+ * const value = domaintransferin[KEY_DOMAIN_TRANSFER_IN_ATTRIBUTES];
8977
+ *
8978
+ * // Dynamic property access
8979
+ * const propertyName = KEY_DOMAIN_TRANSFER_IN_ATTRIBUTES;
8980
+ * const value = domaintransferin[propertyName];
8981
+ * ```
8982
+ *
8983
+ * @see {@link DomainTransferIn} - The TypeScript type definition
8984
+ * @see {@link KEYS_DOMAIN_TRANSFER_IN} - Array of all keys for this type
8985
+ */
8986
+ export const KEY_DOMAIN_TRANSFER_IN_ATTRIBUTES = 'attributes' as keyof DomainTransferIn;
8962
8987
  /**
8963
8988
  * Auth Code
8964
8989
  *
@@ -9134,6 +9159,7 @@ export const KEY_DOMAIN_TRANSFER_IN_RENEWAL_MODE = 'renewal_mode' as keyof Domai
9134
9159
  * @see {@link DomainTransferIn} - The TypeScript type definition
9135
9160
  */
9136
9161
  export const KEYS_DOMAIN_TRANSFER_IN = [
9162
+ KEY_DOMAIN_TRANSFER_IN_ATTRIBUTES,
9137
9163
  KEY_DOMAIN_TRANSFER_IN_AUTH_CODE,
9138
9164
  KEY_DOMAIN_TRANSFER_IN_CONTACTS,
9139
9165
  KEY_DOMAIN_TRANSFER_IN_CREATE_ZONE,
@@ -311,12 +311,13 @@ export type POST_AuthLogout_Response_401 = Problem
311
311
  * @path /v1/auth/signup
312
312
  *
313
313
  * @see {@link POST_AuthSignup_Response_200} - 200 response type
314
+ * @see {@link POST_AuthSignup_Response_403} - 403 response type
314
315
  * @see {@link POST_AuthSignup_Response_409} - 409 response type
315
316
  * @see {@link POST_AuthSignup_Response_422} - 422 response type
316
317
  *
317
318
 
318
319
  */
319
- export type POST_AuthSignup_Response = POST_AuthSignup_Response_200 | POST_AuthSignup_Response_409 | POST_AuthSignup_Response_422;
320
+ export type POST_AuthSignup_Response = POST_AuthSignup_Response_200 | POST_AuthSignup_Response_403 | POST_AuthSignup_Response_409 | POST_AuthSignup_Response_422;
320
321
 
321
322
  /**
322
323
  * 200 response for POST AuthSignup endpoint
@@ -335,6 +336,23 @@ export type POST_AuthSignup_Response = POST_AuthSignup_Response_200 | POST_AuthS
335
336
  */
336
337
  export type POST_AuthSignup_Response_200 = Signup
337
338
 
339
+ /**
340
+ * 403 response for POST AuthSignup endpoint
341
+ *
342
+ * @remarks
343
+ * This type defines the response structure for the 403 status code
344
+ * of the POST AuthSignup endpoint.
345
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
346
+ *
347
+
348
+ *
349
+ * @path /v1/auth/signup
350
+ *
351
+ * @see {@link POST_AuthSignup_Response} - The main response type definition
352
+ * @see {@link Problem} - The actual schema type definition
353
+ */
354
+ export type POST_AuthSignup_Response_403 = Problem
355
+
338
356
  /**
339
357
  * 409 response for POST AuthSignup endpoint
340
358
  *
@@ -906,6 +906,22 @@ export type DnssecRecordType = components['schemas']['DnssecRecordType'];
906
906
  * @see {@link components} - The OpenAPI components schema definition
907
907
  */
908
908
  export type DnssecStatus = components['schemas']['DnssecStatus'];
909
+ /**
910
+ * DomainAttributeKey
911
+ *
912
+ * @remarks
913
+ * Type alias for the `DomainAttributeKey` OpenAPI schema.
914
+ * This type represents domainattributekey data structures used in API requests and responses.
915
+ *
916
+ * @example
917
+ * ```typescript
918
+ * const response = await api.getDomainAttributeKey();
919
+ * const item: DomainAttributeKey = response.results;
920
+ * ```
921
+ *
922
+ * @see {@link components} - The OpenAPI components schema definition
923
+ */
924
+ export type DomainAttributeKey = components['schemas']['DomainAttributeKey'];
909
925
  /**
910
926
  * DomainAvailability
911
927
  *
package/src/openapi.yaml CHANGED
@@ -1366,6 +1366,11 @@ components:
1366
1366
  - disabled
1367
1367
  title: DnssecStatus
1368
1368
  type: string
1369
+ DomainAttributeKey:
1370
+ enum:
1371
+ - auto_renew_period
1372
+ title: DomainAttributeKey
1373
+ type: string
1369
1374
  DomainAvailability:
1370
1375
  properties:
1371
1376
  domain:
@@ -1490,7 +1495,7 @@ components:
1490
1495
  title: Nameservers
1491
1496
  period:
1492
1497
  $ref: '#/components/schemas/DomainPeriod'
1493
- description: How long the domain should be registered for
1498
+ description: The registration period of the domain
1494
1499
  renewal_mode:
1495
1500
  $ref: '#/components/schemas/RenewalMode'
1496
1501
  description: The renewal mode of the domain
@@ -2193,6 +2198,16 @@ components:
2193
2198
  type: object
2194
2199
  DomainTransferIn:
2195
2200
  properties:
2201
+ attributes:
2202
+ anyOf:
2203
+ - additionalProperties:
2204
+ type: string
2205
+ propertyNames:
2206
+ $ref: '#/components/schemas/DomainAttributeKey'
2207
+ type: object
2208
+ - type: 'null'
2209
+ description: Additional attributes of the domain
2210
+ title: Attributes
2196
2211
  auth_code:
2197
2212
  description: The auth code for the domain
2198
2213
  title: Auth Code
@@ -5221,7 +5236,7 @@ info:
5221
5236
  '
5222
5237
  summary: OpusDNS - your gateway to a seamless domain management experience.
5223
5238
  title: OpusDNS API
5224
- version: 2025-09-30-110200
5239
+ version: 2025-10-02-163917
5225
5240
  x-logo:
5226
5241
  altText: OpusDNS API Reference
5227
5242
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -5420,6 +5435,18 @@ paths:
5420
5435
  schema:
5421
5436
  $ref: '#/components/schemas/SignupResponse'
5422
5437
  description: Successful Response
5438
+ '403':
5439
+ content:
5440
+ application/problem+json:
5441
+ example:
5442
+ code: ERROR_SIGNUP_NOT_ALLOWED
5443
+ detail: Additional error context.
5444
+ status: 403
5445
+ title: Organization Management Error
5446
+ type: signup-not-allowed
5447
+ schema:
5448
+ $ref: '#/components/schemas/Problem'
5449
+ description: Forbidden
5423
5450
  '409':
5424
5451
  content:
5425
5452
  application/problem+json:
package/src/schema.d.ts CHANGED
@@ -2251,6 +2251,11 @@ export interface components {
2251
2251
  * @enum {string}
2252
2252
  */
2253
2253
  DnssecStatus: "enabled" | "disabled";
2254
+ /**
2255
+ * DomainAttributeKey
2256
+ * @enum {string}
2257
+ */
2258
+ DomainAttributeKey: "auto_renew_period";
2254
2259
  /** DomainAvailability */
2255
2260
  DomainAvailability: {
2256
2261
  /** Domain */
@@ -2326,7 +2331,7 @@ export interface components {
2326
2331
  * @description The name servers for the domain
2327
2332
  */
2328
2333
  nameservers?: components["schemas"]["Nameserver"][] | null;
2329
- /** @description How long the domain should be registered for */
2334
+ /** @description The registration period of the domain */
2330
2335
  period: components["schemas"]["DomainPeriod"];
2331
2336
  /** @description The renewal mode of the domain */
2332
2337
  renewal_mode: components["schemas"]["RenewalMode"];
@@ -2777,6 +2782,13 @@ export interface components {
2777
2782
  };
2778
2783
  /** DomainTransferIn */
2779
2784
  DomainTransferIn: {
2785
+ /**
2786
+ * Attributes
2787
+ * @description Additional attributes of the domain
2788
+ */
2789
+ attributes?: {
2790
+ [key: string]: string;
2791
+ } | null;
2780
2792
  /**
2781
2793
  * Auth Code
2782
2794
  * @description The auth code for the domain
@@ -4923,6 +4935,22 @@ export interface operations {
4923
4935
  "application/json": components["schemas"]["SignupResponse"];
4924
4936
  };
4925
4937
  };
4938
+ /** @description Forbidden */
4939
+ 403: {
4940
+ headers: {
4941
+ [name: string]: unknown;
4942
+ };
4943
+ content: {
4944
+ /** @example {
4945
+ * "code": "ERROR_SIGNUP_NOT_ALLOWED",
4946
+ * "detail": "Additional error context.",
4947
+ * "status": 403,
4948
+ * "title": "Organization Management Error",
4949
+ * "type": "signup-not-allowed"
4950
+ * } */
4951
+ "application/problem+json": components["schemas"]["Problem"];
4952
+ };
4953
+ };
4926
4954
  /** @description Conflict */
4927
4955
  409: {
4928
4956
  headers: {