@opusdns/api
v0.125.0
Published
TypeScript types for the OpusDNS OpenAPI specification
Downloads
3,006
Readme
OpusDNS API Types, Specification and Constants
This repository contains the OpenAPI specification for the backend API of OpusDNS along with generated TypeScript types and constants.
Installation
npm install @opusdns/apiUsage
Import the types, constants, and schemas you need directly from the package:
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 interfaceoperations- OpenAPI operations interfacecomponents- OpenAPI components interface
Domain Types
Domain- Domain object typeDomainCreate- Domain creation typeDomainUpdate- Domain update typeDomainRenewRequest- Domain renewal type
Request/Response Types
GET_Domains_Request- GET domains request typePOST_Domains_Request_Body- POST domains request body typeGET_Domains_Response- GET domains response type
Constants
DOMAIN_AVAILABILITY_STATUS- Domain availability status enumALLOCATION_METHOD_TYPE- Allocation method type enumDOMAIN_STATUS- Domain status enumCONTACT_ROLE_TYPE- Contact role type enum
DNS Types
DnsZone- DNS zone typeDnsRecord- DNS record typeDnsRrset- DNS RRset type
Organization Types
Organization- Organization typeUser- User typeContact- Contact type
