@opusdns/api 0.86.0 → 0.87.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/helpers/requests.d.ts +39 -0
- package/src/helpers/responses.d.ts +38 -0
- package/src/openapi.yaml +45 -1
- package/src/schema.d.ts +54 -0
package/package.json
CHANGED
|
@@ -3377,6 +3377,45 @@ export type GET_OrganizationsUsers_Request = {
|
|
|
3377
3377
|
*/
|
|
3378
3378
|
export type GET_OrganizationsUsers_Request_Query = GET_OrganizationsUsers_Request['parameters']['query'];
|
|
3379
3379
|
|
|
3380
|
+
/**
|
|
3381
|
+
* Request type for GET Tlds endpoint
|
|
3382
|
+
*
|
|
3383
|
+
* Get list of Specifications for all TLDs we support
|
|
3384
|
+
* Retrieves a list of TLD Specifications we have support for
|
|
3385
|
+
*
|
|
3386
|
+
* @remarks
|
|
3387
|
+
* This type defines the complete request structure for the GET Tlds endpoint.
|
|
3388
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
3389
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3390
|
+
*
|
|
3391
|
+
* @example
|
|
3392
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
3393
|
+
*
|
|
3394
|
+
* @path /v1/tlds/
|
|
3395
|
+
*
|
|
3396
|
+
* @see {@link GET_Tlds_Request_Query} - Query parameters type
|
|
3397
|
+
* @see {@link GET_Tlds_Request_Path} - Path parameters type
|
|
3398
|
+
* @see {@link GET_Tlds_Request_Body} - Request body type
|
|
3399
|
+
*/
|
|
3400
|
+
export type GET_Tlds_Request = {
|
|
3401
|
+
parameters: {
|
|
3402
|
+
query: operations['get_tld_specifications_v1_tlds__get']['parameters']['query'];
|
|
3403
|
+
};
|
|
3404
|
+
}
|
|
3405
|
+
/**
|
|
3406
|
+
* Query parameters for GET /v1/tlds/
|
|
3407
|
+
*
|
|
3408
|
+
* @remarks
|
|
3409
|
+
* This type defines the query parameters for the GET /v1/tlds/ endpoint.
|
|
3410
|
+
* It provides type safety for all query parameters as defined in the OpenAPI specification.
|
|
3411
|
+
*
|
|
3412
|
+
* @example
|
|
3413
|
+
* Use this type to ensure type safety for query parameters.
|
|
3414
|
+
*
|
|
3415
|
+
* @path /v1/tlds/
|
|
3416
|
+
*/
|
|
3417
|
+
export type GET_Tlds_Request_Query = GET_Tlds_Request['parameters']['query'];
|
|
3418
|
+
|
|
3380
3419
|
/**
|
|
3381
3420
|
* Request type for GET TldsPortfolio endpoint
|
|
3382
3421
|
*
|
|
@@ -5499,6 +5499,44 @@ export type GET_OrganizationsUsers_Response_403 = Problem
|
|
|
5499
5499
|
*/
|
|
5500
5500
|
export type GET_OrganizationsUsers_Response_422 = HTTPValidationError
|
|
5501
5501
|
|
|
5502
|
+
/**
|
|
5503
|
+
* Response types for GET Tlds endpoint
|
|
5504
|
+
*
|
|
5505
|
+
* Get list of Specifications for all TLDs we support
|
|
5506
|
+
* Retrieves a list of TLD Specifications we have support for
|
|
5507
|
+
*
|
|
5508
|
+
* @remarks
|
|
5509
|
+
* This type defines all possible response structures for the GET Tlds endpoint.
|
|
5510
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
5511
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
5512
|
+
*
|
|
5513
|
+
|
|
5514
|
+
*
|
|
5515
|
+
* @path /v1/tlds/
|
|
5516
|
+
*
|
|
5517
|
+
* @see {@link GET_Tlds_Response_422} - 422 response type
|
|
5518
|
+
*
|
|
5519
|
+
|
|
5520
|
+
*/
|
|
5521
|
+
export type GET_Tlds_Response = GET_Tlds_Response_422;
|
|
5522
|
+
|
|
5523
|
+
/**
|
|
5524
|
+
* 422 response for GET Tlds endpoint
|
|
5525
|
+
*
|
|
5526
|
+
* @remarks
|
|
5527
|
+
* This type defines the response structure for the 422 status code
|
|
5528
|
+
* of the GET Tlds endpoint.
|
|
5529
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
5530
|
+
*
|
|
5531
|
+
|
|
5532
|
+
*
|
|
5533
|
+
* @path /v1/tlds/
|
|
5534
|
+
*
|
|
5535
|
+
* @see {@link GET_Tlds_Response} - The main response type definition
|
|
5536
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
5537
|
+
*/
|
|
5538
|
+
export type GET_Tlds_Response_422 = HTTPValidationError
|
|
5539
|
+
|
|
5502
5540
|
/**
|
|
5503
5541
|
* Response types for GET TldsByTld endpoint
|
|
5504
5542
|
*
|
package/src/openapi.yaml
CHANGED
|
@@ -4952,7 +4952,7 @@ info:
|
|
|
4952
4952
|
'
|
|
4953
4953
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
4954
4954
|
title: OpusDNS API
|
|
4955
|
-
version: 2025-10-
|
|
4955
|
+
version: 2025-10-28-111859
|
|
4956
4956
|
x-logo:
|
|
4957
4957
|
altText: OpusDNS API Reference
|
|
4958
4958
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -9528,6 +9528,50 @@ paths:
|
|
|
9528
9528
|
summary: Get a specific transaction
|
|
9529
9529
|
tags:
|
|
9530
9530
|
- organization
|
|
9531
|
+
/v1/tlds/:
|
|
9532
|
+
get:
|
|
9533
|
+
description: Retrieves a list of TLD Specifications we have support for
|
|
9534
|
+
operationId: get_tld_specifications_v1_tlds__get
|
|
9535
|
+
parameters:
|
|
9536
|
+
- in: query
|
|
9537
|
+
name: fields
|
|
9538
|
+
required: false
|
|
9539
|
+
schema:
|
|
9540
|
+
anyOf:
|
|
9541
|
+
- type: string
|
|
9542
|
+
- type: 'null'
|
|
9543
|
+
title: Fields
|
|
9544
|
+
- in: query
|
|
9545
|
+
name: tlds
|
|
9546
|
+
required: false
|
|
9547
|
+
schema:
|
|
9548
|
+
anyOf:
|
|
9549
|
+
- type: string
|
|
9550
|
+
- type: 'null'
|
|
9551
|
+
title: Tlds
|
|
9552
|
+
responses:
|
|
9553
|
+
'200':
|
|
9554
|
+
content:
|
|
9555
|
+
application/json:
|
|
9556
|
+
schema:
|
|
9557
|
+
additionalProperties:
|
|
9558
|
+
items:
|
|
9559
|
+
type: object
|
|
9560
|
+
type: array
|
|
9561
|
+
title: Response Get Tld Specifications V1 Tlds Get
|
|
9562
|
+
type: object
|
|
9563
|
+
description: Successful Response
|
|
9564
|
+
'422':
|
|
9565
|
+
content:
|
|
9566
|
+
application/problem+json:
|
|
9567
|
+
schema:
|
|
9568
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
9569
|
+
description: Validation Error
|
|
9570
|
+
security:
|
|
9571
|
+
- OAuth2PasswordBearer: []
|
|
9572
|
+
summary: Get list of Specifications for all TLDs we support
|
|
9573
|
+
tags:
|
|
9574
|
+
- tld
|
|
9531
9575
|
/v1/tlds/portfolio:
|
|
9532
9576
|
get:
|
|
9533
9577
|
description: Retrieves a list of TLDs we have support for
|
package/src/schema.d.ts
CHANGED
|
@@ -989,6 +989,26 @@ export interface paths {
|
|
|
989
989
|
patch?: never;
|
|
990
990
|
trace?: never;
|
|
991
991
|
};
|
|
992
|
+
"/v1/tlds/": {
|
|
993
|
+
parameters: {
|
|
994
|
+
query?: never;
|
|
995
|
+
header?: never;
|
|
996
|
+
path?: never;
|
|
997
|
+
cookie?: never;
|
|
998
|
+
};
|
|
999
|
+
/**
|
|
1000
|
+
* Get list of Specifications for all TLDs we support
|
|
1001
|
+
* @description Retrieves a list of TLD Specifications we have support for
|
|
1002
|
+
*/
|
|
1003
|
+
get: operations["get_tld_specifications_v1_tlds__get"];
|
|
1004
|
+
put?: never;
|
|
1005
|
+
post?: never;
|
|
1006
|
+
delete?: never;
|
|
1007
|
+
options?: never;
|
|
1008
|
+
head?: never;
|
|
1009
|
+
patch?: never;
|
|
1010
|
+
trace?: never;
|
|
1011
|
+
};
|
|
992
1012
|
"/v1/tlds/portfolio": {
|
|
993
1013
|
parameters: {
|
|
994
1014
|
query?: never;
|
|
@@ -8494,6 +8514,40 @@ export interface operations {
|
|
|
8494
8514
|
};
|
|
8495
8515
|
};
|
|
8496
8516
|
};
|
|
8517
|
+
get_tld_specifications_v1_tlds__get: {
|
|
8518
|
+
parameters: {
|
|
8519
|
+
query?: {
|
|
8520
|
+
fields?: string | null;
|
|
8521
|
+
tlds?: string | null;
|
|
8522
|
+
};
|
|
8523
|
+
header?: never;
|
|
8524
|
+
path?: never;
|
|
8525
|
+
cookie?: never;
|
|
8526
|
+
};
|
|
8527
|
+
requestBody?: never;
|
|
8528
|
+
responses: {
|
|
8529
|
+
/** @description Successful Response */
|
|
8530
|
+
200: {
|
|
8531
|
+
headers: {
|
|
8532
|
+
[name: string]: unknown;
|
|
8533
|
+
};
|
|
8534
|
+
content: {
|
|
8535
|
+
"application/json": {
|
|
8536
|
+
[key: string]: Record<string, never>[];
|
|
8537
|
+
};
|
|
8538
|
+
};
|
|
8539
|
+
};
|
|
8540
|
+
/** @description Validation Error */
|
|
8541
|
+
422: {
|
|
8542
|
+
headers: {
|
|
8543
|
+
[name: string]: unknown;
|
|
8544
|
+
};
|
|
8545
|
+
content: {
|
|
8546
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
8547
|
+
};
|
|
8548
|
+
};
|
|
8549
|
+
};
|
|
8550
|
+
};
|
|
8497
8551
|
get_tld_portfolio_v1_tlds_portfolio_get: {
|
|
8498
8552
|
parameters: {
|
|
8499
8553
|
query?: never;
|