@opusdns/api 0.89.0 → 0.91.0

package/src/helpers/responses.d.ts

@@ -34,7 +34,7 @@
 
 import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
 
-import { Problem, HTTPValidationError, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DnsZoneSummary, DomainForward, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, Pagination_EmailForwardAlias, 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 { Problem, HTTPValidationError, DomainAvailabilityList, Pagination_ContactSchema, ContactSchema, ContactVerification, Contact, Pagination_DnsZone, DnsZone, DnsChanges, DnsZoneSummary, Pagination_DomainForwardZone, DomainForward, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, Pagination_EmailForwardAlias, 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 POST AuthToken endpoint
@@ -1661,6 +1661,116 @@ export type GET_DnsSummary_Response = GET_DnsSummary_Response_200;
  */
 export type GET_DnsSummary_Response_200 = DnsZoneSummary
 
+/**
+ * Response types for GET DomainForwards endpoint
+ *
+ * List Domain Forwards
+ *
+ * @remarks
+ * This type defines all possible response structures for the GET 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 GET_DomainForwards_Response_200} - 200 response type
+ * @see {@link GET_DomainForwards_Response_422} - 422 response type
+ *
+
+ */
+export type GET_DomainForwards_Response = GET_DomainForwards_Response_200 | GET_DomainForwards_Response_422;
+
+/**
+ * 200 response for GET DomainForwards endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 200 status code
+ * of the GET DomainForwards endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domain-forwards
+ *
+ * @see {@link GET_DomainForwards_Response} - The main response type definition
+ * @see {@link Pagination_DomainForwardZone} - The actual schema type definition
+ */
+export type GET_DomainForwards_Response_200 = Pagination_DomainForwardZone
+
+/**
+ * 422 response for GET DomainForwards endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 status code
+ * of the GET DomainForwards endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domain-forwards
+ *
+ * @see {@link GET_DomainForwards_Response} - The main response type definition
+ * @see {@link HTTPValidationError} - The actual schema type definition
+ */
+export type GET_DomainForwards_Response_422 = HTTPValidationError
+
+/**
+ * Response types for PATCH DomainForwards endpoint
+ *
+ * Patch Redirects
+ *
+ * @remarks
+ * This type defines all possible response structures for the PATCH 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 PATCH_DomainForwards_Response_404} - 404 response type
+ * @see {@link PATCH_DomainForwards_Response_422} - 422 response type
+ *
+
+ */
+export type PATCH_DomainForwards_Response = PATCH_DomainForwards_Response_404 | PATCH_DomainForwards_Response_422;
+
+/**
+ * 404 response for PATCH DomainForwards endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 404 status code
+ * of the PATCH DomainForwards endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domain-forwards
+ *
+ * @see {@link PATCH_DomainForwards_Response} - The main response type definition
+ * @see {@link Problem} - The actual schema type definition
+ */
+export type PATCH_DomainForwards_Response_404 = Problem
+
+/**
+ * 422 response for PATCH DomainForwards endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 status code
+ * of the PATCH DomainForwards endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domain-forwards
+ *
+ * @see {@link PATCH_DomainForwards_Response} - The main response type definition
+ * @see {@link HTTPValidationError} - The actual schema type definition
+ */
+export type PATCH_DomainForwards_Response_422 = HTTPValidationError
+
 /**
  * Response types for DELETE DomainForwardsByZoneNameByRequestProtocol endpoint
  *
@@ -1676,11 +1786,30 @@ export type GET_DnsSummary_Response_200 = DnsZoneSummary
  * @path /v1/domain-forwards/{zone_name}/{request_protocol}
  * @param zone_name (path) - DNS zone name (trailing dot optional)
  *
+ * @see {@link DELETE_DomainForwardsByZoneNameByRequestProtocol_Response_404} - 404 response type
  * @see {@link DELETE_DomainForwardsByZoneNameByRequestProtocol_Response_422} - 422 response type
  *
 
  */
-export type DELETE_DomainForwardsByZoneNameByRequestProtocol_Response = DELETE_DomainForwardsByZoneNameByRequestProtocol_Response_422;
+export type DELETE_DomainForwardsByZoneNameByRequestProtocol_Response = DELETE_DomainForwardsByZoneNameByRequestProtocol_Response_404 | DELETE_DomainForwardsByZoneNameByRequestProtocol_Response_422;
+
+/**
+ * 404 response for DELETE DomainForwardsByZoneNameByRequestProtocol endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 404 status code
+ * of the DELETE DomainForwardsByZoneNameByRequestProtocol endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domain-forwards/{zone_name}/{request_protocol}
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
+ *
+ * @see {@link DELETE_DomainForwardsByZoneNameByRequestProtocol_Response} - The main response type definition
+ * @see {@link Problem} - The actual schema type definition
+ */
+export type DELETE_DomainForwardsByZoneNameByRequestProtocol_Response_404 = Problem
 
 /**
  * 422 response for DELETE DomainForwardsByZoneNameByRequestProtocol endpoint
@@ -1851,12 +1980,12 @@ export type POST_DomainForwardsByZoneNameByRequestProtocol_Response_422 = HTTPVa
  * @param zone_name (path) - DNS zone name (trailing dot optional)
  *
  * @see {@link PUT_DomainForwardsByZoneNameByRequestProtocol_Response_200} - 200 response type
- * @see {@link PUT_DomainForwardsByZoneNameByRequestProtocol_Response_409} - 409 response type
+ * @see {@link PUT_DomainForwardsByZoneNameByRequestProtocol_Response_404} - 404 response type
  * @see {@link PUT_DomainForwardsByZoneNameByRequestProtocol_Response_422} - 422 response type
  *
 
  */
-export type PUT_DomainForwardsByZoneNameByRequestProtocol_Response = PUT_DomainForwardsByZoneNameByRequestProtocol_Response_200 | PUT_DomainForwardsByZoneNameByRequestProtocol_Response_409 | PUT_DomainForwardsByZoneNameByRequestProtocol_Response_422;
+export type PUT_DomainForwardsByZoneNameByRequestProtocol_Response = PUT_DomainForwardsByZoneNameByRequestProtocol_Response_200 | PUT_DomainForwardsByZoneNameByRequestProtocol_Response_404 | PUT_DomainForwardsByZoneNameByRequestProtocol_Response_422;
 
 /**
  * 200 response for PUT DomainForwardsByZoneNameByRequestProtocol endpoint
@@ -1877,10 +2006,10 @@ export type PUT_DomainForwardsByZoneNameByRequestProtocol_Response = PUT_DomainF
 export type PUT_DomainForwardsByZoneNameByRequestProtocol_Response_200 = DomainForward
 
 /**
- * 409 response for PUT DomainForwardsByZoneNameByRequestProtocol endpoint
+ * 404 response for PUT DomainForwardsByZoneNameByRequestProtocol endpoint
  *
  * @remarks
- * This type defines the response structure for the 409 status code
+ * This type defines the response structure for the 404 status code
  * of the PUT DomainForwardsByZoneNameByRequestProtocol endpoint.
  * It provides type safety for handling this specific response as defined in the OpenAPI specification.
  *
@@ -1892,7 +2021,7 @@ export type PUT_DomainForwardsByZoneNameByRequestProtocol_Response_200 = DomainF
  * @see {@link PUT_DomainForwardsByZoneNameByRequestProtocol_Response} - The main response type definition
  * @see {@link Problem} - The actual schema type definition
  */
-export type PUT_DomainForwardsByZoneNameByRequestProtocol_Response_409 = Problem
+export type PUT_DomainForwardsByZoneNameByRequestProtocol_Response_404 = Problem
 
 /**
  * 422 response for PUT DomainForwardsByZoneNameByRequestProtocol endpoint

package/src/helpers/schemas-arrays.d.ts

@@ -21,7 +21,7 @@
  * This file is auto-generated from the OpenAPI specification.
  * Do not edit manually.
  */
-import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, RegistryHandleAttributeType, ContactAttributeDefinition, ContactRoleAttributeRequirement, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, HttpRedirect, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, Domain, EmailForwardAlias, EventResponse, Invoice, Organization, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
+import { DomainDnssecData, DomainDnssecDataCreate, OrganizationAttribute, OrganizationAttributeUpdate, IpRestriction, TldResponseShort, RegistryHandleAttributeType, ContactAttributeDefinition, ContactRoleAttributeRequirement, PostalAddressType, ContactConfigBase, DnsChange, DnsRecordCreate, DnsRecord, DnsRrsetCreate, DnsRecordPatchOp, DnsRrset, DnsRrsetPatchOp, DomainAvailabilityCheck, ContactHandle, Nameserver, HttpRedirect, DomainForwardPatchOp, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, DomainForwardZone, Domain, EmailForwardAlias, EventResponse, Invoice, Organization, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
 
 /**
  * DomainDnssecDataResponse
@@ -331,6 +331,20 @@ export type NameserverArray = Nameserver[];
  * @see {@link HttpRedirect} - The individual HttpRedirect type definition
  */
 export type HttpRedirectArray = HttpRedirect[];
+/**
+ * DomainForwardPatchOp
+ *
+ * @remarks
+ * Array type for DomainForwardPatchOp objects. Used when the API returns a collection of DomainForwardPatchOp instances.
+ *
+ * @example
+ * ```typescript
+ * const items: DomainForwardPatchOpArray = await api.getDomainForwardPatchOps();
+ * ```
+ *
+ * @see {@link DomainForwardPatchOp} - The individual DomainForwardPatchOp type definition
+ */
+export type DomainForwardPatchOpArray = DomainForwardPatchOp[];
 /**
  * DeletePolicyType
  *
@@ -583,6 +597,20 @@ export type ContactSchemaArray = ContactSchema[];
  * @see {@link DnsZone} - The individual DnsZoneResponse type definition
  */
 export type DnsZoneArray = DnsZone[];
+/**
+ * DomainForwardZone
+ *
+ * @remarks
+ * Array type for DomainForwardZone objects. Used when the API returns a collection of DomainForwardZone instances.
+ *
+ * @example
+ * ```typescript
+ * const items: DomainForwardZoneArray = await api.getDomainForwardZones();
+ * ```
+ *
+ * @see {@link DomainForwardZone} - The individual DomainForwardZone type definition
+ */
+export type DomainForwardZoneArray = DomainForwardZone[];
 /**
  * DomainResponse
  *

package/src/helpers/schemas.d.ts

@@ -1034,6 +1034,54 @@ export type DomainDnssecData = components['schemas']['DomainDnssecDataResponse']
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type DomainForward = components['schemas']['DomainForward'];
+/**
+ * DomainForwardPatchOp
+ *
+ * @remarks
+ * Type alias for the `DomainForwardPatchOp` OpenAPI schema.
+ * This type represents domainforwardpatchop data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getDomainForwardPatchOp();
+ * const item: DomainForwardPatchOp = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type DomainForwardPatchOp = components['schemas']['DomainForwardPatchOp'];
+/**
+ * DomainForwardPatchOps
+ *
+ * @remarks
+ * Type alias for the `DomainForwardPatchOps` OpenAPI schema.
+ * This type represents domainforwardpatchops data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getDomainForwardPatchOps();
+ * const item: DomainForwardPatchOps = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type DomainForwardPatchOps = components['schemas']['DomainForwardPatchOps'];
+/**
+ * DomainForwardProtocols
+ *
+ * @remarks
+ * Type alias for the `DomainForwardProtocols` OpenAPI schema.
+ * This type represents domainforwardprotocols data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getDomainForwardProtocols();
+ * const item: DomainForwardProtocols = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type DomainForwardProtocols = components['schemas']['DomainForwardProtocols'];
 /**
  * DomainForwardRequest
  *
@@ -1050,6 +1098,22 @@ export type DomainForward = components['schemas']['DomainForward'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type DomainForwardRequest = components['schemas']['DomainForwardRequest'];
+/**
+ * DomainForwardZone
+ *
+ * @remarks
+ * Type alias for the `DomainForwardZone` OpenAPI schema.
+ * This type represents domainforwardzone data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getDomainForwardZone();
+ * const item: DomainForwardZone = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type DomainForwardZone = components['schemas']['DomainForwardZone'];
 /**
  * DomainLifecycleBase
  *
@@ -1626,6 +1690,22 @@ export type HttpProtocol = components['schemas']['HttpProtocol'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type HttpRedirect = components['schemas']['HttpRedirect'];
+/**
+ * HttpRedirectRemove
+ *
+ * @remarks
+ * Type alias for the `HttpRedirectRemove` OpenAPI schema.
+ * This type represents httpredirectremove data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getHttpRedirectRemove();
+ * const item: HttpRedirectRemove = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type HttpRedirectRemove = components['schemas']['HttpRedirectRemove'];
 /**
  * IdnBase
  *
@@ -2095,6 +2175,22 @@ export type Pagination_ContactSchema = components['schemas']['Pagination_Contact
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type Pagination_DnsZone = components['schemas']['Pagination_DnsZoneResponse_'];
+/**
+ * Pagination[DomainForwardZone]
+ *
+ * @remarks
+ * Type alias for the `Pagination_DomainForwardZone_` OpenAPI schema.
+ * This type represents pagination[domainforwardzone] data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getPagination_DomainForwardZone();
+ * const item: Pagination_DomainForwardZone = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type Pagination_DomainForwardZone = components['schemas']['Pagination_DomainForwardZone_'];
 /**
  * Pagination[DomainResponse]
  *
@@ -2431,6 +2527,22 @@ export type PricingPeriod = components['schemas']['PricingPeriod'];
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type Problem = components['schemas']['Problem'];
+/**
+ * ProtocolRedirects
+ *
+ * @remarks
+ * Type alias for the `ProtocolRedirects` OpenAPI schema.
+ * This type represents protocolredirects data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getProtocolRedirects();
+ * const item: ProtocolRedirects = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type ProtocolRedirects = components['schemas']['ProtocolRedirects'];
 /**
  * PublicAuthRequestForm
  *