@opusdns/api 0.90.0 → 0.92.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
  *
@@ -1984,6 +2094,8 @@ export type PATCH_DomainForwardsByZoneNameDisable_Response_422 = HTTPValidationE
  *
  * @path /v1/domain-forwards/{zone_name}/enable
  * @param zone_name (path) - DNS zone name (trailing dot optional)
+ * @param auto_create_zone (query) - Auto create zone if it doesn't exist
+ * @param wildcard (query) - Wildcard domain forwarding
  *
  * @see {@link PATCH_DomainForwardsByZoneNameEnable_Response_422} - 422 response type
  *
@@ -2003,6 +2115,8 @@ export type PATCH_DomainForwardsByZoneNameEnable_Response = PATCH_DomainForwards
  *
  * @path /v1/domain-forwards/{zone_name}/enable
  * @param zone_name (path) - DNS zone name (trailing dot optional)
+ * @param auto_create_zone (query) - Auto create zone if it doesn't exist
+ * @param wildcard (query) - Wildcard domain forwarding
  *
  * @see {@link PATCH_DomainForwardsByZoneNameEnable_Response} - The main response type definition
  * @see {@link HTTPValidationError} - The actual schema type definition

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
  *

package/src/openapi.yaml

@@ -1549,13 +1549,13 @@ components:
           title: Updated On
           type: string
         wildcard:
+          default: false
           title: Wildcard
           type: boolean
         zone_name:
           title: Zone Name
           type: string
       required:
-      - wildcard
       - redirects
       - zone_name
       - request_protocol
@@ -1563,6 +1563,50 @@ components:
       - created_on
       title: DomainForward
       type: object
+    DomainForwardPatchOp:
+      properties:
+        op:
+          $ref: '#/components/schemas/PatchOp'
+        redirect:
+          anyOf:
+          - $ref: '#/components/schemas/HttpRedirect'
+          - $ref: '#/components/schemas/HttpRedirectRemove'
+          title: Redirect
+        request_protocol:
+          $ref: '#/components/schemas/HttpProtocol'
+        zone_name:
+          title: Zone Name
+          type: string
+      required:
+      - op
+      - zone_name
+      - request_protocol
+      - redirect
+      title: DomainForwardPatchOp
+      type: object
+    DomainForwardPatchOps:
+      properties:
+        ops:
+          items:
+            $ref: '#/components/schemas/DomainForwardPatchOp'
+          title: Ops
+          type: array
+      required:
+      - ops
+      title: DomainForwardPatchOps
+      type: object
+    DomainForwardProtocols:
+      properties:
+        http:
+          anyOf:
+          - $ref: '#/components/schemas/ProtocolRedirects'
+          - type: 'null'
+        https:
+          anyOf:
+          - $ref: '#/components/schemas/ProtocolRedirects'
+          - type: 'null'
+      title: DomainForwardProtocols
+      type: object
     DomainForwardRequest:
       properties:
         redirects:
@@ -1571,13 +1615,33 @@ components:
           title: Redirects
           type: array
         wildcard:
+          default: false
           title: Wildcard
           type: boolean
       required:
-      - wildcard
       - redirects
       title: DomainForwardRequest
       type: object
+    DomainForwardZone:
+      properties:
+        enabled:
+          title: Enabled
+          type: boolean
+        protocols:
+          $ref: '#/components/schemas/DomainForwardProtocols'
+        wildcard:
+          title: Wildcard
+          type: boolean
+        zone_name:
+          title: Zone Name
+          type: string
+      required:
+      - zone_name
+      - wildcard
+      - enabled
+      - protocols
+      title: DomainForwardZone
+      type: object
     DomainLifecycleBase:
       properties:
         add_grace_period:
@@ -2545,6 +2609,20 @@ components:
       - redirect_code
       title: HttpRedirect
       type: object
+    HttpRedirectRemove:
+      properties:
+        request_path:
+          title: Request Path
+          type: string
+        request_subdomain:
+          anyOf:
+          - type: string
+          - type: 'null'
+          title: Request Subdomain
+      required:
+      - request_path
+      title: HttpRedirectRemove
+      type: object
     IdnBase:
       properties:
         idn_capable:
@@ -3628,6 +3706,20 @@ components:
       - pagination
       title: Pagination[DnsZoneResponse]
       type: object
+    Pagination_DomainForwardZone_:
+      properties:
+        pagination:
+          $ref: '#/components/schemas/PaginationMetadata'
+        results:
+          items:
+            $ref: '#/components/schemas/DomainForwardZone'
+          title: Results
+          type: array
+      required:
+      - results
+      - pagination
+      title: Pagination[DomainForwardZone]
+      type: object
     Pagination_DomainResponse_:
       properties:
         pagination:
@@ -3922,6 +4014,17 @@ components:
       - status
       title: Problem
       type: object
+    ProtocolRedirects:
+      properties:
+        redirects:
+          items:
+            $ref: '#/components/schemas/HttpRedirect'
+          title: Redirects
+          type: array
+      required:
+      - redirects
+      title: ProtocolRedirects
+      type: object
     PublicAuthRequestForm:
       properties:
         client_id:
@@ -5005,7 +5108,7 @@ info:
     '
   summary: OpusDNS - your gateway to a seamless domain management experience.
   title: OpusDNS API
-  version: 2025-10-29-163217
+  version: 2025-10-31-165358
   x-logo:
     altText: OpusDNS API Reference
     url: https://d24lr4zqs1tgqh.cloudfront.net/c9505a20-5ae1-406c-b060-d392569caebf.jpg
@@ -6483,6 +6586,159 @@ paths:
       summary: Update Zone Rrsets
       tags:
       - dns
+  /v1/domain-forwards:
+    get:
+      operationId: list_domain_forwards_v1_domain_forwards_get
+      parameters:
+      - in: query
+        name: sort_by
+        required: false
+        schema:
+          $ref: '#/components/schemas/ZoneSortField'
+          default: created_on
+      - in: query
+        name: sort_order
+        required: false
+        schema:
+          $ref: '#/components/schemas/SortOrder'
+          default: desc
+      - in: query
+        name: dnssec_status
+        required: false
+        schema:
+          anyOf:
+          - $ref: '#/components/schemas/DnssecStatus'
+          - type: 'null'
+          title: Dnssec Status
+      - in: query
+        name: name
+        required: false
+        schema:
+          anyOf:
+          - type: string
+          - type: 'null'
+          title: Name
+      - in: query
+        name: search
+        required: false
+        schema:
+          anyOf:
+          - type: string
+          - type: 'null'
+          title: Search
+      - in: query
+        name: suffix
+        required: false
+        schema:
+          anyOf:
+          - type: string
+          - type: 'null'
+          title: Suffix
+      - in: query
+        name: created_after
+        required: false
+        schema:
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          title: Created After
+      - in: query
+        name: created_before
+        required: false
+        schema:
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          title: Created Before
+      - in: query
+        name: updated_after
+        required: false
+        schema:
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          title: Updated After
+      - in: query
+        name: updated_before
+        required: false
+        schema:
+          anyOf:
+          - format: date-time
+            type: string
+          - type: 'null'
+          title: Updated Before
+      - 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_DomainForwardZone_'
+          description: Successful Response
+        '422':
+          content:
+            application/problem+json:
+              schema:
+                $ref: '#/components/schemas/HTTPValidationError'
+          description: Validation Error
+      security:
+      - OAuth2PasswordBearer: []
+      summary: List Domain Forwards
+      tags:
+      - domain_forward
+    patch:
+      operationId: patch_redirects_v1_domain_forwards_patch
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/DomainForwardPatchOps'
+        required: true
+      responses:
+        '204':
+          description: Successful Response
+        '404':
+          content:
+            application/problem+json:
+              example:
+                code: ERROR_DOMAIN_FORWARD_NOT_EXISTS
+                detail: Domain forward not found
+                status: 404
+                title: Domain Forward Error
+                type: domain-forward-not-found
+              schema:
+                $ref: '#/components/schemas/Problem'
+          description: Not Found
+        '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}/disable:
     patch:
       operationId: disable_domain_forward_v1_domain_forwards__zone_name__disable_patch
@@ -6521,13 +6777,24 @@ paths:
           description: DNS zone name (trailing dot optional)
           title: Zone Name
           type: string
-      - in: query
+      - description: Auto create zone if it doesn't exist
+        in: query
         name: auto_create_zone
         required: false
         schema:
           default: false
+          description: Auto create zone if it doesn't exist
           title: Auto Create Zone
           type: boolean
+      - description: Wildcard domain forwarding
+        in: query
+        name: wildcard
+        required: false
+        schema:
+          default: false
+          description: Wildcard domain forwarding
+          title: Wildcard
+          type: boolean
       responses:
         '204':
           description: Successful Response