@opusdns/api 0.63.0 → 0.64.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.63.0",
11
+ "version": "0.64.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, PlanRelation, PostTransferRequirements, PostalAddressType, PremiumAffectsType, PremiumSourceType, RegistrantChangeType, RegistryHandleAttributeType, Relation, RenewalMode, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TransferAckType, UserStatus, VerificationType, WalletCreditResponseStatus, ZoneSortField } from './schemas';
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';
25
25
 
26
26
  /**
27
27
  * AgreementType. Auto-generated enum for AgreementType
@@ -1919,62 +1919,6 @@ export const PERMISSION_VALUES = [
1919
1919
  'view_events'
1920
1920
  ] as const satisfies [string, ...string[]] | Permission[];
1921
1921
 
1922
- /**
1923
- * PlanRelation. Auto-generated enum for PlanRelation
1924
- *
1925
- * @remarks
1926
- * This constant provides both object and array forms for the PlanRelation enum.
1927
- * The object form allows key-value access, while the array form enables iteration and validation.
1928
- *
1929
- * @example
1930
- * ```typescript
1931
- * // Using the object form for key-value access
1932
- * const status = PLAN_RELATION.SUCCESS;
1933
- *
1934
- * // Using the array form for iteration
1935
- * const allStatuses = PLAN_RELATION_VALUES;
1936
- * console.log(`Available statuses: ${allStatuses.join(', ')}`);
1937
- * ```
1938
- *
1939
- * @see {@link PlanRelation} - The TypeScript type definition
1940
- */
1941
- export const PLAN_RELATION = {
1942
- BASIC: "basic",
1943
- ENTERPRISE: "enterprise",
1944
- CORPORATE: "corporate",
1945
- PREMIUM: "premium",
1946
- STARTER: "starter",
1947
- } as const satisfies Record<string, PlanRelation>;
1948
-
1949
- /**
1950
- * Array of all PlanRelation enum values
1951
- *
1952
- * @remarks
1953
- * This constant provides a array containing all valid PlanRelation enum values.
1954
- * Useful for iteration, validation, and generating dynamic UI components.
1955
- *
1956
- * @example
1957
- * ```typescript
1958
- * // Iterating through all values
1959
- * for (const value of PLAN_RELATION_VALUES) {
1960
- * console.log(`Processing: ${value}`);
1961
- * }
1962
- *
1963
- * // Validation
1964
- * const isValid = PLAN_RELATION_VALUES.includes(someValue);
1965
- * ```
1966
- *
1967
- * @see {@link PlanRelation} - The TypeScript type definition
1968
- * @see {@link PLAN_RELATION} - The object form of this enum
1969
- */
1970
- export const PLAN_RELATION_VALUES = [
1971
- 'basic',
1972
- 'enterprise',
1973
- 'corporate',
1974
- 'premium',
1975
- 'starter'
1976
- ] as const satisfies [string, ...string[]] | PlanRelation[];
1977
-
1978
1922
  /**
1979
1923
  * PostTransferRequirements. Auto-generated enum for PostTransferRequirements
1980
1924
  *
@@ -120,8 +120,8 @@ import { PaginationMetadata } from './schemas';
120
120
  import { PasswordUpdate } from './schemas';
121
121
  import { Period } from './schemas';
122
122
  import { PermissionSet } from './schemas';
123
+ import { PlanIdRequest } from './schemas';
123
124
  import { PlanInfo } from './schemas';
124
- import { PlanUpdate } from './schemas';
125
125
  import { PremiumDomainsBase } from './schemas';
126
126
  import { PriceInfo } from './schemas';
127
127
  import { PricingPeriod } from './schemas';
@@ -14511,6 +14511,57 @@ export const KEYS_PERMISSION_SET = [
14511
14511
  KEY_PERMISSION_SET_PERMISSIONS,
14512
14512
  ] as const satisfies (keyof PermissionSet)[];
14513
14513
 
14514
+ /**
14515
+ * Plan Id
14516
+ *
14517
+ * Plan ID from available plans
14518
+ *
14519
+ * @type {string}
14520
+ *
14521
+ *
14522
+ * @remarks
14523
+ * This key constant provides type-safe access to the `plan_id` property of PlanIdRequest objects.
14524
+ * Use this constant when you need to access properties dynamically or ensure type safety.
14525
+ *
14526
+ * @example
14527
+ * ```typescript
14528
+ * // Direct property access
14529
+ * const value = planidrequest[KEY_PLAN_ID_REQUEST_PLAN_ID];
14530
+ *
14531
+ * // Dynamic property access
14532
+ * const propertyName = KEY_PLAN_ID_REQUEST_PLAN_ID;
14533
+ * const value = planidrequest[propertyName];
14534
+ * ```
14535
+ *
14536
+ * @see {@link PlanIdRequest} - The TypeScript type definition
14537
+ * @see {@link KEYS_PLAN_ID_REQUEST} - Array of all keys for this type
14538
+ */
14539
+ export const KEY_PLAN_ID_REQUEST_PLAN_ID = 'plan_id' as keyof PlanIdRequest;
14540
+
14541
+ /**
14542
+ * Array of all PlanIdRequest property keys
14543
+ *
14544
+ * @remarks
14545
+ * This constant provides a readonly array containing all valid property keys for PlanIdRequest objects.
14546
+ * Useful for iteration, validation, and generating dynamic UI components.
14547
+ *
14548
+ * @example
14549
+ * ```typescript
14550
+ * // Iterating through all keys
14551
+ * for (const key of KEYS_PLAN_ID_REQUEST) {
14552
+ * console.log(`Property: ${key}, Value: ${planidrequest[key]}`);
14553
+ * }
14554
+ *
14555
+ * // Validation
14556
+ * const isValidKey = KEYS_PLAN_ID_REQUEST.includes(someKey);
14557
+ * ```
14558
+ *
14559
+ * @see {@link PlanIdRequest} - The TypeScript type definition
14560
+ */
14561
+ export const KEYS_PLAN_ID_REQUEST = [
14562
+ KEY_PLAN_ID_REQUEST_PLAN_ID,
14563
+ ] as const satisfies (keyof PlanIdRequest)[];
14564
+
14514
14565
  /**
14515
14566
  * Amount
14516
14567
  *
@@ -14694,55 +14745,6 @@ export const KEYS_PLAN_INFO = [
14694
14745
  KEY_PLAN_INFO_PLAN_TYPE,
14695
14746
  ] as const satisfies (keyof PlanInfo)[];
14696
14747
 
14697
- /**
14698
- * plan property
14699
- *
14700
- *
14701
- *
14702
- *
14703
- * @remarks
14704
- * This key constant provides type-safe access to the `plan` property of PlanUpdate objects.
14705
- * Use this constant when you need to access properties dynamically or ensure type safety.
14706
- *
14707
- * @example
14708
- * ```typescript
14709
- * // Direct property access
14710
- * const value = planupdate[KEY_PLAN_UPDATE_PLAN];
14711
- *
14712
- * // Dynamic property access
14713
- * const propertyName = KEY_PLAN_UPDATE_PLAN;
14714
- * const value = planupdate[propertyName];
14715
- * ```
14716
- *
14717
- * @see {@link PlanUpdate} - The TypeScript type definition
14718
- * @see {@link KEYS_PLAN_UPDATE} - Array of all keys for this type
14719
- */
14720
- export const KEY_PLAN_UPDATE_PLAN = 'plan' as keyof PlanUpdate;
14721
-
14722
- /**
14723
- * Array of all PlanUpdate property keys
14724
- *
14725
- * @remarks
14726
- * This constant provides a readonly array containing all valid property keys for PlanUpdate objects.
14727
- * Useful for iteration, validation, and generating dynamic UI components.
14728
- *
14729
- * @example
14730
- * ```typescript
14731
- * // Iterating through all keys
14732
- * for (const key of KEYS_PLAN_UPDATE) {
14733
- * console.log(`Property: ${key}, Value: ${planupdate[key]}`);
14734
- * }
14735
- *
14736
- * // Validation
14737
- * const isValidKey = KEYS_PLAN_UPDATE.includes(someKey);
14738
- * ```
14739
- *
14740
- * @see {@link PlanUpdate} - The TypeScript type definition
14741
- */
14742
- export const KEYS_PLAN_UPDATE = [
14743
- KEY_PLAN_UPDATE_PLAN,
14744
- ] as const satisfies (keyof PlanUpdate)[];
14745
-
14746
14748
  /**
14747
14749
  * Affects
14748
14750
  *
@@ -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, DomainRestoreRequest, DomainTransferIn, EmailForwardAlias, EmailForwardAliasUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, CheckoutSessionRequest, WalletCreditRequest, PlanUpdate, UserCreate, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
37
+ import { OrganizationCredentialExtra, SignupCreate, ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainTransferIn, EmailForwardAlias, EmailForwardAliasUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, CheckoutSessionRequest, WalletCreditRequest, PlanIdRequest, UserCreate, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
38
38
 
39
39
  /**
40
40
  * Request type for GET AuthClientCredentials endpoint
@@ -3232,7 +3232,7 @@ export type PATCH_OrganizationsOrganizationIdPlan_Request = {
3232
3232
  parameters: {
3233
3233
  path: operations['change_plan_v1_organizations__organization_id__plan_patch']['parameters']['path'];
3234
3234
  };
3235
- requestBody: PlanUpdate;
3235
+ requestBody: PlanIdRequest;
3236
3236
  }
3237
3237
  /**
3238
3238
  * Path parameters for PATCH /v1/organizations/{organization_id}/plan
@@ -2256,53 +2256,37 @@ export type Permission = components['schemas']['Permission'];
2256
2256
  */
2257
2257
  export type PermissionSet = components['schemas']['PermissionSet'];
2258
2258
  /**
2259
- * PlanInfo
2260
- *
2261
- * @remarks
2262
- * Type alias for the `PlanInfo` OpenAPI schema.
2263
- * This type represents planinfo data structures used in API requests and responses.
2264
- *
2265
- * @example
2266
- * ```typescript
2267
- * const response = await api.getPlanInfo();
2268
- * const item: PlanInfo = response.results;
2269
- * ```
2270
- *
2271
- * @see {@link components} - The OpenAPI components schema definition
2272
- */
2273
- export type PlanInfo = components['schemas']['PlanInfo'];
2274
- /**
2275
- * PlanRelation
2259
+ * PlanIdRequest
2276
2260
  *
2277
2261
  * @remarks
2278
- * Type alias for the `PlanRelation` OpenAPI schema.
2279
- * This type represents planrelation data structures used in API requests and responses.
2262
+ * Type alias for the `PlanIdRequest` OpenAPI schema.
2263
+ * This type represents planidrequest data structures used in API requests and responses.
2280
2264
  *
2281
2265
  * @example
2282
2266
  * ```typescript
2283
- * const response = await api.getPlanRelation();
2284
- * const item: PlanRelation = response.results;
2267
+ * const response = await api.getPlanIdRequest();
2268
+ * const item: PlanIdRequest = response.results;
2285
2269
  * ```
2286
2270
  *
2287
2271
  * @see {@link components} - The OpenAPI components schema definition
2288
2272
  */
2289
- export type PlanRelation = components['schemas']['PlanRelation'];
2273
+ export type PlanIdRequest = components['schemas']['PlanIdRequest'];
2290
2274
  /**
2291
- * PlanUpdate
2275
+ * PlanInfo
2292
2276
  *
2293
2277
  * @remarks
2294
- * Type alias for the `PlanUpdate` OpenAPI schema.
2295
- * This type represents planupdate data structures used in API requests and responses.
2278
+ * Type alias for the `PlanInfo` OpenAPI schema.
2279
+ * This type represents planinfo data structures used in API requests and responses.
2296
2280
  *
2297
2281
  * @example
2298
2282
  * ```typescript
2299
- * const response = await api.getPlanUpdate();
2300
- * const item: PlanUpdate = response.results;
2283
+ * const response = await api.getPlanInfo();
2284
+ * const item: PlanInfo = response.results;
2301
2285
  * ```
2302
2286
  *
2303
2287
  * @see {@link components} - The OpenAPI components schema definition
2304
2288
  */
2305
- export type PlanUpdate = components['schemas']['PlanUpdate'];
2289
+ export type PlanInfo = components['schemas']['PlanInfo'];
2306
2290
  /**
2307
2291
  * PostTransferRequirements
2308
2292
  *
package/src/openapi.yaml CHANGED
@@ -3791,6 +3791,16 @@ components:
3791
3791
  type: array
3792
3792
  title: PermissionSet
3793
3793
  type: object
3794
+ PlanIdRequest:
3795
+ properties:
3796
+ plan_id:
3797
+ description: Plan ID from available plans
3798
+ title: Plan Id
3799
+ type: string
3800
+ required:
3801
+ - plan_id
3802
+ title: PlanIdRequest
3803
+ type: object
3794
3804
  PlanInfo:
3795
3805
  properties:
3796
3806
  amount:
@@ -3829,22 +3839,6 @@ components:
3829
3839
  - amount
3830
3840
  title: PlanInfo
3831
3841
  type: object
3832
- PlanRelation:
3833
- enum:
3834
- - basic
3835
- - enterprise
3836
- - corporate
3837
- - premium
3838
- - starter
3839
- title: PlanRelation
3840
- type: string
3841
- PlanUpdate:
3842
- properties:
3843
- plan:
3844
- $ref: '#/components/schemas/PlanRelation'
3845
- default: basic
3846
- title: PlanUpdate
3847
- type: object
3848
3842
  PostTransferRequirements:
3849
3843
  enum:
3850
3844
  - update_contacts
@@ -5124,7 +5118,7 @@ info:
5124
5118
  '
5125
5119
  summary: OpusDNS - your gateway to a seamless domain management experience.
5126
5120
  title: OpusDNS API
5127
- version: 2025-09-24-162647
5121
+ version: 2025-09-24-220429
5128
5122
  x-logo:
5129
5123
  altText: OpusDNS API Reference
5130
5124
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -8949,7 +8943,7 @@ paths:
8949
8943
  content:
8950
8944
  application/json:
8951
8945
  schema:
8952
- $ref: '#/components/schemas/PlanUpdate'
8946
+ $ref: '#/components/schemas/PlanIdRequest'
8953
8947
  required: true
8954
8948
  responses:
8955
8949
  '200':
package/src/schema.d.ts CHANGED
@@ -3691,6 +3691,14 @@ export interface components {
3691
3691
  /** Permissions */
3692
3692
  permissions?: components["schemas"]["Permission"][];
3693
3693
  };
3694
+ /** PlanIdRequest */
3695
+ PlanIdRequest: {
3696
+ /**
3697
+ * Plan Id
3698
+ * @description Plan ID from available plans
3699
+ */
3700
+ plan_id: string;
3701
+ };
3694
3702
  /** PlanInfo */
3695
3703
  PlanInfo: {
3696
3704
  /**
@@ -3724,16 +3732,6 @@ export interface components {
3724
3732
  */
3725
3733
  plan_type?: string | null;
3726
3734
  };
3727
- /**
3728
- * PlanRelation
3729
- * @enum {string}
3730
- */
3731
- PlanRelation: "basic" | "enterprise" | "corporate" | "premium" | "starter";
3732
- /** PlanUpdate */
3733
- PlanUpdate: {
3734
- /** @default basic */
3735
- plan: components["schemas"]["PlanRelation"];
3736
- };
3737
3735
  /**
3738
3736
  * PostTransferRequirements
3739
3737
  * @enum {string}
@@ -8008,7 +8006,7 @@ export interface operations {
8008
8006
  };
8009
8007
  requestBody: {
8010
8008
  content: {
8011
- "application/json": components["schemas"]["PlanUpdate"];
8009
+ "application/json": components["schemas"]["PlanIdRequest"];
8012
8010
  };
8013
8011
  };
8014
8012
  responses: {