@opusdns/api 0.221.0 → 0.223.0

package/package.json

@@ -3,7 +3,7 @@
     "@opusdns/api-spec-ts-generator": "^0.19.0"
   },
   "name": "@opusdns/api",
-  "version": "0.221.0",
+  "version": "0.223.0",
   "description": "TypeScript types for the OpusDNS OpenAPI specification",
   "main": "./src/index.ts",
   "module": "./src/index.ts",

package/src/helpers/keys.ts

@@ -70,6 +70,7 @@ import { DnsZoneRrsetsPatchOps } from './schemas';
 import { DnsZoneSummary } from './schemas';
 import { DomainAvailability } from './schemas';
 import { DomainAvailabilityMeta } from './schemas';
+import { DomainAvailabilityRequest } from './schemas';
 import { DomainCheck } from './schemas';
 import { DomainContact } from './schemas';
 import { DomainCreate } from './schemas';
@@ -6674,6 +6675,56 @@ export const KEYS_DOMAIN_AVAILABILITY_META = [
   KEY_DOMAIN_AVAILABILITY_META_TOTAL,
 ] as const satisfies (keyof DomainAvailabilityMeta)[];
 
+/**
+ * Domains
+ *
+ *
+ * @type {array}
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `domains` property of DomainAvailabilityRequest objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = domainavailabilityrequest[KEY_DOMAIN_AVAILABILITY_REQUEST_DOMAINS];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_DOMAIN_AVAILABILITY_REQUEST_DOMAINS;
+ * const value = domainavailabilityrequest[propertyName];
+ * ```
+ *
+ * @see {@link DomainAvailabilityRequest} - The TypeScript type definition
+ * @see {@link KEYS_DOMAIN_AVAILABILITY_REQUEST} - Array of all keys for this type
+ */
+export const KEY_DOMAIN_AVAILABILITY_REQUEST_DOMAINS: keyof DomainAvailabilityRequest = 'domains';
+
+/**
+ * Array of all DomainAvailabilityRequest property keys
+ *
+ * @remarks
+ * This constant provides a readonly array containing all valid property keys for DomainAvailabilityRequest objects.
+ * Useful for iteration, validation, and generating dynamic UI components.
+ *
+ * @example
+ * ```typescript
+ * // Iterating through all keys
+ * for (const key of KEYS_DOMAIN_AVAILABILITY_REQUEST) {
+ *   console.log(`Property: ${key}, Value: ${domainavailabilityrequest[key]}`);
+ * }
+ * 
+ * // Validation
+ * const isValidKey = KEYS_DOMAIN_AVAILABILITY_REQUEST.includes(someKey);
+ * ```
+ *
+ * @see {@link DomainAvailabilityRequest} - The TypeScript type definition
+ */
+export const KEYS_DOMAIN_AVAILABILITY_REQUEST = [
+  KEY_DOMAIN_AVAILABILITY_REQUEST_DOMAINS,
+] as const satisfies (keyof DomainAvailabilityRequest)[];
+
 /**
  * Results
  *
@@ -17754,6 +17805,31 @@ export const KEY_ORGANIZATION_DEFAULT_LOCALE: keyof Organization = 'default_loca
  * @see {@link KEYS_ORGANIZATION} - Array of all keys for this type
  */
 export const KEY_ORGANIZATION_DELETED_ON: keyof Organization = 'deleted_on';
+/**
+ * Keycloak Organization Id
+ *
+ * Keycloak organization id
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `keycloak_organization_id` property of Organization objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = organization[KEY_ORGANIZATION_KEYCLOAK_ORGANIZATION_ID];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_ORGANIZATION_KEYCLOAK_ORGANIZATION_ID;
+ * const value = organization[propertyName];
+ * ```
+ *
+ * @see {@link Organization} - The TypeScript type definition
+ * @see {@link KEYS_ORGANIZATION} - Array of all keys for this type
+ */
+export const KEY_ORGANIZATION_KEYCLOAK_ORGANIZATION_ID: keyof Organization = 'keycloak_organization_id';
 /**
  * Name
  *
@@ -18038,6 +18114,7 @@ export const KEYS_ORGANIZATION = [
   KEY_ORGANIZATION_CURRENCY,
   KEY_ORGANIZATION_DEFAULT_LOCALE,
   KEY_ORGANIZATION_DELETED_ON,
+  KEY_ORGANIZATION_KEYCLOAK_ORGANIZATION_ID,
   KEY_ORGANIZATION_NAME,
   KEY_ORGANIZATION_ORGANIZATION_ID,
   KEY_ORGANIZATION_PARENT_ORGANIZATION_ID,
@@ -19910,6 +19987,31 @@ export const KEY_ORGANIZATION_WITH_BILLING_DATA_DEFAULT_LOCALE: keyof Organizati
  * @see {@link KEYS_ORGANIZATION_WITH_BILLING_DATA} - Array of all keys for this type
  */
 export const KEY_ORGANIZATION_WITH_BILLING_DATA_DELETED_ON: keyof OrganizationWithBillingData = 'deleted_on';
+/**
+ * Keycloak Organization Id
+ *
+ * Keycloak organization id
+ *
+ *
+ *
+ * @remarks
+ * This key constant provides type-safe access to the `keycloak_organization_id` property of OrganizationWithBillingData objects.
+ * Use this constant when you need to access properties dynamically or ensure type safety.
+ *
+ * @example
+ * ```typescript
+ * // Direct property access
+ * const value = organizationwithbillingdata[KEY_ORGANIZATION_WITH_BILLING_DATA_KEYCLOAK_ORGANIZATION_ID];
+ * 
+ * // Dynamic property access
+ * const propertyName = KEY_ORGANIZATION_WITH_BILLING_DATA_KEYCLOAK_ORGANIZATION_ID;
+ * const value = organizationwithbillingdata[propertyName];
+ * ```
+ *
+ * @see {@link OrganizationWithBillingData} - The TypeScript type definition
+ * @see {@link KEYS_ORGANIZATION_WITH_BILLING_DATA} - Array of all keys for this type
+ */
+export const KEY_ORGANIZATION_WITH_BILLING_DATA_KEYCLOAK_ORGANIZATION_ID: keyof OrganizationWithBillingData = 'keycloak_organization_id';
 /**
  * Name
  *
@@ -20197,6 +20299,7 @@ export const KEYS_ORGANIZATION_WITH_BILLING_DATA = [
   KEY_ORGANIZATION_WITH_BILLING_DATA_CURRENCY,
   KEY_ORGANIZATION_WITH_BILLING_DATA_DEFAULT_LOCALE,
   KEY_ORGANIZATION_WITH_BILLING_DATA_DELETED_ON,
+  KEY_ORGANIZATION_WITH_BILLING_DATA_KEYCLOAK_ORGANIZATION_ID,
   KEY_ORGANIZATION_WITH_BILLING_DATA_NAME,
   KEY_ORGANIZATION_WITH_BILLING_DATA_ORGANIZATION_ID,
   KEY_ORGANIZATION_WITH_BILLING_DATA_PARENT_ORGANIZATION_ID,

package/src/helpers/requests.d.ts

@@ -34,7 +34,7 @@ import { operations } from '../schema';
 
 import { DomainDnssecDataCreateArray, OrganizationAttributeUpdateArray } from './schemas-arrays.d';
 
-import { ContactCreate, ContactAttributeSetCreate, ContactAttributeSetUpdate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainForwardPatchOps, DomainForwardCreateRequest, DomainForwardSetCreateRequest, DomainForwardSetRequest, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainWithdrawRequest, DomainTransitRequest, DomainTransferIn, EmailForwardCreate, EmailForwardAliasCreate, EmailForwardAliasUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, ParkingSignupRequest, UserCreate, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
+import { DomainAvailabilityRequest, ContactCreate, ContactAttributeSetCreate, ContactAttributeSetUpdate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainForwardPatchOps, DomainForwardCreateRequest, DomainForwardSetCreateRequest, DomainForwardSetRequest, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainWithdrawRequest, DomainTransitRequest, DomainTransferIn, EmailForwardCreate, EmailForwardAliasCreate, EmailForwardAliasUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, ParkingSignupRequest, UserCreate, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
 
 /**
  * Request type for GET ArchiveEmailForwardLogsAliasesEmailForwardAliasId endpoint
@@ -385,6 +385,43 @@ Specify one or more domains to check for availability.
  */
 export type GET_AvailabilityStream_Request_Query = GET_AvailabilityStream_Request['parameters']['query'];
 
+/**
+ * Request type for POST AvailabilityStream endpoint
+ *
+ * Stream domain availability results
+ * Stream domain availability results using Server-Sent Events (SSE) until the `done` event is received.
+ *
+ * @remarks
+ * This type defines the complete request structure for the POST AvailabilityStream endpoint.
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @example
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @path /v1/availability/stream
+ *
+ * @see {@link POST_AvailabilityStream_Request_Query} - Query parameters type
+ * @see {@link POST_AvailabilityStream_Request_Path} - Path parameters type
+ * @see {@link POST_AvailabilityStream_Request_Body} - Request body type
+ */
+export type POST_AvailabilityStream_Request = {
+  requestBody: DomainAvailabilityRequest;
+}
+/**
+ * Request body for POST /v1/availability/stream
+ *
+ * @remarks
+ * This type defines the request body structure for the POST /v1/availability/stream endpoint.
+ * It provides type safety for the request body as defined in the OpenAPI specification.
+ *
+ * @example
+ * Use this type to ensure type safety for request body structure.
+ *
+ * @path /v1/availability/stream
+ */
+export type POST_AvailabilityStream_Request_Body = POST_AvailabilityStream_Request['requestBody'];
+
 /**
  * Request type for GET Contacts endpoint
  *

package/src/helpers/responses.d.ts

@@ -564,6 +564,80 @@ Specify one or more domains to check for availability.
  */
 export type GET_AvailabilityStream_Response_500 = Problem
 
+/**
+ * Response types for POST AvailabilityStream endpoint
+ *
+ * Stream domain availability results
+ * Stream domain availability results using Server-Sent Events (SSE) until the `done` event is received.
+ *
+ * @remarks
+ * This type defines all possible response structures for the POST AvailabilityStream endpoint.
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
+ * Use this type to ensure type safety when handling API responses from this endpoint.
+ *
+
+ *
+ * @path /v1/availability/stream
+ *
+ * @see {@link POST_AvailabilityStream_Response_401} - 401 response type
+ * @see {@link POST_AvailabilityStream_Response_422} - 422 response type
+ * @see {@link POST_AvailabilityStream_Response_500} - 500 response type
+ *
+
+ */
+export type POST_AvailabilityStream_Response = POST_AvailabilityStream_Response_401 | POST_AvailabilityStream_Response_422 | POST_AvailabilityStream_Response_500;
+
+/**
+ * 401 response for POST AvailabilityStream endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 401 status code
+ * of the POST AvailabilityStream endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/availability/stream
+ *
+ * @see {@link POST_AvailabilityStream_Response} - The main response type definition
+ * @see {@link Problem} - The actual schema type definition
+ */
+export type POST_AvailabilityStream_Response_401 = Problem
+
+/**
+ * 422 response for POST AvailabilityStream endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 status code
+ * of the POST AvailabilityStream endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/availability/stream
+ *
+ * @see {@link POST_AvailabilityStream_Response} - The main response type definition
+ * @see {@link HTTPValidationError} - The actual schema type definition
+ */
+export type POST_AvailabilityStream_Response_422 = HTTPValidationError
+
+/**
+ * 500 response for POST AvailabilityStream endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 500 status code
+ * of the POST AvailabilityStream endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/availability/stream
+ *
+ * @see {@link POST_AvailabilityStream_Response} - The main response type definition
+ * @see {@link Problem} - The actual schema type definition
+ */
+export type POST_AvailabilityStream_Response_500 = Problem
+
 /**
  * Response types for GET Contacts endpoint
  *

package/src/helpers/schemas.d.ts

@@ -1034,6 +1034,22 @@ export type DomainAvailability = components['schemas']['DomainAvailability'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type DomainAvailabilityMeta = components['schemas']['DomainAvailabilityMeta'];
+/**
+ * DomainAvailabilityRequest
+ *
+ * @remarks
+ * Type alias for the `DomainAvailabilityRequest` OpenAPI schema.
+ * This type represents domainavailabilityrequest data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getDomainAvailabilityRequest();
+ * const item: DomainAvailabilityRequest = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type DomainAvailabilityRequest = components['schemas']['DomainAvailabilityRequest'];
 /**
  * DomainAvailabilityStatus
  *

package/src/openapi.yaml

@@ -1634,6 +1634,19 @@ components:
       - processing_time_ms
       title: DomainAvailabilityMeta
       type: object
+    DomainAvailabilityRequest:
+      properties:
+        domains:
+          items:
+            type: string
+          maxItems: 1000
+          minItems: 1
+          title: Domains
+          type: array
+      required:
+      - domains
+      title: DomainAvailabilityRequest
+      type: object
     DomainAvailabilityStatus:
       enum:
       - available
@@ -4415,6 +4428,12 @@ components:
           - type: 'null'
           description: The date/time the entry was deleted on
           title: Deleted On
+        keycloak_organization_id:
+          anyOf:
+          - type: string
+          - type: 'null'
+          description: Keycloak organization id
+          title: Keycloak Organization Id
         name:
           description: Name of the organization.
           minLength: 1
@@ -4950,6 +4969,12 @@ components:
           - type: 'null'
           description: The date/time the entry was deleted on
           title: Deleted On
+        keycloak_organization_id:
+          anyOf:
+          - type: string
+          - type: 'null'
+          description: Keycloak organization id
+          title: Keycloak Organization Id
         name:
           description: Name of the organization.
           minLength: 1
@@ -7313,7 +7338,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2026-03-13-185605
+  version: 2026-03-16-153546
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -8124,6 +8149,68 @@ paths:
       summary: Stream domain availability results
       tags:
       - availability
+    post:
+      description: Stream domain availability results using Server-Sent Events (SSE)
+        until the `done` event is received.
+      operationId: stream_availability_post_v1_availability_stream_post
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/DomainAvailabilityRequest'
+        required: true
+      responses:
+        '200':
+          content:
+            text/event-stream:
+              examples:
+                Data:
+                  description: Returns individual domains' availability
+                  summary: Availability data
+                  value: 'data: {"domain":"example.com","status":"unavailable"}'
+                Event:
+                  description: Returned when an event occurs
+                  summary: Event
+                  value: 'event: done'
+              schema:
+                type: string
+          description: Successful Response
+        '401':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_AUTHENTICATION
+                detail: Additional error context.
+                status: 401
+                title: Authentication Error
+                type: authentication
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Unauthorized
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+        '500':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_AVAILABILITY_PROVIDER
+                detail: Additional error context.
+                status: 500
+                title: Availability Error
+                type: availability-internal
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Internal Server Error
+      security:
+      - OAuth2PasswordBearer: []
+      - APIKeyHeader: []
+      summary: Stream domain availability results
+      tags:
+      - availability
   /v1/contacts:
     get:
       description: Retrieves a paginated list of all contacts

package/src/schema.d.ts

@@ -150,7 +150,11 @@ export interface paths {
          */
         get: operations["stream_availability_v1_availability_stream_get"];
         put?: never;
-        post?: never;
+        /**
+         * Stream domain availability results
+         * @description Stream domain availability results using Server-Sent Events (SSE) until the `done` event is received.
+         */
+        post: operations["stream_availability_post_v1_availability_stream_post"];
         delete?: never;
         options?: never;
         head?: never;
@@ -3050,6 +3054,11 @@ export interface components {
             /** Total */
             total: number;
         };
+        /** DomainAvailabilityRequest */
+        DomainAvailabilityRequest: {
+            /** Domains */
+            domains: string[];
+        };
         /**
          * DomainAvailabilityStatus
          * @enum {string}
@@ -4898,6 +4907,11 @@ export interface components {
              * @description The date/time the entry was deleted on
              */
             deleted_on?: Date | null;
+            /**
+             * Keycloak Organization Id
+             * @description Keycloak organization id
+             */
+            keycloak_organization_id?: string | null;
             /**
              * Name
              * @description Name of the organization.
@@ -5271,6 +5285,11 @@ export interface components {
              * @description The date/time the entry was deleted on
              */
             deleted_on?: Date | null;
+            /**
+             * Keycloak Organization Id
+             * @description Keycloak organization id
+             */
+            keycloak_organization_id?: string | null;
             /**
              * Name
              * @description Name of the organization.
@@ -7159,6 +7178,71 @@ export interface operations {
             };
         };
     };
+    stream_availability_post_v1_availability_stream_post: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["DomainAvailabilityRequest"];
+            };
+        };
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "text/event-stream": string;
+                };
+            };
+            /** @description Unauthorized */
+            401: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /** @example {
+                     *       "code": "ERROR_AUTHENTICATION",
+                     *       "detail": "Additional error context.",
+                     *       "status": 401,
+                     *       "title": "Authentication Error",
+                     *       "type": "authentication"
+                     *     } */
+                    "application/problem+json": components["schemas"]["Problem"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+            /** @description Internal Server Error */
+            500: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    /** @example {
+                     *       "code": "ERROR_AVAILABILITY_PROVIDER",
+                     *       "detail": "Additional error context.",
+                     *       "status": 500,
+                     *       "title": "Availability Error",
+                     *       "type": "availability-internal"
+                     *     } */
+                    "application/problem+json": components["schemas"]["Problem"];
+                };
+            };
+        };
+    };
     get_contacts_v1_contacts_get: {
         parameters: {
             query?: {