@opusdns/api 0.179.0 → 0.181.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/keys.ts +26 -0
- package/src/helpers/responses.d.ts +1 -20
- package/src/openapi.yaml +14 -13
- package/src/schema.d.ts +6 -16
package/package.json
CHANGED
package/src/helpers/keys.ts
CHANGED
|
@@ -6677,6 +6677,31 @@ export const KEYS_DOMAIN_DNSSEC_DATA = [
|
|
|
6677
6677
|
* @see {@link KEYS_DOMAIN_FORWARD} - Array of all keys for this type
|
|
6678
6678
|
*/
|
|
6679
6679
|
export const KEY_DOMAIN_FORWARD_CREATED_ON: keyof DomainForward = 'created_on';
|
|
6680
|
+
/**
|
|
6681
|
+
* Domain Forward Id
|
|
6682
|
+
*
|
|
6683
|
+
*
|
|
6684
|
+
* @type {string}
|
|
6685
|
+
*
|
|
6686
|
+
*
|
|
6687
|
+
* @remarks
|
|
6688
|
+
* This key constant provides type-safe access to the `domain_forward_id` property of DomainForward objects.
|
|
6689
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
6690
|
+
*
|
|
6691
|
+
* @example
|
|
6692
|
+
* ```typescript
|
|
6693
|
+
* // Direct property access
|
|
6694
|
+
* const value = domainforward[KEY_DOMAIN_FORWARD_DOMAIN_FORWARD_ID];
|
|
6695
|
+
*
|
|
6696
|
+
* // Dynamic property access
|
|
6697
|
+
* const propertyName = KEY_DOMAIN_FORWARD_DOMAIN_FORWARD_ID;
|
|
6698
|
+
* const value = domainforward[propertyName];
|
|
6699
|
+
* ```
|
|
6700
|
+
*
|
|
6701
|
+
* @see {@link DomainForward} - The TypeScript type definition
|
|
6702
|
+
* @see {@link KEYS_DOMAIN_FORWARD} - Array of all keys for this type
|
|
6703
|
+
*/
|
|
6704
|
+
export const KEY_DOMAIN_FORWARD_DOMAIN_FORWARD_ID: keyof DomainForward = 'domain_forward_id';
|
|
6680
6705
|
/**
|
|
6681
6706
|
* Enabled
|
|
6682
6707
|
*
|
|
@@ -6847,6 +6872,7 @@ export const KEY_DOMAIN_FORWARD_UPDATED_ON: keyof DomainForward = 'updated_on';
|
|
|
6847
6872
|
*/
|
|
6848
6873
|
export const KEYS_DOMAIN_FORWARD = [
|
|
6849
6874
|
KEY_DOMAIN_FORWARD_CREATED_ON,
|
|
6875
|
+
KEY_DOMAIN_FORWARD_DOMAIN_FORWARD_ID,
|
|
6850
6876
|
KEY_DOMAIN_FORWARD_ENABLED,
|
|
6851
6877
|
KEY_DOMAIN_FORWARD_HOSTNAME,
|
|
6852
6878
|
KEY_DOMAIN_FORWARD_HTTP,
|
|
@@ -3593,32 +3593,13 @@ export type PATCH_DomainForwardsByHostnameDisable_Response_422 = HTTPValidationE
|
|
|
3593
3593
|
* @path /v1/domain-forwards/{hostname}/enable
|
|
3594
3594
|
* @param hostname (path) - Hostname
|
|
3595
3595
|
*
|
|
3596
|
-
* @see {@link PATCH_DomainForwardsByHostnameEnable_Response_400} - 400 response type
|
|
3597
3596
|
* @see {@link PATCH_DomainForwardsByHostnameEnable_Response_401} - 401 response type
|
|
3598
3597
|
* @see {@link PATCH_DomainForwardsByHostnameEnable_Response_403} - 403 response type
|
|
3599
3598
|
* @see {@link PATCH_DomainForwardsByHostnameEnable_Response_422} - 422 response type
|
|
3600
3599
|
*
|
|
3601
3600
|
|
|
3602
3601
|
*/
|
|
3603
|
-
export type PATCH_DomainForwardsByHostnameEnable_Response =
|
|
3604
|
-
|
|
3605
|
-
/**
|
|
3606
|
-
* 400 response for PATCH DomainForwardsByHostnameEnable endpoint
|
|
3607
|
-
*
|
|
3608
|
-
* @remarks
|
|
3609
|
-
* This type defines the response structure for the 400 status code
|
|
3610
|
-
* of the PATCH DomainForwardsByHostnameEnable endpoint.
|
|
3611
|
-
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
3612
|
-
*
|
|
3613
|
-
|
|
3614
|
-
*
|
|
3615
|
-
* @path /v1/domain-forwards/{hostname}/enable
|
|
3616
|
-
* @param hostname (path) - Hostname
|
|
3617
|
-
*
|
|
3618
|
-
* @see {@link PATCH_DomainForwardsByHostnameEnable_Response} - The main response type definition
|
|
3619
|
-
* @see {@link Problem} - The actual schema type definition
|
|
3620
|
-
*/
|
|
3621
|
-
export type PATCH_DomainForwardsByHostnameEnable_Response_400 = Problem
|
|
3602
|
+
export type PATCH_DomainForwardsByHostnameEnable_Response = PATCH_DomainForwardsByHostnameEnable_Response_401 | PATCH_DomainForwardsByHostnameEnable_Response_403 | PATCH_DomainForwardsByHostnameEnable_Response_422;
|
|
3622
3603
|
|
|
3623
3604
|
/**
|
|
3624
3605
|
* 401 response for PATCH DomainForwardsByHostnameEnable endpoint
|
package/src/openapi.yaml
CHANGED
|
@@ -1607,6 +1607,14 @@ components:
|
|
|
1607
1607
|
format: date-time
|
|
1608
1608
|
title: Created On
|
|
1609
1609
|
type: string
|
|
1610
|
+
domain_forward_id:
|
|
1611
|
+
examples:
|
|
1612
|
+
- domain_forward_01h45ytscbebyvny4gc8cr8ma2
|
|
1613
|
+
format: typeid
|
|
1614
|
+
pattern: ^domain_forward_[0-7][0-9a-hjkmnpq-tv-z]{25}$
|
|
1615
|
+
title: Domain Forward Id
|
|
1616
|
+
type: string
|
|
1617
|
+
x-typeid-prefix: domain_forward
|
|
1610
1618
|
enabled:
|
|
1611
1619
|
title: Enabled
|
|
1612
1620
|
type: boolean
|
|
@@ -1636,6 +1644,7 @@ components:
|
|
|
1636
1644
|
title: Updated On
|
|
1637
1645
|
type: string
|
|
1638
1646
|
required:
|
|
1647
|
+
- domain_forward_id
|
|
1639
1648
|
- hostname
|
|
1640
1649
|
- enabled
|
|
1641
1650
|
- updated_on
|
|
@@ -6960,7 +6969,7 @@ info:
|
|
|
6960
6969
|
'
|
|
6961
6970
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
6962
6971
|
title: OpusDNS API
|
|
6963
|
-
version: 2026-01-
|
|
6972
|
+
version: 2026-01-30-145433
|
|
6964
6973
|
x-logo:
|
|
6965
6974
|
altText: OpusDNS API Reference
|
|
6966
6975
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -8895,6 +8904,7 @@ paths:
|
|
|
8895
8904
|
results:
|
|
8896
8905
|
- domain_forwards:
|
|
8897
8906
|
- created_on: '2025-11-18T12:59:57Z'
|
|
8907
|
+
domain_forward_id: domain_forward_01jx0000000000000000000001
|
|
8898
8908
|
enabled: false
|
|
8899
8909
|
hostname: example.com.
|
|
8900
8910
|
https:
|
|
@@ -9321,6 +9331,7 @@ paths:
|
|
|
9321
9331
|
value:
|
|
9322
9332
|
domain_forwards:
|
|
9323
9333
|
- created_on: '2025-11-18T12:59:57Z'
|
|
9334
|
+
domain_forward_id: domain_forward_01jx0000000000000000000001
|
|
9324
9335
|
enabled: false
|
|
9325
9336
|
hostname: example.com.
|
|
9326
9337
|
https:
|
|
@@ -9942,6 +9953,7 @@ paths:
|
|
|
9942
9953
|
summary: Response for HTTP domain forward
|
|
9943
9954
|
value:
|
|
9944
9955
|
created_on: '2025-11-14T09:01:38'
|
|
9956
|
+
domain_forward_id: domain_forward_01jx0000000000000000000001
|
|
9945
9957
|
enabled: false
|
|
9946
9958
|
hostname: example.com.
|
|
9947
9959
|
http:
|
|
@@ -9972,6 +9984,7 @@ paths:
|
|
|
9972
9984
|
summary: Response for HTTP to HTTPS
|
|
9973
9985
|
value:
|
|
9974
9986
|
created_on: '2025-11-14T09:01:38'
|
|
9987
|
+
domain_forward_id: domain_forward_01jx0000000000000000000002
|
|
9975
9988
|
enabled: false
|
|
9976
9989
|
hostname: example.com.
|
|
9977
9990
|
http:
|
|
@@ -10785,18 +10798,6 @@ paths:
|
|
|
10785
10798
|
responses:
|
|
10786
10799
|
'204':
|
|
10787
10800
|
description: Successful Response
|
|
10788
|
-
'400':
|
|
10789
|
-
content:
|
|
10790
|
-
application/problem+json:
|
|
10791
|
-
example:
|
|
10792
|
-
code: ERROR_DOMAIN_FORWARD_WILDCARD_NOT_SUPPORTED
|
|
10793
|
-
detail: Additional error context.
|
|
10794
|
-
status: 400
|
|
10795
|
-
title: HTTPS Wildcard Not Supported
|
|
10796
|
-
type: domain-forward-wildcard-not-supported
|
|
10797
|
-
schema:
|
|
10798
|
-
$ref: '#/components/schemas/Problem'
|
|
10799
|
-
description: Bad Request
|
|
10800
10801
|
'401':
|
|
10801
10802
|
content:
|
|
10802
10803
|
application/problem+json:
|
package/src/schema.d.ts
CHANGED
|
@@ -2950,6 +2950,12 @@ export interface components {
|
|
|
2950
2950
|
* Format: date-time
|
|
2951
2951
|
*/
|
|
2952
2952
|
created_on: Date;
|
|
2953
|
+
/**
|
|
2954
|
+
* Domain Forward Id
|
|
2955
|
+
* Format: typeid
|
|
2956
|
+
* @example domain_forward_01h45ytscbebyvny4gc8cr8ma2
|
|
2957
|
+
*/
|
|
2958
|
+
domain_forward_id: TypeId<"domain_forward">;
|
|
2953
2959
|
/** Enabled */
|
|
2954
2960
|
enabled: boolean;
|
|
2955
2961
|
/** Hostname */
|
|
@@ -9096,22 +9102,6 @@ export interface operations {
|
|
|
9096
9102
|
};
|
|
9097
9103
|
content?: never;
|
|
9098
9104
|
};
|
|
9099
|
-
/** @description Bad Request */
|
|
9100
|
-
400: {
|
|
9101
|
-
headers: {
|
|
9102
|
-
[name: string]: unknown;
|
|
9103
|
-
};
|
|
9104
|
-
content: {
|
|
9105
|
-
/** @example {
|
|
9106
|
-
* "code": "ERROR_DOMAIN_FORWARD_WILDCARD_NOT_SUPPORTED",
|
|
9107
|
-
* "detail": "Additional error context.",
|
|
9108
|
-
* "status": 400,
|
|
9109
|
-
* "title": "HTTPS Wildcard Not Supported",
|
|
9110
|
-
* "type": "domain-forward-wildcard-not-supported"
|
|
9111
|
-
* } */
|
|
9112
|
-
"application/problem+json": components["schemas"]["Problem"];
|
|
9113
|
-
};
|
|
9114
|
-
};
|
|
9115
9105
|
/** @description Unauthorized */
|
|
9116
9106
|
401: {
|
|
9117
9107
|
headers: {
|