@opusdns/api 0.52.0 → 0.53.0

package/package.json

@@ -8,7 +8,7 @@
     "typescript": "^5.8.2"
   },
   "name": "@opusdns/api",
-  "version": "0.52.0",
+  "version": "0.53.0",
   "description": "TypeScript types for the OpusDNS OpenAPI specification",
   "main": "./src/index.ts",
   "module": "./src/index.ts",

package/src/helpers/keys.ts

@@ -9489,7 +9489,7 @@ export const KEYS_IDN_BASE = [
 /**
  * Ip Network
  *
- * IP address or CIDR range for the restriction.
+ * IP address or CIDR network range. Individual IPs can be specified without CIDR notation.
  *
  * @type {string}
  *
@@ -9591,7 +9591,7 @@ export const KEY_IP_RESTRICTION_CREATED_ON = 'created_on' as keyof IpRestriction
 /**
  * Ip Network
  *
- * IP address or CIDR range for the restriction.
+ * IP address or CIDR network range. Single IPs are returned with /32 (IPv4) or /128 (IPv6) notation.
  *
  * @type {string}
  *
@@ -9720,7 +9720,7 @@ export const KEYS_IP_RESTRICTION = [
 /**
  * Ip Network
  *
- * IP address or CIDR range for the restriction.
+ * IP address or CIDR network range to replace the existing restriction.
  *
  *
  *

package/src/helpers/requests.d.ts

@@ -2952,7 +2952,10 @@ export type PATCH_OrganizationsAttributesOrganizationId_Request_Body = PATCH_Org
  * Request type for GET OrganizationsIpRestrictions endpoint
  *
  * List Ip Restrictions
- * Get all IP restrictions for the organization
+ * List all IP restrictions for the organization.
+
+Returns a list of all IP restrictions configured for your organization.
+Single IP addresses are returned with CIDR notation (/32 for IPv4, /128 for IPv6).
  *
  * @remarks
  * This type defines the complete request structure for the GET OrganizationsIpRestrictions endpoint.
@@ -2975,7 +2978,10 @@ export type GET_OrganizationsIpRestrictions_Request = {
  * Request type for POST OrganizationsIpRestrictions endpoint
  *
  * Create Ip Restriction
- * Create a new IP restriction for the organization
+ * Create a new IP restriction for the organization.
+
+Accepts either a single IP address or a CIDR network range.
+Individual IP addresses are stored and returned with CIDR notation (/32 for IPv4, /128 for IPv6).
  *
  * @remarks
  * This type defines the complete request structure for the POST OrganizationsIpRestrictions endpoint.
@@ -3012,7 +3018,9 @@ export type POST_OrganizationsIpRestrictions_Request_Body = POST_OrganizationsIp
  * Request type for DELETE OrganizationsIpRestrictionsIpRestrictionId endpoint
  *
  * Delete Ip Restriction
- * Delete an IP restriction
+ * Delete an IP restriction.
+
+Permanently removes the specified IP restriction from your organization.
  *
  * @remarks
  * This type defines the complete request structure for the DELETE OrganizationsIpRestrictionsIpRestrictionId endpoint.
@@ -3051,7 +3059,10 @@ export type DELETE_OrganizationsIpRestrictionsIpRestrictionId_Request_Path = DEL
  * Request type for GET OrganizationsIpRestrictionsIpRestrictionId endpoint
  *
  * Get Ip Restriction
- * Get a specific IP restriction by ID
+ * Get a specific IP restriction by ID.
+
+Returns the details of a specific IP restriction if it exists and belongs to your organization.
+Single IP addresses are returned with CIDR notation (/32 for IPv4, /128 for IPv6).
  *
  * @remarks
  * This type defines the complete request structure for the GET OrganizationsIpRestrictionsIpRestrictionId endpoint.
@@ -3090,7 +3101,10 @@ export type GET_OrganizationsIpRestrictionsIpRestrictionId_Request_Path = GET_Or
  * Request type for PATCH OrganizationsIpRestrictionsIpRestrictionId endpoint
  *
  * Update Ip Restriction
- * Update an IP restriction
+ * Update an existing IP restriction.
+
+You can update the IP network range or the last usage timestamp.
+Individual IP addresses are stored and returned with CIDR notation (/32 for IPv4, /128 for IPv6).
  *
  * @remarks
  * This type defines the complete request structure for the PATCH OrganizationsIpRestrictionsIpRestrictionId endpoint.

package/src/helpers/responses.d.ts

@@ -4759,7 +4759,10 @@ export type GET_OrganizationsByOrganizationIdPricingProductTypeByProductType_Res
  * Response types for GET OrganizationsIpRestrictions endpoint
  *
  * List Ip Restrictions
- * Get all IP restrictions for the organization
+ * List all IP restrictions for the organization.
+
+Returns a list of all IP restrictions configured for your organization.
+Single IP addresses are returned with CIDR notation (/32 for IPv4, /128 for IPv6).
  *
  * @remarks
  * This type defines all possible response structures for the GET OrganizationsIpRestrictions endpoint.
@@ -4797,7 +4800,10 @@ export type GET_OrganizationsIpRestrictions_Response_200 = IpRestrictionArray
  * Response types for POST OrganizationsIpRestrictions endpoint
  *
  * Create Ip Restriction
- * Create a new IP restriction for the organization
+ * Create a new IP restriction for the organization.
+
+Accepts either a single IP address or a CIDR network range.
+Individual IP addresses are stored and returned with CIDR notation (/32 for IPv4, /128 for IPv6).
  *
  * @remarks
  * This type defines all possible response structures for the POST OrganizationsIpRestrictions endpoint.
@@ -4853,7 +4859,9 @@ export type POST_OrganizationsIpRestrictions_Response_422 = HTTPValidationError
  * Response types for DELETE OrganizationsIpRestrictionsByIpRestrictionId endpoint
  *
  * Delete Ip Restriction
- * Delete an IP restriction
+ * Delete an IP restriction.
+
+Permanently removes the specified IP restriction from your organization.
  *
  * @remarks
  * This type defines all possible response structures for the DELETE OrganizationsIpRestrictionsByIpRestrictionId endpoint.
@@ -4891,7 +4899,10 @@ export type DELETE_OrganizationsIpRestrictionsByIpRestrictionId_Response_422 = H
  * Response types for GET OrganizationsIpRestrictionsByIpRestrictionId endpoint
  *
  * Get Ip Restriction
- * Get a specific IP restriction by ID
+ * Get a specific IP restriction by ID.
+
+Returns the details of a specific IP restriction if it exists and belongs to your organization.
+Single IP addresses are returned with CIDR notation (/32 for IPv4, /128 for IPv6).
  *
  * @remarks
  * This type defines all possible response structures for the GET OrganizationsIpRestrictionsByIpRestrictionId endpoint.
@@ -4947,7 +4958,10 @@ export type GET_OrganizationsIpRestrictionsByIpRestrictionId_Response_422 = HTTP
  * Response types for PATCH OrganizationsIpRestrictionsByIpRestrictionId endpoint
  *
  * Update Ip Restriction
- * Update an IP restriction
+ * Update an existing IP restriction.
+
+You can update the IP network range or the last usage timestamp.
+Individual IP addresses are stored and returned with CIDR notation (/32 for IPv4, /128 for IPv6).
  *
  * @remarks
  * This type defines all possible response structures for the PATCH OrganizationsIpRestrictionsByIpRestrictionId endpoint.

package/src/helpers/schemas.d.ts

@@ -1499,7 +1499,10 @@ export type HTTPValidationError = components['schemas']['HTTPValidationError'];
  */
 export type IdnBase = components['schemas']['IdnBase'];
 /**
- * IpRestrictionCreate
+ * IpRestrictionCreate. Create an IP restriction for an organization.
+
+Accepts either a single IP address or a CIDR network range.
+Individual IP addresses are stored and returned with CIDR notation (/32 for IPv4, /128 for IPv6).
  *
  * @remarks
  * Type alias for the `IpRestrictionCreate` OpenAPI schema.
@@ -1531,7 +1534,9 @@ export type IpRestrictionCreate = components['schemas']['IpRestrictionCreate'];
  */
 export type IpRestriction = components['schemas']['IpRestrictionResponse'];
 /**
- * IpRestrictionUpdate
+ * IpRestrictionUpdate. Update an existing IP restriction.
+
+You can update the IP network range or the last usage timestamp.
  *
  * @remarks
  * Type alias for the `IpRestrictionUpdate` OpenAPI schema.

package/src/openapi.yaml

@@ -2352,11 +2352,22 @@ components:
       title: IdnBase
       type: object
     IpRestrictionCreate:
+      description: 'Create an IP restriction for an organization.
+
+
+        Accepts either a single IP address or a CIDR network range.
+
+        Individual IP addresses are stored and returned with CIDR notation (/32 for
+        IPv4, /128 for IPv6).'
       properties:
         ip_network:
-          description: IP address or CIDR range for the restriction.
+          description: IP address or CIDR network range. Individual IPs can be specified
+            without CIDR notation.
           examples:
+          - 192.0.2.1
           - 192.0.2.0/24
+          - 2001:db8::1
+          - 2001:db8::/32
           format: ipvanynetwork
           title: Ip Network
           type: string
@@ -2379,9 +2390,13 @@ components:
           title: Created On
           type: string
         ip_network:
-          description: IP address or CIDR range for the restriction.
+          description: IP address or CIDR network range. Single IPs are returned with
+            /32 (IPv4) or /128 (IPv6) notation.
           examples:
+          - 192.0.2.1/32
           - 192.0.2.0/24
+          - 2001:db8::1/128
+          - 2001:db8::/32
           format: ipvanynetwork
           title: Ip Network
           type: string
@@ -2410,15 +2425,22 @@ components:
       title: IpRestrictionResponse
       type: object
     IpRestrictionUpdate:
+      description: 'Update an existing IP restriction.
+
+
+        You can update the IP network range or the last usage timestamp.'
       properties:
         ip_network:
           anyOf:
           - format: ipvanynetwork
             type: string
           - type: 'null'
-          description: IP address or CIDR range for the restriction.
+          description: IP address or CIDR network range to replace the existing restriction.
           examples:
+          - 192.0.2.1
           - 192.0.2.0/24
+          - 2001:db8::1
+          - 2001:db8::/32
           title: Ip Network
         last_used_on:
           anyOf:
@@ -5335,7 +5357,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2025-09-18-131050
+  version: 2025-09-18-175058
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -8879,7 +8901,13 @@ paths:
       - organization
   /v1/organizations/ip-restrictions:
     get:
-      description: Get all IP restrictions for the organization
+      description: 'List all IP restrictions for the organization.
+
+
+        Returns a list of all IP restrictions configured for your organization.
+
+        Single IP addresses are returned with CIDR notation (/32 for IPv4, /128 for
+        IPv6).'
       operationId: list_ip_restrictions_v1_organizations_ip_restrictions_get
       responses:
         '200':
@@ -8898,7 +8926,13 @@ paths:
       tags:
       - organization
     post:
-      description: Create a new IP restriction for the organization
+      description: 'Create a new IP restriction for the organization.
+
+
+        Accepts either a single IP address or a CIDR network range.
+
+        Individual IP addresses are stored and returned with CIDR notation (/32 for
+        IPv4, /128 for IPv6).'
       operationId: create_ip_restriction_v1_organizations_ip_restrictions_post
       requestBody:
         content:
@@ -8926,7 +8960,10 @@ paths:
       - organization
   /v1/organizations/ip-restrictions/{ip_restriction_id}:
     delete:
-      description: Delete an IP restriction
+      description: 'Delete an IP restriction.
+
+
+        Permanently removes the specified IP restriction from your organization.'
       operationId: delete_ip_restriction_v1_organizations_ip_restrictions__ip_restriction_id__delete
       parameters:
       - in: path
@@ -8950,7 +8987,14 @@ paths:
       tags:
       - organization
     get:
-      description: Get a specific IP restriction by ID
+      description: 'Get a specific IP restriction by ID.
+
+
+        Returns the details of a specific IP restriction if it exists and belongs
+        to your organization.
+
+        Single IP addresses are returned with CIDR notation (/32 for IPv4, /128 for
+        IPv6).'
       operationId: get_ip_restriction_v1_organizations_ip_restrictions__ip_restriction_id__get
       parameters:
       - in: path
@@ -8978,7 +9022,13 @@ paths:
       tags:
       - organization
     patch:
-      description: Update an IP restriction
+      description: 'Update an existing IP restriction.
+
+
+        You can update the IP network range or the last usage timestamp.
+
+        Individual IP addresses are stored and returned with CIDR notation (/32 for
+        IPv4, /128 for IPv6).'
       operationId: update_ip_restriction_v1_organizations_ip_restrictions__ip_restriction_id__patch
       parameters:
       - in: path

package/src/schema.d.ts

@@ -861,13 +861,19 @@ export interface paths {
         };
         /**
          * List Ip Restrictions
-         * @description Get all IP restrictions for the organization
+         * @description List all IP restrictions for the organization.
+         *
+         *     Returns a list of all IP restrictions configured for your organization.
+         *     Single IP addresses are returned with CIDR notation (/32 for IPv4, /128 for IPv6).
          */
         get: operations["list_ip_restrictions_v1_organizations_ip_restrictions_get"];
         put?: never;
         /**
          * Create Ip Restriction
-         * @description Create a new IP restriction for the organization
+         * @description Create a new IP restriction for the organization.
+         *
+         *     Accepts either a single IP address or a CIDR network range.
+         *     Individual IP addresses are stored and returned with CIDR notation (/32 for IPv4, /128 for IPv6).
          */
         post: operations["create_ip_restriction_v1_organizations_ip_restrictions_post"];
         delete?: never;
@@ -885,21 +891,29 @@ export interface paths {
         };
         /**
          * Get Ip Restriction
-         * @description Get a specific IP restriction by ID
+         * @description Get a specific IP restriction by ID.
+         *
+         *     Returns the details of a specific IP restriction if it exists and belongs to your organization.
+         *     Single IP addresses are returned with CIDR notation (/32 for IPv4, /128 for IPv6).
          */
         get: operations["get_ip_restriction_v1_organizations_ip_restrictions__ip_restriction_id__get"];
         put?: never;
         post?: never;
         /**
          * Delete Ip Restriction
-         * @description Delete an IP restriction
+         * @description Delete an IP restriction.
+         *
+         *     Permanently removes the specified IP restriction from your organization.
          */
         delete: operations["delete_ip_restriction_v1_organizations_ip_restrictions__ip_restriction_id__delete"];
         options?: never;
         head?: never;
         /**
          * Update Ip Restriction
-         * @description Update an IP restriction
+         * @description Update an existing IP restriction.
+         *
+         *     You can update the IP network range or the last usage timestamp.
+         *     Individual IP addresses are stored and returned with CIDR notation (/32 for IPv4, /128 for IPv6).
          */
         patch: operations["update_ip_restriction_v1_organizations_ip_restrictions__ip_restriction_id__patch"];
         trace?: never;
@@ -2749,12 +2763,18 @@ export interface components {
              */
             idn_tables?: string[] | null;
         };
-        /** IpRestrictionCreate */
+        /**
+         * IpRestrictionCreate
+         * @description Create an IP restriction for an organization.
+         *
+         *     Accepts either a single IP address or a CIDR network range.
+         *     Individual IP addresses are stored and returned with CIDR notation (/32 for IPv4, /128 for IPv6).
+         */
         IpRestrictionCreate: {
             /**
              * Ip Network
              * Format: ipvanynetwork
-             * @description IP address or CIDR range for the restriction.
+             * @description IP address or CIDR network range. Individual IPs can be specified without CIDR notation.
              */
             ip_network: string;
             /**
@@ -2773,7 +2793,7 @@ export interface components {
             /**
              * Ip Network
              * Format: ipvanynetwork
-             * @description IP address or CIDR range for the restriction.
+             * @description IP address or CIDR network range. Single IPs are returned with /32 (IPv4) or /128 (IPv6) notation.
              */
             ip_network: string;
             /** Ip Restriction Id */
@@ -2786,11 +2806,16 @@ export interface components {
              */
             organization_id: TypeId<"organization">;
         };
-        /** IpRestrictionUpdate */
+        /**
+         * IpRestrictionUpdate
+         * @description Update an existing IP restriction.
+         *
+         *     You can update the IP network range or the last usage timestamp.
+         */
         IpRestrictionUpdate: {
             /**
              * Ip Network
-             * @description IP address or CIDR range for the restriction.
+             * @description IP address or CIDR network range to replace the existing restriction.
              */
             ip_network?: string | null;
             /**