@opusdns/api 0.82.0 → 0.84.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, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, Pagination_EmailForwardAlias, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, 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_Redirect, DomainSearch, Pagination_Domain, Domain, DomainRenew, DomainRestore, DomainCheck, DomainSummary, Pagination_EmailForwardAlias, EmailForwardAlias, Pagination_Event, EventSchema, Pagination_Organization, Organization, OrganizationWithBillingData, 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,334 @@ export type GET_DnsSummary_Response = GET_DnsSummary_Response_200;
  */
 export type GET_DnsSummary_Response_200 = DnsZoneSummary
 
+/**
+ * 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_422} - 422 response type
+ *
+
+ */
+export type PATCH_DomainForwards_Response = PATCH_DomainForwards_Response_422;
+
+/**
+ * 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 DomainForwardsByZoneName endpoint
+ *
+ * Delete Redirects
+ *
+ * @remarks
+ * This type defines all possible response structures for the DELETE DomainForwardsByZoneName 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/{zone_name}
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
+ *
+ * @see {@link DELETE_DomainForwardsByZoneName_Response_422} - 422 response type
+ *
+
+ */
+export type DELETE_DomainForwardsByZoneName_Response = DELETE_DomainForwardsByZoneName_Response_422;
+
+/**
+ * 422 response for DELETE DomainForwardsByZoneName endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 status code
+ * of the DELETE DomainForwardsByZoneName endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domain-forwards/{zone_name}
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
+ *
+ * @see {@link DELETE_DomainForwardsByZoneName_Response} - The main response type definition
+ * @see {@link HTTPValidationError} - The actual schema type definition
+ */
+export type DELETE_DomainForwardsByZoneName_Response_422 = HTTPValidationError
+
+/**
+ * Response types for GET DomainForwardsByZoneName endpoint
+ *
+ * Get Redirects
+ *
+ * @remarks
+ * This type defines all possible response structures for the GET DomainForwardsByZoneName 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/{zone_name}
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
+ *
+ * @see {@link GET_DomainForwardsByZoneName_Response_200} - 200 response type
+ * @see {@link GET_DomainForwardsByZoneName_Response_422} - 422 response type
+ *
+
+ */
+export type GET_DomainForwardsByZoneName_Response = GET_DomainForwardsByZoneName_Response_200 | GET_DomainForwardsByZoneName_Response_422;
+
+/**
+ * 200 response for GET DomainForwardsByZoneName endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 200 status code
+ * of the GET DomainForwardsByZoneName endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domain-forwards/{zone_name}
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
+ *
+ * @see {@link GET_DomainForwardsByZoneName_Response} - The main response type definition
+ * @see {@link Pagination_Redirect} - The actual schema type definition
+ */
+export type GET_DomainForwardsByZoneName_Response_200 = Pagination_Redirect
+
+/**
+ * 422 response for GET DomainForwardsByZoneName endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 status code
+ * of the GET DomainForwardsByZoneName endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domain-forwards/{zone_name}
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
+ *
+ * @see {@link GET_DomainForwardsByZoneName_Response} - The main response type definition
+ * @see {@link HTTPValidationError} - The actual schema type definition
+ */
+export type GET_DomainForwardsByZoneName_Response_422 = HTTPValidationError
+
+/**
+ * Response types for POST DomainForwardsByZoneName endpoint
+ *
+ * Create Redirects
+ *
+ * @remarks
+ * This type defines all possible response structures for the POST DomainForwardsByZoneName 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/{zone_name}
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
+ *
+ * @see {@link POST_DomainForwardsByZoneName_Response_409} - 409 response type
+ * @see {@link POST_DomainForwardsByZoneName_Response_422} - 422 response type
+ *
+
+ */
+export type POST_DomainForwardsByZoneName_Response = POST_DomainForwardsByZoneName_Response_409 | POST_DomainForwardsByZoneName_Response_422;
+
+/**
+ * 409 response for POST DomainForwardsByZoneName endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 409 status code
+ * of the POST DomainForwardsByZoneName endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domain-forwards/{zone_name}
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
+ *
+ * @see {@link POST_DomainForwardsByZoneName_Response} - The main response type definition
+ * @see {@link Problem} - The actual schema type definition
+ */
+export type POST_DomainForwardsByZoneName_Response_409 = Problem
+
+/**
+ * 422 response for POST DomainForwardsByZoneName endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 status code
+ * of the POST DomainForwardsByZoneName endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domain-forwards/{zone_name}
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
+ *
+ * @see {@link POST_DomainForwardsByZoneName_Response} - The main response type definition
+ * @see {@link HTTPValidationError} - The actual schema type definition
+ */
+export type POST_DomainForwardsByZoneName_Response_422 = HTTPValidationError
+
+/**
+ * Response types for PUT DomainForwardsByZoneName endpoint
+ *
+ * Update Redirects
+ *
+ * @remarks
+ * This type defines all possible response structures for the PUT DomainForwardsByZoneName 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/{zone_name}
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
+ *
+ * @see {@link PUT_DomainForwardsByZoneName_Response_409} - 409 response type
+ * @see {@link PUT_DomainForwardsByZoneName_Response_422} - 422 response type
+ *
+
+ */
+export type PUT_DomainForwardsByZoneName_Response = PUT_DomainForwardsByZoneName_Response_409 | PUT_DomainForwardsByZoneName_Response_422;
+
+/**
+ * 409 response for PUT DomainForwardsByZoneName endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 409 status code
+ * of the PUT DomainForwardsByZoneName endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domain-forwards/{zone_name}
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
+ *
+ * @see {@link PUT_DomainForwardsByZoneName_Response} - The main response type definition
+ * @see {@link Problem} - The actual schema type definition
+ */
+export type PUT_DomainForwardsByZoneName_Response_409 = Problem
+
+/**
+ * 422 response for PUT DomainForwardsByZoneName endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 status code
+ * of the PUT DomainForwardsByZoneName endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domain-forwards/{zone_name}
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
+ *
+ * @see {@link PUT_DomainForwardsByZoneName_Response} - The main response type definition
+ * @see {@link HTTPValidationError} - The actual schema type definition
+ */
+export type PUT_DomainForwardsByZoneName_Response_422 = HTTPValidationError
+
+/**
+ * Response types for PATCH DomainForwardsByZoneNameDisable endpoint
+ *
+ * Disable Domain Forward
+ *
+ * @remarks
+ * This type defines all possible response structures for the PATCH DomainForwardsByZoneNameDisable 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/{zone_name}/disable
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
+ *
+ * @see {@link PATCH_DomainForwardsByZoneNameDisable_Response_422} - 422 response type
+ *
+
+ */
+export type PATCH_DomainForwardsByZoneNameDisable_Response = PATCH_DomainForwardsByZoneNameDisable_Response_422;
+
+/**
+ * 422 response for PATCH DomainForwardsByZoneNameDisable endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 status code
+ * of the PATCH DomainForwardsByZoneNameDisable endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domain-forwards/{zone_name}/disable
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
+ *
+ * @see {@link PATCH_DomainForwardsByZoneNameDisable_Response} - The main response type definition
+ * @see {@link HTTPValidationError} - The actual schema type definition
+ */
+export type PATCH_DomainForwardsByZoneNameDisable_Response_422 = HTTPValidationError
+
+/**
+ * Response types for PATCH DomainForwardsByZoneNameEnable endpoint
+ *
+ * Enable Domain Forward
+ *
+ * @remarks
+ * This type defines all possible response structures for the PATCH DomainForwardsByZoneNameEnable 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/{zone_name}/enable
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
+ *
+ * @see {@link PATCH_DomainForwardsByZoneNameEnable_Response_422} - 422 response type
+ *
+
+ */
+export type PATCH_DomainForwardsByZoneNameEnable_Response = PATCH_DomainForwardsByZoneNameEnable_Response_422;
+
+/**
+ * 422 response for PATCH DomainForwardsByZoneNameEnable endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 status code
+ * of the PATCH DomainForwardsByZoneNameEnable endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/domain-forwards/{zone_name}/enable
+ * @param zone_name (path) - DNS zone name (trailing dot optional)
+ *
+ * @see {@link PATCH_DomainForwardsByZoneNameEnable_Response} - The main response type definition
+ * @see {@link HTTPValidationError} - The actual schema type definition
+ */
+export type PATCH_DomainForwardsByZoneNameEnable_Response_422 = HTTPValidationError
+
 /**
  * Response types for GET DomainSearchSuggest 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, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, Domain, EmailForwardAlias, EventResponse, 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, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, Domain, EmailForwardAlias, EventResponse, Organization, Redirect, Period, Permission, PremiumAffectsType, RedirectPatchOp, RedirectUpdate, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
 
 /**
  * DomainDnssecDataResponse
@@ -625,6 +625,20 @@ export type EventResponseArray = EventResponse[];
  * @see {@link Organization} - The individual Organization type definition
  */
 export type OrganizationArray = Organization[];
+/**
+ * Redirect
+ *
+ * @remarks
+ * Array type for Redirect objects. Used when the API returns a collection of Redirect instances.
+ *
+ * @example
+ * ```typescript
+ * const items: RedirectArray = await api.getRedirects();
+ * ```
+ *
+ * @see {@link Redirect} - The individual Redirect type definition
+ */
+export type RedirectArray = Redirect[];
 /**
  * Period
  *
@@ -667,6 +681,34 @@ export type PermissionArray = Permission[];
  * @see {@link PremiumAffectsType} - The individual PremiumAffectsType type definition
  */
 export type PremiumAffectsTypeArray = PremiumAffectsType[];
+/**
+ * RedirectPatchOp
+ *
+ * @remarks
+ * Array type for RedirectPatchOp objects. Used when the API returns a collection of RedirectPatchOp instances.
+ *
+ * @example
+ * ```typescript
+ * const items: RedirectPatchOpArray = await api.getRedirectPatchOps();
+ * ```
+ *
+ * @see {@link RedirectPatchOp} - The individual RedirectPatchOp type definition
+ */
+export type RedirectPatchOpArray = RedirectPatchOp[];
+/**
+ * RedirectUpdate
+ *
+ * @remarks
+ * Array type for RedirectUpdate objects. Used when the API returns a collection of RedirectUpdate instances.
+ *
+ * @example
+ * ```typescript
+ * const items: RedirectUpdateArray = await api.getRedirectUpdates();
+ * ```
+ *
+ * @see {@link RedirectUpdate} - The individual RedirectUpdate type definition
+ */
+export type RedirectUpdateArray = RedirectUpdate[];
 /**
  * Relation
  *

package/src/helpers/schemas.d.ts

@@ -2015,6 +2015,22 @@ export type Pagination_Event = components['schemas']['Pagination_EventResponse_'
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type Pagination_Organization = components['schemas']['Pagination_Organization_'];
+/**
+ * Pagination[Redirect]
+ *
+ * @remarks
+ * Type alias for the `Pagination_Redirect_` OpenAPI schema.
+ * This type represents pagination[redirect] data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getPagination_Redirect();
+ * const item: Pagination_Redirect = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type Pagination_Redirect = components['schemas']['Pagination_Redirect_'];
 /**
  * Pagination[User]
  *
@@ -2303,6 +2319,102 @@ export type PublicAuthRequestForm = components['schemas']['PublicAuthRequestForm
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type RdapBase = components['schemas']['RdapBase'];
+/**
+ * Redirect
+ *
+ * @remarks
+ * Type alias for the `Redirect` OpenAPI schema.
+ * This type represents redirect data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getRedirect();
+ * const item: Redirect = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type Redirect = components['schemas']['Redirect'];
+/**
+ * RedirectPatchOp
+ *
+ * @remarks
+ * Type alias for the `RedirectPatchOp` OpenAPI schema.
+ * This type represents redirectpatchop data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getRedirectPatchOp();
+ * const item: RedirectPatchOp = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type RedirectPatchOp = components['schemas']['RedirectPatchOp'];
+/**
+ * RedirectPatchOps
+ *
+ * @remarks
+ * Type alias for the `RedirectPatchOps` OpenAPI schema.
+ * This type represents redirectpatchops data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getRedirectPatchOps();
+ * const item: RedirectPatchOps = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type RedirectPatchOps = components['schemas']['RedirectPatchOps'];
+/**
+ * RedirectRemove
+ *
+ * @remarks
+ * Type alias for the `RedirectRemove` OpenAPI schema.
+ * This type represents redirectremove data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getRedirectRemove();
+ * const item: RedirectRemove = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type RedirectRemove = components['schemas']['RedirectRemove'];
+/**
+ * RedirectSet
+ *
+ * @remarks
+ * Type alias for the `RedirectSet` OpenAPI schema.
+ * This type represents redirectset data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getRedirectSet();
+ * const item: RedirectSet = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type RedirectSet = components['schemas']['RedirectSet'];
+/**
+ * RedirectUpdate
+ *
+ * @remarks
+ * Type alias for the `RedirectUpdate` OpenAPI schema.
+ * This type represents redirectupdate data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getRedirectUpdate();
+ * const item: RedirectUpdate = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type RedirectUpdate = components['schemas']['RedirectUpdate'];
 /**
  * RegistrantChangeType
  *