@opusdns/api 0.11.0 → 0.12.1

package/README.md

@@ -1,8 +1,65 @@
-### OpusDNS OpenAPI specification and types
+# OpusDNS API Types, Specification and Constants
 
-This repository contains the [OpenAPI specification](https://swagger.io/specification/) for the backend API of [OpusDNS](https://www.opusdns.com/).
+This repository contains the [OpenAPI specification](https://swagger.io/specification/) for the backend API of [OpusDNS](https://www.opusdns.com/) along with generated TypeScript types and constants.
+
+## Installation
+
+```bash
+npm install @opusdns/api
+```
+
+## Usage
+
+Import the types, constants, and schemas you need directly from the package:
+
+```typescript
+import { 
+  Domain, 
+  DOMAIN_AVAILABILITY_STATUS, 
+  paths, 
+  operations, 
+  components,
+  GET_Domains_Request,
+  POST_Domains_Request_Body,
+  ALLOCATION_METHOD_TYPE
+} from '@opusdns/api';
+```
+
+### Available Exports
+
+#### Schema Types
+- `paths` - OpenAPI paths interface
+- `operations` - OpenAPI operations interface  
+- `components` - OpenAPI components interface
+
+#### Domain Types
+- `Domain` - Domain object type
+- `DomainCreate` - Domain creation type
+- `DomainUpdate` - Domain update type
+- `DomainRenewRequest` - Domain renewal type
+
+#### Request/Response Types
+- `GET_Domains_Request` - GET domains request type
+- `POST_Domains_Request_Body` - POST domains request body type
+- `GET_Domains_Response` - GET domains response type
+
+#### Constants
+- `DOMAIN_AVAILABILITY_STATUS` - Domain availability status enum
+- `ALLOCATION_METHOD_TYPE` - Allocation method type enum
+- `DOMAIN_STATUS` - Domain status enum
+- `CONTACT_ROLE_TYPE` - Contact role type enum
+
+#### DNS Types
+- `DnsZone` - DNS zone type
+- `DnsRecord` - DNS record type
+- `DnsRrset` - DNS RRset type
+
+#### Organization Types
+- `Organization` - Organization type
+- `User` - User type
+- `Contact` - Contact type
 
 ### Links
 
- - [Main website](https://www.opusdns.com/).
- - [Developer docs](https://developers.opusdns.com/).
+- [Main website](https://www.opusdns.com/)
+- [Developer docs](https://developers.opusdns.com/)

package/package.json

@@ -8,11 +8,20 @@
     "typescript": "^5.8.2"
   },
   "name": "@opusdns/api",
-  "version": "0.11.0",
+  "version": "0.12.1",
   "description": "TypeScript types for the OpusDNS OpenAPI specification",
-  "main": "src/index.d.ts",
-  "types": "src/index.d.ts",
+  "main": "./src/index.ts",
+  "module": "./src/index.ts",
+  "types": "./src/index.d.ts",
   "type": "module",
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "import": "./src/index.ts"
+    },
+    "./helpers": "./src/helpers/index.ts",
+    "./types": "./src/index.d.ts"
+  },
   "dependencies": {
     "typeid-js": "^1.2.0"
   },
@@ -25,13 +34,15 @@
   "bugs": {
     "url": "https://github.com/OpusDNS/api-spec/issues"
   },
-  "homepage": "https://github.com/OpusDNS/api-spec#readme",
   "scripts": {
     "generate:schema": "tsx scripts/generate-schema.ts",
     "generate:helpers": "tsx scripts/helpers/generate-all.ts"
   },
+  "homepage": "https://github.com/OpusDNS/api-spec#readme",
   "files": [
     "package.json",
-    "src/"
+    "src/",
+    "README.md",
+    "LICENSE"
   ]
 }

package/src/helpers/index.ts

@@ -14,7 +14,7 @@
 
 export * from './keys';
 export * from './requests';
-export * from './schemas';
-export * from './schemas-arrays';
-export * from './constants';
-export * from './responses';
+export * from './schemas.d';
+export * from './schemas-arrays.d';
+export * from './constants.d';
+export * from './responses.d';

package/src/helpers/{requests.ts → requests.d.ts}

@@ -32,9 +32,9 @@
 
 import { operations } from '../schema';
 
-import { DomainDnssecDataCreateArray, OrganizationAttributeUpdateArray } from './schemas-arrays';
+import { DomainDnssecDataCreateArray, OrganizationAttributeUpdateArray } from './schemas-arrays.d';
 
-import { OrganizationCredentialExtra, SignupCreate, ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainCreate, DomainUpdate, DomainRenewRequest, DomainTransferIn, EmailForwardCreate, EmailForwardBulkDelete, EmailForwardBulkUpdate, EmailForwardUpdate, NotificationCreate, NotificationUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, PlanUpdate, UserCreate, TermsOfServiceAccept, UserUpdate, SpiceDbRelationshipUpdate } from './schemas';
+import { OrganizationCredentialExtra, SignupCreate, ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainCreate, DomainUpdate, DomainRenewRequest, DomainTransferIn, EmailForwardCreate, EmailForwardBulkDelete, EmailForwardBulkUpdate, EmailForwardUpdate, NotificationCreate, NotificationUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, PlanUpdate, UserCreate, TermsOfServiceAccept, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
 
 /**
  * Request type for GET AuthClientCredentials endpoint
@@ -150,6 +150,42 @@ export type DELETE_AuthClientCredentialsApiKeyId_Request = {
  */
 export type DELETE_AuthClientCredentialsApiKeyId_Request_Path = DELETE_AuthClientCredentialsApiKeyId_Request['parameters']['path'];
 
+/**
+ * Request type for POST AuthInternalClientCredentials endpoint
+ *
+ * Issue Opusdns Internal Api Key
+ *
+ * @remarks
+ * This type defines the complete request structure for the POST AuthInternalClientCredentials 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/auth/internal_client_credentials
+ *
+ * @see {@link POST_AuthInternalClientCredentials_Request_Query} - Query parameters type
+ * @see {@link POST_AuthInternalClientCredentials_Request_Path} - Path parameters type
+ * @see {@link POST_AuthInternalClientCredentials_Request_Body} - Request body type
+ */
+export type POST_AuthInternalClientCredentials_Request = {
+  requestBody: OrganizationCredentialExtra;
+}
+/**
+ * Request body for POST /v1/auth/internal_client_credentials
+ *
+ * @remarks
+ * This type defines the request body structure for the POST /v1/auth/internal_client_credentials 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/auth/internal_client_credentials
+ */
+export type POST_AuthInternalClientCredentials_Request_Body = POST_AuthInternalClientCredentials_Request['requestBody'];
+
 /**
  * Request type for POST AuthLogout endpoint
  *

package/src/helpers/{responses.ts → responses.d.ts}

@@ -32,9 +32,9 @@
 
 
 
-import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays';
+import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
 
-import { Pagination_OrganizationCredential, Problem, HTTPValidationError, OrganizationCredentialCreated, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainCheck, DomainSummary, Pagination_EmailForward, EmailForward, EmailForwardBulkDeleteResult, EmailForwardBulkUpdateResult, Pagination_Event, EventSchema, Pagination_UserNotificationSummary, Notification, UserNotification, Pagination_Organization, Organization, OrganizationWithPlan, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas';
+import { Pagination_OrganizationCredential, Problem, HTTPValidationError, OrganizationCredentialCreated, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainCheck, DomainSummary, Pagination_EmailForward, EmailForward, EmailForwardBulkDeleteResult, EmailForwardBulkUpdateResult, Pagination_Event, EventSchema, Pagination_UserNotificationSummary, Notification, UserNotification, Pagination_Organization, Organization, OrganizationWithPlan, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
 
 /**
  * Response types for GET AuthClientCredentials endpoint
@@ -259,6 +259,61 @@ export type DELETE_AuthClientCredentialsByApiKeyId_Response_404 = Problem
  */
 export type DELETE_AuthClientCredentialsByApiKeyId_Response_422 = HTTPValidationError
 
+/**
+ * Response types for POST AuthInternalClientCredentials endpoint
+ *
+ * Issue Opusdns Internal Api Key
+ *
+ * @remarks
+ * This type defines all possible response structures for the POST AuthInternalClientCredentials 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/auth/internal_client_credentials
+ *
+ * @see {@link POST_AuthInternalClientCredentials_Response_200} - 200 response type
+ * @see {@link POST_AuthInternalClientCredentials_Response_422} - 422 response type
+ *
+
+ */
+export type POST_AuthInternalClientCredentials_Response = POST_AuthInternalClientCredentials_Response_200 | POST_AuthInternalClientCredentials_Response_422;
+
+/**
+ * 200 response for POST AuthInternalClientCredentials endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 200 status code
+ * of the POST AuthInternalClientCredentials endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/auth/internal_client_credentials
+ *
+ * @see {@link POST_AuthInternalClientCredentials_Response} - The main response type definition
+ * @see {@link OrganizationCredentialCreated} - The actual schema type definition
+ */
+export type POST_AuthInternalClientCredentials_Response_200 = OrganizationCredentialCreated
+
+/**
+ * 422 response for POST AuthInternalClientCredentials endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 status code
+ * of the POST AuthInternalClientCredentials endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/auth/internal_client_credentials
+ *
+ * @see {@link POST_AuthInternalClientCredentials_Response} - The main response type definition
+ * @see {@link HTTPValidationError} - The actual schema type definition
+ */
+export type POST_AuthInternalClientCredentials_Response_422 = HTTPValidationError
+
 /**
  * Response types for POST AuthLogout endpoint
  *

package/src/helpers/{schemas-arrays.ts → schemas-arrays.d.ts}

@@ -21,7 +21,7 @@
  * This file is auto-generated from the OpenAPI specification.
  * Do not edit manually.
  */
-import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, BulkOperationResult, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, Nameserver, DeletePolicyType, SyncOperationType, DomainContact, DomainStatus, DomainSearchSuggestion, DomainClientStatus, EmailForwardBulkUpdateItem, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, ContactSchema, DnsZone, Domain, EmailForward, EventResponse, OrganizationCredential, Organization, UserNotificationSummary, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeUpdate, DomainAvailability } from './schemas';
+import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, BulkOperationResult, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, Nameserver, DeletePolicyType, SyncOperationType, DomainContact, DomainStatus, DomainSearchSuggestion, DomainClientStatus, EmailForwardBulkUpdateItem, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, ContactSchema, DnsZone, Domain, EmailForward, EventResponse, OrganizationCredential, Organization, UserNotificationSummary, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeUpdate, DomainAvailability } from './schemas.d';
 
 /**
  * DomainDnssecDataResponse

package/src/index.ts

@@ -0,0 +1,10 @@
+// Runtime exports (constants and keys)
+export * from './helpers/keys';
+export * from './helpers/constants';
+
+// Export all types including schema types
+export type * from './helpers/responses.d';
+export type * from './helpers/requests.d';
+export type * from './helpers/schemas.d';
+export type * from './helpers/schemas-arrays.d';
+export type * from './schema.d';

package/src/openapi.yaml

@@ -4953,7 +4953,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2025-07-31-173148
+  version: 2025-07-31-235405
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -5113,6 +5113,33 @@ paths:
       summary: Delete Api Key
       tags:
       - authentication
+  /v1/auth/internal_client_credentials:
+    post:
+      operationId: issue_opusdns_internal_api_key_v1_auth_internal_client_credentials_post
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/OrganizationCredentialExtra'
+        required: true
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/OrganizationCredentialCreated'
+          description: Successful Response
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      summary: Issue Opusdns Internal Api Key
+      tags:
+      - authentication
   /v1/auth/logout:
     post:
       operationId: logout_v1_auth_logout_post

package/src/schema.d.ts

@@ -35,6 +35,23 @@ export interface paths {
         patch?: never;
         trace?: never;
     };
+    "/v1/auth/internal_client_credentials": {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        get?: never;
+        put?: never;
+        /** Issue Opusdns Internal Api Key */
+        post: operations["issue_opusdns_internal_api_key_v1_auth_internal_client_credentials_post"];
+        delete?: never;
+        options?: never;
+        head?: never;
+        patch?: never;
+        trace?: never;
+    };
     "/v1/auth/logout": {
         parameters: {
             query?: never;
@@ -4419,6 +4436,39 @@ export interface operations {
             };
         };
     };
+    issue_opusdns_internal_api_key_v1_auth_internal_client_credentials_post: {
+        parameters: {
+            query?: never;
+            header?: never;
+            path?: never;
+            cookie?: never;
+        };
+        requestBody: {
+            content: {
+                "application/json": components["schemas"]["OrganizationCredentialExtra"];
+            };
+        };
+        responses: {
+            /** @description Successful Response */
+            200: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/json": components["schemas"]["OrganizationCredentialCreated"];
+                };
+            };
+            /** @description Validation Error */
+            422: {
+                headers: {
+                    [name: string]: unknown;
+                };
+                content: {
+                    "application/problem+json": components["schemas"]["HTTPValidationError"];
+                };
+            };
+        };
+    };
     logout_v1_auth_logout_post: {
         parameters: {
             query?: never;

package/src/types/index.ts

@@ -7,5 +7,4 @@
 
 export * from './constants';
 export * from './keys';
-export * from './paths';
 export * from './types';

package/src/types/types.ts

@@ -3,7 +3,7 @@
  * All types have moved to the helpers directory (see src/helpers/schemas.ts and related files). Please update your imports.
  */
 
-import { components, operations } from '../schema';
+import type { components, operations } from '../schema.d.ts';
 
 
 /** 

package/src/index.d.ts

@@ -1,2 +0,0 @@
-export * from './helpers';
-export * from './schema';