@opusdns/api 0.121.0 → 0.123.0

package/src/helpers/responses.d.ts

@@ -34,7 +34,7 @@
 
 import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
 
-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';
+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, RequestAuthcode2, 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';
 
 /**
  * Response types for GET ArchiveEmailForwardLogsAliasesByEmailForwardAliasId endpoint
@@ -2541,6 +2541,134 @@ export type PATCH_DomainForwards_Response_404 = Problem
  */
 export type PATCH_DomainForwards_Response_422 = HTTPValidationError
 
+/**
+ * Response types for POST DomainForwards endpoint
+ *
+ * Create a domain forward
+ * Creates a new domain forward configuration. Wildcard forwards can be created by using *.hostname (e.g., *.example.com).
+ *
+ * @remarks
+ * This type defines all possible response structures for the POST DomainForwards endpoint.
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
+ * Use this type to ensure type safety when handling API responses from this endpoint.
+ *
+
+ *
+ * @path /v1/domain-forwards
+ *
+ * @see {@link POST_DomainForwards_Response_201} - 201 response type
+ * @see {@link POST_DomainForwards_Response_401} - 401 response type
+ * @see {@link POST_DomainForwards_Response_403} - 403 response type
+ * @see {@link POST_DomainForwards_Response_404} - 404 response type
+ * @see {@link POST_DomainForwards_Response_409} - 409 response type
+ * @see {@link POST_DomainForwards_Response_422} - 422 response type
+ *
+
+ */
+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;
+
+/**
+ * 201 response for POST DomainForwards endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 201 status code
+ * of the POST DomainForwards endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domain-forwards
+ *
+ * @see {@link POST_DomainForwards_Response} - The main response type definition
+ * @see {@link DomainForward} - The actual schema type definition
+ */
+export type POST_DomainForwards_Response_201 = DomainForward
+
+/**
+ * 401 response for POST DomainForwards endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 401 status code
+ * of the POST DomainForwards endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domain-forwards
+ *
+ * @see {@link POST_DomainForwards_Response} - The main response type definition
+ * @see {@link Problem} - The actual schema type definition
+ */
+export type POST_DomainForwards_Response_401 = Problem
+
+/**
+ * 403 response for POST DomainForwards endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 403 status code
+ * of the POST DomainForwards endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domain-forwards
+ *
+ * @see {@link POST_DomainForwards_Response} - The main response type definition
+ * @see {@link Problem} - The actual schema type definition
+ */
+export type POST_DomainForwards_Response_403 = Problem
+
+/**
+ * 404 response for POST DomainForwards endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 404 status code
+ * of the POST DomainForwards endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domain-forwards
+ *
+ * @see {@link POST_DomainForwards_Response} - The main response type definition
+ * @see {@link Problem} - The actual schema type definition
+ */
+export type POST_DomainForwards_Response_404 = Problem
+
+/**
+ * 409 response for POST DomainForwards endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 409 status code
+ * of the POST DomainForwards endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domain-forwards
+ *
+ * @see {@link POST_DomainForwards_Response} - The main response type definition
+ * @see {@link Problem} - The actual schema type definition
+ */
+export type POST_DomainForwards_Response_409 = Problem
+
+/**
+ * 422 response for POST DomainForwards endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 status code
+ * of the POST DomainForwards endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domain-forwards
+ *
+ * @see {@link POST_DomainForwards_Response} - The main response type definition
+ * @see {@link HTTPValidationError} - The actual schema type definition
+ */
+export type POST_DomainForwards_Response_422 = HTTPValidationError
+
 /**
  * Response types for DELETE DomainForwardsByHostname endpoint
  *
@@ -2757,8 +2885,8 @@ export type GET_DomainForwardsByHostname_Response_422 = HTTPValidationError
 /**
  * Response types for POST DomainForwardsByHostname endpoint
  *
- * Create a domain forward
- * Creates a new domain forward configuration for the specified hostname
+ * Create a domain forward (deprecated)
+ * **DEPRECATED**: Use POST /v1/domain-forwards instead. Creates a new domain forward configuration for the specified hostname.
  *
  * @remarks
  * This type defines all possible response structures for the POST DomainForwardsByHostname endpoint.
@@ -3446,7 +3574,6 @@ export type PATCH_DomainForwardsByHostnameDisable_Response_422 = HTTPValidationE
  *
  * @path /v1/domain-forwards/{hostname}/enable
  * @param hostname (path) - Hostname
- * @param wildcard (query) - Wildcard domain forwarding
  *
  * @see {@link PATCH_DomainForwardsByHostnameEnable_Response_400} - 400 response type
  * @see {@link PATCH_DomainForwardsByHostnameEnable_Response_401} - 401 response type
@@ -3469,7 +3596,6 @@ export type PATCH_DomainForwardsByHostnameEnable_Response = PATCH_DomainForwards
  *
  * @path /v1/domain-forwards/{hostname}/enable
  * @param hostname (path) - Hostname
- * @param wildcard (query) - Wildcard domain forwarding
  *
  * @see {@link PATCH_DomainForwardsByHostnameEnable_Response} - The main response type definition
  * @see {@link Problem} - The actual schema type definition
@@ -3488,7 +3614,6 @@ export type PATCH_DomainForwardsByHostnameEnable_Response_400 = Problem
  *
  * @path /v1/domain-forwards/{hostname}/enable
  * @param hostname (path) - Hostname
- * @param wildcard (query) - Wildcard domain forwarding
  *
  * @see {@link PATCH_DomainForwardsByHostnameEnable_Response} - The main response type definition
  * @see {@link Problem} - The actual schema type definition
@@ -3507,7 +3632,6 @@ export type PATCH_DomainForwardsByHostnameEnable_Response_401 = Problem
  *
  * @path /v1/domain-forwards/{hostname}/enable
  * @param hostname (path) - Hostname
- * @param wildcard (query) - Wildcard domain forwarding
  *
  * @see {@link PATCH_DomainForwardsByHostnameEnable_Response} - The main response type definition
  * @see {@link Problem} - The actual schema type definition
@@ -3526,7 +3650,6 @@ export type PATCH_DomainForwardsByHostnameEnable_Response_403 = Problem
  *
  * @path /v1/domain-forwards/{hostname}/enable
  * @param hostname (path) - Hostname
- * @param wildcard (query) - Wildcard domain forwarding
  *
  * @see {@link PATCH_DomainForwardsByHostnameEnable_Response} - The main response type definition
  * @see {@link HTTPValidationError} - The actual schema type definition
@@ -4896,6 +5019,97 @@ export type POST_DomainsTldSpecificDeByDomainReferenceTransit_Response_404 = Pro
  */
 export type POST_DomainsTldSpecificDeByDomainReferenceTransit_Response_422 = HTTPValidationError
 
+/**
+ * Response types for POST DomainsTldSpecificEuByDomainReferenceAuthCodeRequest endpoint
+ *
+ * Requests your auth code directly from EURid (registry)
+ *
+ * @remarks
+ * This type defines all possible response structures for the POST DomainsTldSpecificEuByDomainReferenceAuthCodeRequest endpoint.
+ * Each response code maps to a specific response type as defined in the OpenAPI specification.
+ * Use this type to ensure type safety when handling API responses from this endpoint.
+ *
+
+ *
+ * @path /v1/domains/tld-specific/eu/{domain_reference}/auth_code/request
+ *
+ * @see {@link POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response_200} - 200 response type
+ * @see {@link POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response_400} - 400 response type
+ * @see {@link POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response_404} - 404 response type
+ * @see {@link POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response_422} - 422 response type
+ *
+
+ */
+export type POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response = POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response_200 | POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response_400 | POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response_404 | POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response_422;
+
+/**
+ * 200 response for POST DomainsTldSpecificEuByDomainReferenceAuthCodeRequest endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 200 status code
+ * of the POST DomainsTldSpecificEuByDomainReferenceAuthCodeRequest endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domains/tld-specific/eu/{domain_reference}/auth_code/request
+ *
+ * @see {@link POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response} - The main response type definition
+ * @see {@link RequestAuthcode2} - The actual schema type definition
+ */
+export type POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response_200 = RequestAuthcode2
+
+/**
+ * 400 response for POST DomainsTldSpecificEuByDomainReferenceAuthCodeRequest endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 400 status code
+ * of the POST DomainsTldSpecificEuByDomainReferenceAuthCodeRequest endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domains/tld-specific/eu/{domain_reference}/auth_code/request
+ *
+ * @see {@link POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response} - The main response type definition
+ * @see {@link Problem} - The actual schema type definition
+ */
+export type POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response_400 = Problem
+
+/**
+ * 404 response for POST DomainsTldSpecificEuByDomainReferenceAuthCodeRequest endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 404 status code
+ * of the POST DomainsTldSpecificEuByDomainReferenceAuthCodeRequest endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domains/tld-specific/eu/{domain_reference}/auth_code/request
+ *
+ * @see {@link POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response} - The main response type definition
+ * @see {@link Problem} - The actual schema type definition
+ */
+export type POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response_404 = Problem
+
+/**
+ * 422 response for POST DomainsTldSpecificEuByDomainReferenceAuthCodeRequest endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 status code
+ * of the POST DomainsTldSpecificEuByDomainReferenceAuthCodeRequest endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domains/tld-specific/eu/{domain_reference}/auth_code/request
+ *
+ * @see {@link POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response} - The main response type definition
+ * @see {@link HTTPValidationError} - The actual schema type definition
+ */
+export type POST_DomainsTldSpecificEuByDomainReferenceAuthCodeRequest_Response_422 = HTTPValidationError
+
 /**
  * Response types for POST DomainsTransfer endpoint
  *

package/src/helpers/schemas.d.ts

@@ -1034,6 +1034,22 @@ export type DomainDnssecData = components['schemas']['DomainDnssecDataResponse']
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type DomainForward = components['schemas']['DomainForward'];
+/**
+ * DomainForwardCreateRequest
+ *
+ * @remarks
+ * Type alias for the `DomainForwardCreateRequest` OpenAPI schema.
+ * This type represents domainforwardcreaterequest data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getDomainForwardCreateRequest();
+ * const item: DomainForwardCreateRequest = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type DomainForwardCreateRequest = components['schemas']['DomainForwardCreateRequest'];
 /**
  * DomainForwardPatchOp
  *
@@ -3119,22 +3135,6 @@ export type RelationSet = components['schemas']['RelationSet'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type RenewalMode = components['schemas']['RenewalMode'];
-/**
- * RequestAuthcodeResponse
- *
- * @remarks
- * Type alias for the `RequestAuthcodeResponse` OpenAPI schema.
- * This type represents requestauthcoderesponse data structures used in API requests and responses.
- *
- * @example
- * ```typescript
- * const response = await api.getRequestAuthcode();
- * const item: RequestAuthcode = response.results;
- * ```
- *
- * @see {@link components} - The OpenAPI components schema definition
- */
-export type RequestAuthcode = components['schemas']['RequestAuthcodeResponse'];
 /**
  * RequestHistory
  *
@@ -3615,6 +3615,38 @@ export type WildcardHttpRedirectRequest = components['schemas']['WildcardHttpRed
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type ZoneSortField = components['schemas']['ZoneSortField'];
+/**
+ * RequestAuthcodeResponse
+ *
+ * @remarks
+ * Type alias for the `api__domain__tld_specific__be__models__RequestAuthcodeResponse` OpenAPI schema.
+ * This type represents requestauthcoderesponse data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getRequestAuthcode();
+ * const item: RequestAuthcode = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type RequestAuthcode = components['schemas']['api__domain__tld_specific__be__models__RequestAuthcodeResponse'];
+/**
+ * RequestAuthcodeResponse
+ *
+ * @remarks
+ * Type alias for the `api__domain__tld_specific__eu__models__RequestAuthcodeResponse` OpenAPI schema.
+ * This type represents requestauthcoderesponse data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getRequestAuthcode2();
+ * const item: RequestAuthcode2 = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type RequestAuthcode2 = components['schemas']['api__domain__tld_specific__eu__models__RequestAuthcodeResponse'];
 /**
  * DomainAvailabilityResponse
  *