@opusdns/api 0.82.0 → 0.83.0

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
  *

package/src/openapi.yaml

@@ -3498,6 +3498,20 @@ components:
       - pagination
       title: Pagination[Organization]
       type: object
+    Pagination_Redirect_:
+      properties:
+        pagination:
+          $ref: '#/components/schemas/PaginationMetadata'
+        results:
+          items:
+            $ref: '#/components/schemas/Redirect'
+          title: Results
+          type: array
+      required:
+      - results
+      - pagination
+      title: Pagination[Redirect]
+      type: object
     Pagination_User_:
       properties:
         pagination:
@@ -3761,6 +3775,141 @@ components:
           title: Rdap Server
       title: RdapBase
       type: object
+    Redirect:
+      properties:
+        redirect_code:
+          title: Redirect Code
+          type: integer
+        request_domain:
+          title: Request Domain
+          type: string
+        request_path:
+          title: Request Path
+          type: string
+        request_protocol:
+          title: Request Protocol
+          type: string
+        request_subdomain:
+          title: Request Subdomain
+          type: string
+        target_domain:
+          title: Target Domain
+          type: string
+        target_path:
+          title: Target Path
+          type: string
+        target_protocol:
+          title: Target Protocol
+          type: string
+        target_subdomain:
+          title: Target Subdomain
+          type: string
+      required:
+      - request_protocol
+      - request_subdomain
+      - request_path
+      - target_protocol
+      - target_subdomain
+      - target_domain
+      - target_path
+      - redirect_code
+      - request_domain
+      title: Redirect
+      type: object
+    RedirectPatchOp:
+      properties:
+        op:
+          $ref: '#/components/schemas/PatchOp'
+        redirect:
+          anyOf:
+          - $ref: '#/components/schemas/Redirect'
+          - $ref: '#/components/schemas/RedirectRemove'
+          title: Redirect
+      required:
+      - op
+      - redirect
+      title: RedirectPatchOp
+      type: object
+    RedirectPatchOps:
+      properties:
+        ops:
+          items:
+            $ref: '#/components/schemas/RedirectPatchOp'
+          title: Ops
+          type: array
+      required:
+      - ops
+      title: RedirectPatchOps
+      type: object
+    RedirectRemove:
+      properties:
+        request_domain:
+          title: Request Domain
+          type: string
+        request_path:
+          title: Request Path
+          type: string
+        request_protocol:
+          title: Request Protocol
+          type: string
+        request_subdomain:
+          title: Request Subdomain
+          type: string
+      required:
+      - request_protocol
+      - request_subdomain
+      - request_path
+      - request_domain
+      title: RedirectRemove
+      type: object
+    RedirectSet:
+      properties:
+        redirects:
+          items:
+            $ref: '#/components/schemas/RedirectUpdate'
+          title: Redirects
+          type: array
+      required:
+      - redirects
+      title: RedirectSet
+      type: object
+    RedirectUpdate:
+      properties:
+        redirect_code:
+          title: Redirect Code
+          type: integer
+        request_path:
+          title: Request Path
+          type: string
+        request_protocol:
+          title: Request Protocol
+          type: string
+        request_subdomain:
+          title: Request Subdomain
+          type: string
+        target_domain:
+          title: Target Domain
+          type: string
+        target_path:
+          title: Target Path
+          type: string
+        target_protocol:
+          title: Target Protocol
+          type: string
+        target_subdomain:
+          title: Target Subdomain
+          type: string
+      required:
+      - request_protocol
+      - request_subdomain
+      - request_path
+      - target_protocol
+      - target_subdomain
+      - target_domain
+      - target_path
+      - redirect_code
+      title: RedirectUpdate
+      type: object
     RegistrantChangeType:
       enum:
       - update
@@ -4797,7 +4946,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2025-10-10-154932
+  version: 2025-10-14-131453
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -6096,6 +6245,241 @@ paths:
       summary: Update Zone Rrsets
       tags:
       - dns
+  /v1/domain-forwards:
+    patch:
+      operationId: patch_redirects_v1_domain_forwards_patch
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/RedirectPatchOps'
+        required: true
+      responses:
+        '204':
+          description: Successful Response
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      summary: Patch Redirects
+      tags:
+      - domain_forward
+  /v1/domain-forwards/{zone_name}:
+    delete:
+      operationId: delete_redirects_v1_domain_forwards__zone_name__delete
+      parameters:
+      - description: DNS zone name (trailing dot optional)
+        in: path
+        name: zone_name
+        required: true
+        schema:
+          description: DNS zone name (trailing dot optional)
+          title: Zone Name
+          type: string
+      responses:
+        '204':
+          description: Successful Response
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      summary: Delete Redirects
+      tags:
+      - domain_forward
+    get:
+      operationId: get_redirects_v1_domain_forwards__zone_name__get
+      parameters:
+      - description: DNS zone name (trailing dot optional)
+        in: path
+        name: zone_name
+        required: true
+        schema:
+          description: DNS zone name (trailing dot optional)
+          title: Zone Name
+          type: string
+      - in: query
+        name: page
+        required: false
+        schema:
+          default: 1
+          minimum: 1
+          title: Page
+          type: integer
+      - in: query
+        name: page_size
+        required: false
+        schema:
+          default: 10
+          maximum: 100
+          minimum: 1
+          title: Page Size
+          type: integer
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Pagination_Redirect_'
+          description: Successful Response
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      summary: Get Redirects
+      tags:
+      - domain_forward
+    post:
+      operationId: create_redirects_v1_domain_forwards__zone_name__post
+      parameters:
+      - description: DNS zone name (trailing dot optional)
+        in: path
+        name: zone_name
+        required: true
+        schema:
+          description: DNS zone name (trailing dot optional)
+          title: Zone Name
+          type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/RedirectSet'
+        required: true
+      responses:
+        '201':
+          description: Successful Response
+        '409':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_DOMAIN_FORWARD_REDIRECT_ALREADY_EXISTS
+                detail: Redirect already exists for A, d, d, i, t, i, o, n, a, l,  ,
+                  e, r, r, o, r,  , c, o, n, t, e, x, t, .
+                status: 409
+                title: Domain Forward Error
+                type: domain-forward-redirect-already-exists
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Conflict
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      summary: Create Redirects
+      tags:
+      - domain_forward
+    put:
+      operationId: update_redirects_v1_domain_forwards__zone_name__put
+      parameters:
+      - description: DNS zone name (trailing dot optional)
+        in: path
+        name: zone_name
+        required: true
+        schema:
+          description: DNS zone name (trailing dot optional)
+          title: Zone Name
+          type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/RedirectSet'
+        required: true
+      responses:
+        '204':
+          description: Successful Response
+        '409':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_DOMAIN_FORWARD_REDIRECT_NOT_EXISTS
+                detail: Redirect does not exist for A, d, d, i, t, i, o, n, a, l,  ,
+                  e, r, r, o, r,  , c, o, n, t, e, x, t, .
+                status: 409
+                title: Domain Forward Error
+                type: domain-forward-redirect-not-exists
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Conflict
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      summary: Update Redirects
+      tags:
+      - domain_forward
+  /v1/domain-forwards/{zone_name}/disable:
+    patch:
+      operationId: disable_domain_forward_v1_domain_forwards__zone_name__disable_patch
+      parameters:
+      - description: DNS zone name (trailing dot optional)
+        in: path
+        name: zone_name
+        required: true
+        schema:
+          description: DNS zone name (trailing dot optional)
+          title: Zone Name
+          type: string
+      responses:
+        '204':
+          description: Successful Response
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      summary: Disable Domain Forward
+      tags:
+      - domain_forward
+  /v1/domain-forwards/{zone_name}/enable:
+    patch:
+      operationId: enable_domain_forward_v1_domain_forwards__zone_name__enable_patch
+      parameters:
+      - description: DNS zone name (trailing dot optional)
+        in: path
+        name: zone_name
+        required: true
+        schema:
+          description: DNS zone name (trailing dot optional)
+          title: Zone Name
+          type: string
+      responses:
+        '204':
+          description: Successful Response
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      summary: Enable Domain Forward
+      tags:
+      - domain_forward
   /v1/domain-search/suggest:
     get:
       description: Get a list of domain suggestions based on a search query