@opusdns/api 0.133.0 → 0.134.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
@@ -3,7 +3,7 @@
3
3
  "@opusdns/api-spec-ts-generator": "^0.19.0"
4
4
  },
5
5
  "name": "@opusdns/api",
6
- "version": "0.133.0",
6
+ "version": "0.134.0",
7
7
  "description": "TypeScript types for the OpusDNS OpenAPI specification",
8
8
  "main": "./src/index.ts",
9
9
  "module": "./src/index.ts",
@@ -21,7 +21,7 @@
21
21
  * ```
22
22
  */
23
23
 
24
- import { AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ContactRoleType, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainSortField, DomainStatus, EmailForwardLogSortField, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, GrantType, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, LaunchPhaseType, LocalPresenceRequirementType, ObjectEventType, ObjectLogSortField, OrganizationStatus, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TransferAckType, UserStatus, VerificationType, ZoneSortField, common__schemas__domain_forward__PatchOp } from './schemas';
24
+ import { AllocationMethodType, AttributeType, BillingTransactionAction, BillingTransactionProductType, BillingTransactionSortField, BillingTransactionStatus, ContactRoleType, ContactSortField, Currency, DeletePolicyType, DnsChangeAction, DnsRrsetType, DnssecAlgorithm, DnssecDigestType, DnssecModeType, DnssecRecordType, DnssecStatus, DomainAttributeKey, DomainAvailabilityStatus, DomainClientStatus, DomainContactType, DomainForwardSortField, DomainForwardZoneSortField, DomainSortField, DomainStatus, EmailForwardLogSortField, EmailForwardSortField, EmailForwardZoneSortField, EmailVerificationStatus, EventObjectType, EventSortField, EventSubtype, EventType, GrantType, HostStatus, HttpProtocol, InvoiceResponsePaymentStatus, InvoiceResponseStatus, InvoiceResponseType, LaunchPhaseType, LocalPresenceRequirementType, ObjectEventType, ObjectLogSortField, OrganizationStatus, PatchOp, PeriodUnit, Permission, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, RedirectCode, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, RequestHistorySortField, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TransferAckType, UserStatus, VerificationType, ZoneSortField } from './schemas';
25
25
 
26
26
  /**
27
27
  * AllocationMethodType. Auto-generated enum for AllocationMethodType
@@ -2437,6 +2437,56 @@ export const ORGANIZATION_STATUS_VALUES = [
2437
2437
  'inactive'
2438
2438
  ] as const satisfies [string, ...string[]] | OrganizationStatus[];
2439
2439
 
2440
+ /**
2441
+ * PatchOp. Auto-generated enum for PatchOp
2442
+ *
2443
+ * @remarks
2444
+ * This constant provides both object and array forms for the PatchOp enum.
2445
+ * The object form allows key-value access, while the array form enables iteration and validation.
2446
+ *
2447
+ * @example
2448
+ * ```typescript
2449
+ * // Using the object form for key-value access
2450
+ * const status = PATCH_OP.SUCCESS;
2451
+ *
2452
+ * // Using the array form for iteration
2453
+ * const allStatuses = PATCH_OP_VALUES;
2454
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
2455
+ * ```
2456
+ *
2457
+ * @see {@link PatchOp} - The TypeScript type definition
2458
+ */
2459
+ export const PATCH_OP = {
2460
+ UPSERT: "upsert",
2461
+ REMOVE: "remove",
2462
+ } as const satisfies Record<string, PatchOp>;
2463
+
2464
+ /**
2465
+ * Array of all PatchOp enum values
2466
+ *
2467
+ * @remarks
2468
+ * This constant provides a array containing all valid PatchOp enum values.
2469
+ * Useful for iteration, validation, and generating dynamic UI components.
2470
+ *
2471
+ * @example
2472
+ * ```typescript
2473
+ * // Iterating through all values
2474
+ * for (const value of PATCH_OP_VALUES) {
2475
+ * console.log(`Processing: ${value}`);
2476
+ * }
2477
+ *
2478
+ * // Validation
2479
+ * const isValid = PATCH_OP_VALUES.includes(someValue);
2480
+ * ```
2481
+ *
2482
+ * @see {@link PatchOp} - The TypeScript type definition
2483
+ * @see {@link PATCH_OP} - The object form of this enum
2484
+ */
2485
+ export const PATCH_OP_VALUES = [
2486
+ 'upsert',
2487
+ 'remove'
2488
+ ] as const satisfies [string, ...string[]] | PatchOp[];
2489
+
2440
2490
  /**
2441
2491
  * PeriodUnit. Auto-generated enum for PeriodUnit
2442
2492
  *
@@ -3564,53 +3614,3 @@ export const ZONE_SORT_FIELD_VALUES = [
3564
3614
  'dnssec_status'
3565
3615
  ] as const satisfies [string, ...string[]] | ZoneSortField[];
3566
3616
 
3567
- /**
3568
- * PatchOp. Auto-generated enum for common__schemas__domain_forward__PatchOp
3569
- *
3570
- * @remarks
3571
- * This constant provides both object and array forms for the common__schemas__domain_forward__PatchOp enum.
3572
- * The object form allows key-value access, while the array form enables iteration and validation.
3573
- *
3574
- * @example
3575
- * ```typescript
3576
- * // Using the object form for key-value access
3577
- * const status = COMMON_SCHEMAS_DOMAIN_FORWARD_PATCH_OP.SUCCESS;
3578
- *
3579
- * // Using the array form for iteration
3580
- * const allStatuses = COMMON_SCHEMAS_DOMAIN_FORWARD_PATCH_OP_VALUES;
3581
- * console.log(`Available statuses: ${allStatuses.join(', ')}`);
3582
- * ```
3583
- *
3584
- * @see {@link common__schemas__domain_forward__PatchOp} - The TypeScript type definition
3585
- */
3586
- export const COMMON_SCHEMAS_DOMAIN_FORWARD_PATCH_OP = {
3587
- UPSERT: "upsert",
3588
- REMOVE: "remove",
3589
- } as const satisfies Record<string, common__schemas__domain_forward__PatchOp>;
3590
-
3591
- /**
3592
- * Array of all common__schemas__domain_forward__PatchOp enum values
3593
- *
3594
- * @remarks
3595
- * This constant provides a array containing all valid common__schemas__domain_forward__PatchOp enum values.
3596
- * Useful for iteration, validation, and generating dynamic UI components.
3597
- *
3598
- * @example
3599
- * ```typescript
3600
- * // Iterating through all values
3601
- * for (const value of COMMON_SCHEMAS_DOMAIN_FORWARD_PATCH_OP_VALUES) {
3602
- * console.log(`Processing: ${value}`);
3603
- * }
3604
- *
3605
- * // Validation
3606
- * const isValid = COMMON_SCHEMAS_DOMAIN_FORWARD_PATCH_OP_VALUES.includes(someValue);
3607
- * ```
3608
- *
3609
- * @see {@link common__schemas__domain_forward__PatchOp} - The TypeScript type definition
3610
- * @see {@link COMMON_SCHEMAS_DOMAIN_FORWARD_PATCH_OP} - The object form of this enum
3611
- */
3612
- export const COMMON_SCHEMAS_DOMAIN_FORWARD_PATCH_OP_VALUES = [
3613
- 'upsert',
3614
- 'remove'
3615
- ] as const satisfies [string, ...string[]] | common__schemas__domain_forward__PatchOp[];
3616
-
@@ -2847,6 +2847,22 @@ export type Pagination_User = components['schemas']['Pagination_User_'];
2847
2847
  * @see {@link components} - The OpenAPI components schema definition
2848
2848
  */
2849
2849
  export type PasswordUpdate = components['schemas']['PasswordUpdate'];
2850
+ /**
2851
+ * PatchOp
2852
+ *
2853
+ * @remarks
2854
+ * Type alias for the `PatchOp` OpenAPI schema.
2855
+ * This type represents patchop data structures used in API requests and responses.
2856
+ *
2857
+ * @example
2858
+ * ```typescript
2859
+ * const response = await api.getPatchOp();
2860
+ * const item: PatchOp = response.results;
2861
+ * ```
2862
+ *
2863
+ * @see {@link components} - The OpenAPI components schema definition
2864
+ */
2865
+ export type PatchOp = components['schemas']['PatchOp'];
2850
2866
  /**
2851
2867
  * Period
2852
2868
  *
@@ -3790,20 +3806,4 @@ export type DomainAvailabilityList = components['schemas']['common__models__avai
3790
3806
  *
3791
3807
  * @see {@link components} - The OpenAPI components schema definition
3792
3808
  */
3793
- export type DomainAvailabilityCheck = components['schemas']['common__models__domain__domain__DomainAvailabilityResponse'];
3794
- /**
3795
- * PatchOp
3796
- *
3797
- * @remarks
3798
- * Type alias for the `common__schemas__domain_forward__PatchOp` OpenAPI schema.
3799
- * This type represents patchop data structures used in API requests and responses.
3800
- *
3801
- * @example
3802
- * ```typescript
3803
- * const response = await api.getPatchOp();
3804
- * const item: PatchOp = response.results;
3805
- * ```
3806
- *
3807
- * @see {@link components} - The OpenAPI components schema definition
3808
- */
3809
- export type PatchOp = components['schemas']['common__schemas__domain_forward__PatchOp'];
3809
+ export type DomainAvailabilityCheck = components['schemas']['common__models__domain__domain__DomainAvailabilityResponse'];
package/src/openapi.yaml CHANGED
@@ -1013,7 +1013,7 @@ components:
1013
1013
  DnsRecordPatchOp:
1014
1014
  properties:
1015
1015
  op:
1016
- $ref: '#/components/schemas/common__schemas__domain_forward__PatchOp'
1016
+ $ref: '#/components/schemas/PatchOp'
1017
1017
  record:
1018
1018
  $ref: '#/components/schemas/DnsRrsetWithOneRecordPatch'
1019
1019
  required:
@@ -1077,7 +1077,7 @@ components:
1077
1077
  DnsRrsetPatchOp:
1078
1078
  properties:
1079
1079
  op:
1080
- $ref: '#/components/schemas/common__schemas__domain_forward__PatchOp'
1080
+ $ref: '#/components/schemas/PatchOp'
1081
1081
  rrset:
1082
1082
  $ref: '#/components/schemas/DnsRrsetPatch'
1083
1083
  required:
@@ -1613,7 +1613,7 @@ components:
1613
1613
  DomainForwardPatchOp:
1614
1614
  properties:
1615
1615
  op:
1616
- $ref: '#/components/schemas/common__schemas__domain_forward__PatchOp'
1616
+ $ref: '#/components/schemas/PatchOp'
1617
1617
  redirect:
1618
1618
  anyOf:
1619
1619
  - $ref: '#/components/schemas/HttpRedirectUpsert'
@@ -4591,6 +4591,12 @@ components:
4591
4591
  - new_password
4592
4592
  title: PasswordUpdate
4593
4593
  type: object
4594
+ PatchOp:
4595
+ enum:
4596
+ - upsert
4597
+ - remove
4598
+ title: PatchOp
4599
+ type: string
4594
4600
  Period:
4595
4601
  properties:
4596
4602
  unit:
@@ -6062,12 +6068,6 @@ components:
6062
6068
  - reason
6063
6069
  title: DomainAvailabilityResponse
6064
6070
  type: object
6065
- common__schemas__domain_forward__PatchOp:
6066
- enum:
6067
- - upsert
6068
- - remove
6069
- title: PatchOp
6070
- type: string
6071
6071
  securitySchemes:
6072
6072
  APIKeyHeader:
6073
6073
  description: API key for the organization.
@@ -6143,7 +6143,7 @@ info:
6143
6143
  '
6144
6144
  summary: OpusDNS - your gateway to a seamless domain management experience.
6145
6145
  title: OpusDNS API
6146
- version: 2025-12-18-094427
6146
+ version: 2025-12-18-130936
6147
6147
  x-logo:
6148
6148
  altText: OpusDNS API Reference
6149
6149
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
package/src/schema.d.ts CHANGED
@@ -2320,7 +2320,7 @@ export interface components {
2320
2320
  };
2321
2321
  /** DnsRecordPatchOp */
2322
2322
  DnsRecordPatchOp: {
2323
- op: components["schemas"]["common__schemas__domain_forward__PatchOp"];
2323
+ op: components["schemas"]["PatchOp"];
2324
2324
  record: components["schemas"]["DnsRrsetWithOneRecordPatch"];
2325
2325
  };
2326
2326
  /** DnsRecordResponse */
@@ -2350,7 +2350,7 @@ export interface components {
2350
2350
  };
2351
2351
  /** DnsRrsetPatchOp */
2352
2352
  DnsRrsetPatchOp: {
2353
- op: components["schemas"]["common__schemas__domain_forward__PatchOp"];
2353
+ op: components["schemas"]["PatchOp"];
2354
2354
  rrset: components["schemas"]["DnsRrsetPatch"];
2355
2355
  };
2356
2356
  /** DnsRrsetResponse */
@@ -2680,7 +2680,7 @@ export interface components {
2680
2680
  };
2681
2681
  /** DomainForwardPatchOp */
2682
2682
  DomainForwardPatchOp: {
2683
- op: components["schemas"]["common__schemas__domain_forward__PatchOp"];
2683
+ op: components["schemas"]["PatchOp"];
2684
2684
  /** Redirect */
2685
2685
  redirect: components["schemas"]["HttpRedirectUpsert"] | components["schemas"]["HttpRedirectRemove"];
2686
2686
  };
@@ -4655,6 +4655,11 @@ export interface components {
4655
4655
  */
4656
4656
  new_password: string;
4657
4657
  };
4658
+ /**
4659
+ * PatchOp
4660
+ * @enum {string}
4661
+ */
4662
+ PatchOp: "upsert" | "remove";
4658
4663
  /** Period */
4659
4664
  Period: {
4660
4665
  /** @description The unit of the period */
@@ -5644,11 +5649,6 @@ export interface components {
5644
5649
  /** Reason */
5645
5650
  reason: string | null;
5646
5651
  };
5647
- /**
5648
- * PatchOp
5649
- * @enum {string}
5650
- */
5651
- common__schemas__domain_forward__PatchOp: "upsert" | "remove";
5652
5652
  };
5653
5653
  responses: never;
5654
5654
  parameters: never;