@opusdns/api 0.52.0 → 0.54.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.52.0",
11
+ "version": "0.54.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, 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';
24
+ import { AgreementType, 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, RegistryHandleAttributeType, Relation, RenewalMode, ReservedSourceType, SortOrder, SyncOperationType, TLDType, TransferAckType, UserNotificationStatus, UserStatus, VerificationType, ZoneSortField } from './schemas';
25
25
 
26
26
  /**
27
27
  * AgreementType. Auto-generated enum for AgreementType
@@ -1809,6 +1809,62 @@ export const PERMISSION_VALUES = [
1809
1809
  'view_events'
1810
1810
  ] as const satisfies [string, ...string[]] | Permission[];
1811
1811
 
1812
+ /**
1813
+ * PlanRelation. Auto-generated enum for PlanRelation
1814
+ *
1815
+ * @remarks
1816
+ * This constant provides both object and array forms for the PlanRelation enum.
1817
+ * The object form allows key-value access, while the array form enables iteration and validation.
1818
+ *
1819
+ * @example
1820
+ * ```typescript
1821
+ * // Using the object form for key-value access
1822
+ * const status = PLAN_RELATION.SUCCESS;
1823
+ *
1824
+ * // Using the array form for iteration
1825
+ * const allStatuses = PLAN_RELATION_VALUES;
1826
+ * console.log(`Available statuses: ${allStatuses.join(', ')}`);
1827
+ * ```
1828
+ *
1829
+ * @see {@link PlanRelation} - The TypeScript type definition
1830
+ */
1831
+ export const PLAN_RELATION = {
1832
+ BASIC: "basic",
1833
+ ENTERPRISE: "enterprise",
1834
+ CORPORATE: "corporate",
1835
+ PREMIUM: "premium",
1836
+ STARTER: "starter",
1837
+ } as const satisfies Record<string, PlanRelation>;
1838
+
1839
+ /**
1840
+ * Array of all PlanRelation enum values
1841
+ *
1842
+ * @remarks
1843
+ * This constant provides a array containing all valid PlanRelation enum values.
1844
+ * Useful for iteration, validation, and generating dynamic UI components.
1845
+ *
1846
+ * @example
1847
+ * ```typescript
1848
+ * // Iterating through all values
1849
+ * for (const value of PLAN_RELATION_VALUES) {
1850
+ * console.log(`Processing: ${value}`);
1851
+ * }
1852
+ *
1853
+ * // Validation
1854
+ * const isValid = PLAN_RELATION_VALUES.includes(someValue);
1855
+ * ```
1856
+ *
1857
+ * @see {@link PlanRelation} - The TypeScript type definition
1858
+ * @see {@link PLAN_RELATION} - The object form of this enum
1859
+ */
1860
+ export const PLAN_RELATION_VALUES = [
1861
+ 'basic',
1862
+ 'enterprise',
1863
+ 'corporate',
1864
+ 'premium',
1865
+ 'starter'
1866
+ ] as const satisfies [string, ...string[]] | PlanRelation[];
1867
+
1812
1868
  /**
1813
1869
  * PostTransferRequirements. Auto-generated enum for PostTransferRequirements
1814
1870
  *
@@ -121,6 +121,7 @@ import { PasswordUpdate } from './schemas';
121
121
  import { Period } from './schemas';
122
122
  import { PermissionSet } from './schemas';
123
123
  import { PlanInfo } from './schemas';
124
+ import { PlanUpdate } from './schemas';
124
125
  import { PremiumDomainsBase } from './schemas';
125
126
  import { PriceInfo } from './schemas';
126
127
  import { Problem } from './schemas';
@@ -9489,7 +9490,7 @@ export const KEYS_IDN_BASE = [
9489
9490
  /**
9490
9491
  * Ip Network
9491
9492
  *
9492
- * IP address or CIDR range for the restriction.
9493
+ * IP address or CIDR network range. Individual IPs can be specified without CIDR notation.
9493
9494
  *
9494
9495
  * @type {string}
9495
9496
  *
@@ -9591,7 +9592,7 @@ export const KEY_IP_RESTRICTION_CREATED_ON = 'created_on' as keyof IpRestriction
9591
9592
  /**
9592
9593
  * Ip Network
9593
9594
  *
9594
- * IP address or CIDR range for the restriction.
9595
+ * IP address or CIDR network range. Single IPs are returned with /32 (IPv4) or /128 (IPv6) notation.
9595
9596
  *
9596
9597
  * @type {string}
9597
9598
  *
@@ -9720,7 +9721,7 @@ export const KEYS_IP_RESTRICTION = [
9720
9721
  /**
9721
9722
  * Ip Network
9722
9723
  *
9723
- * IP address or CIDR range for the restriction.
9724
+ * IP address or CIDR network range to replace the existing restriction.
9724
9725
  *
9725
9726
  *
9726
9727
  *
@@ -15081,6 +15082,55 @@ export const KEYS_PLAN_INFO = [
15081
15082
  KEY_PLAN_INFO_PLAN_TYPE,
15082
15083
  ] as const satisfies (keyof PlanInfo)[];
15083
15084
 
15085
+ /**
15086
+ * plan property
15087
+ *
15088
+ *
15089
+ *
15090
+ *
15091
+ * @remarks
15092
+ * This key constant provides type-safe access to the `plan` property of PlanUpdate objects.
15093
+ * Use this constant when you need to access properties dynamically or ensure type safety.
15094
+ *
15095
+ * @example
15096
+ * ```typescript
15097
+ * // Direct property access
15098
+ * const value = planupdate[KEY_PLAN_UPDATE_PLAN];
15099
+ *
15100
+ * // Dynamic property access
15101
+ * const propertyName = KEY_PLAN_UPDATE_PLAN;
15102
+ * const value = planupdate[propertyName];
15103
+ * ```
15104
+ *
15105
+ * @see {@link PlanUpdate} - The TypeScript type definition
15106
+ * @see {@link KEYS_PLAN_UPDATE} - Array of all keys for this type
15107
+ */
15108
+ export const KEY_PLAN_UPDATE_PLAN = 'plan' as keyof PlanUpdate;
15109
+
15110
+ /**
15111
+ * Array of all PlanUpdate property keys
15112
+ *
15113
+ * @remarks
15114
+ * This constant provides a readonly array containing all valid property keys for PlanUpdate objects.
15115
+ * Useful for iteration, validation, and generating dynamic UI components.
15116
+ *
15117
+ * @example
15118
+ * ```typescript
15119
+ * // Iterating through all keys
15120
+ * for (const key of KEYS_PLAN_UPDATE) {
15121
+ * console.log(`Property: ${key}, Value: ${planupdate[key]}`);
15122
+ * }
15123
+ *
15124
+ * // Validation
15125
+ * const isValidKey = KEYS_PLAN_UPDATE.includes(someKey);
15126
+ * ```
15127
+ *
15128
+ * @see {@link PlanUpdate} - The TypeScript type definition
15129
+ */
15130
+ export const KEYS_PLAN_UPDATE = [
15131
+ KEY_PLAN_UPDATE_PLAN,
15132
+ ] as const satisfies (keyof PlanUpdate)[];
15133
+
15084
15134
  /**
15085
15135
  * Affects
15086
15136
  *
@@ -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, NotificationCreate, NotificationUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, UserCreate, StartPasswordReset, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
37
+ import { OrganizationCredentialExtra, SignupCreate, ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainTransferIn, EmailForwardAlias, EmailForwardAliasUpdate, NotificationCreate, NotificationUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, PlanUpdate, UserCreate, StartPasswordReset, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
38
38
 
39
39
  /**
40
40
  * Request type for GET AuthClientCredentials endpoint
@@ -2952,7 +2952,10 @@ export type PATCH_OrganizationsAttributesOrganizationId_Request_Body = PATCH_Org
2952
2952
  * Request type for GET OrganizationsIpRestrictions endpoint
2953
2953
  *
2954
2954
  * List Ip Restrictions
2955
- * Get all IP restrictions for the organization
2955
+ * List all IP restrictions for the organization.
2956
+
2957
+ Returns a list of all IP restrictions configured for your organization.
2958
+ Single IP addresses are returned with CIDR notation (/32 for IPv4, /128 for IPv6).
2956
2959
  *
2957
2960
  * @remarks
2958
2961
  * This type defines the complete request structure for the GET OrganizationsIpRestrictions endpoint.
@@ -2975,7 +2978,10 @@ export type GET_OrganizationsIpRestrictions_Request = {
2975
2978
  * Request type for POST OrganizationsIpRestrictions endpoint
2976
2979
  *
2977
2980
  * Create Ip Restriction
2978
- * Create a new IP restriction for the organization
2981
+ * Create a new IP restriction for the organization.
2982
+
2983
+ Accepts either a single IP address or a CIDR network range.
2984
+ Individual IP addresses are stored and returned with CIDR notation (/32 for IPv4, /128 for IPv6).
2979
2985
  *
2980
2986
  * @remarks
2981
2987
  * This type defines the complete request structure for the POST OrganizationsIpRestrictions endpoint.
@@ -3012,7 +3018,9 @@ export type POST_OrganizationsIpRestrictions_Request_Body = POST_OrganizationsIp
3012
3018
  * Request type for DELETE OrganizationsIpRestrictionsIpRestrictionId endpoint
3013
3019
  *
3014
3020
  * Delete Ip Restriction
3015
- * Delete an IP restriction
3021
+ * Delete an IP restriction.
3022
+
3023
+ Permanently removes the specified IP restriction from your organization.
3016
3024
  *
3017
3025
  * @remarks
3018
3026
  * This type defines the complete request structure for the DELETE OrganizationsIpRestrictionsIpRestrictionId endpoint.
@@ -3051,7 +3059,10 @@ export type DELETE_OrganizationsIpRestrictionsIpRestrictionId_Request_Path = DEL
3051
3059
  * Request type for GET OrganizationsIpRestrictionsIpRestrictionId endpoint
3052
3060
  *
3053
3061
  * Get Ip Restriction
3054
- * Get a specific IP restriction by ID
3062
+ * Get a specific IP restriction by ID.
3063
+
3064
+ Returns the details of a specific IP restriction if it exists and belongs to your organization.
3065
+ Single IP addresses are returned with CIDR notation (/32 for IPv4, /128 for IPv6).
3055
3066
  *
3056
3067
  * @remarks
3057
3068
  * This type defines the complete request structure for the GET OrganizationsIpRestrictionsIpRestrictionId endpoint.
@@ -3090,7 +3101,10 @@ export type GET_OrganizationsIpRestrictionsIpRestrictionId_Request_Path = GET_Or
3090
3101
  * Request type for PATCH OrganizationsIpRestrictionsIpRestrictionId endpoint
3091
3102
  *
3092
3103
  * Update Ip Restriction
3093
- * Update an IP restriction
3104
+ * Update an existing IP restriction.
3105
+
3106
+ You can update the IP network range or the last usage timestamp.
3107
+ Individual IP addresses are stored and returned with CIDR notation (/32 for IPv4, /128 for IPv6).
3094
3108
  *
3095
3109
  * @remarks
3096
3110
  * This type defines the complete request structure for the PATCH OrganizationsIpRestrictionsIpRestrictionId endpoint.
@@ -3267,6 +3281,58 @@ export type PATCH_OrganizationsOrganizationId_Request_Path = PATCH_Organizations
3267
3281
  */
3268
3282
  export type PATCH_OrganizationsOrganizationId_Request_Body = PATCH_OrganizationsOrganizationId_Request['requestBody'];
3269
3283
 
3284
+ /**
3285
+ * Request type for PATCH OrganizationsOrganizationIdPlan endpoint
3286
+ *
3287
+ * Change Plan
3288
+ *
3289
+ * @remarks
3290
+ * This type defines the complete request structure for the PATCH OrganizationsOrganizationIdPlan endpoint.
3291
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
3292
+ * Use this type to ensure type safety when making API requests to this endpoint.
3293
+ *
3294
+ * @example
3295
+ * Use this type to ensure type safety when making API requests to this endpoint.
3296
+ *
3297
+ * @path /v1/organizations/{organization_id}/plan
3298
+ *
3299
+ * @see {@link PATCH_OrganizationsOrganizationIdPlan_Request_Query} - Query parameters type
3300
+ * @see {@link PATCH_OrganizationsOrganizationIdPlan_Request_Path} - Path parameters type
3301
+ * @see {@link PATCH_OrganizationsOrganizationIdPlan_Request_Body} - Request body type
3302
+ */
3303
+ export type PATCH_OrganizationsOrganizationIdPlan_Request = {
3304
+ parameters: {
3305
+ path: operations['change_plan_v1_organizations__organization_id__plan_patch']['parameters']['path'];
3306
+ };
3307
+ requestBody: PlanUpdate;
3308
+ }
3309
+ /**
3310
+ * Path parameters for PATCH /v1/organizations/{organization_id}/plan
3311
+ *
3312
+ * @remarks
3313
+ * This type defines the path parameters for the PATCH /v1/organizations/{organization_id}/plan endpoint.
3314
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
3315
+ *
3316
+ * @example
3317
+ * Use this type to ensure type safety for path parameters.
3318
+ *
3319
+ * @path /v1/organizations/{organization_id}/plan
3320
+ */
3321
+ export type PATCH_OrganizationsOrganizationIdPlan_Request_Path = PATCH_OrganizationsOrganizationIdPlan_Request['parameters']['path'];
3322
+ /**
3323
+ * Request body for PATCH /v1/organizations/{organization_id}/plan
3324
+ *
3325
+ * @remarks
3326
+ * This type defines the request body structure for the PATCH /v1/organizations/{organization_id}/plan endpoint.
3327
+ * It provides type safety for the request body as defined in the OpenAPI specification.
3328
+ *
3329
+ * @example
3330
+ * Use this type to ensure type safety for request body structure.
3331
+ *
3332
+ * @path /v1/organizations/{organization_id}/plan
3333
+ */
3334
+ export type PATCH_OrganizationsOrganizationIdPlan_Request_Body = PATCH_OrganizationsOrganizationIdPlan_Request['requestBody'];
3335
+
3270
3336
  /**
3271
3337
  * Request type for GET OrganizationsOrganizationIdPlans endpoint
3272
3338
  *
@@ -4645,6 +4645,61 @@ export type PATCH_OrganizationsByOrganizationId_Response_200 = Organization
4645
4645
  */
4646
4646
  export type PATCH_OrganizationsByOrganizationId_Response_422 = HTTPValidationError
4647
4647
 
4648
+ /**
4649
+ * Response types for PATCH OrganizationsByOrganizationIdPlan endpoint
4650
+ *
4651
+ * Change Plan
4652
+ *
4653
+ * @remarks
4654
+ * This type defines all possible response structures for the PATCH OrganizationsByOrganizationIdPlan endpoint.
4655
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
4656
+ * Use this type to ensure type safety when handling API responses from this endpoint.
4657
+ *
4658
+
4659
+ *
4660
+ * @path /v1/organizations/{organization_id}/plan
4661
+ *
4662
+ * @see {@link PATCH_OrganizationsByOrganizationIdPlan_Response_200} - 200 response type
4663
+ * @see {@link PATCH_OrganizationsByOrganizationIdPlan_Response_422} - 422 response type
4664
+ *
4665
+
4666
+ */
4667
+ export type PATCH_OrganizationsByOrganizationIdPlan_Response = PATCH_OrganizationsByOrganizationIdPlan_Response_200 | PATCH_OrganizationsByOrganizationIdPlan_Response_422;
4668
+
4669
+ /**
4670
+ * 200 response for PATCH OrganizationsByOrganizationIdPlan endpoint
4671
+ *
4672
+ * @remarks
4673
+ * This type defines the response structure for the 200 status code
4674
+ * of the PATCH OrganizationsByOrganizationIdPlan endpoint.
4675
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4676
+ *
4677
+
4678
+ *
4679
+ * @path /v1/organizations/{organization_id}/plan
4680
+ *
4681
+ * @see {@link PATCH_OrganizationsByOrganizationIdPlan_Response} - The main response type definition
4682
+ * @see {@link OrganizationWithBillingData} - The actual schema type definition
4683
+ */
4684
+ export type PATCH_OrganizationsByOrganizationIdPlan_Response_200 = OrganizationWithBillingData
4685
+
4686
+ /**
4687
+ * 422 response for PATCH OrganizationsByOrganizationIdPlan endpoint
4688
+ *
4689
+ * @remarks
4690
+ * This type defines the response structure for the 422 status code
4691
+ * of the PATCH OrganizationsByOrganizationIdPlan endpoint.
4692
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
4693
+ *
4694
+
4695
+ *
4696
+ * @path /v1/organizations/{organization_id}/plan
4697
+ *
4698
+ * @see {@link PATCH_OrganizationsByOrganizationIdPlan_Response} - The main response type definition
4699
+ * @see {@link HTTPValidationError} - The actual schema type definition
4700
+ */
4701
+ export type PATCH_OrganizationsByOrganizationIdPlan_Response_422 = HTTPValidationError
4702
+
4648
4703
  /**
4649
4704
  * Response types for GET OrganizationsByOrganizationIdPlans endpoint
4650
4705
  *
@@ -4759,7 +4814,10 @@ export type GET_OrganizationsByOrganizationIdPricingProductTypeByProductType_Res
4759
4814
  * Response types for GET OrganizationsIpRestrictions endpoint
4760
4815
  *
4761
4816
  * List Ip Restrictions
4762
- * Get all IP restrictions for the organization
4817
+ * List all IP restrictions for the organization.
4818
+
4819
+ Returns a list of all IP restrictions configured for your organization.
4820
+ Single IP addresses are returned with CIDR notation (/32 for IPv4, /128 for IPv6).
4763
4821
  *
4764
4822
  * @remarks
4765
4823
  * This type defines all possible response structures for the GET OrganizationsIpRestrictions endpoint.
@@ -4797,7 +4855,10 @@ export type GET_OrganizationsIpRestrictions_Response_200 = IpRestrictionArray
4797
4855
  * Response types for POST OrganizationsIpRestrictions endpoint
4798
4856
  *
4799
4857
  * Create Ip Restriction
4800
- * Create a new IP restriction for the organization
4858
+ * Create a new IP restriction for the organization.
4859
+
4860
+ Accepts either a single IP address or a CIDR network range.
4861
+ Individual IP addresses are stored and returned with CIDR notation (/32 for IPv4, /128 for IPv6).
4801
4862
  *
4802
4863
  * @remarks
4803
4864
  * This type defines all possible response structures for the POST OrganizationsIpRestrictions endpoint.
@@ -4853,7 +4914,9 @@ export type POST_OrganizationsIpRestrictions_Response_422 = HTTPValidationError
4853
4914
  * Response types for DELETE OrganizationsIpRestrictionsByIpRestrictionId endpoint
4854
4915
  *
4855
4916
  * Delete Ip Restriction
4856
- * Delete an IP restriction
4917
+ * Delete an IP restriction.
4918
+
4919
+ Permanently removes the specified IP restriction from your organization.
4857
4920
  *
4858
4921
  * @remarks
4859
4922
  * This type defines all possible response structures for the DELETE OrganizationsIpRestrictionsByIpRestrictionId endpoint.
@@ -4891,7 +4954,10 @@ export type DELETE_OrganizationsIpRestrictionsByIpRestrictionId_Response_422 = H
4891
4954
  * Response types for GET OrganizationsIpRestrictionsByIpRestrictionId endpoint
4892
4955
  *
4893
4956
  * Get Ip Restriction
4894
- * Get a specific IP restriction by ID
4957
+ * Get a specific IP restriction by ID.
4958
+
4959
+ Returns the details of a specific IP restriction if it exists and belongs to your organization.
4960
+ Single IP addresses are returned with CIDR notation (/32 for IPv4, /128 for IPv6).
4895
4961
  *
4896
4962
  * @remarks
4897
4963
  * This type defines all possible response structures for the GET OrganizationsIpRestrictionsByIpRestrictionId endpoint.
@@ -4947,7 +5013,10 @@ export type GET_OrganizationsIpRestrictionsByIpRestrictionId_Response_422 = HTTP
4947
5013
  * Response types for PATCH OrganizationsIpRestrictionsByIpRestrictionId endpoint
4948
5014
  *
4949
5015
  * Update Ip Restriction
4950
- * Update an IP restriction
5016
+ * Update an existing IP restriction.
5017
+
5018
+ You can update the IP network range or the last usage timestamp.
5019
+ Individual IP addresses are stored and returned with CIDR notation (/32 for IPv4, /128 for IPv6).
4951
5020
  *
4952
5021
  * @remarks
4953
5022
  * This type defines all possible response structures for the PATCH OrganizationsIpRestrictionsByIpRestrictionId endpoint.
@@ -1499,7 +1499,10 @@ export type HTTPValidationError = components['schemas']['HTTPValidationError'];
1499
1499
  */
1500
1500
  export type IdnBase = components['schemas']['IdnBase'];
1501
1501
  /**
1502
- * IpRestrictionCreate
1502
+ * IpRestrictionCreate. Create an IP restriction for an organization.
1503
+
1504
+ Accepts either a single IP address or a CIDR network range.
1505
+ Individual IP addresses are stored and returned with CIDR notation (/32 for IPv4, /128 for IPv6).
1503
1506
  *
1504
1507
  * @remarks
1505
1508
  * Type alias for the `IpRestrictionCreate` OpenAPI schema.
@@ -1531,7 +1534,9 @@ export type IpRestrictionCreate = components['schemas']['IpRestrictionCreate'];
1531
1534
  */
1532
1535
  export type IpRestriction = components['schemas']['IpRestrictionResponse'];
1533
1536
  /**
1534
- * IpRestrictionUpdate
1537
+ * IpRestrictionUpdate. Update an existing IP restriction.
1538
+
1539
+ You can update the IP network range or the last usage timestamp.
1535
1540
  *
1536
1541
  * @remarks
1537
1542
  * Type alias for the `IpRestrictionUpdate` OpenAPI schema.
@@ -2234,6 +2239,38 @@ export type PermissionSet = components['schemas']['PermissionSet'];
2234
2239
  * @see {@link components} - The OpenAPI components schema definition
2235
2240
  */
2236
2241
  export type PlanInfo = components['schemas']['PlanInfo'];
2242
+ /**
2243
+ * PlanRelation
2244
+ *
2245
+ * @remarks
2246
+ * Type alias for the `PlanRelation` OpenAPI schema.
2247
+ * This type represents planrelation data structures used in API requests and responses.
2248
+ *
2249
+ * @example
2250
+ * ```typescript
2251
+ * const response = await api.getPlanRelation();
2252
+ * const item: PlanRelation = response.results;
2253
+ * ```
2254
+ *
2255
+ * @see {@link components} - The OpenAPI components schema definition
2256
+ */
2257
+ export type PlanRelation = components['schemas']['PlanRelation'];
2258
+ /**
2259
+ * PlanUpdate
2260
+ *
2261
+ * @remarks
2262
+ * Type alias for the `PlanUpdate` OpenAPI schema.
2263
+ * This type represents planupdate data structures used in API requests and responses.
2264
+ *
2265
+ * @example
2266
+ * ```typescript
2267
+ * const response = await api.getPlanUpdate();
2268
+ * const item: PlanUpdate = response.results;
2269
+ * ```
2270
+ *
2271
+ * @see {@link components} - The OpenAPI components schema definition
2272
+ */
2273
+ export type PlanUpdate = components['schemas']['PlanUpdate'];
2237
2274
  /**
2238
2275
  * PostTransferRequirements
2239
2276
  *
package/src/openapi.yaml CHANGED
@@ -2352,11 +2352,22 @@ components:
2352
2352
  title: IdnBase
2353
2353
  type: object
2354
2354
  IpRestrictionCreate:
2355
+ description: 'Create an IP restriction for an organization.
2356
+
2357
+
2358
+ Accepts either a single IP address or a CIDR network range.
2359
+
2360
+ Individual IP addresses are stored and returned with CIDR notation (/32 for
2361
+ IPv4, /128 for IPv6).'
2355
2362
  properties:
2356
2363
  ip_network:
2357
- description: IP address or CIDR range for the restriction.
2364
+ description: IP address or CIDR network range. Individual IPs can be specified
2365
+ without CIDR notation.
2358
2366
  examples:
2367
+ - 192.0.2.1
2359
2368
  - 192.0.2.0/24
2369
+ - 2001:db8::1
2370
+ - 2001:db8::/32
2360
2371
  format: ipvanynetwork
2361
2372
  title: Ip Network
2362
2373
  type: string
@@ -2379,9 +2390,13 @@ components:
2379
2390
  title: Created On
2380
2391
  type: string
2381
2392
  ip_network:
2382
- description: IP address or CIDR range for the restriction.
2393
+ description: IP address or CIDR network range. Single IPs are returned with
2394
+ /32 (IPv4) or /128 (IPv6) notation.
2383
2395
  examples:
2396
+ - 192.0.2.1/32
2384
2397
  - 192.0.2.0/24
2398
+ - 2001:db8::1/128
2399
+ - 2001:db8::/32
2385
2400
  format: ipvanynetwork
2386
2401
  title: Ip Network
2387
2402
  type: string
@@ -2410,15 +2425,22 @@ components:
2410
2425
  title: IpRestrictionResponse
2411
2426
  type: object
2412
2427
  IpRestrictionUpdate:
2428
+ description: 'Update an existing IP restriction.
2429
+
2430
+
2431
+ You can update the IP network range or the last usage timestamp.'
2413
2432
  properties:
2414
2433
  ip_network:
2415
2434
  anyOf:
2416
2435
  - format: ipvanynetwork
2417
2436
  type: string
2418
2437
  - type: 'null'
2419
- description: IP address or CIDR range for the restriction.
2438
+ description: IP address or CIDR network range to replace the existing restriction.
2420
2439
  examples:
2440
+ - 192.0.2.1
2421
2441
  - 192.0.2.0/24
2442
+ - 2001:db8::1
2443
+ - 2001:db8::/32
2422
2444
  title: Ip Network
2423
2445
  last_used_on:
2424
2446
  anyOf:
@@ -3858,6 +3880,22 @@ components:
3858
3880
  - amount
3859
3881
  title: PlanInfo
3860
3882
  type: object
3883
+ PlanRelation:
3884
+ enum:
3885
+ - basic
3886
+ - enterprise
3887
+ - corporate
3888
+ - premium
3889
+ - starter
3890
+ title: PlanRelation
3891
+ type: string
3892
+ PlanUpdate:
3893
+ properties:
3894
+ plan:
3895
+ $ref: '#/components/schemas/PlanRelation'
3896
+ default: basic
3897
+ title: PlanUpdate
3898
+ type: object
3861
3899
  PostTransferRequirements:
3862
3900
  enum:
3863
3901
  - update_contacts
@@ -5335,7 +5373,7 @@ info:
5335
5373
  '
5336
5374
  summary: OpusDNS - your gateway to a seamless domain management experience.
5337
5375
  title: OpusDNS API
5338
- version: 2025-09-18-131050
5376
+ version: 2025-09-18-175712
5339
5377
  x-logo:
5340
5378
  altText: OpusDNS API Reference
5341
5379
  url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -8879,7 +8917,13 @@ paths:
8879
8917
  - organization
8880
8918
  /v1/organizations/ip-restrictions:
8881
8919
  get:
8882
- description: Get all IP restrictions for the organization
8920
+ description: 'List all IP restrictions for the organization.
8921
+
8922
+
8923
+ Returns a list of all IP restrictions configured for your organization.
8924
+
8925
+ Single IP addresses are returned with CIDR notation (/32 for IPv4, /128 for
8926
+ IPv6).'
8883
8927
  operationId: list_ip_restrictions_v1_organizations_ip_restrictions_get
8884
8928
  responses:
8885
8929
  '200':
@@ -8898,7 +8942,13 @@ paths:
8898
8942
  tags:
8899
8943
  - organization
8900
8944
  post:
8901
- description: Create a new IP restriction for the organization
8945
+ description: 'Create a new IP restriction for the organization.
8946
+
8947
+
8948
+ Accepts either a single IP address or a CIDR network range.
8949
+
8950
+ Individual IP addresses are stored and returned with CIDR notation (/32 for
8951
+ IPv4, /128 for IPv6).'
8902
8952
  operationId: create_ip_restriction_v1_organizations_ip_restrictions_post
8903
8953
  requestBody:
8904
8954
  content:
@@ -8926,7 +8976,10 @@ paths:
8926
8976
  - organization
8927
8977
  /v1/organizations/ip-restrictions/{ip_restriction_id}:
8928
8978
  delete:
8929
- description: Delete an IP restriction
8979
+ description: 'Delete an IP restriction.
8980
+
8981
+
8982
+ Permanently removes the specified IP restriction from your organization.'
8930
8983
  operationId: delete_ip_restriction_v1_organizations_ip_restrictions__ip_restriction_id__delete
8931
8984
  parameters:
8932
8985
  - in: path
@@ -8950,7 +9003,14 @@ paths:
8950
9003
  tags:
8951
9004
  - organization
8952
9005
  get:
8953
- description: Get a specific IP restriction by ID
9006
+ description: 'Get a specific IP restriction by ID.
9007
+
9008
+
9009
+ Returns the details of a specific IP restriction if it exists and belongs
9010
+ to your organization.
9011
+
9012
+ Single IP addresses are returned with CIDR notation (/32 for IPv4, /128 for
9013
+ IPv6).'
8954
9014
  operationId: get_ip_restriction_v1_organizations_ip_restrictions__ip_restriction_id__get
8955
9015
  parameters:
8956
9016
  - in: path
@@ -8978,7 +9038,13 @@ paths:
8978
9038
  tags:
8979
9039
  - organization
8980
9040
  patch:
8981
- description: Update an IP restriction
9041
+ description: 'Update an existing IP restriction.
9042
+
9043
+
9044
+ You can update the IP network range or the last usage timestamp.
9045
+
9046
+ Individual IP addresses are stored and returned with CIDR notation (/32 for
9047
+ IPv4, /128 for IPv6).'
8982
9048
  operationId: update_ip_restriction_v1_organizations_ip_restrictions__ip_restriction_id__patch
8983
9049
  parameters:
8984
9050
  - in: path
@@ -9163,6 +9229,45 @@ paths:
9163
9229
  summary: Update Organization
9164
9230
  tags:
9165
9231
  - organization
9232
+ /v1/organizations/{organization_id}/plan:
9233
+ patch:
9234
+ operationId: change_plan_v1_organizations__organization_id__plan_patch
9235
+ parameters:
9236
+ - in: path
9237
+ name: organization_id
9238
+ required: true
9239
+ schema:
9240
+ examples:
9241
+ - organization_01h45ytscbebyvny4gc8cr8ma2
9242
+ format: typeid
9243
+ pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
9244
+ title: Organization Id
9245
+ type: string
9246
+ x-typeid-prefix: organization
9247
+ requestBody:
9248
+ content:
9249
+ application/json:
9250
+ schema:
9251
+ $ref: '#/components/schemas/PlanUpdate'
9252
+ required: true
9253
+ responses:
9254
+ '200':
9255
+ content:
9256
+ application/json:
9257
+ schema:
9258
+ $ref: '#/components/schemas/OrganizationWithBillingData'
9259
+ description: Successful Response
9260
+ '422':
9261
+ content:
9262
+ application/problem+json:
9263
+ schema:
9264
+ $ref: '#/components/schemas/HTTPValidationError'
9265
+ description: Validation Error
9266
+ security:
9267
+ - OAuth2PasswordBearer: []
9268
+ summary: Change Plan
9269
+ tags:
9270
+ - organization
9166
9271
  /v1/organizations/{organization_id}/plans:
9167
9272
  get:
9168
9273
  operationId: get_current_available_plans_v1_organizations__organization_id__plans_get
package/src/schema.d.ts CHANGED
@@ -861,13 +861,19 @@ export interface paths {
861
861
  };
862
862
  /**
863
863
  * List Ip Restrictions
864
- * @description Get all IP restrictions for the organization
864
+ * @description List all IP restrictions for the organization.
865
+ *
866
+ * Returns a list of all IP restrictions configured for your organization.
867
+ * Single IP addresses are returned with CIDR notation (/32 for IPv4, /128 for IPv6).
865
868
  */
866
869
  get: operations["list_ip_restrictions_v1_organizations_ip_restrictions_get"];
867
870
  put?: never;
868
871
  /**
869
872
  * Create Ip Restriction
870
- * @description Create a new IP restriction for the organization
873
+ * @description Create a new IP restriction for the organization.
874
+ *
875
+ * Accepts either a single IP address or a CIDR network range.
876
+ * Individual IP addresses are stored and returned with CIDR notation (/32 for IPv4, /128 for IPv6).
871
877
  */
872
878
  post: operations["create_ip_restriction_v1_organizations_ip_restrictions_post"];
873
879
  delete?: never;
@@ -885,21 +891,29 @@ export interface paths {
885
891
  };
886
892
  /**
887
893
  * Get Ip Restriction
888
- * @description Get a specific IP restriction by ID
894
+ * @description Get a specific IP restriction by ID.
895
+ *
896
+ * Returns the details of a specific IP restriction if it exists and belongs to your organization.
897
+ * Single IP addresses are returned with CIDR notation (/32 for IPv4, /128 for IPv6).
889
898
  */
890
899
  get: operations["get_ip_restriction_v1_organizations_ip_restrictions__ip_restriction_id__get"];
891
900
  put?: never;
892
901
  post?: never;
893
902
  /**
894
903
  * Delete Ip Restriction
895
- * @description Delete an IP restriction
904
+ * @description Delete an IP restriction.
905
+ *
906
+ * Permanently removes the specified IP restriction from your organization.
896
907
  */
897
908
  delete: operations["delete_ip_restriction_v1_organizations_ip_restrictions__ip_restriction_id__delete"];
898
909
  options?: never;
899
910
  head?: never;
900
911
  /**
901
912
  * Update Ip Restriction
902
- * @description Update an IP restriction
913
+ * @description Update an existing IP restriction.
914
+ *
915
+ * You can update the IP network range or the last usage timestamp.
916
+ * Individual IP addresses are stored and returned with CIDR notation (/32 for IPv4, /128 for IPv6).
903
917
  */
904
918
  patch: operations["update_ip_restriction_v1_organizations_ip_restrictions__ip_restriction_id__patch"];
905
919
  trace?: never;
@@ -957,6 +971,23 @@ export interface paths {
957
971
  patch: operations["update_organization_v1_organizations__organization_id__patch"];
958
972
  trace?: never;
959
973
  };
974
+ "/v1/organizations/{organization_id}/plan": {
975
+ parameters: {
976
+ query?: never;
977
+ header?: never;
978
+ path?: never;
979
+ cookie?: never;
980
+ };
981
+ get?: never;
982
+ put?: never;
983
+ post?: never;
984
+ delete?: never;
985
+ options?: never;
986
+ head?: never;
987
+ /** Change Plan */
988
+ patch: operations["change_plan_v1_organizations__organization_id__plan_patch"];
989
+ trace?: never;
990
+ };
960
991
  "/v1/organizations/{organization_id}/plans": {
961
992
  parameters: {
962
993
  query?: never;
@@ -2749,12 +2780,18 @@ export interface components {
2749
2780
  */
2750
2781
  idn_tables?: string[] | null;
2751
2782
  };
2752
- /** IpRestrictionCreate */
2783
+ /**
2784
+ * IpRestrictionCreate
2785
+ * @description Create an IP restriction for an organization.
2786
+ *
2787
+ * Accepts either a single IP address or a CIDR network range.
2788
+ * Individual IP addresses are stored and returned with CIDR notation (/32 for IPv4, /128 for IPv6).
2789
+ */
2753
2790
  IpRestrictionCreate: {
2754
2791
  /**
2755
2792
  * Ip Network
2756
2793
  * Format: ipvanynetwork
2757
- * @description IP address or CIDR range for the restriction.
2794
+ * @description IP address or CIDR network range. Individual IPs can be specified without CIDR notation.
2758
2795
  */
2759
2796
  ip_network: string;
2760
2797
  /**
@@ -2773,7 +2810,7 @@ export interface components {
2773
2810
  /**
2774
2811
  * Ip Network
2775
2812
  * Format: ipvanynetwork
2776
- * @description IP address or CIDR range for the restriction.
2813
+ * @description IP address or CIDR network range. Single IPs are returned with /32 (IPv4) or /128 (IPv6) notation.
2777
2814
  */
2778
2815
  ip_network: string;
2779
2816
  /** Ip Restriction Id */
@@ -2786,11 +2823,16 @@ export interface components {
2786
2823
  */
2787
2824
  organization_id: TypeId<"organization">;
2788
2825
  };
2789
- /** IpRestrictionUpdate */
2826
+ /**
2827
+ * IpRestrictionUpdate
2828
+ * @description Update an existing IP restriction.
2829
+ *
2830
+ * You can update the IP network range or the last usage timestamp.
2831
+ */
2790
2832
  IpRestrictionUpdate: {
2791
2833
  /**
2792
2834
  * Ip Network
2793
- * @description IP address or CIDR range for the restriction.
2835
+ * @description IP address or CIDR network range to replace the existing restriction.
2794
2836
  */
2795
2837
  ip_network?: string | null;
2796
2838
  /**
@@ -3776,6 +3818,16 @@ export interface components {
3776
3818
  */
3777
3819
  plan_type?: string | null;
3778
3820
  };
3821
+ /**
3822
+ * PlanRelation
3823
+ * @enum {string}
3824
+ */
3825
+ PlanRelation: "basic" | "enterprise" | "corporate" | "premium" | "starter";
3826
+ /** PlanUpdate */
3827
+ PlanUpdate: {
3828
+ /** @default basic */
3829
+ plan: components["schemas"]["PlanRelation"];
3830
+ };
3779
3831
  /**
3780
3832
  * PostTransferRequirements
3781
3833
  * @enum {string}
@@ -8262,6 +8314,41 @@ export interface operations {
8262
8314
  };
8263
8315
  };
8264
8316
  };
8317
+ change_plan_v1_organizations__organization_id__plan_patch: {
8318
+ parameters: {
8319
+ query?: never;
8320
+ header?: never;
8321
+ path: {
8322
+ organization_id: TypeId<"organization">;
8323
+ };
8324
+ cookie?: never;
8325
+ };
8326
+ requestBody: {
8327
+ content: {
8328
+ "application/json": components["schemas"]["PlanUpdate"];
8329
+ };
8330
+ };
8331
+ responses: {
8332
+ /** @description Successful Response */
8333
+ 200: {
8334
+ headers: {
8335
+ [name: string]: unknown;
8336
+ };
8337
+ content: {
8338
+ "application/json": components["schemas"]["OrganizationWithBillingData"];
8339
+ };
8340
+ };
8341
+ /** @description Validation Error */
8342
+ 422: {
8343
+ headers: {
8344
+ [name: string]: unknown;
8345
+ };
8346
+ content: {
8347
+ "application/problem+json": components["schemas"]["HTTPValidationError"];
8348
+ };
8349
+ };
8350
+ };
8351
+ };
8265
8352
  get_current_available_plans_v1_organizations__organization_id__plans_get: {
8266
8353
  parameters: {
8267
8354
  query?: never;