@opusdns/api 0.122.0 → 0.124.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 +127 -0
- package/src/helpers/requests.d.ts +40 -19
- package/src/helpers/responses.d.ts +130 -7
- package/src/helpers/schemas.d.ts +16 -0
- package/src/openapi.yaml +199 -19
- package/src/schema.d.ts +120 -8
package/package.json
CHANGED
package/src/helpers/keys.ts
CHANGED
|
@@ -69,6 +69,7 @@ import { DomainCreate } from './schemas';
|
|
|
69
69
|
import { DomainDnssecDataCreate } from './schemas';
|
|
70
70
|
import { DomainDnssecData } from './schemas';
|
|
71
71
|
import { DomainForward } from './schemas';
|
|
72
|
+
import { DomainForwardCreateRequest } from './schemas';
|
|
72
73
|
import { DomainForwardPatchOp } from './schemas';
|
|
73
74
|
import { DomainForwardPatchOps } from './schemas';
|
|
74
75
|
import { DomainForwardProtocolSetRequest } from './schemas';
|
|
@@ -6588,6 +6589,132 @@ export const KEYS_DOMAIN_FORWARD = [
|
|
|
6588
6589
|
KEY_DOMAIN_FORWARD_WILDCARD,
|
|
6589
6590
|
] as const satisfies (keyof DomainForward)[];
|
|
6590
6591
|
|
|
6592
|
+
/**
|
|
6593
|
+
* Enabled
|
|
6594
|
+
*
|
|
6595
|
+
*
|
|
6596
|
+
* @type {boolean}
|
|
6597
|
+
*
|
|
6598
|
+
*
|
|
6599
|
+
* @remarks
|
|
6600
|
+
* This key constant provides type-safe access to the `enabled` property of DomainForwardCreateRequest objects.
|
|
6601
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
6602
|
+
*
|
|
6603
|
+
* @example
|
|
6604
|
+
* ```typescript
|
|
6605
|
+
* // Direct property access
|
|
6606
|
+
* const value = domainforwardcreaterequest[KEY_DOMAIN_FORWARD_CREATE_REQUEST_ENABLED];
|
|
6607
|
+
*
|
|
6608
|
+
* // Dynamic property access
|
|
6609
|
+
* const propertyName = KEY_DOMAIN_FORWARD_CREATE_REQUEST_ENABLED;
|
|
6610
|
+
* const value = domainforwardcreaterequest[propertyName];
|
|
6611
|
+
* ```
|
|
6612
|
+
*
|
|
6613
|
+
* @see {@link DomainForwardCreateRequest} - The TypeScript type definition
|
|
6614
|
+
* @see {@link KEYS_DOMAIN_FORWARD_CREATE_REQUEST} - Array of all keys for this type
|
|
6615
|
+
*/
|
|
6616
|
+
export const KEY_DOMAIN_FORWARD_CREATE_REQUEST_ENABLED = 'enabled' as keyof DomainForwardCreateRequest;
|
|
6617
|
+
/**
|
|
6618
|
+
* Hostname
|
|
6619
|
+
*
|
|
6620
|
+
*
|
|
6621
|
+
* @type {string}
|
|
6622
|
+
*
|
|
6623
|
+
*
|
|
6624
|
+
* @remarks
|
|
6625
|
+
* This key constant provides type-safe access to the `hostname` property of DomainForwardCreateRequest objects.
|
|
6626
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
6627
|
+
*
|
|
6628
|
+
* @example
|
|
6629
|
+
* ```typescript
|
|
6630
|
+
* // Direct property access
|
|
6631
|
+
* const value = domainforwardcreaterequest[KEY_DOMAIN_FORWARD_CREATE_REQUEST_HOSTNAME];
|
|
6632
|
+
*
|
|
6633
|
+
* // Dynamic property access
|
|
6634
|
+
* const propertyName = KEY_DOMAIN_FORWARD_CREATE_REQUEST_HOSTNAME;
|
|
6635
|
+
* const value = domainforwardcreaterequest[propertyName];
|
|
6636
|
+
* ```
|
|
6637
|
+
*
|
|
6638
|
+
* @see {@link DomainForwardCreateRequest} - The TypeScript type definition
|
|
6639
|
+
* @see {@link KEYS_DOMAIN_FORWARD_CREATE_REQUEST} - Array of all keys for this type
|
|
6640
|
+
*/
|
|
6641
|
+
export const KEY_DOMAIN_FORWARD_CREATE_REQUEST_HOSTNAME = 'hostname' as keyof DomainForwardCreateRequest;
|
|
6642
|
+
/**
|
|
6643
|
+
* http property
|
|
6644
|
+
*
|
|
6645
|
+
*
|
|
6646
|
+
*
|
|
6647
|
+
*
|
|
6648
|
+
* @remarks
|
|
6649
|
+
* This key constant provides type-safe access to the `http` property of DomainForwardCreateRequest objects.
|
|
6650
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
6651
|
+
*
|
|
6652
|
+
* @example
|
|
6653
|
+
* ```typescript
|
|
6654
|
+
* // Direct property access
|
|
6655
|
+
* const value = domainforwardcreaterequest[KEY_DOMAIN_FORWARD_CREATE_REQUEST_HTTP];
|
|
6656
|
+
*
|
|
6657
|
+
* // Dynamic property access
|
|
6658
|
+
* const propertyName = KEY_DOMAIN_FORWARD_CREATE_REQUEST_HTTP;
|
|
6659
|
+
* const value = domainforwardcreaterequest[propertyName];
|
|
6660
|
+
* ```
|
|
6661
|
+
*
|
|
6662
|
+
* @see {@link DomainForwardCreateRequest} - The TypeScript type definition
|
|
6663
|
+
* @see {@link KEYS_DOMAIN_FORWARD_CREATE_REQUEST} - Array of all keys for this type
|
|
6664
|
+
*/
|
|
6665
|
+
export const KEY_DOMAIN_FORWARD_CREATE_REQUEST_HTTP = 'http' as keyof DomainForwardCreateRequest;
|
|
6666
|
+
/**
|
|
6667
|
+
* https property
|
|
6668
|
+
*
|
|
6669
|
+
*
|
|
6670
|
+
*
|
|
6671
|
+
*
|
|
6672
|
+
* @remarks
|
|
6673
|
+
* This key constant provides type-safe access to the `https` property of DomainForwardCreateRequest objects.
|
|
6674
|
+
* Use this constant when you need to access properties dynamically or ensure type safety.
|
|
6675
|
+
*
|
|
6676
|
+
* @example
|
|
6677
|
+
* ```typescript
|
|
6678
|
+
* // Direct property access
|
|
6679
|
+
* const value = domainforwardcreaterequest[KEY_DOMAIN_FORWARD_CREATE_REQUEST_HTTPS];
|
|
6680
|
+
*
|
|
6681
|
+
* // Dynamic property access
|
|
6682
|
+
* const propertyName = KEY_DOMAIN_FORWARD_CREATE_REQUEST_HTTPS;
|
|
6683
|
+
* const value = domainforwardcreaterequest[propertyName];
|
|
6684
|
+
* ```
|
|
6685
|
+
*
|
|
6686
|
+
* @see {@link DomainForwardCreateRequest} - The TypeScript type definition
|
|
6687
|
+
* @see {@link KEYS_DOMAIN_FORWARD_CREATE_REQUEST} - Array of all keys for this type
|
|
6688
|
+
*/
|
|
6689
|
+
export const KEY_DOMAIN_FORWARD_CREATE_REQUEST_HTTPS = 'https' as keyof DomainForwardCreateRequest;
|
|
6690
|
+
|
|
6691
|
+
/**
|
|
6692
|
+
* Array of all DomainForwardCreateRequest property keys
|
|
6693
|
+
*
|
|
6694
|
+
* @remarks
|
|
6695
|
+
* This constant provides a readonly array containing all valid property keys for DomainForwardCreateRequest objects.
|
|
6696
|
+
* Useful for iteration, validation, and generating dynamic UI components.
|
|
6697
|
+
*
|
|
6698
|
+
* @example
|
|
6699
|
+
* ```typescript
|
|
6700
|
+
* // Iterating through all keys
|
|
6701
|
+
* for (const key of KEYS_DOMAIN_FORWARD_CREATE_REQUEST) {
|
|
6702
|
+
* console.log(`Property: ${key}, Value: ${domainforwardcreaterequest[key]}`);
|
|
6703
|
+
* }
|
|
6704
|
+
*
|
|
6705
|
+
* // Validation
|
|
6706
|
+
* const isValidKey = KEYS_DOMAIN_FORWARD_CREATE_REQUEST.includes(someKey);
|
|
6707
|
+
* ```
|
|
6708
|
+
*
|
|
6709
|
+
* @see {@link DomainForwardCreateRequest} - The TypeScript type definition
|
|
6710
|
+
*/
|
|
6711
|
+
export const KEYS_DOMAIN_FORWARD_CREATE_REQUEST = [
|
|
6712
|
+
KEY_DOMAIN_FORWARD_CREATE_REQUEST_ENABLED,
|
|
6713
|
+
KEY_DOMAIN_FORWARD_CREATE_REQUEST_HOSTNAME,
|
|
6714
|
+
KEY_DOMAIN_FORWARD_CREATE_REQUEST_HTTP,
|
|
6715
|
+
KEY_DOMAIN_FORWARD_CREATE_REQUEST_HTTPS,
|
|
6716
|
+
] as const satisfies (keyof DomainForwardCreateRequest)[];
|
|
6717
|
+
|
|
6591
6718
|
/**
|
|
6592
6719
|
* op property
|
|
6593
6720
|
*
|
|
@@ -34,7 +34,7 @@ import { operations } from '../schema';
|
|
|
34
34
|
|
|
35
35
|
import { DomainDnssecDataCreateArray, OrganizationAttributeUpdateArray } from './schemas-arrays.d';
|
|
36
36
|
|
|
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';
|
|
37
|
+
import { ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainForwardPatchOps, DomainForwardCreateRequest, 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
40
|
* Request type for GET ArchiveEmailForwardLogsAliasesEmailForwardAliasId endpoint
|
|
@@ -1487,6 +1487,43 @@ export type PATCH_DomainForwards_Request = {
|
|
|
1487
1487
|
*/
|
|
1488
1488
|
export type PATCH_DomainForwards_Request_Body = PATCH_DomainForwards_Request['requestBody'];
|
|
1489
1489
|
|
|
1490
|
+
/**
|
|
1491
|
+
* Request type for POST DomainForwards endpoint
|
|
1492
|
+
*
|
|
1493
|
+
* Create a domain forward
|
|
1494
|
+
* Creates a new domain forward configuration. Wildcard forwards can be created by using *.hostname (e.g., *.example.com).
|
|
1495
|
+
*
|
|
1496
|
+
* @remarks
|
|
1497
|
+
* This type defines the complete request structure for the POST DomainForwards endpoint.
|
|
1498
|
+
* It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
|
|
1499
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
1500
|
+
*
|
|
1501
|
+
* @example
|
|
1502
|
+
* Use this type to ensure type safety when making API requests to this endpoint.
|
|
1503
|
+
*
|
|
1504
|
+
* @path /v1/domain-forwards
|
|
1505
|
+
*
|
|
1506
|
+
* @see {@link POST_DomainForwards_Request_Query} - Query parameters type
|
|
1507
|
+
* @see {@link POST_DomainForwards_Request_Path} - Path parameters type
|
|
1508
|
+
* @see {@link POST_DomainForwards_Request_Body} - Request body type
|
|
1509
|
+
*/
|
|
1510
|
+
export type POST_DomainForwards_Request = {
|
|
1511
|
+
requestBody: DomainForwardCreateRequest;
|
|
1512
|
+
}
|
|
1513
|
+
/**
|
|
1514
|
+
* Request body for POST /v1/domain-forwards
|
|
1515
|
+
*
|
|
1516
|
+
* @remarks
|
|
1517
|
+
* This type defines the request body structure for the POST /v1/domain-forwards endpoint.
|
|
1518
|
+
* It provides type safety for the request body as defined in the OpenAPI specification.
|
|
1519
|
+
*
|
|
1520
|
+
* @example
|
|
1521
|
+
* Use this type to ensure type safety for request body structure.
|
|
1522
|
+
*
|
|
1523
|
+
* @path /v1/domain-forwards
|
|
1524
|
+
*/
|
|
1525
|
+
export type POST_DomainForwards_Request_Body = POST_DomainForwards_Request['requestBody'];
|
|
1526
|
+
|
|
1490
1527
|
/**
|
|
1491
1528
|
* Request type for DELETE DomainForwardsHostname endpoint
|
|
1492
1529
|
*
|
|
@@ -1572,8 +1609,8 @@ export type GET_DomainForwardsHostname_Request_Path = GET_DomainForwardsHostname
|
|
|
1572
1609
|
/**
|
|
1573
1610
|
* Request type for POST DomainForwardsHostname endpoint
|
|
1574
1611
|
*
|
|
1575
|
-
* Create a domain forward
|
|
1576
|
-
* Creates a new domain forward configuration for the specified hostname
|
|
1612
|
+
* Create a domain forward (deprecated)
|
|
1613
|
+
* **DEPRECATED**: Use POST /v1/domain-forwards instead. Creates a new domain forward configuration for the specified hostname.
|
|
1577
1614
|
*
|
|
1578
1615
|
* @remarks
|
|
1579
1616
|
* This type defines the complete request structure for the POST DomainForwardsHostname endpoint.
|
|
@@ -1681,7 +1718,6 @@ export type PATCH_DomainForwardsHostnameDisable_Request_Path = PATCH_DomainForwa
|
|
|
1681
1718
|
*
|
|
1682
1719
|
* @path /v1/domain-forwards/{hostname}/enable
|
|
1683
1720
|
* @param hostname (path) - Hostname
|
|
1684
|
-
* @param wildcard (query) - Wildcard domain forwarding
|
|
1685
1721
|
*
|
|
1686
1722
|
* @see {@link PATCH_DomainForwardsHostnameEnable_Request_Query} - Query parameters type
|
|
1687
1723
|
* @see {@link PATCH_DomainForwardsHostnameEnable_Request_Path} - Path parameters type
|
|
@@ -1689,24 +1725,9 @@ export type PATCH_DomainForwardsHostnameDisable_Request_Path = PATCH_DomainForwa
|
|
|
1689
1725
|
*/
|
|
1690
1726
|
export type PATCH_DomainForwardsHostnameEnable_Request = {
|
|
1691
1727
|
parameters: {
|
|
1692
|
-
query: operations['enable_domain_forward_v1_domain_forwards__hostname__enable_patch']['parameters']['query'];
|
|
1693
1728
|
path: operations['enable_domain_forward_v1_domain_forwards__hostname__enable_patch']['parameters']['path'];
|
|
1694
1729
|
};
|
|
1695
1730
|
}
|
|
1696
|
-
/**
|
|
1697
|
-
* Query parameters for PATCH /v1/domain-forwards/{hostname}/enable
|
|
1698
|
-
*
|
|
1699
|
-
* @remarks
|
|
1700
|
-
* This type defines the query parameters for the PATCH /v1/domain-forwards/{hostname}/enable endpoint.
|
|
1701
|
-
* It provides type safety for all query parameters as defined in the OpenAPI specification.
|
|
1702
|
-
*
|
|
1703
|
-
* @example
|
|
1704
|
-
* Use this type to ensure type safety for query parameters.
|
|
1705
|
-
*
|
|
1706
|
-
* @path /v1/domain-forwards/{hostname}/enable
|
|
1707
|
-
* @param wildcard (query) - Wildcard domain forwarding
|
|
1708
|
-
*/
|
|
1709
|
-
export type PATCH_DomainForwardsHostnameEnable_Request_Query = PATCH_DomainForwardsHostnameEnable_Request['parameters']['query'];
|
|
1710
1731
|
/**
|
|
1711
1732
|
* Path parameters for PATCH /v1/domain-forwards/{hostname}/enable
|
|
1712
1733
|
*
|
|
@@ -2541,6 +2541,134 @@ export type PATCH_DomainForwards_Response_404 = Problem
|
|
|
2541
2541
|
*/
|
|
2542
2542
|
export type PATCH_DomainForwards_Response_422 = HTTPValidationError
|
|
2543
2543
|
|
|
2544
|
+
/**
|
|
2545
|
+
* Response types for POST DomainForwards endpoint
|
|
2546
|
+
*
|
|
2547
|
+
* Create a domain forward
|
|
2548
|
+
* Creates a new domain forward configuration. Wildcard forwards can be created by using *.hostname (e.g., *.example.com).
|
|
2549
|
+
*
|
|
2550
|
+
* @remarks
|
|
2551
|
+
* This type defines all possible response structures for the POST DomainForwards endpoint.
|
|
2552
|
+
* Each response code maps to a specific response type as defined in the OpenAPI specification.
|
|
2553
|
+
* Use this type to ensure type safety when handling API responses from this endpoint.
|
|
2554
|
+
*
|
|
2555
|
+
|
|
2556
|
+
*
|
|
2557
|
+
* @path /v1/domain-forwards
|
|
2558
|
+
*
|
|
2559
|
+
* @see {@link POST_DomainForwards_Response_201} - 201 response type
|
|
2560
|
+
* @see {@link POST_DomainForwards_Response_401} - 401 response type
|
|
2561
|
+
* @see {@link POST_DomainForwards_Response_403} - 403 response type
|
|
2562
|
+
* @see {@link POST_DomainForwards_Response_404} - 404 response type
|
|
2563
|
+
* @see {@link POST_DomainForwards_Response_409} - 409 response type
|
|
2564
|
+
* @see {@link POST_DomainForwards_Response_422} - 422 response type
|
|
2565
|
+
*
|
|
2566
|
+
|
|
2567
|
+
*/
|
|
2568
|
+
export type POST_DomainForwards_Response = POST_DomainForwards_Response_201 | POST_DomainForwards_Response_401 | POST_DomainForwards_Response_403 | POST_DomainForwards_Response_404 | POST_DomainForwards_Response_409 | POST_DomainForwards_Response_422;
|
|
2569
|
+
|
|
2570
|
+
/**
|
|
2571
|
+
* 201 response for POST DomainForwards endpoint
|
|
2572
|
+
*
|
|
2573
|
+
* @remarks
|
|
2574
|
+
* This type defines the response structure for the 201 status code
|
|
2575
|
+
* of the POST DomainForwards endpoint.
|
|
2576
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2577
|
+
*
|
|
2578
|
+
|
|
2579
|
+
*
|
|
2580
|
+
* @path /v1/domain-forwards
|
|
2581
|
+
*
|
|
2582
|
+
* @see {@link POST_DomainForwards_Response} - The main response type definition
|
|
2583
|
+
* @see {@link DomainForward} - The actual schema type definition
|
|
2584
|
+
*/
|
|
2585
|
+
export type POST_DomainForwards_Response_201 = DomainForward
|
|
2586
|
+
|
|
2587
|
+
/**
|
|
2588
|
+
* 401 response for POST DomainForwards endpoint
|
|
2589
|
+
*
|
|
2590
|
+
* @remarks
|
|
2591
|
+
* This type defines the response structure for the 401 status code
|
|
2592
|
+
* of the POST DomainForwards endpoint.
|
|
2593
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2594
|
+
*
|
|
2595
|
+
|
|
2596
|
+
*
|
|
2597
|
+
* @path /v1/domain-forwards
|
|
2598
|
+
*
|
|
2599
|
+
* @see {@link POST_DomainForwards_Response} - The main response type definition
|
|
2600
|
+
* @see {@link Problem} - The actual schema type definition
|
|
2601
|
+
*/
|
|
2602
|
+
export type POST_DomainForwards_Response_401 = Problem
|
|
2603
|
+
|
|
2604
|
+
/**
|
|
2605
|
+
* 403 response for POST DomainForwards endpoint
|
|
2606
|
+
*
|
|
2607
|
+
* @remarks
|
|
2608
|
+
* This type defines the response structure for the 403 status code
|
|
2609
|
+
* of the POST DomainForwards endpoint.
|
|
2610
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2611
|
+
*
|
|
2612
|
+
|
|
2613
|
+
*
|
|
2614
|
+
* @path /v1/domain-forwards
|
|
2615
|
+
*
|
|
2616
|
+
* @see {@link POST_DomainForwards_Response} - The main response type definition
|
|
2617
|
+
* @see {@link Problem} - The actual schema type definition
|
|
2618
|
+
*/
|
|
2619
|
+
export type POST_DomainForwards_Response_403 = Problem
|
|
2620
|
+
|
|
2621
|
+
/**
|
|
2622
|
+
* 404 response for POST DomainForwards endpoint
|
|
2623
|
+
*
|
|
2624
|
+
* @remarks
|
|
2625
|
+
* This type defines the response structure for the 404 status code
|
|
2626
|
+
* of the POST DomainForwards endpoint.
|
|
2627
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2628
|
+
*
|
|
2629
|
+
|
|
2630
|
+
*
|
|
2631
|
+
* @path /v1/domain-forwards
|
|
2632
|
+
*
|
|
2633
|
+
* @see {@link POST_DomainForwards_Response} - The main response type definition
|
|
2634
|
+
* @see {@link Problem} - The actual schema type definition
|
|
2635
|
+
*/
|
|
2636
|
+
export type POST_DomainForwards_Response_404 = Problem
|
|
2637
|
+
|
|
2638
|
+
/**
|
|
2639
|
+
* 409 response for POST DomainForwards endpoint
|
|
2640
|
+
*
|
|
2641
|
+
* @remarks
|
|
2642
|
+
* This type defines the response structure for the 409 status code
|
|
2643
|
+
* of the POST DomainForwards endpoint.
|
|
2644
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2645
|
+
*
|
|
2646
|
+
|
|
2647
|
+
*
|
|
2648
|
+
* @path /v1/domain-forwards
|
|
2649
|
+
*
|
|
2650
|
+
* @see {@link POST_DomainForwards_Response} - The main response type definition
|
|
2651
|
+
* @see {@link Problem} - The actual schema type definition
|
|
2652
|
+
*/
|
|
2653
|
+
export type POST_DomainForwards_Response_409 = Problem
|
|
2654
|
+
|
|
2655
|
+
/**
|
|
2656
|
+
* 422 response for POST DomainForwards endpoint
|
|
2657
|
+
*
|
|
2658
|
+
* @remarks
|
|
2659
|
+
* This type defines the response structure for the 422 status code
|
|
2660
|
+
* of the POST DomainForwards endpoint.
|
|
2661
|
+
* It provides type safety for handling this specific response as defined in the OpenAPI specification.
|
|
2662
|
+
*
|
|
2663
|
+
|
|
2664
|
+
*
|
|
2665
|
+
* @path /v1/domain-forwards
|
|
2666
|
+
*
|
|
2667
|
+
* @see {@link POST_DomainForwards_Response} - The main response type definition
|
|
2668
|
+
* @see {@link HTTPValidationError} - The actual schema type definition
|
|
2669
|
+
*/
|
|
2670
|
+
export type POST_DomainForwards_Response_422 = HTTPValidationError
|
|
2671
|
+
|
|
2544
2672
|
/**
|
|
2545
2673
|
* Response types for DELETE DomainForwardsByHostname endpoint
|
|
2546
2674
|
*
|
|
@@ -2757,8 +2885,8 @@ export type GET_DomainForwardsByHostname_Response_422 = HTTPValidationError
|
|
|
2757
2885
|
/**
|
|
2758
2886
|
* Response types for POST DomainForwardsByHostname endpoint
|
|
2759
2887
|
*
|
|
2760
|
-
* Create a domain forward
|
|
2761
|
-
* Creates a new domain forward configuration for the specified hostname
|
|
2888
|
+
* Create a domain forward (deprecated)
|
|
2889
|
+
* **DEPRECATED**: Use POST /v1/domain-forwards instead. Creates a new domain forward configuration for the specified hostname.
|
|
2762
2890
|
*
|
|
2763
2891
|
* @remarks
|
|
2764
2892
|
* This type defines all possible response structures for the POST DomainForwardsByHostname endpoint.
|
|
@@ -3446,7 +3574,6 @@ export type PATCH_DomainForwardsByHostnameDisable_Response_422 = HTTPValidationE
|
|
|
3446
3574
|
*
|
|
3447
3575
|
* @path /v1/domain-forwards/{hostname}/enable
|
|
3448
3576
|
* @param hostname (path) - Hostname
|
|
3449
|
-
* @param wildcard (query) - Wildcard domain forwarding
|
|
3450
3577
|
*
|
|
3451
3578
|
* @see {@link PATCH_DomainForwardsByHostnameEnable_Response_400} - 400 response type
|
|
3452
3579
|
* @see {@link PATCH_DomainForwardsByHostnameEnable_Response_401} - 401 response type
|
|
@@ -3469,7 +3596,6 @@ export type PATCH_DomainForwardsByHostnameEnable_Response = PATCH_DomainForwards
|
|
|
3469
3596
|
*
|
|
3470
3597
|
* @path /v1/domain-forwards/{hostname}/enable
|
|
3471
3598
|
* @param hostname (path) - Hostname
|
|
3472
|
-
* @param wildcard (query) - Wildcard domain forwarding
|
|
3473
3599
|
*
|
|
3474
3600
|
* @see {@link PATCH_DomainForwardsByHostnameEnable_Response} - The main response type definition
|
|
3475
3601
|
* @see {@link Problem} - The actual schema type definition
|
|
@@ -3488,7 +3614,6 @@ export type PATCH_DomainForwardsByHostnameEnable_Response_400 = Problem
|
|
|
3488
3614
|
*
|
|
3489
3615
|
* @path /v1/domain-forwards/{hostname}/enable
|
|
3490
3616
|
* @param hostname (path) - Hostname
|
|
3491
|
-
* @param wildcard (query) - Wildcard domain forwarding
|
|
3492
3617
|
*
|
|
3493
3618
|
* @see {@link PATCH_DomainForwardsByHostnameEnable_Response} - The main response type definition
|
|
3494
3619
|
* @see {@link Problem} - The actual schema type definition
|
|
@@ -3507,7 +3632,6 @@ export type PATCH_DomainForwardsByHostnameEnable_Response_401 = Problem
|
|
|
3507
3632
|
*
|
|
3508
3633
|
* @path /v1/domain-forwards/{hostname}/enable
|
|
3509
3634
|
* @param hostname (path) - Hostname
|
|
3510
|
-
* @param wildcard (query) - Wildcard domain forwarding
|
|
3511
3635
|
*
|
|
3512
3636
|
* @see {@link PATCH_DomainForwardsByHostnameEnable_Response} - The main response type definition
|
|
3513
3637
|
* @see {@link Problem} - The actual schema type definition
|
|
@@ -3526,7 +3650,6 @@ export type PATCH_DomainForwardsByHostnameEnable_Response_403 = Problem
|
|
|
3526
3650
|
*
|
|
3527
3651
|
* @path /v1/domain-forwards/{hostname}/enable
|
|
3528
3652
|
* @param hostname (path) - Hostname
|
|
3529
|
-
* @param wildcard (query) - Wildcard domain forwarding
|
|
3530
3653
|
*
|
|
3531
3654
|
* @see {@link PATCH_DomainForwardsByHostnameEnable_Response} - The main response type definition
|
|
3532
3655
|
* @see {@link HTTPValidationError} - The actual schema type definition
|
package/src/helpers/schemas.d.ts
CHANGED
|
@@ -1034,6 +1034,22 @@ export type DomainDnssecData = components['schemas']['DomainDnssecDataResponse']
|
|
|
1034
1034
|
* @see {@link components} - The OpenAPI components schema definition
|
|
1035
1035
|
*/
|
|
1036
1036
|
export type DomainForward = components['schemas']['DomainForward'];
|
|
1037
|
+
/**
|
|
1038
|
+
* DomainForwardCreateRequest
|
|
1039
|
+
*
|
|
1040
|
+
* @remarks
|
|
1041
|
+
* Type alias for the `DomainForwardCreateRequest` OpenAPI schema.
|
|
1042
|
+
* This type represents domainforwardcreaterequest data structures used in API requests and responses.
|
|
1043
|
+
*
|
|
1044
|
+
* @example
|
|
1045
|
+
* ```typescript
|
|
1046
|
+
* const response = await api.getDomainForwardCreateRequest();
|
|
1047
|
+
* const item: DomainForwardCreateRequest = response.results;
|
|
1048
|
+
* ```
|
|
1049
|
+
*
|
|
1050
|
+
* @see {@link components} - The OpenAPI components schema definition
|
|
1051
|
+
*/
|
|
1052
|
+
export type DomainForwardCreateRequest = components['schemas']['DomainForwardCreateRequest'];
|
|
1037
1053
|
/**
|
|
1038
1054
|
* DomainForwardPatchOp
|
|
1039
1055
|
*
|
package/src/openapi.yaml
CHANGED
|
@@ -1575,6 +1575,27 @@ components:
|
|
|
1575
1575
|
- created_on
|
|
1576
1576
|
title: DomainForward
|
|
1577
1577
|
type: object
|
|
1578
|
+
DomainForwardCreateRequest:
|
|
1579
|
+
properties:
|
|
1580
|
+
enabled:
|
|
1581
|
+
default: false
|
|
1582
|
+
title: Enabled
|
|
1583
|
+
type: boolean
|
|
1584
|
+
hostname:
|
|
1585
|
+
title: Hostname
|
|
1586
|
+
type: string
|
|
1587
|
+
http:
|
|
1588
|
+
anyOf:
|
|
1589
|
+
- $ref: '#/components/schemas/DomainForwardProtocolSetRequest'
|
|
1590
|
+
- type: 'null'
|
|
1591
|
+
https:
|
|
1592
|
+
anyOf:
|
|
1593
|
+
- $ref: '#/components/schemas/DomainForwardProtocolSetRequest'
|
|
1594
|
+
- type: 'null'
|
|
1595
|
+
required:
|
|
1596
|
+
- hostname
|
|
1597
|
+
title: DomainForwardCreateRequest
|
|
1598
|
+
type: object
|
|
1578
1599
|
DomainForwardPatchOp:
|
|
1579
1600
|
properties:
|
|
1580
1601
|
op:
|
|
@@ -5957,7 +5978,7 @@ info:
|
|
|
5957
5978
|
'
|
|
5958
5979
|
summary: OpusDNS - your gateway to a seamless domain management experience.
|
|
5959
5980
|
title: OpusDNS API
|
|
5960
|
-
version: 2025-12-11-
|
|
5981
|
+
version: 2025-12-11-192124
|
|
5961
5982
|
x-logo:
|
|
5962
5983
|
altText: OpusDNS API Reference
|
|
5963
5984
|
url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
|
|
@@ -8834,6 +8855,178 @@ paths:
|
|
|
8834
8855
|
summary: Patch domain forward redirects
|
|
8835
8856
|
tags:
|
|
8836
8857
|
- domain_forward
|
|
8858
|
+
post:
|
|
8859
|
+
description: Creates a new domain forward configuration. Wildcard forwards can
|
|
8860
|
+
be created by using *.hostname (e.g., *.example.com).
|
|
8861
|
+
operationId: create_domain_forward_v2_v1_domain_forwards_post
|
|
8862
|
+
requestBody:
|
|
8863
|
+
content:
|
|
8864
|
+
application/json:
|
|
8865
|
+
examples:
|
|
8866
|
+
domain_forward:
|
|
8867
|
+
description: Create a HTTP domain forward with redirect from HTTP
|
|
8868
|
+
to HTTPS and HTTPS to auth.example.com
|
|
8869
|
+
summary: HTTP domain forward
|
|
8870
|
+
value:
|
|
8871
|
+
enabled: false
|
|
8872
|
+
http:
|
|
8873
|
+
redirects:
|
|
8874
|
+
- redirect_code: 301
|
|
8875
|
+
request_path: /
|
|
8876
|
+
target_hostname: example.com
|
|
8877
|
+
target_path: /
|
|
8878
|
+
target_protocol: https
|
|
8879
|
+
wildcard: false
|
|
8880
|
+
https:
|
|
8881
|
+
redirects:
|
|
8882
|
+
- redirect_code: 302
|
|
8883
|
+
request_path: /
|
|
8884
|
+
target_hostname: auth.example.com
|
|
8885
|
+
target_path: /
|
|
8886
|
+
target_protocol: https
|
|
8887
|
+
wildcard: false
|
|
8888
|
+
wildcard: false
|
|
8889
|
+
http_to_https:
|
|
8890
|
+
description: Create a HTTP domain forward with redirect from HTTP
|
|
8891
|
+
to HTTPS
|
|
8892
|
+
summary: HTTP to HTTPS
|
|
8893
|
+
value:
|
|
8894
|
+
enabled: false
|
|
8895
|
+
https:
|
|
8896
|
+
redirects:
|
|
8897
|
+
- redirect_code: 301
|
|
8898
|
+
request_path: /
|
|
8899
|
+
target_hostname: example.com
|
|
8900
|
+
target_path: /
|
|
8901
|
+
target_protocol: https
|
|
8902
|
+
wildcard: false
|
|
8903
|
+
wildcard: false
|
|
8904
|
+
schema:
|
|
8905
|
+
$ref: '#/components/schemas/DomainForwardCreateRequest'
|
|
8906
|
+
required: true
|
|
8907
|
+
responses:
|
|
8908
|
+
'201':
|
|
8909
|
+
content:
|
|
8910
|
+
application/json:
|
|
8911
|
+
examples:
|
|
8912
|
+
http_domain_forward_response:
|
|
8913
|
+
description: Response when creating a HTTP domain forward with redirect
|
|
8914
|
+
from HTTP to HTTPS and HTTPS to auth.example.com
|
|
8915
|
+
summary: Response for HTTP domain forward
|
|
8916
|
+
value:
|
|
8917
|
+
created_on: '2025-11-14T09:01:38'
|
|
8918
|
+
enabled: false
|
|
8919
|
+
hostname: example.com.
|
|
8920
|
+
http:
|
|
8921
|
+
created_on: '2025-11-14T09:01:38'
|
|
8922
|
+
redirects:
|
|
8923
|
+
- redirect_code: 301
|
|
8924
|
+
request_hostname: example.com.
|
|
8925
|
+
request_path: /
|
|
8926
|
+
request_protocol: http
|
|
8927
|
+
target_hostname: example.com
|
|
8928
|
+
target_path: /
|
|
8929
|
+
target_protocol: https
|
|
8930
|
+
updated_on: '2025-11-14T09:01:38'
|
|
8931
|
+
wildcard: false
|
|
8932
|
+
https:
|
|
8933
|
+
created_on: '2025-11-14T09:01:38'
|
|
8934
|
+
redirects:
|
|
8935
|
+
- redirect_code: 302
|
|
8936
|
+
request_hostname: example.com.
|
|
8937
|
+
request_path: /
|
|
8938
|
+
request_protocol: https
|
|
8939
|
+
target_hostname: auth.example.com
|
|
8940
|
+
target_path: /
|
|
8941
|
+
target_protocol: https
|
|
8942
|
+
updated_on: '2025-11-14T09:01:38'
|
|
8943
|
+
wildcard: false
|
|
8944
|
+
updated_on: '2025-11-14T09:01:38'
|
|
8945
|
+
wildcard: false
|
|
8946
|
+
http_to_https_response:
|
|
8947
|
+
description: Response when creating a HTTP to HTTPS domain forward
|
|
8948
|
+
summary: Response for HTTP to HTTPS
|
|
8949
|
+
value:
|
|
8950
|
+
created_on: '2025-11-14T09:01:38'
|
|
8951
|
+
enabled: false
|
|
8952
|
+
hostname: example.com.
|
|
8953
|
+
http:
|
|
8954
|
+
created_on: '2025-11-14T09:01:38'
|
|
8955
|
+
redirects:
|
|
8956
|
+
- redirect_code: 301
|
|
8957
|
+
request_hostname: example.com.
|
|
8958
|
+
request_path: /
|
|
8959
|
+
request_protocol: http
|
|
8960
|
+
target_hostname: example.com
|
|
8961
|
+
target_path: /
|
|
8962
|
+
target_protocol: https
|
|
8963
|
+
updated_on: '2025-11-14T09:01:38'
|
|
8964
|
+
wildcard: false
|
|
8965
|
+
updated_on: '2025-11-14T09:01:38'
|
|
8966
|
+
wildcard: false
|
|
8967
|
+
schema:
|
|
8968
|
+
$ref: '#/components/schemas/DomainForward'
|
|
8969
|
+
description: Domain forward created successfully
|
|
8970
|
+
'401':
|
|
8971
|
+
content:
|
|
8972
|
+
application/problem+json:
|
|
8973
|
+
example:
|
|
8974
|
+
code: ERROR_AUTHENTICATION
|
|
8975
|
+
detail: Additional error context.
|
|
8976
|
+
status: 401
|
|
8977
|
+
title: Authentication Error
|
|
8978
|
+
type: authentication
|
|
8979
|
+
schema:
|
|
8980
|
+
$ref: '#/components/schemas/Problem'
|
|
8981
|
+
description: Unauthorized
|
|
8982
|
+
'403':
|
|
8983
|
+
content:
|
|
8984
|
+
application/problem+json:
|
|
8985
|
+
example:
|
|
8986
|
+
code: ERROR_PERMISSION_DENIED
|
|
8987
|
+
detail: Insufficient permissions to perform this action
|
|
8988
|
+
status: 403
|
|
8989
|
+
title: Permission Denied
|
|
8990
|
+
type: permission-denied
|
|
8991
|
+
schema:
|
|
8992
|
+
$ref: '#/components/schemas/Problem'
|
|
8993
|
+
description: Forbidden
|
|
8994
|
+
'404':
|
|
8995
|
+
content:
|
|
8996
|
+
application/problem+json:
|
|
8997
|
+
example:
|
|
8998
|
+
code: ERROR_ZONE_NOT_FOUND
|
|
8999
|
+
detail: Zone not found
|
|
9000
|
+
status: 404
|
|
9001
|
+
title: DNS Error
|
|
9002
|
+
type: dns-zone-not-found
|
|
9003
|
+
zone_name: Zone example.com. not found
|
|
9004
|
+
schema:
|
|
9005
|
+
$ref: '#/components/schemas/Problem'
|
|
9006
|
+
description: DNS zone was not found
|
|
9007
|
+
'409':
|
|
9008
|
+
content:
|
|
9009
|
+
application/problem+json:
|
|
9010
|
+
example:
|
|
9011
|
+
code: ERROR_DOMAIN_FORWARD_ALREADY_EXISTS
|
|
9012
|
+
detail: Domain forward already exists for example.com.
|
|
9013
|
+
status: 409
|
|
9014
|
+
title: Domain Forward Error
|
|
9015
|
+
type: domain-forward-already-exists
|
|
9016
|
+
schema:
|
|
9017
|
+
$ref: '#/components/schemas/Problem'
|
|
9018
|
+
description: Domain forward already exists
|
|
9019
|
+
'422':
|
|
9020
|
+
content:
|
|
9021
|
+
application/problem+json:
|
|
9022
|
+
schema:
|
|
9023
|
+
$ref: '#/components/schemas/HTTPValidationError'
|
|
9024
|
+
description: Validation Error
|
|
9025
|
+
security:
|
|
9026
|
+
- OAuth2PasswordBearer: []
|
|
9027
|
+
summary: Create a domain forward
|
|
9028
|
+
tags:
|
|
9029
|
+
- domain_forward
|
|
8837
9030
|
/v1/domain-forwards/{hostname}:
|
|
8838
9031
|
delete:
|
|
8839
9032
|
description: Deletes the domain forward configuration for the specified hostname
|
|
@@ -8964,7 +9157,9 @@ paths:
|
|
|
8964
9157
|
tags:
|
|
8965
9158
|
- domain_forward
|
|
8966
9159
|
post:
|
|
8967
|
-
|
|
9160
|
+
deprecated: true
|
|
9161
|
+
description: '**DEPRECATED**: Use POST /v1/domain-forwards instead. Creates
|
|
9162
|
+
a new domain forward configuration for the specified hostname.'
|
|
8968
9163
|
operationId: create_domain_forward_v1_domain_forwards__hostname__post
|
|
8969
9164
|
parameters:
|
|
8970
9165
|
- description: Hostname
|
|
@@ -9140,7 +9335,7 @@ paths:
|
|
|
9140
9335
|
description: Validation Error
|
|
9141
9336
|
security:
|
|
9142
9337
|
- OAuth2PasswordBearer: []
|
|
9143
|
-
summary: Create a domain forward
|
|
9338
|
+
summary: Create a domain forward (deprecated)
|
|
9144
9339
|
tags:
|
|
9145
9340
|
- domain_forward
|
|
9146
9341
|
/v1/domain-forwards/{hostname}/disable:
|
|
@@ -9208,15 +9403,6 @@ paths:
|
|
|
9208
9403
|
description: Hostname
|
|
9209
9404
|
title: Hostname
|
|
9210
9405
|
type: string
|
|
9211
|
-
- description: Wildcard domain forwarding
|
|
9212
|
-
in: query
|
|
9213
|
-
name: wildcard
|
|
9214
|
-
required: false
|
|
9215
|
-
schema:
|
|
9216
|
-
default: false
|
|
9217
|
-
description: Wildcard domain forwarding
|
|
9218
|
-
title: Wildcard
|
|
9219
|
-
type: boolean
|
|
9220
9406
|
responses:
|
|
9221
9407
|
'204':
|
|
9222
9408
|
description: Successful Response
|
|
@@ -9227,7 +9413,7 @@ paths:
|
|
|
9227
9413
|
code: ERROR_DOMAIN_FORWARD_WILDCARD_NOT_SUPPORTED
|
|
9228
9414
|
detail: Additional error context.
|
|
9229
9415
|
status: 400
|
|
9230
|
-
title: Wildcard Not Supported
|
|
9416
|
+
title: HTTPS Wildcard Not Supported
|
|
9231
9417
|
type: domain-forward-wildcard-not-supported
|
|
9232
9418
|
schema:
|
|
9233
9419
|
$ref: '#/components/schemas/Problem'
|
|
@@ -13709,11 +13895,6 @@ tags:
|
|
|
13709
13895
|
'
|
|
13710
13896
|
name: organization
|
|
13711
13897
|
x-displayName: Organizations
|
|
13712
|
-
- description: 'Endpoints for RDAP.
|
|
13713
|
-
|
|
13714
|
-
'
|
|
13715
|
-
name: rdap
|
|
13716
|
-
x-displayName: RDAP
|
|
13717
13898
|
- description: 'Endpoints for retrieving TLD specifications.
|
|
13718
13899
|
|
|
13719
13900
|
'
|
|
@@ -13742,7 +13923,6 @@ x-tagGroups:
|
|
|
13742
13923
|
- dns
|
|
13743
13924
|
- email_forward
|
|
13744
13925
|
- domain_forward
|
|
13745
|
-
- rdap
|
|
13746
13926
|
- domain_search
|
|
13747
13927
|
- archive
|
|
13748
13928
|
- jobs
|
package/src/schema.d.ts
CHANGED
|
@@ -475,7 +475,11 @@ export interface paths {
|
|
|
475
475
|
*/
|
|
476
476
|
get: operations["list_domain_forwards_v1_domain_forwards_get"];
|
|
477
477
|
put?: never;
|
|
478
|
-
|
|
478
|
+
/**
|
|
479
|
+
* Create a domain forward
|
|
480
|
+
* @description Creates a new domain forward configuration. Wildcard forwards can be created by using *.hostname (e.g., *.example.com).
|
|
481
|
+
*/
|
|
482
|
+
post: operations["create_domain_forward_v2_v1_domain_forwards_post"];
|
|
479
483
|
delete?: never;
|
|
480
484
|
options?: never;
|
|
481
485
|
head?: never;
|
|
@@ -500,8 +504,9 @@ export interface paths {
|
|
|
500
504
|
get: operations["get_domain_forward_v1_domain_forwards__hostname__get"];
|
|
501
505
|
put?: never;
|
|
502
506
|
/**
|
|
503
|
-
* Create a domain forward
|
|
504
|
-
* @
|
|
507
|
+
* Create a domain forward (deprecated)
|
|
508
|
+
* @deprecated
|
|
509
|
+
* @description **DEPRECATED**: Use POST /v1/domain-forwards instead. Creates a new domain forward configuration for the specified hostname.
|
|
505
510
|
*/
|
|
506
511
|
post: operations["create_domain_forward_v1_domain_forwards__hostname__post"];
|
|
507
512
|
/**
|
|
@@ -2655,6 +2660,18 @@ export interface components {
|
|
|
2655
2660
|
/** Wildcard */
|
|
2656
2661
|
wildcard: boolean;
|
|
2657
2662
|
};
|
|
2663
|
+
/** DomainForwardCreateRequest */
|
|
2664
|
+
DomainForwardCreateRequest: {
|
|
2665
|
+
/**
|
|
2666
|
+
* Enabled
|
|
2667
|
+
* @default false
|
|
2668
|
+
*/
|
|
2669
|
+
enabled: boolean;
|
|
2670
|
+
/** Hostname */
|
|
2671
|
+
hostname: string;
|
|
2672
|
+
http?: components["schemas"]["DomainForwardProtocolSetRequest"] | null;
|
|
2673
|
+
https?: components["schemas"]["DomainForwardProtocolSetRequest"] | null;
|
|
2674
|
+
};
|
|
2658
2675
|
/** DomainForwardPatchOp */
|
|
2659
2676
|
DomainForwardPatchOp: {
|
|
2660
2677
|
op: components["schemas"]["PatchOp"];
|
|
@@ -7346,6 +7363,104 @@ export interface operations {
|
|
|
7346
7363
|
};
|
|
7347
7364
|
};
|
|
7348
7365
|
};
|
|
7366
|
+
create_domain_forward_v2_v1_domain_forwards_post: {
|
|
7367
|
+
parameters: {
|
|
7368
|
+
query?: never;
|
|
7369
|
+
header?: never;
|
|
7370
|
+
path?: never;
|
|
7371
|
+
cookie?: never;
|
|
7372
|
+
};
|
|
7373
|
+
requestBody: {
|
|
7374
|
+
content: {
|
|
7375
|
+
"application/json": components["schemas"]["DomainForwardCreateRequest"];
|
|
7376
|
+
};
|
|
7377
|
+
};
|
|
7378
|
+
responses: {
|
|
7379
|
+
/** @description Domain forward created successfully */
|
|
7380
|
+
201: {
|
|
7381
|
+
headers: {
|
|
7382
|
+
[name: string]: unknown;
|
|
7383
|
+
};
|
|
7384
|
+
content: {
|
|
7385
|
+
"application/json": components["schemas"]["DomainForward"];
|
|
7386
|
+
};
|
|
7387
|
+
};
|
|
7388
|
+
/** @description Unauthorized */
|
|
7389
|
+
401: {
|
|
7390
|
+
headers: {
|
|
7391
|
+
[name: string]: unknown;
|
|
7392
|
+
};
|
|
7393
|
+
content: {
|
|
7394
|
+
/** @example {
|
|
7395
|
+
* "code": "ERROR_AUTHENTICATION",
|
|
7396
|
+
* "detail": "Additional error context.",
|
|
7397
|
+
* "status": 401,
|
|
7398
|
+
* "title": "Authentication Error",
|
|
7399
|
+
* "type": "authentication"
|
|
7400
|
+
* } */
|
|
7401
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
7402
|
+
};
|
|
7403
|
+
};
|
|
7404
|
+
/** @description Forbidden */
|
|
7405
|
+
403: {
|
|
7406
|
+
headers: {
|
|
7407
|
+
[name: string]: unknown;
|
|
7408
|
+
};
|
|
7409
|
+
content: {
|
|
7410
|
+
/** @example {
|
|
7411
|
+
* "code": "ERROR_PERMISSION_DENIED",
|
|
7412
|
+
* "detail": "Insufficient permissions to perform this action",
|
|
7413
|
+
* "status": 403,
|
|
7414
|
+
* "title": "Permission Denied",
|
|
7415
|
+
* "type": "permission-denied"
|
|
7416
|
+
* } */
|
|
7417
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
7418
|
+
};
|
|
7419
|
+
};
|
|
7420
|
+
/** @description DNS zone was not found */
|
|
7421
|
+
404: {
|
|
7422
|
+
headers: {
|
|
7423
|
+
[name: string]: unknown;
|
|
7424
|
+
};
|
|
7425
|
+
content: {
|
|
7426
|
+
/** @example {
|
|
7427
|
+
* "code": "ERROR_ZONE_NOT_FOUND",
|
|
7428
|
+
* "detail": "Zone not found",
|
|
7429
|
+
* "status": 404,
|
|
7430
|
+
* "title": "DNS Error",
|
|
7431
|
+
* "type": "dns-zone-not-found",
|
|
7432
|
+
* "zone_name": "Zone example.com. not found"
|
|
7433
|
+
* } */
|
|
7434
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
7435
|
+
};
|
|
7436
|
+
};
|
|
7437
|
+
/** @description Domain forward already exists */
|
|
7438
|
+
409: {
|
|
7439
|
+
headers: {
|
|
7440
|
+
[name: string]: unknown;
|
|
7441
|
+
};
|
|
7442
|
+
content: {
|
|
7443
|
+
/** @example {
|
|
7444
|
+
* "code": "ERROR_DOMAIN_FORWARD_ALREADY_EXISTS",
|
|
7445
|
+
* "detail": "Domain forward already exists for example.com.",
|
|
7446
|
+
* "status": 409,
|
|
7447
|
+
* "title": "Domain Forward Error",
|
|
7448
|
+
* "type": "domain-forward-already-exists"
|
|
7449
|
+
* } */
|
|
7450
|
+
"application/problem+json": components["schemas"]["Problem"];
|
|
7451
|
+
};
|
|
7452
|
+
};
|
|
7453
|
+
/** @description Validation Error */
|
|
7454
|
+
422: {
|
|
7455
|
+
headers: {
|
|
7456
|
+
[name: string]: unknown;
|
|
7457
|
+
};
|
|
7458
|
+
content: {
|
|
7459
|
+
"application/problem+json": components["schemas"]["HTTPValidationError"];
|
|
7460
|
+
};
|
|
7461
|
+
};
|
|
7462
|
+
};
|
|
7463
|
+
};
|
|
7349
7464
|
patch_redirects_v1_domain_forwards_patch: {
|
|
7350
7465
|
parameters: {
|
|
7351
7466
|
query?: never;
|
|
@@ -7748,10 +7863,7 @@ export interface operations {
|
|
|
7748
7863
|
};
|
|
7749
7864
|
enable_domain_forward_v1_domain_forwards__hostname__enable_patch: {
|
|
7750
7865
|
parameters: {
|
|
7751
|
-
query?:
|
|
7752
|
-
/** @description Wildcard domain forwarding */
|
|
7753
|
-
wildcard?: boolean;
|
|
7754
|
-
};
|
|
7866
|
+
query?: never;
|
|
7755
7867
|
header?: never;
|
|
7756
7868
|
path: {
|
|
7757
7869
|
/** @description Hostname */
|
|
@@ -7778,7 +7890,7 @@ export interface operations {
|
|
|
7778
7890
|
* "code": "ERROR_DOMAIN_FORWARD_WILDCARD_NOT_SUPPORTED",
|
|
7779
7891
|
* "detail": "Additional error context.",
|
|
7780
7892
|
* "status": 400,
|
|
7781
|
-
* "title": "Wildcard Not Supported",
|
|
7893
|
+
* "title": "HTTPS Wildcard Not Supported",
|
|
7782
7894
|
* "type": "domain-forward-wildcard-not-supported"
|
|
7783
7895
|
* } */
|
|
7784
7896
|
"application/problem+json": components["schemas"]["Problem"];
|