@opusdns/api 0.7.0 → 0.9.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/package.json +1 -1
- package/src/openapi.yaml +244 -7
- package/src/schema.d.ts +229 -7
- package/src/types/constants.ts +9 -1
- package/src/types/keys.ts +18 -0
- package/src/types/types.ts +5 -1
package/package.json
CHANGED
package/src/openapi.yaml
CHANGED
|
@@ -657,6 +657,17 @@ components:
|
|
|
657
657
|
- rdata
|
|
658
658
|
title: DnsRecordCreate
|
|
659
659
|
type: object
|
|
660
|
+
DnsRecordPatchOp:
|
|
661
|
+
properties:
|
|
662
|
+
op:
|
|
663
|
+
$ref: '#/components/schemas/PatchOp'
|
|
664
|
+
record:
|
|
665
|
+
$ref: '#/components/schemas/DnsRrsetWithOneRecordPatch'
|
|
666
|
+
required:
|
|
667
|
+
- op
|
|
668
|
+
- record
|
|
669
|
+
title: DnsRecordPatchOp
|
|
670
|
+
type: object
|
|
660
671
|
DnsRecordResponse:
|
|
661
672
|
properties:
|
|
662
673
|
rdata:
|
|
@@ -685,8 +696,42 @@ components:
|
|
|
685
696
|
- name
|
|
686
697
|
- type
|
|
687
698
|
- ttl
|
|
699
|
+
- records
|
|
688
700
|
title: DnsRrsetCreate
|
|
689
701
|
type: object
|
|
702
|
+
DnsRrsetPatch:
|
|
703
|
+
properties:
|
|
704
|
+
name:
|
|
705
|
+
title: Name
|
|
706
|
+
type: string
|
|
707
|
+
records:
|
|
708
|
+
items:
|
|
709
|
+
$ref: '#/components/schemas/DnsRecordCreate'
|
|
710
|
+
title: Records
|
|
711
|
+
type: array
|
|
712
|
+
ttl:
|
|
713
|
+
title: Ttl
|
|
714
|
+
type: integer
|
|
715
|
+
type:
|
|
716
|
+
$ref: '#/components/schemas/DnsRrsetType'
|
|
717
|
+
required:
|
|
718
|
+
- name
|
|
719
|
+
- type
|
|
720
|
+
- ttl
|
|
721
|
+
- records
|
|
722
|
+
title: DnsRrsetPatch
|
|
723
|
+
type: object
|
|
724
|
+
DnsRrsetPatchOp:
|
|
725
|
+
properties:
|
|
726
|
+
op:
|
|
727
|
+
$ref: '#/components/schemas/PatchOp'
|
|
728
|
+
rrset:
|
|
729
|
+
$ref: '#/components/schemas/DnsRrsetPatch'
|
|
730
|
+
required:
|
|
731
|
+
- op
|
|
732
|
+
- rrset
|
|
733
|
+
title: DnsRrsetPatchOp
|
|
734
|
+
type: object
|
|
690
735
|
DnsRrsetResponse:
|
|
691
736
|
properties:
|
|
692
737
|
name:
|
|
@@ -725,6 +770,26 @@ components:
|
|
|
725
770
|
- SRV
|
|
726
771
|
title: DnsRrsetType
|
|
727
772
|
type: string
|
|
773
|
+
DnsRrsetWithOneRecordPatch:
|
|
774
|
+
properties:
|
|
775
|
+
name:
|
|
776
|
+
title: Name
|
|
777
|
+
type: string
|
|
778
|
+
rdata:
|
|
779
|
+
title: Rdata
|
|
780
|
+
type: string
|
|
781
|
+
ttl:
|
|
782
|
+
title: Ttl
|
|
783
|
+
type: integer
|
|
784
|
+
type:
|
|
785
|
+
$ref: '#/components/schemas/DnsRrsetType'
|
|
786
|
+
required:
|
|
787
|
+
- rdata
|
|
788
|
+
- name
|
|
789
|
+
- type
|
|
790
|
+
- ttl
|
|
791
|
+
title: DnsRrsetWithOneRecordPatch
|
|
792
|
+
type: object
|
|
728
793
|
DnsZoneCreate:
|
|
729
794
|
properties:
|
|
730
795
|
dnssec_status:
|
|
@@ -742,6 +807,17 @@ components:
|
|
|
742
807
|
- name
|
|
743
808
|
title: DnsZoneCreate
|
|
744
809
|
type: object
|
|
810
|
+
DnsZoneRecordsPatchOps:
|
|
811
|
+
properties:
|
|
812
|
+
ops:
|
|
813
|
+
items:
|
|
814
|
+
$ref: '#/components/schemas/DnsRecordPatchOp'
|
|
815
|
+
title: Ops
|
|
816
|
+
type: array
|
|
817
|
+
required:
|
|
818
|
+
- ops
|
|
819
|
+
title: DnsZoneRecordsPatchOps
|
|
820
|
+
type: object
|
|
745
821
|
DnsZoneResponse:
|
|
746
822
|
properties:
|
|
747
823
|
dnssec_status:
|
|
@@ -770,6 +846,17 @@ components:
|
|
|
770
846
|
type: array
|
|
771
847
|
title: DnsZoneRrsetsCreate
|
|
772
848
|
type: object
|
|
849
|
+
DnsZoneRrsetsPatchOps:
|
|
850
|
+
properties:
|
|
851
|
+
ops:
|
|
852
|
+
items:
|
|
853
|
+
$ref: '#/components/schemas/DnsRrsetPatchOp'
|
|
854
|
+
title: Ops
|
|
855
|
+
type: array
|
|
856
|
+
required:
|
|
857
|
+
- ops
|
|
858
|
+
title: DnsZoneRrsetsPatchOps
|
|
859
|
+
type: object
|
|
773
860
|
DnssecAlgorithm:
|
|
774
861
|
enum:
|
|
775
862
|
- 1
|
|
@@ -1351,6 +1438,53 @@ components:
|
|
|
1351
1438
|
- clientHold
|
|
1352
1439
|
title: DomainStatus
|
|
1353
1440
|
type: string
|
|
1441
|
+
DomainSummaryData:
|
|
1442
|
+
properties:
|
|
1443
|
+
by_status:
|
|
1444
|
+
additionalProperties:
|
|
1445
|
+
type: integer
|
|
1446
|
+
description: 'Domain counts by status (status: count)'
|
|
1447
|
+
title: By Status
|
|
1448
|
+
type: object
|
|
1449
|
+
by_tld:
|
|
1450
|
+
additionalProperties:
|
|
1451
|
+
type: integer
|
|
1452
|
+
description: 'Domain counts by TLD (tld: count)'
|
|
1453
|
+
title: By Tld
|
|
1454
|
+
type: object
|
|
1455
|
+
expiring_soon:
|
|
1456
|
+
$ref: '#/components/schemas/DomainsExpiringSoon'
|
|
1457
|
+
description: Domains expiring soon
|
|
1458
|
+
total_count:
|
|
1459
|
+
description: Total number of domains
|
|
1460
|
+
title: Total Count
|
|
1461
|
+
type: integer
|
|
1462
|
+
required:
|
|
1463
|
+
- total_count
|
|
1464
|
+
- by_status
|
|
1465
|
+
- by_tld
|
|
1466
|
+
- expiring_soon
|
|
1467
|
+
title: DomainSummaryData
|
|
1468
|
+
type: object
|
|
1469
|
+
DomainSummaryResponse:
|
|
1470
|
+
properties:
|
|
1471
|
+
domains:
|
|
1472
|
+
$ref: '#/components/schemas/DomainSummaryData'
|
|
1473
|
+
description: Domain summary data
|
|
1474
|
+
organization_id:
|
|
1475
|
+
description: The organization ID
|
|
1476
|
+
examples:
|
|
1477
|
+
- organization_01h45ytscbebyvny4gc8cr8ma2
|
|
1478
|
+
format: typeid
|
|
1479
|
+
pattern: ^organization_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
1480
|
+
title: Organization Id
|
|
1481
|
+
type: string
|
|
1482
|
+
x-typeid-prefix: organization
|
|
1483
|
+
required:
|
|
1484
|
+
- organization_id
|
|
1485
|
+
- domains
|
|
1486
|
+
title: DomainSummaryResponse
|
|
1487
|
+
type: object
|
|
1354
1488
|
DomainTransferIn:
|
|
1355
1489
|
properties:
|
|
1356
1490
|
auth_code:
|
|
@@ -1441,6 +1575,26 @@ components:
|
|
|
1441
1575
|
title: Statuses
|
|
1442
1576
|
title: DomainUpdate
|
|
1443
1577
|
type: object
|
|
1578
|
+
DomainsExpiringSoon:
|
|
1579
|
+
properties:
|
|
1580
|
+
next_30_days:
|
|
1581
|
+
description: Number of domains expiring in the next 30 days
|
|
1582
|
+
title: Next 30 Days
|
|
1583
|
+
type: integer
|
|
1584
|
+
next_60_days:
|
|
1585
|
+
description: Number of domains expiring in the next 60 days
|
|
1586
|
+
title: Next 60 Days
|
|
1587
|
+
type: integer
|
|
1588
|
+
next_90_days:
|
|
1589
|
+
description: Number of domains expiring in the next 90 days
|
|
1590
|
+
title: Next 90 Days
|
|
1591
|
+
type: integer
|
|
1592
|
+
required:
|
|
1593
|
+
- next_30_days
|
|
1594
|
+
- next_60_days
|
|
1595
|
+
- next_90_days
|
|
1596
|
+
title: DomainsExpiringSoon
|
|
1597
|
+
type: object
|
|
1444
1598
|
EmailForward:
|
|
1445
1599
|
properties:
|
|
1446
1600
|
created_on:
|
|
@@ -3059,6 +3213,12 @@ components:
|
|
|
3059
3213
|
- pagination
|
|
3060
3214
|
title: Pagination[User]
|
|
3061
3215
|
type: object
|
|
3216
|
+
PatchOp:
|
|
3217
|
+
enum:
|
|
3218
|
+
- upsert
|
|
3219
|
+
- remove
|
|
3220
|
+
title: PatchOp
|
|
3221
|
+
type: string
|
|
3062
3222
|
PeriodUnit:
|
|
3063
3223
|
enum:
|
|
3064
3224
|
- y
|
|
@@ -3904,7 +4064,7 @@ info:
|
|
|
3904
4064
|
'
|
|
3905
4065
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
3906
4066
|
title: OpusDNS API
|
|
3907
|
-
version: 2025-07-
|
|
4067
|
+
version: 2025-07-25-140023
|
|
3908
4068
|
x-logo:
|
|
3909
4069
|
altText: OpusDNS API Reference
|
|
3910
4070
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -5268,9 +5428,72 @@ paths:
|
|
|
5268
5428
|
summary: Enable Dnssec
|
|
5269
5429
|
tags:
|
|
5270
5430
|
- dns
|
|
5431
|
+
/v1/dns/{zone_name}/records:
|
|
5432
|
+
patch:
|
|
5433
|
+
operationId: patch_zone_records_v1_dns__zone_name__records_patch
|
|
5434
|
+
parameters:
|
|
5435
|
+
- description: DNS zone name (trailing dot optional)
|
|
5436
|
+
in: path
|
|
5437
|
+
name: zone_name
|
|
5438
|
+
required: true
|
|
5439
|
+
schema:
|
|
5440
|
+
description: DNS zone name (trailing dot optional)
|
|
5441
|
+
title: Zone Name
|
|
5442
|
+
type: string
|
|
5443
|
+
requestBody:
|
|
5444
|
+
content:
|
|
5445
|
+
application/json:
|
|
5446
|
+
schema:
|
|
5447
|
+
$ref: '#/components/schemas/DnsZoneRecordsPatchOps'
|
|
5448
|
+
required: true
|
|
5449
|
+
responses:
|
|
5450
|
+
'204':
|
|
5451
|
+
description: Successful Response
|
|
5452
|
+
'422':
|
|
5453
|
+
content:
|
|
5454
|
+
application/problem+json:
|
|
5455
|
+
schema:
|
|
5456
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
5457
|
+
description: Validation Error
|
|
5458
|
+
security:
|
|
5459
|
+
- OAuth2PasswordBearer: []
|
|
5460
|
+
summary: Patch Zone Records
|
|
5461
|
+
tags:
|
|
5462
|
+
- dns
|
|
5271
5463
|
/v1/dns/{zone_name}/rrsets:
|
|
5464
|
+
patch:
|
|
5465
|
+
operationId: patch_zone_rrsets_v1_dns__zone_name__rrsets_patch
|
|
5466
|
+
parameters:
|
|
5467
|
+
- description: DNS zone name (trailing dot optional)
|
|
5468
|
+
in: path
|
|
5469
|
+
name: zone_name
|
|
5470
|
+
required: true
|
|
5471
|
+
schema:
|
|
5472
|
+
description: DNS zone name (trailing dot optional)
|
|
5473
|
+
title: Zone Name
|
|
5474
|
+
type: string
|
|
5475
|
+
requestBody:
|
|
5476
|
+
content:
|
|
5477
|
+
application/json:
|
|
5478
|
+
schema:
|
|
5479
|
+
$ref: '#/components/schemas/DnsZoneRrsetsPatchOps'
|
|
5480
|
+
required: true
|
|
5481
|
+
responses:
|
|
5482
|
+
'204':
|
|
5483
|
+
description: Successful Response
|
|
5484
|
+
'422':
|
|
5485
|
+
content:
|
|
5486
|
+
application/problem+json:
|
|
5487
|
+
schema:
|
|
5488
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
5489
|
+
description: Validation Error
|
|
5490
|
+
security:
|
|
5491
|
+
- OAuth2PasswordBearer: []
|
|
5492
|
+
summary: Patch Zone Rrsets
|
|
5493
|
+
tags:
|
|
5494
|
+
- dns
|
|
5272
5495
|
put:
|
|
5273
|
-
operationId:
|
|
5496
|
+
operationId: update_zone_rrsets_v1_dns__zone_name__rrsets_put
|
|
5274
5497
|
parameters:
|
|
5275
5498
|
- description: DNS zone name (trailing dot optional)
|
|
5276
5499
|
in: path
|
|
@@ -5287,10 +5510,7 @@ paths:
|
|
|
5287
5510
|
$ref: '#/components/schemas/DnsZoneRrsetsCreate'
|
|
5288
5511
|
required: true
|
|
5289
5512
|
responses:
|
|
5290
|
-
'
|
|
5291
|
-
content:
|
|
5292
|
-
application/json:
|
|
5293
|
-
schema: {}
|
|
5513
|
+
'204':
|
|
5294
5514
|
description: Successful Response
|
|
5295
5515
|
'422':
|
|
5296
5516
|
content:
|
|
@@ -5300,7 +5520,7 @@ paths:
|
|
|
5300
5520
|
description: Validation Error
|
|
5301
5521
|
security:
|
|
5302
5522
|
- OAuth2PasswordBearer: []
|
|
5303
|
-
summary: Update Zone
|
|
5523
|
+
summary: Update Zone Rrsets
|
|
5304
5524
|
tags:
|
|
5305
5525
|
- dns
|
|
5306
5526
|
/v1/domain-search/suggest:
|
|
@@ -5682,6 +5902,23 @@ paths:
|
|
|
5682
5902
|
summary: Check domain availability
|
|
5683
5903
|
tags:
|
|
5684
5904
|
- domain
|
|
5905
|
+
/v1/domains/summary:
|
|
5906
|
+
get:
|
|
5907
|
+
description: Retrieves a summary of domains including counts by status, TLD,
|
|
5908
|
+
and expiration timeframes
|
|
5909
|
+
operationId: get_domain_summary_v1_domains_summary_get
|
|
5910
|
+
responses:
|
|
5911
|
+
'200':
|
|
5912
|
+
content:
|
|
5913
|
+
application/json:
|
|
5914
|
+
schema:
|
|
5915
|
+
$ref: '#/components/schemas/DomainSummaryResponse'
|
|
5916
|
+
description: Successful Response
|
|
5917
|
+
security:
|
|
5918
|
+
- OAuth2PasswordBearer: []
|
|
5919
|
+
summary: Get domain summary
|
|
5920
|
+
tags:
|
|
5921
|
+
- domain
|
|
5685
5922
|
/v1/domains/transfer:
|
|
5686
5923
|
post:
|
|
5687
5924
|
description: 'Start the transfer process for a domain <br>
|
package/src/schema.d.ts
CHANGED
|
@@ -317,6 +317,23 @@ export interface paths {
|
|
|
317
317
|
patch?: never;
|
|
318
318
|
trace?: never;
|
|
319
319
|
};
|
|
320
|
+
"/v1/dns/{zone_name}/records": {
|
|
321
|
+
parameters: {
|
|
322
|
+
query?: never;
|
|
323
|
+
header?: never;
|
|
324
|
+
path?: never;
|
|
325
|
+
cookie?: never;
|
|
326
|
+
};
|
|
327
|
+
get?: never;
|
|
328
|
+
put?: never;
|
|
329
|
+
post?: never;
|
|
330
|
+
delete?: never;
|
|
331
|
+
options?: never;
|
|
332
|
+
head?: never;
|
|
333
|
+
/** Patch Zone Records */
|
|
334
|
+
patch: operations["patch_zone_records_v1_dns__zone_name__records_patch"];
|
|
335
|
+
trace?: never;
|
|
336
|
+
};
|
|
320
337
|
"/v1/dns/{zone_name}/rrsets": {
|
|
321
338
|
parameters: {
|
|
322
339
|
query?: never;
|
|
@@ -325,13 +342,14 @@ export interface paths {
|
|
|
325
342
|
cookie?: never;
|
|
326
343
|
};
|
|
327
344
|
get?: never;
|
|
328
|
-
/** Update Zone */
|
|
329
|
-
put: operations["
|
|
345
|
+
/** Update Zone Rrsets */
|
|
346
|
+
put: operations["update_zone_rrsets_v1_dns__zone_name__rrsets_put"];
|
|
330
347
|
post?: never;
|
|
331
348
|
delete?: never;
|
|
332
349
|
options?: never;
|
|
333
350
|
head?: never;
|
|
334
|
-
|
|
351
|
+
/** Patch Zone Rrsets */
|
|
352
|
+
patch: operations["patch_zone_rrsets_v1_dns__zone_name__rrsets_patch"];
|
|
335
353
|
trace?: never;
|
|
336
354
|
};
|
|
337
355
|
"/v1/domain-search/suggest": {
|
|
@@ -392,6 +410,26 @@ export interface paths {
|
|
|
392
410
|
patch?: never;
|
|
393
411
|
trace?: never;
|
|
394
412
|
};
|
|
413
|
+
"/v1/domains/summary": {
|
|
414
|
+
parameters: {
|
|
415
|
+
query?: never;
|
|
416
|
+
header?: never;
|
|
417
|
+
path?: never;
|
|
418
|
+
cookie?: never;
|
|
419
|
+
};
|
|
420
|
+
/**
|
|
421
|
+
* Get domain summary
|
|
422
|
+
* @description Retrieves a summary of domains including counts by status, TLD, and expiration timeframes
|
|
423
|
+
*/
|
|
424
|
+
get: operations["get_domain_summary_v1_domains_summary_get"];
|
|
425
|
+
put?: never;
|
|
426
|
+
post?: never;
|
|
427
|
+
delete?: never;
|
|
428
|
+
options?: never;
|
|
429
|
+
head?: never;
|
|
430
|
+
patch?: never;
|
|
431
|
+
trace?: never;
|
|
432
|
+
};
|
|
395
433
|
"/v1/domains/transfer": {
|
|
396
434
|
parameters: {
|
|
397
435
|
query?: never;
|
|
@@ -1428,6 +1466,11 @@ export interface components {
|
|
|
1428
1466
|
/** Rdata */
|
|
1429
1467
|
rdata: string;
|
|
1430
1468
|
};
|
|
1469
|
+
/** DnsRecordPatchOp */
|
|
1470
|
+
DnsRecordPatchOp: {
|
|
1471
|
+
op: components["schemas"]["PatchOp"];
|
|
1472
|
+
record: components["schemas"]["DnsRrsetWithOneRecordPatch"];
|
|
1473
|
+
};
|
|
1431
1474
|
/** DnsRecordResponse */
|
|
1432
1475
|
DnsRecordResponse: {
|
|
1433
1476
|
/** Rdata */
|
|
@@ -1438,11 +1481,26 @@ export interface components {
|
|
|
1438
1481
|
/** Name */
|
|
1439
1482
|
name: string;
|
|
1440
1483
|
/** Records */
|
|
1441
|
-
records
|
|
1484
|
+
records: components["schemas"]["DnsRecordCreate"][];
|
|
1485
|
+
/** Ttl */
|
|
1486
|
+
ttl: number;
|
|
1487
|
+
type: components["schemas"]["DnsRrsetType"];
|
|
1488
|
+
};
|
|
1489
|
+
/** DnsRrsetPatch */
|
|
1490
|
+
DnsRrsetPatch: {
|
|
1491
|
+
/** Name */
|
|
1492
|
+
name: string;
|
|
1493
|
+
/** Records */
|
|
1494
|
+
records: components["schemas"]["DnsRecordCreate"][];
|
|
1442
1495
|
/** Ttl */
|
|
1443
1496
|
ttl: number;
|
|
1444
1497
|
type: components["schemas"]["DnsRrsetType"];
|
|
1445
1498
|
};
|
|
1499
|
+
/** DnsRrsetPatchOp */
|
|
1500
|
+
DnsRrsetPatchOp: {
|
|
1501
|
+
op: components["schemas"]["PatchOp"];
|
|
1502
|
+
rrset: components["schemas"]["DnsRrsetPatch"];
|
|
1503
|
+
};
|
|
1446
1504
|
/** DnsRrsetResponse */
|
|
1447
1505
|
DnsRrsetResponse: {
|
|
1448
1506
|
/** Name */
|
|
@@ -1458,6 +1516,16 @@ export interface components {
|
|
|
1458
1516
|
* @enum {string}
|
|
1459
1517
|
*/
|
|
1460
1518
|
DnsRrsetType: "A" | "AAAA" | "ALIAS" | "CAA" | "CNAME" | "DNSKEY" | "DS" | "MX" | "NS" | "PTR" | "TXT" | "SOA" | "SRV";
|
|
1519
|
+
/** DnsRrsetWithOneRecordPatch */
|
|
1520
|
+
DnsRrsetWithOneRecordPatch: {
|
|
1521
|
+
/** Name */
|
|
1522
|
+
name: string;
|
|
1523
|
+
/** Rdata */
|
|
1524
|
+
rdata: string;
|
|
1525
|
+
/** Ttl */
|
|
1526
|
+
ttl: number;
|
|
1527
|
+
type: components["schemas"]["DnsRrsetType"];
|
|
1528
|
+
};
|
|
1461
1529
|
/** DnsZoneCreate */
|
|
1462
1530
|
DnsZoneCreate: {
|
|
1463
1531
|
/** @default disabled */
|
|
@@ -1467,6 +1535,11 @@ export interface components {
|
|
|
1467
1535
|
/** Rrsets */
|
|
1468
1536
|
rrsets?: components["schemas"]["DnsRrsetCreate"][];
|
|
1469
1537
|
};
|
|
1538
|
+
/** DnsZoneRecordsPatchOps */
|
|
1539
|
+
DnsZoneRecordsPatchOps: {
|
|
1540
|
+
/** Ops */
|
|
1541
|
+
ops: components["schemas"]["DnsRecordPatchOp"][];
|
|
1542
|
+
};
|
|
1470
1543
|
/** DnsZoneResponse */
|
|
1471
1544
|
DnsZoneResponse: {
|
|
1472
1545
|
/** @default disabled */
|
|
@@ -1482,6 +1555,11 @@ export interface components {
|
|
|
1482
1555
|
/** Rrsets */
|
|
1483
1556
|
rrsets?: components["schemas"]["DnsRrsetCreate"][];
|
|
1484
1557
|
};
|
|
1558
|
+
/** DnsZoneRrsetsPatchOps */
|
|
1559
|
+
DnsZoneRrsetsPatchOps: {
|
|
1560
|
+
/** Ops */
|
|
1561
|
+
ops: components["schemas"]["DnsRrsetPatchOp"][];
|
|
1562
|
+
};
|
|
1485
1563
|
/**
|
|
1486
1564
|
* DnssecAlgorithm
|
|
1487
1565
|
* @enum {integer}
|
|
@@ -1846,6 +1924,41 @@ export interface components {
|
|
|
1846
1924
|
* @enum {string}
|
|
1847
1925
|
*/
|
|
1848
1926
|
DomainStatus: "ok" | "serverTransferProhibited" | "serverUpdateProhibited" | "serverDeleteProhibited" | "serverRenewProhibited" | "serverHold" | "transferPeriod" | "renewPeriod" | "redemptionPeriod" | "pendingUpdate" | "pendingTransfer" | "pendingRestore" | "pendingRenew" | "pendingDelete" | "pendingCreate" | "inactive" | "autoRenewPeriod" | "addPeriod" | "deleted" | "clientTransferProhibited" | "clientUpdateProhibited" | "clientDeleteProhibited" | "clientRenewProhibited" | "clientHold";
|
|
1927
|
+
/** DomainSummaryData */
|
|
1928
|
+
DomainSummaryData: {
|
|
1929
|
+
/**
|
|
1930
|
+
* By Status
|
|
1931
|
+
* @description Domain counts by status (status: count)
|
|
1932
|
+
*/
|
|
1933
|
+
by_status: {
|
|
1934
|
+
[key: string]: number;
|
|
1935
|
+
};
|
|
1936
|
+
/**
|
|
1937
|
+
* By Tld
|
|
1938
|
+
* @description Domain counts by TLD (tld: count)
|
|
1939
|
+
*/
|
|
1940
|
+
by_tld: {
|
|
1941
|
+
[key: string]: number;
|
|
1942
|
+
};
|
|
1943
|
+
/** @description Domains expiring soon */
|
|
1944
|
+
expiring_soon: components["schemas"]["DomainsExpiringSoon"];
|
|
1945
|
+
/**
|
|
1946
|
+
* Total Count
|
|
1947
|
+
* @description Total number of domains
|
|
1948
|
+
*/
|
|
1949
|
+
total_count: number;
|
|
1950
|
+
};
|
|
1951
|
+
/** DomainSummaryResponse */
|
|
1952
|
+
DomainSummaryResponse: {
|
|
1953
|
+
/** @description Domain summary data */
|
|
1954
|
+
domains: components["schemas"]["DomainSummaryData"];
|
|
1955
|
+
/**
|
|
1956
|
+
* Organization Id
|
|
1957
|
+
* Format: typeid
|
|
1958
|
+
* @description The organization ID
|
|
1959
|
+
*/
|
|
1960
|
+
organization_id: TypeID<"organization">;
|
|
1961
|
+
};
|
|
1849
1962
|
/** DomainTransferIn */
|
|
1850
1963
|
DomainTransferIn: {
|
|
1851
1964
|
/**
|
|
@@ -1894,6 +2007,24 @@ export interface components {
|
|
|
1894
2007
|
*/
|
|
1895
2008
|
statuses?: components["schemas"]["DomainClientStatus"][] | null;
|
|
1896
2009
|
};
|
|
2010
|
+
/** DomainsExpiringSoon */
|
|
2011
|
+
DomainsExpiringSoon: {
|
|
2012
|
+
/**
|
|
2013
|
+
* Next 30 Days
|
|
2014
|
+
* @description Number of domains expiring in the next 30 days
|
|
2015
|
+
*/
|
|
2016
|
+
next_30_days: number;
|
|
2017
|
+
/**
|
|
2018
|
+
* Next 60 Days
|
|
2019
|
+
* @description Number of domains expiring in the next 60 days
|
|
2020
|
+
*/
|
|
2021
|
+
next_60_days: number;
|
|
2022
|
+
/**
|
|
2023
|
+
* Next 90 Days
|
|
2024
|
+
* @description Number of domains expiring in the next 90 days
|
|
2025
|
+
*/
|
|
2026
|
+
next_90_days: number;
|
|
2027
|
+
};
|
|
1897
2028
|
/** EmailForward */
|
|
1898
2029
|
EmailForward: {
|
|
1899
2030
|
/**
|
|
@@ -3009,6 +3140,11 @@ export interface components {
|
|
|
3009
3140
|
/** Results */
|
|
3010
3141
|
results: components["schemas"]["User"][];
|
|
3011
3142
|
};
|
|
3143
|
+
/**
|
|
3144
|
+
* PatchOp
|
|
3145
|
+
* @enum {string}
|
|
3146
|
+
*/
|
|
3147
|
+
PatchOp: "upsert" | "remove";
|
|
3012
3148
|
/**
|
|
3013
3149
|
* PeriodUnit
|
|
3014
3150
|
* @enum {string}
|
|
@@ -4575,7 +4711,41 @@ export interface operations {
|
|
|
4575
4711
|
};
|
|
4576
4712
|
};
|
|
4577
4713
|
};
|
|
4578
|
-
|
|
4714
|
+
patch_zone_records_v1_dns__zone_name__records_patch: {
|
|
4715
|
+
parameters: {
|
|
4716
|
+
query?: never;
|
|
4717
|
+
header?: never;
|
|
4718
|
+
path: {
|
|
4719
|
+
/** @description DNS zone name (trailing dot optional) */
|
|
4720
|
+
zone_name: string;
|
|
4721
|
+
};
|
|
4722
|
+
cookie?: never;
|
|
4723
|
+
};
|
|
4724
|
+
requestBody: {
|
|
4725
|
+
content: {
|
|
4726
|
+
"application/json": components["schemas"]["DnsZoneRecordsPatchOps"];
|
|
4727
|
+
};
|
|
4728
|
+
};
|
|
4729
|
+
responses: {
|
|
4730
|
+
/** @description Successful Response */
|
|
4731
|
+
204: {
|
|
4732
|
+
headers: {
|
|
4733
|
+
[name: string]: unknown;
|
|
4734
|
+
};
|
|
4735
|
+
content?: never;
|
|
4736
|
+
};
|
|
4737
|
+
/** @description Validation Error */
|
|
4738
|
+
422: {
|
|
4739
|
+
headers: {
|
|
4740
|
+
[name: string]: unknown;
|
|
4741
|
+
};
|
|
4742
|
+
content: {
|
|
4743
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
4744
|
+
};
|
|
4745
|
+
};
|
|
4746
|
+
};
|
|
4747
|
+
};
|
|
4748
|
+
update_zone_rrsets_v1_dns__zone_name__rrsets_put: {
|
|
4579
4749
|
parameters: {
|
|
4580
4750
|
query?: never;
|
|
4581
4751
|
header?: never;
|
|
@@ -4592,14 +4762,46 @@ export interface operations {
|
|
|
4592
4762
|
};
|
|
4593
4763
|
responses: {
|
|
4594
4764
|
/** @description Successful Response */
|
|
4595
|
-
|
|
4765
|
+
204: {
|
|
4766
|
+
headers: {
|
|
4767
|
+
[name: string]: unknown;
|
|
4768
|
+
};
|
|
4769
|
+
content?: never;
|
|
4770
|
+
};
|
|
4771
|
+
/** @description Validation Error */
|
|
4772
|
+
422: {
|
|
4596
4773
|
headers: {
|
|
4597
4774
|
[name: string]: unknown;
|
|
4598
4775
|
};
|
|
4599
4776
|
content: {
|
|
4600
|
-
"application/json":
|
|
4777
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
4601
4778
|
};
|
|
4602
4779
|
};
|
|
4780
|
+
};
|
|
4781
|
+
};
|
|
4782
|
+
patch_zone_rrsets_v1_dns__zone_name__rrsets_patch: {
|
|
4783
|
+
parameters: {
|
|
4784
|
+
query?: never;
|
|
4785
|
+
header?: never;
|
|
4786
|
+
path: {
|
|
4787
|
+
/** @description DNS zone name (trailing dot optional) */
|
|
4788
|
+
zone_name: string;
|
|
4789
|
+
};
|
|
4790
|
+
cookie?: never;
|
|
4791
|
+
};
|
|
4792
|
+
requestBody: {
|
|
4793
|
+
content: {
|
|
4794
|
+
"application/json": components["schemas"]["DnsZoneRrsetsPatchOps"];
|
|
4795
|
+
};
|
|
4796
|
+
};
|
|
4797
|
+
responses: {
|
|
4798
|
+
/** @description Successful Response */
|
|
4799
|
+
204: {
|
|
4800
|
+
headers: {
|
|
4801
|
+
[name: string]: unknown;
|
|
4802
|
+
};
|
|
4803
|
+
content?: never;
|
|
4804
|
+
};
|
|
4603
4805
|
/** @description Validation Error */
|
|
4604
4806
|
422: {
|
|
4605
4807
|
headers: {
|
|
@@ -4810,6 +5012,26 @@ export interface operations {
|
|
|
4810
5012
|
};
|
|
4811
5013
|
};
|
|
4812
5014
|
};
|
|
5015
|
+
get_domain_summary_v1_domains_summary_get: {
|
|
5016
|
+
parameters: {
|
|
5017
|
+
query?: never;
|
|
5018
|
+
header?: never;
|
|
5019
|
+
path?: never;
|
|
5020
|
+
cookie?: never;
|
|
5021
|
+
};
|
|
5022
|
+
requestBody?: never;
|
|
5023
|
+
responses: {
|
|
5024
|
+
/** @description Successful Response */
|
|
5025
|
+
200: {
|
|
5026
|
+
headers: {
|
|
5027
|
+
[name: string]: unknown;
|
|
5028
|
+
};
|
|
5029
|
+
content: {
|
|
5030
|
+
"application/json": components["schemas"]["DomainSummaryResponse"];
|
|
5031
|
+
};
|
|
5032
|
+
};
|
|
5033
|
+
};
|
|
5034
|
+
};
|
|
4813
5035
|
transfer_domain_v1_domains_transfer_post: {
|
|
4814
5036
|
parameters: {
|
|
4815
5037
|
query?: never;
|
package/src/types/constants.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
/**
|
|
2
2
|
* Auto-generated enums from OpenAPI schema
|
|
3
|
-
* Generated on: 2025-07-
|
|
3
|
+
* Generated on: 2025-07-25T14:03:33.604Z
|
|
4
4
|
*/
|
|
5
5
|
|
|
6
6
|
/**
|
|
@@ -238,6 +238,14 @@ export enum ORGANIZATION_STATUS {
|
|
|
238
238
|
INACTIVE = "inactive",
|
|
239
239
|
}
|
|
240
240
|
|
|
241
|
+
/**
|
|
242
|
+
* PATCH_OP
|
|
243
|
+
*/
|
|
244
|
+
export enum PATCH_OP {
|
|
245
|
+
UPSERT = "upsert",
|
|
246
|
+
REMOVE = "remove",
|
|
247
|
+
}
|
|
248
|
+
|
|
241
249
|
/**
|
|
242
250
|
* PERIOD_UNIT
|
|
243
251
|
*/
|
package/src/types/keys.ts
CHANGED
|
@@ -17,6 +17,7 @@ import { Get_Domains_Response_V1 } from './types';
|
|
|
17
17
|
import { Get_DomainsBydomainReference_Response_V1 } from './types';
|
|
18
18
|
import { Get_DomainsCheck_Response_V1 } from './types';
|
|
19
19
|
import { Get_DomainSearchSuggest_Response_V1 } from './types';
|
|
20
|
+
import { Get_DomainsSummary_Response_V1 } from './types';
|
|
20
21
|
import { Get_EmailForwards_Response_V1 } from './types';
|
|
21
22
|
import { Get_EmailForwardsByemailForwardId_Response_V1 } from './types';
|
|
22
23
|
import { Get_Event_Response_V1 } from './types';
|
|
@@ -50,6 +51,7 @@ import { DnsZone } from './types';
|
|
|
50
51
|
import { DomainCheck } from './types';
|
|
51
52
|
import { Domain } from './types';
|
|
52
53
|
import { DomainSearch } from './types';
|
|
54
|
+
import { DomainSummary } from './types';
|
|
53
55
|
import { EmailForward } from './types';
|
|
54
56
|
import { EventSchema } from './types';
|
|
55
57
|
import { IpRestriction } from './types';
|
|
@@ -258,6 +260,14 @@ export const GET_DOMAIN_SEARCH_SUGGEST_RESPONSE_V1_KEYS = [
|
|
|
258
260
|
GET_DOMAIN_SEARCH_SUGGEST_RESPONSE_V1_KEY_RESULTS,
|
|
259
261
|
] as const;
|
|
260
262
|
|
|
263
|
+
export const GET_DOMAINS_SUMMARY_RESPONSE_V1_KEY_DOMAINS = 'domains' as keyof Get_DomainsSummary_Response_V1;
|
|
264
|
+
export const GET_DOMAINS_SUMMARY_RESPONSE_V1_KEY_ORGANIZATION_ID = 'organization_id' as keyof Get_DomainsSummary_Response_V1;
|
|
265
|
+
|
|
266
|
+
export const GET_DOMAINS_SUMMARY_RESPONSE_V1_KEYS = [
|
|
267
|
+
GET_DOMAINS_SUMMARY_RESPONSE_V1_KEY_DOMAINS,
|
|
268
|
+
GET_DOMAINS_SUMMARY_RESPONSE_V1_KEY_ORGANIZATION_ID,
|
|
269
|
+
] as const;
|
|
270
|
+
|
|
261
271
|
export const GET_EMAIL_FORWARDS_RESPONSE_V1_KEY_PAGINATION = 'pagination' as keyof Get_EmailForwards_Response_V1;
|
|
262
272
|
export const GET_EMAIL_FORWARDS_RESPONSE_V1_KEY_RESULTS = 'results' as keyof Get_EmailForwards_Response_V1;
|
|
263
273
|
|
|
@@ -974,6 +984,14 @@ export const DOMAIN_SEARCH_KEYS = [
|
|
|
974
984
|
DOMAIN_SEARCH_KEY_RESULTS,
|
|
975
985
|
] as const;
|
|
976
986
|
|
|
987
|
+
export const DOMAIN_SUMMARY_KEY_DOMAINS = 'domains' as keyof DomainSummary;
|
|
988
|
+
export const DOMAIN_SUMMARY_KEY_ORGANIZATION_ID = 'organization_id' as keyof DomainSummary;
|
|
989
|
+
|
|
990
|
+
export const DOMAIN_SUMMARY_KEYS = [
|
|
991
|
+
DOMAIN_SUMMARY_KEY_DOMAINS,
|
|
992
|
+
DOMAIN_SUMMARY_KEY_ORGANIZATION_ID,
|
|
993
|
+
] as const;
|
|
994
|
+
|
|
977
995
|
export const EMAIL_FORWARD_KEY_CREATED_ON = 'created_on' as keyof EmailForward;
|
|
978
996
|
export const EMAIL_FORWARD_KEY_EMAIL_FORWARD_ID = 'email_forward_id' as keyof EmailForward;
|
|
979
997
|
export const EMAIL_FORWARD_KEY_SOURCE_ADDRESS = 'source_address' as keyof EmailForward;
|
package/src/types/types.ts
CHANGED
|
@@ -23,6 +23,7 @@ export type Get_Domains_Response_V1 = components['schemas']['Pagination_DomainRe
|
|
|
23
23
|
export type Get_DomainsBydomainReference_Response_V1 = components['schemas']['DomainResponse'];
|
|
24
24
|
export type Get_DomainsCheck_Response_V1 = components['schemas']['DomainCheckResponse'];
|
|
25
25
|
export type Get_DomainSearchSuggest_Response_V1 = components['schemas']['DomainSearchResponse'];
|
|
26
|
+
export type Get_DomainsSummary_Response_V1 = components['schemas']['DomainSummaryResponse'];
|
|
26
27
|
export type Get_EmailForwards_Response_V1 = components['schemas']['Pagination_EmailForward_'];
|
|
27
28
|
export type Get_EmailForwardsByemailForwardId_Response_V1 = components['schemas']['EmailForward'];
|
|
28
29
|
export type Get_Event_Response_V1 = components['schemas']['Pagination_EventResponse_'];
|
|
@@ -83,7 +84,9 @@ export type Get_DnsByzoneName_ParamsPath_V1 = operations['get_zone_v1_dns__zone_
|
|
|
83
84
|
export type Delete_DnsByzoneName_ParamsPath_V1 = operations['delete_zone_v1_dns__zone_name__delete']['parameters']['path'];
|
|
84
85
|
export type Post_DnsByzoneNameDnssecDisable_ParamsPath_V1 = operations['disable_dnssec_v1_dns__zone_name__dnssec_disable_post']['parameters']['path'];
|
|
85
86
|
export type Post_DnsByzoneNameDnssecEnable_ParamsPath_V1 = operations['enable_dnssec_v1_dns__zone_name__dnssec_enable_post']['parameters']['path'];
|
|
86
|
-
export type
|
|
87
|
+
export type Patch_DnsByzoneNameRecords_ParamsPath_V1 = operations['patch_zone_records_v1_dns__zone_name__records_patch']['parameters']['path'];
|
|
88
|
+
export type Put_DnsByzoneNameRrsets_ParamsPath_V1 = operations['update_zone_rrsets_v1_dns__zone_name__rrsets_put']['parameters']['path'];
|
|
89
|
+
export type Patch_DnsByzoneNameRrsets_ParamsPath_V1 = operations['patch_zone_rrsets_v1_dns__zone_name__rrsets_patch']['parameters']['path'];
|
|
87
90
|
export type Get_DomainSearchSuggest_ParamsQuery_V1 = operations['suggest_v1_domain_search_suggest_get']['parameters']['query'];
|
|
88
91
|
export type Get_Domains_ParamsQuery_V1 = operations['get_domains_v1_domains_get']['parameters']['query'];
|
|
89
92
|
export type Get_DomainsCheck_ParamsQuery_V1 = operations['epp_check_domain_v1_domains_check_get']['parameters']['query'];
|
|
@@ -149,6 +152,7 @@ export type DomainNameserversArray = Domain['nameservers'];
|
|
|
149
152
|
export type DomainRegistry_statusesArray = Domain['registry_statuses'];
|
|
150
153
|
export type DomainSearch = components['schemas']['DomainSearchResponse'];
|
|
151
154
|
export type DomainSearchResultsArray = DomainSearch['results'];
|
|
155
|
+
export type DomainSummary = components['schemas']['DomainSummaryResponse'];
|
|
152
156
|
export type EmailForward = components['schemas']['EmailForward'];
|
|
153
157
|
export type EventSchema = components['schemas']['EventSchema'];
|
|
154
158
|
export type IpRestriction = components['schemas']['IpRestrictionResponse'];
|