@opusdns/api 0.115.0 → 0.117.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 +17 -17
- package/src/helpers/responses.d.ts +35 -17
- package/src/openapi.yaml +17 -3
- package/src/schema.d.ts +21 -3
package/package.json
CHANGED
|
@@ -37,57 +37,57 @@ import { DomainDnssecDataCreateArray, OrganizationAttributeUpdateArray } from '.
|
|
|
37
37
|
import { ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainForwardPatchOps, DomainForwardRequest, DomainForwardSetRequest, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainWithdrawRequest, DomainTransitRequest, DomainTransferIn, EmailForwardCreate, EmailForwardAliasCreate, EmailForwardAliasUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, UserCreate, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
|
-
* Request type for GET
|
|
40
|
+
* Request type for GET ArchiveEmailForwardLogsAliasesEmailForwardAliasId endpoint
|
|
41
41
|
*
|
|
42
42
|
* Retrieve email forward logs by alias
|
|
43
43
|
* Retrieves a paginated list of email forward logs for a specific email forward alias. Only returns logs created after the email forward was created.
|
|
44
44
|
*
|
|
45
45
|
* @remarks
|
|
46
|
-
* This type defines the complete request structure for the GET
|
|
46
|
+
* This type defines the complete request structure for the GET ArchiveEmailForwardLogsAliasesEmailForwardAliasId endpoint.
|
|
47
47
|
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
48
48
|
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
49
49
|
*
|
|
50
50
|
* @example
|
|
51
51
|
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
52
52
|
*
|
|
53
|
-
* @path /v1/archive/email-forward-logs/
|
|
53
|
+
* @path /v1/archive/email-forward-logs/aliases/{email_forward_alias_id}
|
|
54
54
|
*
|
|
55
|
-
* @see {@link
|
|
56
|
-
* @see {@link
|
|
57
|
-
* @see {@link
|
|
55
|
+
* @see {@link GET_ArchiveEmailForwardLogsAliasesEmailForwardAliasId_Request_Query} - Query parameters type
|
|
56
|
+
* @see {@link GET_ArchiveEmailForwardLogsAliasesEmailForwardAliasId_Request_Path} - Path parameters type
|
|
57
|
+
* @see {@link GET_ArchiveEmailForwardLogsAliasesEmailForwardAliasId_Request_Body} - Request body type
|
|
58
58
|
*/
|
|
59
|
-
export type
|
|
59
|
+
export type GET_ArchiveEmailForwardLogsAliasesEmailForwardAliasId_Request = {
|
|
60
60
|
parameters: {
|
|
61
|
-
query: operations['
|
|
62
|
-
path: operations['
|
|
61
|
+
query: operations['get_email_forward_logs_by_alias_v1_archive_email_forward_logs_aliases__email_forward_alias_id__get']['parameters']['query'];
|
|
62
|
+
path: operations['get_email_forward_logs_by_alias_v1_archive_email_forward_logs_aliases__email_forward_alias_id__get']['parameters']['path'];
|
|
63
63
|
};
|
|
64
64
|
}
|
|
65
65
|
/**
|
|
66
|
-
* Query parameters for GET /v1/archive/email-forward-logs/
|
|
66
|
+
* Query parameters for GET /v1/archive/email-forward-logs/aliases/{email_forward_alias_id}
|
|
67
67
|
*
|
|
68
68
|
* @remarks
|
|
69
|
-
* This type defines the query parameters for the GET /v1/archive/email-forward-logs/
|
|
69
|
+
* This type defines the query parameters for the GET /v1/archive/email-forward-logs/aliases/{email_forward_alias_id} endpoint.
|
|
70
70
|
* It provides type safety for all query parameters as defined in the OpenAPI specification.
|
|
71
71
|
*
|
|
72
72
|
* @example
|
|
73
73
|
* Use this type to ensure type safety for query parameters.
|
|
74
74
|
*
|
|
75
|
-
* @path /v1/archive/email-forward-logs/
|
|
75
|
+
* @path /v1/archive/email-forward-logs/aliases/{email_forward_alias_id}
|
|
76
76
|
*/
|
|
77
|
-
export type
|
|
77
|
+
export type GET_ArchiveEmailForwardLogsAliasesEmailForwardAliasId_Request_Query = GET_ArchiveEmailForwardLogsAliasesEmailForwardAliasId_Request['parameters']['query'];
|
|
78
78
|
/**
|
|
79
|
-
* Path parameters for GET /v1/archive/email-forward-logs/
|
|
79
|
+
* Path parameters for GET /v1/archive/email-forward-logs/aliases/{email_forward_alias_id}
|
|
80
80
|
*
|
|
81
81
|
* @remarks
|
|
82
|
-
* This type defines the path parameters for the GET /v1/archive/email-forward-logs/
|
|
82
|
+
* This type defines the path parameters for the GET /v1/archive/email-forward-logs/aliases/{email_forward_alias_id} endpoint.
|
|
83
83
|
* It provides type safety for all path parameters as defined in the OpenAPI specification.
|
|
84
84
|
*
|
|
85
85
|
* @example
|
|
86
86
|
* Use this type to ensure type safety for path parameters.
|
|
87
87
|
*
|
|
88
|
-
* @path /v1/archive/email-forward-logs/
|
|
88
|
+
* @path /v1/archive/email-forward-logs/aliases/{email_forward_alias_id}
|
|
89
89
|
*/
|
|
90
|
-
export type
|
|
90
|
+
export type GET_ArchiveEmailForwardLogsAliasesEmailForwardAliasId_Request_Path = GET_ArchiveEmailForwardLogsAliasesEmailForwardAliasId_Request['parameters']['path'];
|
|
91
91
|
|
|
92
92
|
/**
|
|
93
93
|
* Request type for GET ArchiveEmailForwardLogsEmailForwardId endpoint
|
|
@@ -37,60 +37,60 @@ import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray,
|
|
|
37
37
|
import { Pagination_EmailForwardLog, HTTPValidationError, Pagination_ObjectLog, Pagination_RequestHistory, Problem, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DomainForwardZone, EmailForwardZone, Pagination_DomainForwardZone, Pagination_EmailForwardZone, DnsZoneSummary, Pagination_DomainForward, DomainForward, DomainForwardSet, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, DomainWithdraw, RequestAuthcode, DomainTransit, Pagination_EmailForward, EmailForward, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, Pagination_Invoice, GetPrices, Pagination_BillingTransaction, BillingTransaction, IpRestriction, Pagination_User, TldSpecification, User, UserWithAttributes, PermissionSet, RelationSet, UserWithRelationPermissions } from './schemas.d';
|
|
38
38
|
|
|
39
39
|
/**
|
|
40
|
-
* Response types for GET
|
|
40
|
+
* Response types for GET ArchiveEmailForwardLogsAliasesByEmailForwardAliasId endpoint
|
|
41
41
|
*
|
|
42
42
|
* Retrieve email forward logs by alias
|
|
43
43
|
* Retrieves a paginated list of email forward logs for a specific email forward alias. Only returns logs created after the email forward was created.
|
|
44
44
|
*
|
|
45
45
|
* @remarks
|
|
46
|
-
* This type defines all possible response structures for the GET
|
|
46
|
+
* This type defines all possible response structures for the GET ArchiveEmailForwardLogsAliasesByEmailForwardAliasId endpoint.
|
|
47
47
|
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
48
48
|
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
49
49
|
*
|
|
50
50
|
|
|
51
51
|
*
|
|
52
|
-
* @path /v1/archive/email-forward-logs/
|
|
52
|
+
* @path /v1/archive/email-forward-logs/aliases/{email_forward_alias_id}
|
|
53
53
|
*
|
|
54
|
-
* @see {@link
|
|
55
|
-
* @see {@link
|
|
54
|
+
* @see {@link GET_ArchiveEmailForwardLogsAliasesByEmailForwardAliasId_Response_200} - 200 response type
|
|
55
|
+
* @see {@link GET_ArchiveEmailForwardLogsAliasesByEmailForwardAliasId_Response_422} - 422 response type
|
|
56
56
|
*
|
|
57
57
|
|
|
58
58
|
*/
|
|
59
|
-
export type
|
|
59
|
+
export type GET_ArchiveEmailForwardLogsAliasesByEmailForwardAliasId_Response = GET_ArchiveEmailForwardLogsAliasesByEmailForwardAliasId_Response_200 | GET_ArchiveEmailForwardLogsAliasesByEmailForwardAliasId_Response_422;
|
|
60
60
|
|
|
61
61
|
/**
|
|
62
|
-
* 200 response for GET
|
|
62
|
+
* 200 response for GET ArchiveEmailForwardLogsAliasesByEmailForwardAliasId endpoint
|
|
63
63
|
*
|
|
64
64
|
* @remarks
|
|
65
65
|
* This type defines the response structure for the 200 status code
|
|
66
|
-
* of the GET
|
|
66
|
+
* of the GET ArchiveEmailForwardLogsAliasesByEmailForwardAliasId endpoint.
|
|
67
67
|
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
68
68
|
*
|
|
69
69
|
|
|
70
70
|
*
|
|
71
|
-
* @path /v1/archive/email-forward-logs/
|
|
71
|
+
* @path /v1/archive/email-forward-logs/aliases/{email_forward_alias_id}
|
|
72
72
|
*
|
|
73
|
-
* @see {@link
|
|
73
|
+
* @see {@link GET_ArchiveEmailForwardLogsAliasesByEmailForwardAliasId_Response} - The main response type definition
|
|
74
74
|
* @see {@link Pagination_EmailForwardLog} - The actual schema type definition
|
|
75
75
|
*/
|
|
76
|
-
export type
|
|
76
|
+
export type GET_ArchiveEmailForwardLogsAliasesByEmailForwardAliasId_Response_200 = Pagination_EmailForwardLog
|
|
77
77
|
|
|
78
78
|
/**
|
|
79
|
-
* 422 response for GET
|
|
79
|
+
* 422 response for GET ArchiveEmailForwardLogsAliasesByEmailForwardAliasId endpoint
|
|
80
80
|
*
|
|
81
81
|
* @remarks
|
|
82
82
|
* This type defines the response structure for the 422 status code
|
|
83
|
-
* of the GET
|
|
83
|
+
* of the GET ArchiveEmailForwardLogsAliasesByEmailForwardAliasId endpoint.
|
|
84
84
|
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
85
85
|
*
|
|
86
86
|
|
|
87
87
|
*
|
|
88
|
-
* @path /v1/archive/email-forward-logs/
|
|
88
|
+
* @path /v1/archive/email-forward-logs/aliases/{email_forward_alias_id}
|
|
89
89
|
*
|
|
90
|
-
* @see {@link
|
|
90
|
+
* @see {@link GET_ArchiveEmailForwardLogsAliasesByEmailForwardAliasId_Response} - The main response type definition
|
|
91
91
|
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
92
92
|
*/
|
|
93
|
-
export type
|
|
93
|
+
export type GET_ArchiveEmailForwardLogsAliasesByEmailForwardAliasId_Response_422 = HTTPValidationError
|
|
94
94
|
|
|
95
95
|
/**
|
|
96
96
|
* Response types for GET ArchiveEmailForwardLogsByEmailForwardId endpoint
|
|
@@ -4747,12 +4747,13 @@ export type POST_DomainsTldSpecificAtByDomainReferenceWithdraw_Response_422 = HT
|
|
|
4747
4747
|
* @path /v1/domains/tld-specific/be/{domain_reference}/auth_code/request
|
|
4748
4748
|
*
|
|
4749
4749
|
* @see {@link POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_200} - 200 response type
|
|
4750
|
+
* @see {@link POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_400} - 400 response type
|
|
4750
4751
|
* @see {@link POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_404} - 404 response type
|
|
4751
4752
|
* @see {@link POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_422} - 422 response type
|
|
4752
4753
|
*
|
|
4753
4754
|
|
|
4754
4755
|
*/
|
|
4755
|
-
export type POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response = POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_200 | POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_404 | POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_422;
|
|
4756
|
+
export type POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response = POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_200 | POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_400 | POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_404 | POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_422;
|
|
4756
4757
|
|
|
4757
4758
|
/**
|
|
4758
4759
|
* 200 response for POST DomainsTldSpecificBeByDomainReferenceAuthCodeRequest endpoint
|
|
@@ -4771,6 +4772,23 @@ export type POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response =
|
|
|
4771
4772
|
*/
|
|
4772
4773
|
export type POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_200 = RequestAuthcode
|
|
4773
4774
|
|
|
4775
|
+
/**
|
|
4776
|
+
* 400 response for POST DomainsTldSpecificBeByDomainReferenceAuthCodeRequest endpoint
|
|
4777
|
+
*
|
|
4778
|
+
* @remarks
|
|
4779
|
+
* This type defines the response structure for the 400 status code
|
|
4780
|
+
* of the POST DomainsTldSpecificBeByDomainReferenceAuthCodeRequest endpoint.
|
|
4781
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
4782
|
+
*
|
|
4783
|
+
|
|
4784
|
+
*
|
|
4785
|
+
* @path /v1/domains/tld-specific/be/{domain_reference}/auth_code/request
|
|
4786
|
+
*
|
|
4787
|
+
* @see {@link POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response} - The main response type definition
|
|
4788
|
+
* @see {@link Problem} - The actual schema type definition
|
|
4789
|
+
*/
|
|
4790
|
+
export type POST_DomainsTldSpecificBeByDomainReferenceAuthCodeRequest_Response_400 = Problem
|
|
4791
|
+
|
|
4774
4792
|
/**
|
|
4775
4793
|
* 404 response for POST DomainsTldSpecificBeByDomainReferenceAuthCodeRequest endpoint
|
|
4776
4794
|
*
|
package/src/openapi.yaml
CHANGED
|
@@ -5921,18 +5921,18 @@ info:
|
|
|
5921
5921
|
'
|
|
5922
5922
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
5923
5923
|
title: OpusDNS API
|
|
5924
|
-
version: 2025-12-08-
|
|
5924
|
+
version: 2025-12-08-162155
|
|
5925
5925
|
x-logo:
|
|
5926
5926
|
altText: OpusDNS API Reference
|
|
5927
5927
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
5928
5928
|
openapi: 3.1.0
|
|
5929
5929
|
paths:
|
|
5930
|
-
/v1/archive/email-forward-logs/
|
|
5930
|
+
/v1/archive/email-forward-logs/aliases/{email_forward_alias_id}:
|
|
5931
5931
|
get:
|
|
5932
5932
|
description: Retrieves a paginated list of email forward logs for a specific
|
|
5933
5933
|
email forward alias. Only returns logs created after the email forward was
|
|
5934
5934
|
created.
|
|
5935
|
-
operationId:
|
|
5935
|
+
operationId: get_email_forward_logs_by_alias_v1_archive_email_forward_logs_aliases__email_forward_alias_id__get
|
|
5936
5936
|
parameters:
|
|
5937
5937
|
- in: path
|
|
5938
5938
|
name: email_forward_alias_id
|
|
@@ -10047,6 +10047,20 @@ paths:
|
|
|
10047
10047
|
schema:
|
|
10048
10048
|
$ref: '#/components/schemas/RequestAuthcodeResponse'
|
|
10049
10049
|
description: Successful Response
|
|
10050
|
+
'400':
|
|
10051
|
+
content:
|
|
10052
|
+
application/problem+json:
|
|
10053
|
+
example:
|
|
10054
|
+
code: ERROR_DOMAIN_TRANSFER
|
|
10055
|
+
detail: There was an error transferring the domain
|
|
10056
|
+
domain_name: Additional error context.
|
|
10057
|
+
reason: An unspecified error occurred
|
|
10058
|
+
status: 400
|
|
10059
|
+
title: Domain Transfer Error
|
|
10060
|
+
type: domain-transfer
|
|
10061
|
+
schema:
|
|
10062
|
+
$ref: '#/components/schemas/Problem'
|
|
10063
|
+
description: Bad Request
|
|
10050
10064
|
'404':
|
|
10051
10065
|
content:
|
|
10052
10066
|
application/problem+json:
|
package/src/schema.d.ts
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
import { TypeId } from "typeid-js";
|
|
2
2
|
export interface paths {
|
|
3
|
-
"/v1/archive/email-forward-logs/
|
|
3
|
+
"/v1/archive/email-forward-logs/aliases/{email_forward_alias_id}": {
|
|
4
4
|
parameters: {
|
|
5
5
|
query?: never;
|
|
6
6
|
header?: never;
|
|
@@ -11,7 +11,7 @@ export interface paths {
|
|
|
11
11
|
* Retrieve email forward logs by alias
|
|
12
12
|
* @description Retrieves a paginated list of email forward logs for a specific email forward alias. Only returns logs created after the email forward was created.
|
|
13
13
|
*/
|
|
14
|
-
get: operations["
|
|
14
|
+
get: operations["get_email_forward_logs_by_alias_v1_archive_email_forward_logs_aliases__email_forward_alias_id__get"];
|
|
15
15
|
put?: never;
|
|
16
16
|
post?: never;
|
|
17
17
|
delete?: never;
|
|
@@ -5486,7 +5486,7 @@ export interface components {
|
|
|
5486
5486
|
}
|
|
5487
5487
|
export type $defs = Record<string, never>;
|
|
5488
5488
|
export interface operations {
|
|
5489
|
-
|
|
5489
|
+
get_email_forward_logs_by_alias_v1_archive_email_forward_logs_aliases__email_forward_alias_id__get: {
|
|
5490
5490
|
parameters: {
|
|
5491
5491
|
query?: {
|
|
5492
5492
|
sort_by?: components["schemas"]["EmailForwardLogSortField"];
|
|
@@ -8460,6 +8460,24 @@ export interface operations {
|
|
|
8460
8460
|
"application/json": components["schemas"]["RequestAuthcodeResponse"];
|
|
8461
8461
|
};
|
|
8462
8462
|
};
|
|
8463
|
+
/** @description Bad Request */
|
|
8464
|
+
400: {
|
|
8465
|
+
headers: {
|
|
8466
|
+
[name: string]: unknown;
|
|
8467
|
+
};
|
|
8468
|
+
content: {
|
|
8469
|
+
/** @example {
|
|
8470
|
+
* "code": "ERROR_DOMAIN_TRANSFER",
|
|
8471
|
+
* "detail": "There was an error transferring the domain",
|
|
8472
|
+
* "domain_name": "Additional error context.",
|
|
8473
|
+
* "reason": "An unspecified error occurred",
|
|
8474
|
+
* "status": 400,
|
|
8475
|
+
* "title": "Domain Transfer Error",
|
|
8476
|
+
* "type": "domain-transfer"
|
|
8477
|
+
* } */
|
|
8478
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
8479
|
+
};
|
|
8480
|
+
};
|
|
8463
8481
|
/** @description Not Found */
|
|
8464
8482
|
404: {
|
|
8465
8483
|
headers: {
|