@opusdns/api 0.12.0 → 0.12.1
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/README.md +61 -4
- package/package.json +16 -5
- package/src/helpers/index.ts +4 -4
- package/src/helpers/{requests.ts → requests.d.ts} +2 -2
- package/src/helpers/{responses.ts → responses.d.ts} +2 -2
- package/src/helpers/{schemas-arrays.ts → schemas-arrays.d.ts} +1 -1
- package/src/index.ts +10 -0
- package/src/openapi.yaml +1 -1
- package/src/types/index.ts +0 -1
- package/src/types/types.ts +1 -1
- package/src/index.d.ts +0 -2
- /package/src/helpers/{schemas.ts → schemas.d.ts} +0 -0
package/README.md
CHANGED
|
@@ -1,8 +1,65 @@
|
|
|
1
|
-
|
|
1
|
+
# OpusDNS API Types, Specification and Constants
|
|
2
2
|
|
|
3
|
-
This repository contains the [OpenAPI specification](https://swagger.io/specification/) for the backend API of [OpusDNS](https://www.opusdns.com/).
|
|
3
|
+
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.
|
|
4
|
+
|
|
5
|
+
## Installation
|
|
6
|
+
|
|
7
|
+
```bash
|
|
8
|
+
npm install @opusdns/api
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
## Usage
|
|
12
|
+
|
|
13
|
+
Import the types, constants, and schemas you need directly from the package:
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import {
|
|
17
|
+
Domain,
|
|
18
|
+
DOMAIN_AVAILABILITY_STATUS,
|
|
19
|
+
paths,
|
|
20
|
+
operations,
|
|
21
|
+
components,
|
|
22
|
+
GET_Domains_Request,
|
|
23
|
+
POST_Domains_Request_Body,
|
|
24
|
+
ALLOCATION_METHOD_TYPE
|
|
25
|
+
} from '@opusdns/api';
|
|
26
|
+
```
|
|
27
|
+
|
|
28
|
+
### Available Exports
|
|
29
|
+
|
|
30
|
+
#### Schema Types
|
|
31
|
+
- `paths` - OpenAPI paths interface
|
|
32
|
+
- `operations` - OpenAPI operations interface
|
|
33
|
+
- `components` - OpenAPI components interface
|
|
34
|
+
|
|
35
|
+
#### Domain Types
|
|
36
|
+
- `Domain` - Domain object type
|
|
37
|
+
- `DomainCreate` - Domain creation type
|
|
38
|
+
- `DomainUpdate` - Domain update type
|
|
39
|
+
- `DomainRenewRequest` - Domain renewal type
|
|
40
|
+
|
|
41
|
+
#### Request/Response Types
|
|
42
|
+
- `GET_Domains_Request` - GET domains request type
|
|
43
|
+
- `POST_Domains_Request_Body` - POST domains request body type
|
|
44
|
+
- `GET_Domains_Response` - GET domains response type
|
|
45
|
+
|
|
46
|
+
#### Constants
|
|
47
|
+
- `DOMAIN_AVAILABILITY_STATUS` - Domain availability status enum
|
|
48
|
+
- `ALLOCATION_METHOD_TYPE` - Allocation method type enum
|
|
49
|
+
- `DOMAIN_STATUS` - Domain status enum
|
|
50
|
+
- `CONTACT_ROLE_TYPE` - Contact role type enum
|
|
51
|
+
|
|
52
|
+
#### DNS Types
|
|
53
|
+
- `DnsZone` - DNS zone type
|
|
54
|
+
- `DnsRecord` - DNS record type
|
|
55
|
+
- `DnsRrset` - DNS RRset type
|
|
56
|
+
|
|
57
|
+
#### Organization Types
|
|
58
|
+
- `Organization` - Organization type
|
|
59
|
+
- `User` - User type
|
|
60
|
+
- `Contact` - Contact type
|
|
4
61
|
|
|
5
62
|
### Links
|
|
6
63
|
|
|
7
|
-
|
|
8
|
-
|
|
64
|
+
- [Main website](https://www.opusdns.com/)
|
|
65
|
+
- [Developer docs](https://developers.opusdns.com/)
|
package/package.json
CHANGED
|
@@ -8,11 +8,20 @@
|
|
|
8
8
|
"typescript": "^5.8.2"
|
|
9
9
|
},
|
|
10
10
|
"name": "@opusdns/api",
|
|
11
|
-
"version": "0.12.
|
|
11
|
+
"version": "0.12.1",
|
|
12
12
|
"description": "TypeScript types for the OpusDNS OpenAPI specification",
|
|
13
|
-
"main": "src/index.
|
|
14
|
-
"
|
|
13
|
+
"main": "./src/index.ts",
|
|
14
|
+
"module": "./src/index.ts",
|
|
15
|
+
"types": "./src/index.d.ts",
|
|
15
16
|
"type": "module",
|
|
17
|
+
"exports": {
|
|
18
|
+
".": {
|
|
19
|
+
"types": "./src/index.d.ts",
|
|
20
|
+
"import": "./src/index.ts"
|
|
21
|
+
},
|
|
22
|
+
"./helpers": "./src/helpers/index.ts",
|
|
23
|
+
"./types": "./src/index.d.ts"
|
|
24
|
+
},
|
|
16
25
|
"dependencies": {
|
|
17
26
|
"typeid-js": "^1.2.0"
|
|
18
27
|
},
|
|
@@ -25,13 +34,15 @@
|
|
|
25
34
|
"bugs": {
|
|
26
35
|
"url": "https://github.com/OpusDNS/api-spec/issues"
|
|
27
36
|
},
|
|
28
|
-
"homepage": "https://github.com/OpusDNS/api-spec#readme",
|
|
29
37
|
"scripts": {
|
|
30
38
|
"generate:schema": "tsx scripts/generate-schema.ts",
|
|
31
39
|
"generate:helpers": "tsx scripts/helpers/generate-all.ts"
|
|
32
40
|
},
|
|
41
|
+
"homepage": "https://github.com/OpusDNS/api-spec#readme",
|
|
33
42
|
"files": [
|
|
34
43
|
"package.json",
|
|
35
|
-
"src/"
|
|
44
|
+
"src/",
|
|
45
|
+
"README.md",
|
|
46
|
+
"LICENSE"
|
|
36
47
|
]
|
|
37
48
|
}
|
package/src/helpers/index.ts
CHANGED
|
@@ -14,7 +14,7 @@
|
|
|
14
14
|
|
|
15
15
|
export * from './keys';
|
|
16
16
|
export * from './requests';
|
|
17
|
-
export * from './schemas';
|
|
18
|
-
export * from './schemas-arrays';
|
|
19
|
-
export * from './constants';
|
|
20
|
-
export * from './responses';
|
|
17
|
+
export * from './schemas.d';
|
|
18
|
+
export * from './schemas-arrays.d';
|
|
19
|
+
export * from './constants.d';
|
|
20
|
+
export * from './responses.d';
|
|
@@ -32,9 +32,9 @@
|
|
|
32
32
|
|
|
33
33
|
import { operations } from '../schema';
|
|
34
34
|
|
|
35
|
-
import { DomainDnssecDataCreateArray, OrganizationAttributeUpdateArray } from './schemas-arrays';
|
|
35
|
+
import { DomainDnssecDataCreateArray, OrganizationAttributeUpdateArray } from './schemas-arrays.d';
|
|
36
36
|
|
|
37
|
-
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';
|
|
37
|
+
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';
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
40
|
* Request type for GET AuthClientCredentials endpoint
|
|
@@ -32,9 +32,9 @@
|
|
|
32
32
|
|
|
33
33
|
|
|
34
34
|
|
|
35
|
-
import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays';
|
|
35
|
+
import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
|
|
36
36
|
|
|
37
|
-
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';
|
|
37
|
+
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';
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
40
|
* Response types for GET AuthClientCredentials endpoint
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
* This file is auto-generated from the OpenAPI specification.
|
|
22
22
|
* Do not edit manually.
|
|
23
23
|
*/
|
|
24
|
-
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';
|
|
24
|
+
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';
|
|
25
25
|
|
|
26
26
|
/**
|
|
27
27
|
* DomainDnssecDataResponse
|
package/src/index.ts
ADDED
|
@@ -0,0 +1,10 @@
|
|
|
1
|
+
// Runtime exports (constants and keys)
|
|
2
|
+
export * from './helpers/keys';
|
|
3
|
+
export * from './helpers/constants';
|
|
4
|
+
|
|
5
|
+
// Export all types including schema types
|
|
6
|
+
export type * from './helpers/responses.d';
|
|
7
|
+
export type * from './helpers/requests.d';
|
|
8
|
+
export type * from './helpers/schemas.d';
|
|
9
|
+
export type * from './helpers/schemas-arrays.d';
|
|
10
|
+
export type * from './schema.d';
|
package/src/openapi.yaml
CHANGED
|
@@ -4953,7 +4953,7 @@ info:
|
|
|
4953
4953
|
'
|
|
4954
4954
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
4955
4955
|
title: OpusDNS API
|
|
4956
|
-
version: 2025-07-31-
|
|
4956
|
+
version: 2025-07-31-235405
|
|
4957
4957
|
x-logo:
|
|
4958
4958
|
altText: OpusDNS API Reference
|
|
4959
4959
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
package/src/types/index.ts
CHANGED
package/src/types/types.ts
CHANGED
package/src/index.d.ts
DELETED
|
File without changes
|