@opusdns/api 0.125.0 → 0.127.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 +2 -2
- package/src/helpers/keys.ts +742 -742
- package/src/helpers/responses.d.ts +95 -5
- package/src/openapi.yaml +31 -1
- package/src/schema.d.ts +45 -0
|
@@ -2335,10 +2335,11 @@ export type GET_DnsEmailForwards_Response_422 = HTTPValidationError
|
|
|
2335
2335
|
* @path /v1/dns/summary
|
|
2336
2336
|
*
|
|
2337
2337
|
* @see {@link GET_DnsSummary_Response_200} - 200 response type
|
|
2338
|
+
* @see {@link GET_DnsSummary_Response_422} - 422 response type
|
|
2338
2339
|
*
|
|
2339
2340
|
|
|
2340
2341
|
*/
|
|
2341
|
-
export type GET_DnsSummary_Response = GET_DnsSummary_Response_200;
|
|
2342
|
+
export type GET_DnsSummary_Response = GET_DnsSummary_Response_200 | GET_DnsSummary_Response_422;
|
|
2342
2343
|
|
|
2343
2344
|
/**
|
|
2344
2345
|
* 200 response for GET DnsSummary endpoint
|
|
@@ -2357,6 +2358,23 @@ export type GET_DnsSummary_Response = GET_DnsSummary_Response_200;
|
|
|
2357
2358
|
*/
|
|
2358
2359
|
export type GET_DnsSummary_Response_200 = DnsZoneSummary
|
|
2359
2360
|
|
|
2361
|
+
/**
|
|
2362
|
+
* 422 response for GET DnsSummary endpoint
|
|
2363
|
+
*
|
|
2364
|
+
* @remarks
|
|
2365
|
+
* This type defines the response structure for the 422 status code
|
|
2366
|
+
* of the GET DnsSummary endpoint.
|
|
2367
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2368
|
+
*
|
|
2369
|
+
|
|
2370
|
+
*
|
|
2371
|
+
* @path /v1/dns/summary
|
|
2372
|
+
*
|
|
2373
|
+
* @see {@link GET_DnsSummary_Response} - The main response type definition
|
|
2374
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
2375
|
+
*/
|
|
2376
|
+
export type GET_DnsSummary_Response_422 = HTTPValidationError
|
|
2377
|
+
|
|
2360
2378
|
/**
|
|
2361
2379
|
* Response types for GET DomainForwards endpoint
|
|
2362
2380
|
*
|
|
@@ -4760,10 +4778,11 @@ export type GET_DomainsCheck_Response_422 = HTTPValidationError
|
|
|
4760
4778
|
* @path /v1/domains/summary
|
|
4761
4779
|
*
|
|
4762
4780
|
* @see {@link GET_DomainsSummary_Response_200} - 200 response type
|
|
4781
|
+
* @see {@link GET_DomainsSummary_Response_422} - 422 response type
|
|
4763
4782
|
*
|
|
4764
4783
|
|
|
4765
4784
|
*/
|
|
4766
|
-
export type GET_DomainsSummary_Response = GET_DomainsSummary_Response_200;
|
|
4785
|
+
export type GET_DomainsSummary_Response = GET_DomainsSummary_Response_200 | GET_DomainsSummary_Response_422;
|
|
4767
4786
|
|
|
4768
4787
|
/**
|
|
4769
4788
|
* 200 response for GET DomainsSummary endpoint
|
|
@@ -4782,6 +4801,23 @@ export type GET_DomainsSummary_Response = GET_DomainsSummary_Response_200;
|
|
|
4782
4801
|
*/
|
|
4783
4802
|
export type GET_DomainsSummary_Response_200 = DomainSummary
|
|
4784
4803
|
|
|
4804
|
+
/**
|
|
4805
|
+
* 422 response for GET DomainsSummary endpoint
|
|
4806
|
+
*
|
|
4807
|
+
* @remarks
|
|
4808
|
+
* This type defines the response structure for the 422 status code
|
|
4809
|
+
* of the GET DomainsSummary endpoint.
|
|
4810
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4811
|
+
*
|
|
4812
|
+
|
|
4813
|
+
*
|
|
4814
|
+
* @path /v1/domains/summary
|
|
4815
|
+
*
|
|
4816
|
+
* @see {@link GET_DomainsSummary_Response} - The main response type definition
|
|
4817
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
4818
|
+
*/
|
|
4819
|
+
export type GET_DomainsSummary_Response_422 = HTTPValidationError
|
|
4820
|
+
|
|
4785
4821
|
/**
|
|
4786
4822
|
* Response types for POST DomainsTldSpecificAtByDomainReferenceWithdraw endpoint
|
|
4787
4823
|
*
|
|
@@ -7553,10 +7589,11 @@ Single IP addresses are returned with CIDR notation (/32 for IPv4, /128 for IPv6
|
|
|
7553
7589
|
* @see {@link GET_OrganizationsIpRestrictions_Response_200} - 200 response type
|
|
7554
7590
|
* @see {@link GET_OrganizationsIpRestrictions_Response_401} - 401 response type
|
|
7555
7591
|
* @see {@link GET_OrganizationsIpRestrictions_Response_403} - 403 response type
|
|
7592
|
+
* @see {@link GET_OrganizationsIpRestrictions_Response_422} - 422 response type
|
|
7556
7593
|
*
|
|
7557
7594
|
|
|
7558
7595
|
*/
|
|
7559
|
-
export type GET_OrganizationsIpRestrictions_Response = GET_OrganizationsIpRestrictions_Response_200 | GET_OrganizationsIpRestrictions_Response_401 | GET_OrganizationsIpRestrictions_Response_403;
|
|
7596
|
+
export type GET_OrganizationsIpRestrictions_Response = GET_OrganizationsIpRestrictions_Response_200 | GET_OrganizationsIpRestrictions_Response_401 | GET_OrganizationsIpRestrictions_Response_403 | GET_OrganizationsIpRestrictions_Response_422;
|
|
7560
7597
|
|
|
7561
7598
|
/**
|
|
7562
7599
|
* 200 response for GET OrganizationsIpRestrictions endpoint
|
|
@@ -7609,6 +7646,23 @@ export type GET_OrganizationsIpRestrictions_Response_401 = Problem
|
|
|
7609
7646
|
*/
|
|
7610
7647
|
export type GET_OrganizationsIpRestrictions_Response_403 = Problem
|
|
7611
7648
|
|
|
7649
|
+
/**
|
|
7650
|
+
* 422 response for GET OrganizationsIpRestrictions endpoint
|
|
7651
|
+
*
|
|
7652
|
+
* @remarks
|
|
7653
|
+
* This type defines the response structure for the 422 status code
|
|
7654
|
+
* of the GET OrganizationsIpRestrictions endpoint.
|
|
7655
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
7656
|
+
*
|
|
7657
|
+
|
|
7658
|
+
*
|
|
7659
|
+
* @path /v1/organizations/ip-restrictions
|
|
7660
|
+
*
|
|
7661
|
+
* @see {@link GET_OrganizationsIpRestrictions_Response} - The main response type definition
|
|
7662
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
7663
|
+
*/
|
|
7664
|
+
export type GET_OrganizationsIpRestrictions_Response_422 = HTTPValidationError
|
|
7665
|
+
|
|
7612
7666
|
/**
|
|
7613
7667
|
* Response types for POST OrganizationsIpRestrictions endpoint
|
|
7614
7668
|
*
|
|
@@ -7987,10 +8041,11 @@ export type PATCH_OrganizationsIpRestrictionsByIpRestrictionId_Response_422 = HT
|
|
|
7987
8041
|
*
|
|
7988
8042
|
* @see {@link GET_OrganizationsRoles_Response_401} - 401 response type
|
|
7989
8043
|
* @see {@link GET_OrganizationsRoles_Response_403} - 403 response type
|
|
8044
|
+
* @see {@link GET_OrganizationsRoles_Response_422} - 422 response type
|
|
7990
8045
|
*
|
|
7991
8046
|
|
|
7992
8047
|
*/
|
|
7993
|
-
export type GET_OrganizationsRoles_Response = GET_OrganizationsRoles_Response_401 | GET_OrganizationsRoles_Response_403;
|
|
8048
|
+
export type GET_OrganizationsRoles_Response = GET_OrganizationsRoles_Response_401 | GET_OrganizationsRoles_Response_403 | GET_OrganizationsRoles_Response_422;
|
|
7994
8049
|
|
|
7995
8050
|
/**
|
|
7996
8051
|
* 401 response for GET OrganizationsRoles endpoint
|
|
@@ -8026,6 +8081,23 @@ export type GET_OrganizationsRoles_Response_401 = Problem
|
|
|
8026
8081
|
*/
|
|
8027
8082
|
export type GET_OrganizationsRoles_Response_403 = Problem
|
|
8028
8083
|
|
|
8084
|
+
/**
|
|
8085
|
+
* 422 response for GET OrganizationsRoles endpoint
|
|
8086
|
+
*
|
|
8087
|
+
* @remarks
|
|
8088
|
+
* This type defines the response structure for the 422 status code
|
|
8089
|
+
* of the GET OrganizationsRoles endpoint.
|
|
8090
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
8091
|
+
*
|
|
8092
|
+
|
|
8093
|
+
*
|
|
8094
|
+
* @path /v1/organizations/roles
|
|
8095
|
+
*
|
|
8096
|
+
* @see {@link GET_OrganizationsRoles_Response} - The main response type definition
|
|
8097
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
8098
|
+
*/
|
|
8099
|
+
export type GET_OrganizationsRoles_Response_422 = HTTPValidationError
|
|
8100
|
+
|
|
8029
8101
|
/**
|
|
8030
8102
|
* Response types for GET OrganizationsUsers endpoint
|
|
8031
8103
|
*
|
|
@@ -8246,10 +8318,11 @@ export type GET_TldsByTld_Response_422 = HTTPValidationError
|
|
|
8246
8318
|
* @path /v1/tlds/portfolio
|
|
8247
8319
|
*
|
|
8248
8320
|
* @see {@link GET_TldsPortfolio_Response_200} - 200 response type
|
|
8321
|
+
* @see {@link GET_TldsPortfolio_Response_422} - 422 response type
|
|
8249
8322
|
*
|
|
8250
8323
|
|
|
8251
8324
|
*/
|
|
8252
|
-
export type GET_TldsPortfolio_Response = GET_TldsPortfolio_Response_200;
|
|
8325
|
+
export type GET_TldsPortfolio_Response = GET_TldsPortfolio_Response_200 | GET_TldsPortfolio_Response_422;
|
|
8253
8326
|
|
|
8254
8327
|
/**
|
|
8255
8328
|
* 200 response for GET TldsPortfolio endpoint
|
|
@@ -8268,6 +8341,23 @@ export type GET_TldsPortfolio_Response = GET_TldsPortfolio_Response_200;
|
|
|
8268
8341
|
*/
|
|
8269
8342
|
export type GET_TldsPortfolio_Response_200 = TldResponseShortArray
|
|
8270
8343
|
|
|
8344
|
+
/**
|
|
8345
|
+
* 422 response for GET TldsPortfolio endpoint
|
|
8346
|
+
*
|
|
8347
|
+
* @remarks
|
|
8348
|
+
* This type defines the response structure for the 422 status code
|
|
8349
|
+
* of the GET TldsPortfolio endpoint.
|
|
8350
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
8351
|
+
*
|
|
8352
|
+
|
|
8353
|
+
*
|
|
8354
|
+
* @path /v1/tlds/portfolio
|
|
8355
|
+
*
|
|
8356
|
+
* @see {@link GET_TldsPortfolio_Response} - The main response type definition
|
|
8357
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
8358
|
+
*/
|
|
8359
|
+
export type GET_TldsPortfolio_Response_422 = HTTPValidationError
|
|
8360
|
+
|
|
8271
8361
|
/**
|
|
8272
8362
|
* Response types for POST Users endpoint
|
|
8273
8363
|
*
|
package/src/openapi.yaml
CHANGED
|
@@ -5999,7 +5999,7 @@ info:
|
|
|
5999
5999
|
'
|
|
6000
6000
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
6001
6001
|
title: OpusDNS API
|
|
6002
|
-
version: 2025-12-
|
|
6002
|
+
version: 2025-12-16-173817
|
|
6003
6003
|
x-logo:
|
|
6004
6004
|
altText: OpusDNS API Reference
|
|
6005
6005
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -8061,6 +8061,12 @@ paths:
|
|
|
8061
8061
|
schema:
|
|
8062
8062
|
$ref: '#/components/schemas/DnsZoneSummary'
|
|
8063
8063
|
description: DNS zones summary retrieved successfully
|
|
8064
|
+
'422':
|
|
8065
|
+
content:
|
|
8066
|
+
application/problem+json:
|
|
8067
|
+
schema:
|
|
8068
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
8069
|
+
description: Validation Error
|
|
8064
8070
|
security:
|
|
8065
8071
|
- OAuth2PasswordBearer: []
|
|
8066
8072
|
summary: Get Zones Summary
|
|
@@ -10205,6 +10211,12 @@ paths:
|
|
|
10205
10211
|
schema:
|
|
10206
10212
|
$ref: '#/components/schemas/DomainSummaryResponse'
|
|
10207
10213
|
description: Successful Response
|
|
10214
|
+
'422':
|
|
10215
|
+
content:
|
|
10216
|
+
application/problem+json:
|
|
10217
|
+
schema:
|
|
10218
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
10219
|
+
description: Validation Error
|
|
10208
10220
|
security:
|
|
10209
10221
|
- OAuth2PasswordBearer: []
|
|
10210
10222
|
summary: Get domain summary
|
|
@@ -12472,6 +12484,12 @@ paths:
|
|
|
12472
12484
|
schema:
|
|
12473
12485
|
$ref: '#/components/schemas/Problem'
|
|
12474
12486
|
description: Forbidden
|
|
12487
|
+
'422':
|
|
12488
|
+
content:
|
|
12489
|
+
application/problem+json:
|
|
12490
|
+
schema:
|
|
12491
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
12492
|
+
description: Validation Error
|
|
12475
12493
|
security:
|
|
12476
12494
|
- OAuth2PasswordBearer: []
|
|
12477
12495
|
summary: List IP restrictions
|
|
@@ -12743,6 +12761,12 @@ paths:
|
|
|
12743
12761
|
schema:
|
|
12744
12762
|
$ref: '#/components/schemas/Problem'
|
|
12745
12763
|
description: Forbidden
|
|
12764
|
+
'422':
|
|
12765
|
+
content:
|
|
12766
|
+
application/problem+json:
|
|
12767
|
+
schema:
|
|
12768
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
12769
|
+
description: Validation Error
|
|
12746
12770
|
security:
|
|
12747
12771
|
- OAuth2PasswordBearer: []
|
|
12748
12772
|
summary: List all roles
|
|
@@ -13400,6 +13424,12 @@ paths:
|
|
|
13400
13424
|
title: Response Get Tld Portfolio V1 Tlds Portfolio Get
|
|
13401
13425
|
type: array
|
|
13402
13426
|
description: Successful Response
|
|
13427
|
+
'422':
|
|
13428
|
+
content:
|
|
13429
|
+
application/problem+json:
|
|
13430
|
+
schema:
|
|
13431
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
13432
|
+
description: Validation Error
|
|
13403
13433
|
security:
|
|
13404
13434
|
- OAuth2PasswordBearer: []
|
|
13405
13435
|
summary: Get the list of TLDs we support
|
package/src/schema.d.ts
CHANGED
|
@@ -6873,6 +6873,15 @@ export interface operations {
|
|
|
6873
6873
|
"application/json": components["schemas"]["DnsZoneSummary"];
|
|
6874
6874
|
};
|
|
6875
6875
|
};
|
|
6876
|
+
/** @description Validation Error */
|
|
6877
|
+
422: {
|
|
6878
|
+
headers: {
|
|
6879
|
+
[name: string]: unknown;
|
|
6880
|
+
};
|
|
6881
|
+
content: {
|
|
6882
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
6883
|
+
};
|
|
6884
|
+
};
|
|
6876
6885
|
};
|
|
6877
6886
|
};
|
|
6878
6887
|
get_zone_v1_dns__zone_name__get: {
|
|
@@ -8558,6 +8567,15 @@ export interface operations {
|
|
|
8558
8567
|
"application/json": components["schemas"]["DomainSummaryResponse"];
|
|
8559
8568
|
};
|
|
8560
8569
|
};
|
|
8570
|
+
/** @description Validation Error */
|
|
8571
|
+
422: {
|
|
8572
|
+
headers: {
|
|
8573
|
+
[name: string]: unknown;
|
|
8574
|
+
};
|
|
8575
|
+
content: {
|
|
8576
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
8577
|
+
};
|
|
8578
|
+
};
|
|
8561
8579
|
};
|
|
8562
8580
|
};
|
|
8563
8581
|
withdraw_domain_v1_domains_tld_specific_at__domain_reference__withdraw_post: {
|
|
@@ -10759,6 +10777,15 @@ export interface operations {
|
|
|
10759
10777
|
"application/problem+json": components["schemas"]["Problem"];
|
|
10760
10778
|
};
|
|
10761
10779
|
};
|
|
10780
|
+
/** @description Validation Error */
|
|
10781
|
+
422: {
|
|
10782
|
+
headers: {
|
|
10783
|
+
[name: string]: unknown;
|
|
10784
|
+
};
|
|
10785
|
+
content: {
|
|
10786
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
10787
|
+
};
|
|
10788
|
+
};
|
|
10762
10789
|
};
|
|
10763
10790
|
};
|
|
10764
10791
|
create_ip_restriction_v1_organizations_ip_restrictions_post: {
|
|
@@ -11067,6 +11094,15 @@ export interface operations {
|
|
|
11067
11094
|
"application/problem+json": components["schemas"]["Problem"];
|
|
11068
11095
|
};
|
|
11069
11096
|
};
|
|
11097
|
+
/** @description Validation Error */
|
|
11098
|
+
422: {
|
|
11099
|
+
headers: {
|
|
11100
|
+
[name: string]: unknown;
|
|
11101
|
+
};
|
|
11102
|
+
content: {
|
|
11103
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
11104
|
+
};
|
|
11105
|
+
};
|
|
11070
11106
|
};
|
|
11071
11107
|
};
|
|
11072
11108
|
list_users_v1_organizations_users_get: {
|
|
@@ -11617,6 +11653,15 @@ export interface operations {
|
|
|
11617
11653
|
"application/json": components["schemas"]["TldResponseShort"][];
|
|
11618
11654
|
};
|
|
11619
11655
|
};
|
|
11656
|
+
/** @description Validation Error */
|
|
11657
|
+
422: {
|
|
11658
|
+
headers: {
|
|
11659
|
+
[name: string]: unknown;
|
|
11660
|
+
};
|
|
11661
|
+
content: {
|
|
11662
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
11663
|
+
};
|
|
11664
|
+
};
|
|
11620
11665
|
};
|
|
11621
11666
|
};
|
|
11622
11667
|
get_tld_spec_v1_tlds__tld__get: {
|