@opusdns/api 0.6.0
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/LICENSE +165 -0
- package/README.md +8 -0
- package/package.json +37 -0
- package/src/openapi.yaml +7677 -0
- package/src/schema.d.ts +6574 -0
- package/src/types/constants.ts +362 -0
- package/src/types/index.ts +11 -0
- package/src/types/keys.ts +1173 -0
- package/src/types/types.ts +173 -0
|
@@ -0,0 +1,362 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Auto-generated enums from OpenAPI schema
|
|
3
|
+
* Generated on: 2025-07-17T22:54:52.868Z
|
|
4
|
+
*/
|
|
5
|
+
|
|
6
|
+
/**
|
|
7
|
+
* BULK_OPERATION_STATUS
|
|
8
|
+
*/
|
|
9
|
+
export enum BULK_OPERATION_STATUS {
|
|
10
|
+
SUCCESS = "success",
|
|
11
|
+
FAILED = "failed",
|
|
12
|
+
}
|
|
13
|
+
|
|
14
|
+
/**
|
|
15
|
+
* CONTACT_SORT_FIELD
|
|
16
|
+
*/
|
|
17
|
+
export enum CONTACT_SORT_FIELD {
|
|
18
|
+
FIRST_NAME = "first_name",
|
|
19
|
+
LAST_NAME = "last_name",
|
|
20
|
+
EMAIL = "email",
|
|
21
|
+
CREATED_ON = "created_on",
|
|
22
|
+
}
|
|
23
|
+
|
|
24
|
+
/**
|
|
25
|
+
* CURRENCY
|
|
26
|
+
*/
|
|
27
|
+
export enum CURRENCY {
|
|
28
|
+
USD = "USD",
|
|
29
|
+
EUR = "EUR",
|
|
30
|
+
}
|
|
31
|
+
|
|
32
|
+
/**
|
|
33
|
+
* DNS_CHANGE_ACTION
|
|
34
|
+
*/
|
|
35
|
+
export enum DNS_CHANGE_ACTION {
|
|
36
|
+
CREATE_ZONE = "create_zone",
|
|
37
|
+
DELETE_ZONE = "delete_zone",
|
|
38
|
+
CREATE_RECORD = "create_record",
|
|
39
|
+
DELETE_RECORD = "delete_record",
|
|
40
|
+
ENABLE_DNSSEC = "enable_dnssec",
|
|
41
|
+
DISABLE_DNSSEC = "disable_dnssec",
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
/**
|
|
45
|
+
* DNS_RRSET_TYPE
|
|
46
|
+
*/
|
|
47
|
+
export enum DNS_RRSET_TYPE {
|
|
48
|
+
A = "A",
|
|
49
|
+
AAAA = "AAAA",
|
|
50
|
+
ALIAS = "ALIAS",
|
|
51
|
+
CAA = "CAA",
|
|
52
|
+
CNAME = "CNAME",
|
|
53
|
+
DNSKEY = "DNSKEY",
|
|
54
|
+
DS = "DS",
|
|
55
|
+
MX = "MX",
|
|
56
|
+
NS = "NS",
|
|
57
|
+
PTR = "PTR",
|
|
58
|
+
TXT = "TXT",
|
|
59
|
+
SOA = "SOA",
|
|
60
|
+
SRV = "SRV",
|
|
61
|
+
}
|
|
62
|
+
|
|
63
|
+
/**
|
|
64
|
+
* DNSSEC_ALGORITHM
|
|
65
|
+
*/
|
|
66
|
+
export const DNSSECALGORITHM = [1, 2, 3, 4, 5, 6, 7, 8, 10, 12, 13, 14, 15, 16, 17, 23] as const;
|
|
67
|
+
|
|
68
|
+
export type Dnssecalgorithm = typeof DNSSECALGORITHM[number];
|
|
69
|
+
|
|
70
|
+
/**
|
|
71
|
+
* DNSSEC_DIGEST_TYPE
|
|
72
|
+
*/
|
|
73
|
+
export const DNSSECDIGESTTYPE = [1, 2, 3, 4, 5, 6] as const;
|
|
74
|
+
|
|
75
|
+
export type Dnssecdigesttype = typeof DNSSECDIGESTTYPE[number];
|
|
76
|
+
|
|
77
|
+
/**
|
|
78
|
+
* DNSSEC_RECORD_TYPE
|
|
79
|
+
*/
|
|
80
|
+
export enum DNSSEC_RECORD_TYPE {
|
|
81
|
+
DS_DATA = "ds_data",
|
|
82
|
+
KEY_DATA = "key_data",
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
/**
|
|
86
|
+
* DNSSEC_STATUS
|
|
87
|
+
*/
|
|
88
|
+
export enum DNSSEC_STATUS {
|
|
89
|
+
ENABLED = "enabled",
|
|
90
|
+
DISABLED = "disabled",
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
/**
|
|
94
|
+
* DOMAIN_AVAILABILITY_STATUS
|
|
95
|
+
*/
|
|
96
|
+
export enum DOMAIN_AVAILABILITY_STATUS {
|
|
97
|
+
AVAILABLE = "available",
|
|
98
|
+
UNAVAILABLE = "unavailable",
|
|
99
|
+
MARKET_AVAILABLE = "market_available",
|
|
100
|
+
TMCH_CLAIM = "tmch_claim",
|
|
101
|
+
ERROR = "error",
|
|
102
|
+
}
|
|
103
|
+
|
|
104
|
+
/**
|
|
105
|
+
* DOMAIN_CLIENT_STATUS
|
|
106
|
+
*/
|
|
107
|
+
export enum DOMAIN_CLIENT_STATUS {
|
|
108
|
+
CLIENTTRANSFERPROHIBITED = "clientTransferProhibited",
|
|
109
|
+
CLIENTUPDATEPROHIBITED = "clientUpdateProhibited",
|
|
110
|
+
CLIENTDELETEPROHIBITED = "clientDeleteProhibited",
|
|
111
|
+
CLIENTRENEWPROHIBITED = "clientRenewProhibited",
|
|
112
|
+
CLIENTHOLD = "clientHold",
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
/**
|
|
116
|
+
* DOMAIN_CONTACT_TYPE
|
|
117
|
+
*/
|
|
118
|
+
export enum DOMAIN_CONTACT_TYPE {
|
|
119
|
+
REGISTRANT = "registrant",
|
|
120
|
+
ADMIN = "admin",
|
|
121
|
+
TECH = "tech",
|
|
122
|
+
BILLING = "billing",
|
|
123
|
+
}
|
|
124
|
+
|
|
125
|
+
/**
|
|
126
|
+
* DOMAIN_STATUS
|
|
127
|
+
*/
|
|
128
|
+
export enum DOMAIN_STATUS {
|
|
129
|
+
OK = "ok",
|
|
130
|
+
SERVERTRANSFERPROHIBITED = "serverTransferProhibited",
|
|
131
|
+
SERVERUPDATEPROHIBITED = "serverUpdateProhibited",
|
|
132
|
+
SERVERDELETEPROHIBITED = "serverDeleteProhibited",
|
|
133
|
+
SERVERRENEWPROHIBITED = "serverRenewProhibited",
|
|
134
|
+
SERVERHOLD = "serverHold",
|
|
135
|
+
TRANSFERPERIOD = "transferPeriod",
|
|
136
|
+
RENEWPERIOD = "renewPeriod",
|
|
137
|
+
REDEMPTIONPERIOD = "redemptionPeriod",
|
|
138
|
+
PENDINGUPDATE = "pendingUpdate",
|
|
139
|
+
PENDINGTRANSFER = "pendingTransfer",
|
|
140
|
+
PENDINGRESTORE = "pendingRestore",
|
|
141
|
+
PENDINGRENEW = "pendingRenew",
|
|
142
|
+
PENDINGDELETE = "pendingDelete",
|
|
143
|
+
PENDINGCREATE = "pendingCreate",
|
|
144
|
+
INACTIVE = "inactive",
|
|
145
|
+
AUTORENEWPERIOD = "autoRenewPeriod",
|
|
146
|
+
ADDPERIOD = "addPeriod",
|
|
147
|
+
DELETED = "deleted",
|
|
148
|
+
CLIENTTRANSFERPROHIBITED = "clientTransferProhibited",
|
|
149
|
+
CLIENTUPDATEPROHIBITED = "clientUpdateProhibited",
|
|
150
|
+
CLIENTDELETEPROHIBITED = "clientDeleteProhibited",
|
|
151
|
+
CLIENTRENEWPROHIBITED = "clientRenewProhibited",
|
|
152
|
+
CLIENTHOLD = "clientHold",
|
|
153
|
+
}
|
|
154
|
+
|
|
155
|
+
/**
|
|
156
|
+
* EMAIL_FORWARD_STATUS
|
|
157
|
+
*/
|
|
158
|
+
export enum EMAIL_FORWARD_STATUS {
|
|
159
|
+
ACTIVE = "active",
|
|
160
|
+
INACTIVE = "inactive",
|
|
161
|
+
}
|
|
162
|
+
|
|
163
|
+
/**
|
|
164
|
+
* EMAIL_VERIFICATION_STATUS
|
|
165
|
+
*/
|
|
166
|
+
export enum EMAIL_VERIFICATION_STATUS {
|
|
167
|
+
VERIFIED = "verified",
|
|
168
|
+
PENDING = "pending",
|
|
169
|
+
CANCELED = "canceled",
|
|
170
|
+
}
|
|
171
|
+
|
|
172
|
+
/**
|
|
173
|
+
* EVENT_OBJECT_TYPE
|
|
174
|
+
*/
|
|
175
|
+
export enum EVENT_OBJECT_TYPE {
|
|
176
|
+
DOMAIN = "DOMAIN",
|
|
177
|
+
CONTACT = "CONTACT",
|
|
178
|
+
HOST = "HOST",
|
|
179
|
+
RAW = "RAW",
|
|
180
|
+
UNKNOWN = "UNKNOWN",
|
|
181
|
+
}
|
|
182
|
+
|
|
183
|
+
/**
|
|
184
|
+
* EVENT_SUBTYPE
|
|
185
|
+
*/
|
|
186
|
+
export enum EVENT_SUBTYPE {
|
|
187
|
+
NOTIFICATION = "NOTIFICATION",
|
|
188
|
+
SUCCESS = "SUCCESS",
|
|
189
|
+
FAILURE = "FAILURE",
|
|
190
|
+
CANCELED = "CANCELED",
|
|
191
|
+
}
|
|
192
|
+
|
|
193
|
+
/**
|
|
194
|
+
* EVENT_TYPE
|
|
195
|
+
*/
|
|
196
|
+
export enum EVENT_TYPE {
|
|
197
|
+
REGISTRATION = "REGISTRATION",
|
|
198
|
+
RENEWAL = "RENEWAL",
|
|
199
|
+
MODIFICATION = "MODIFICATION",
|
|
200
|
+
DELETION = "DELETION",
|
|
201
|
+
INBOUND_TRANSFER = "INBOUND_TRANSFER",
|
|
202
|
+
OUTBOUND_TRANSFER = "OUTBOUND_TRANSFER",
|
|
203
|
+
}
|
|
204
|
+
|
|
205
|
+
/**
|
|
206
|
+
* GRANT_TYPE
|
|
207
|
+
*/
|
|
208
|
+
export enum GRANT_TYPE {
|
|
209
|
+
CLIENT_CREDENTIALS = "client_credentials",
|
|
210
|
+
PASSWORD = "password",
|
|
211
|
+
REFRESH_TOKEN = "refresh_token",
|
|
212
|
+
}
|
|
213
|
+
|
|
214
|
+
/**
|
|
215
|
+
* ORGANIZATION_CREDENTIAL_STATUS
|
|
216
|
+
*/
|
|
217
|
+
export enum ORGANIZATION_CREDENTIAL_STATUS {
|
|
218
|
+
ACTIVE = "active",
|
|
219
|
+
REVOKED = "revoked",
|
|
220
|
+
}
|
|
221
|
+
|
|
222
|
+
/**
|
|
223
|
+
* ORGANIZATION_STATUS
|
|
224
|
+
*/
|
|
225
|
+
export enum ORGANIZATION_STATUS {
|
|
226
|
+
ACTIVE = "active",
|
|
227
|
+
INACTIVE = "inactive",
|
|
228
|
+
}
|
|
229
|
+
|
|
230
|
+
/**
|
|
231
|
+
* PERIOD_UNIT
|
|
232
|
+
*/
|
|
233
|
+
export enum PERIOD_UNIT {
|
|
234
|
+
Y = "y",
|
|
235
|
+
M = "m",
|
|
236
|
+
D = "d",
|
|
237
|
+
}
|
|
238
|
+
|
|
239
|
+
/**
|
|
240
|
+
* PERMISSION
|
|
241
|
+
*/
|
|
242
|
+
export enum PERMISSION {
|
|
243
|
+
ACKNOWLEDGE = "acknowledge",
|
|
244
|
+
BULK_CREATE = "bulk_create",
|
|
245
|
+
BULK_DELETE = "bulk_delete",
|
|
246
|
+
BULK_RENEW_EXPIRE = "bulk_renew_expire",
|
|
247
|
+
BULK_TRANSFER_TRADE = "bulk_transfer_trade",
|
|
248
|
+
BULK_UPDATE = "bulk_update",
|
|
249
|
+
CREATE = "create",
|
|
250
|
+
DELETE = "delete",
|
|
251
|
+
ENTERPRISE = "enterprise",
|
|
252
|
+
MANAGE_API_KEYS = "manage_api_keys",
|
|
253
|
+
MANAGE_BILLING = "manage_billing",
|
|
254
|
+
MANAGE_CMS_CONTENT = "manage_cms_content",
|
|
255
|
+
MANAGE_CONTACTS = "manage_contacts",
|
|
256
|
+
MANAGE_DNS_ZONES = "manage_dns_zones",
|
|
257
|
+
MANAGE_DOMAINS = "manage_domains",
|
|
258
|
+
MANAGE_EMAIL_FORWARDS = "manage_email_forwards",
|
|
259
|
+
MANAGE_OPUSDNS_API_KEYS = "manage_opusdns_api_keys",
|
|
260
|
+
MANAGE_PRODUCTS = "manage_products",
|
|
261
|
+
MANAGE_RESELLER = "manage_reseller",
|
|
262
|
+
MANAGE_USER_RELATIONS = "manage_user_relations",
|
|
263
|
+
MANAGE_USERS = "manage_users",
|
|
264
|
+
PLAN_MANAGER = "plan_manager",
|
|
265
|
+
PREMIUM = "premium",
|
|
266
|
+
PREMIUM_RESELLER = "premium_reseller",
|
|
267
|
+
RENEW_EXPIRE = "renew_expire",
|
|
268
|
+
SIGN_ORG_TOS = "sign_org_tos",
|
|
269
|
+
STARTER = "starter",
|
|
270
|
+
TRANSFER_TRADE = "transfer_trade",
|
|
271
|
+
UPDATE = "update",
|
|
272
|
+
VERIFY = "verify",
|
|
273
|
+
VIEW = "view",
|
|
274
|
+
VIEW_AUDIT_LOGS = "view_audit_logs",
|
|
275
|
+
}
|
|
276
|
+
|
|
277
|
+
/**
|
|
278
|
+
* PLAN_RELATION
|
|
279
|
+
*/
|
|
280
|
+
export enum PLAN_RELATION {
|
|
281
|
+
BASIC_PLAN = "basic_plan",
|
|
282
|
+
ENTERPRISE_PLAN = "enterprise_plan",
|
|
283
|
+
PREMIUM_PLAN = "premium_plan",
|
|
284
|
+
STARTER_PLAN = "starter_plan",
|
|
285
|
+
}
|
|
286
|
+
|
|
287
|
+
/**
|
|
288
|
+
* RELATION
|
|
289
|
+
*/
|
|
290
|
+
export enum RELATION {
|
|
291
|
+
ACCEPTED_TOS = "accepted_tos",
|
|
292
|
+
ADMIN = "admin",
|
|
293
|
+
API_ADMIN = "api_admin",
|
|
294
|
+
BILLING_MANAGER = "billing_manager",
|
|
295
|
+
CLIENT_API_KEY = "client_api_key",
|
|
296
|
+
CMS_CONTENT_EDITOR = "cms_content_editor",
|
|
297
|
+
CONTACT_MANAGER = "contact_manager",
|
|
298
|
+
DOMAIN_MANAGER = "domain_manager",
|
|
299
|
+
EMAIL_FORWARD_MANAGER = "email_forward_manager",
|
|
300
|
+
MEMBER = "member",
|
|
301
|
+
OPUSDNS_INTERNAL_API_KEY = "opusdns_internal_api_key",
|
|
302
|
+
ORGANIZATION_MANAGER = "organization_manager",
|
|
303
|
+
OWNER = "owner",
|
|
304
|
+
PARENT = "parent",
|
|
305
|
+
PRODUCT_MANAGER = "product_manager",
|
|
306
|
+
RECIPIENT = "recipient",
|
|
307
|
+
RESELLER_MANAGER = "reseller_manager",
|
|
308
|
+
ROOT_ADMIN = "root_admin",
|
|
309
|
+
SELF = "self",
|
|
310
|
+
}
|
|
311
|
+
|
|
312
|
+
/**
|
|
313
|
+
* RENEWAL_MODE
|
|
314
|
+
*/
|
|
315
|
+
export enum RENEWAL_MODE {
|
|
316
|
+
RENEW = "renew",
|
|
317
|
+
EXPIRE = "expire",
|
|
318
|
+
DELETE = "delete",
|
|
319
|
+
}
|
|
320
|
+
|
|
321
|
+
/**
|
|
322
|
+
* SORT_ORDER
|
|
323
|
+
*/
|
|
324
|
+
export enum SORT_ORDER {
|
|
325
|
+
ASC = "asc",
|
|
326
|
+
DESC = "desc",
|
|
327
|
+
}
|
|
328
|
+
|
|
329
|
+
/**
|
|
330
|
+
* USER_NOTIFICATION_STATUS
|
|
331
|
+
*/
|
|
332
|
+
export enum USER_NOTIFICATION_STATUS {
|
|
333
|
+
READ = "read",
|
|
334
|
+
UNREAD = "unread",
|
|
335
|
+
}
|
|
336
|
+
|
|
337
|
+
/**
|
|
338
|
+
* USER_STATUS
|
|
339
|
+
*/
|
|
340
|
+
export enum USER_STATUS {
|
|
341
|
+
ACTIVE = "active",
|
|
342
|
+
INACTIVE = "inactive",
|
|
343
|
+
}
|
|
344
|
+
|
|
345
|
+
/**
|
|
346
|
+
* VERIFICATION_TYPE
|
|
347
|
+
*/
|
|
348
|
+
export enum VERIFICATION_TYPE {
|
|
349
|
+
API = "api",
|
|
350
|
+
EMAIL = "email",
|
|
351
|
+
}
|
|
352
|
+
|
|
353
|
+
/**
|
|
354
|
+
* ZONE_SORT_FIELD
|
|
355
|
+
*/
|
|
356
|
+
export enum ZONE_SORT_FIELD {
|
|
357
|
+
NAME = "name",
|
|
358
|
+
CREATED_ON = "created_on",
|
|
359
|
+
UPDATED_ON = "updated_on",
|
|
360
|
+
DNSSEC_STATUS = "dnssec_status",
|
|
361
|
+
}
|
|
362
|
+
|
|
@@ -0,0 +1,11 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Index file for OpusDNS API types and constants.
|
|
3
|
+
*
|
|
4
|
+
* This file is auto-generated from the OpenAPI specification.
|
|
5
|
+
* Do not edit manually.
|
|
6
|
+
*/
|
|
7
|
+
|
|
8
|
+
export * from './constants';
|
|
9
|
+
export * from './keys';
|
|
10
|
+
export * from './paths';
|
|
11
|
+
export * from './types';
|