@opusdns/api 0.113.0 → 0.115.0

package/src/helpers/requests.d.ts

@@ -36,6 +36,112 @@ import { DomainDnssecDataCreateArray, OrganizationAttributeUpdateArray } from '.
 
 import { ContactCreate, DnsZoneCreate, DnsZoneRecordsPatchOps, DnsZoneRrsetsPatchOps, DnsZoneRrsetsCreate, DomainForwardPatchOps, DomainForwardRequest, DomainForwardSetRequest, DomainCreate, DomainUpdate, DomainRenewRequest, DomainRestoreRequest, DomainWithdrawRequest, DomainTransitRequest, DomainTransferIn, EmailForwardCreate, EmailForwardAliasCreate, EmailForwardAliasUpdate, OrganizationCreate, IpRestrictionCreate, IpRestrictionUpdate, OrganizationUpdate, UserCreate, PasswordUpdate, UserUpdate, SpiceDbRelationshipUpdate } from './schemas.d';
 
+/**
+ * Request type for GET ArchiveEmailForwardLogsAliasEmailForwardAliasId endpoint
+ *
+ * Retrieve email forward logs by alias
+ * Retrieves a paginated list of email forward logs for a specific email forward alias. Only returns logs created after the email forward was created.
+ *
+ * @remarks
+ * This type defines the complete request structure for the GET ArchiveEmailForwardLogsAliasEmailForwardAliasId endpoint.
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @example
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @path /v1/archive/email-forward-logs/alias/{email_forward_alias_id}
+ *
+ * @see {@link GET_ArchiveEmailForwardLogsAliasEmailForwardAliasId_Request_Query} - Query parameters type
+ * @see {@link GET_ArchiveEmailForwardLogsAliasEmailForwardAliasId_Request_Path} - Path parameters type
+ * @see {@link GET_ArchiveEmailForwardLogsAliasEmailForwardAliasId_Request_Body} - Request body type
+ */
+export type GET_ArchiveEmailForwardLogsAliasEmailForwardAliasId_Request = {
+  parameters: {
+    query: operations['get_email_forward_logs_by_alias_v1_archive_email_forward_logs_alias__email_forward_alias_id__get']['parameters']['query'];
+    path: operations['get_email_forward_logs_by_alias_v1_archive_email_forward_logs_alias__email_forward_alias_id__get']['parameters']['path'];
+  };
+}
+/**
+ * Query parameters for GET /v1/archive/email-forward-logs/alias/{email_forward_alias_id}
+ *
+ * @remarks
+ * This type defines the query parameters for the GET /v1/archive/email-forward-logs/alias/{email_forward_alias_id} endpoint.
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
+ *
+ * @example
+ * Use this type to ensure type safety for query parameters.
+ *
+ * @path /v1/archive/email-forward-logs/alias/{email_forward_alias_id}
+ */
+export type GET_ArchiveEmailForwardLogsAliasEmailForwardAliasId_Request_Query = GET_ArchiveEmailForwardLogsAliasEmailForwardAliasId_Request['parameters']['query'];
+/**
+ * Path parameters for GET /v1/archive/email-forward-logs/alias/{email_forward_alias_id}
+ *
+ * @remarks
+ * This type defines the path parameters for the GET /v1/archive/email-forward-logs/alias/{email_forward_alias_id} endpoint.
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
+ *
+ * @example
+ * Use this type to ensure type safety for path parameters.
+ *
+ * @path /v1/archive/email-forward-logs/alias/{email_forward_alias_id}
+ */
+export type GET_ArchiveEmailForwardLogsAliasEmailForwardAliasId_Request_Path = GET_ArchiveEmailForwardLogsAliasEmailForwardAliasId_Request['parameters']['path'];
+
+/**
+ * Request type for GET ArchiveEmailForwardLogsEmailForwardId endpoint
+ *
+ * Retrieve email forward logs
+ * Retrieves a paginated list of email forward logs for a specific email forward. Only returns logs created after the email forward was created.
+ *
+ * @remarks
+ * This type defines the complete request structure for the GET ArchiveEmailForwardLogsEmailForwardId endpoint.
+ * It includes all parameters (query, path) and request body types as defined in the OpenAPI specification.
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @example
+ * Use this type to ensure type safety when making API requests to this endpoint.
+ *
+ * @path /v1/archive/email-forward-logs/{email_forward_id}
+ *
+ * @see {@link GET_ArchiveEmailForwardLogsEmailForwardId_Request_Query} - Query parameters type
+ * @see {@link GET_ArchiveEmailForwardLogsEmailForwardId_Request_Path} - Path parameters type
+ * @see {@link GET_ArchiveEmailForwardLogsEmailForwardId_Request_Body} - Request body type
+ */
+export type GET_ArchiveEmailForwardLogsEmailForwardId_Request = {
+  parameters: {
+    query: operations['get_email_forward_logs_v1_archive_email_forward_logs__email_forward_id__get']['parameters']['query'];
+    path: operations['get_email_forward_logs_v1_archive_email_forward_logs__email_forward_id__get']['parameters']['path'];
+  };
+}
+/**
+ * Query parameters for GET /v1/archive/email-forward-logs/{email_forward_id}
+ *
+ * @remarks
+ * This type defines the query parameters for the GET /v1/archive/email-forward-logs/{email_forward_id} endpoint.
+ * It provides type safety for all query parameters as defined in the OpenAPI specification.
+ *
+ * @example
+ * Use this type to ensure type safety for query parameters.
+ *
+ * @path /v1/archive/email-forward-logs/{email_forward_id}
+ */
+export type GET_ArchiveEmailForwardLogsEmailForwardId_Request_Query = GET_ArchiveEmailForwardLogsEmailForwardId_Request['parameters']['query'];
+/**
+ * Path parameters for GET /v1/archive/email-forward-logs/{email_forward_id}
+ *
+ * @remarks
+ * This type defines the path parameters for the GET /v1/archive/email-forward-logs/{email_forward_id} endpoint.
+ * It provides type safety for all path parameters as defined in the OpenAPI specification.
+ *
+ * @example
+ * Use this type to ensure type safety for path parameters.
+ *
+ * @path /v1/archive/email-forward-logs/{email_forward_id}
+ */
+export type GET_ArchiveEmailForwardLogsEmailForwardId_Request_Path = GET_ArchiveEmailForwardLogsEmailForwardId_Request['parameters']['path'];
+
 /**
  * Request type for GET ArchiveObjectLogs endpoint
  *

package/src/helpers/responses.d.ts

@@ -34,7 +34,119 @@
 
 import { DomainDnssecDataArray, OrganizationAttribute2Array, IpRestrictionArray, TldResponseShortArray } from './schemas-arrays.d';
 
-import { Pagination_ObjectLog, HTTPValidationError, 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, 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 ArchiveEmailForwardLogsAliasByEmailForwardAliasId endpoint
+ *
+ * Retrieve email forward logs by alias
+ * Retrieves a paginated list of email forward logs for a specific email forward alias. Only returns logs created after the email forward was created.
+ *
+ * @remarks
+ * This type defines all possible response structures for the GET ArchiveEmailForwardLogsAliasByEmailForwardAliasId 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/archive/email-forward-logs/alias/{email_forward_alias_id}
+ *
+ * @see {@link GET_ArchiveEmailForwardLogsAliasByEmailForwardAliasId_Response_200} - 200 response type
+ * @see {@link GET_ArchiveEmailForwardLogsAliasByEmailForwardAliasId_Response_422} - 422 response type
+ *
+
+ */
+export type GET_ArchiveEmailForwardLogsAliasByEmailForwardAliasId_Response = GET_ArchiveEmailForwardLogsAliasByEmailForwardAliasId_Response_200 | GET_ArchiveEmailForwardLogsAliasByEmailForwardAliasId_Response_422;
+
+/**
+ * 200 response for GET ArchiveEmailForwardLogsAliasByEmailForwardAliasId endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 200 status code
+ * of the GET ArchiveEmailForwardLogsAliasByEmailForwardAliasId endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/archive/email-forward-logs/alias/{email_forward_alias_id}
+ *
+ * @see {@link GET_ArchiveEmailForwardLogsAliasByEmailForwardAliasId_Response} - The main response type definition
+ * @see {@link Pagination_EmailForwardLog} - The actual schema type definition
+ */
+export type GET_ArchiveEmailForwardLogsAliasByEmailForwardAliasId_Response_200 = Pagination_EmailForwardLog
+
+/**
+ * 422 response for GET ArchiveEmailForwardLogsAliasByEmailForwardAliasId endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 status code
+ * of the GET ArchiveEmailForwardLogsAliasByEmailForwardAliasId endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/archive/email-forward-logs/alias/{email_forward_alias_id}
+ *
+ * @see {@link GET_ArchiveEmailForwardLogsAliasByEmailForwardAliasId_Response} - The main response type definition
+ * @see {@link HTTPValidationError} - The actual schema type definition
+ */
+export type GET_ArchiveEmailForwardLogsAliasByEmailForwardAliasId_Response_422 = HTTPValidationError
+
+/**
+ * Response types for GET ArchiveEmailForwardLogsByEmailForwardId endpoint
+ *
+ * Retrieve email forward logs
+ * Retrieves a paginated list of email forward logs for a specific email forward. Only returns logs created after the email forward was created.
+ *
+ * @remarks
+ * This type defines all possible response structures for the GET ArchiveEmailForwardLogsByEmailForwardId 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/archive/email-forward-logs/{email_forward_id}
+ *
+ * @see {@link GET_ArchiveEmailForwardLogsByEmailForwardId_Response_200} - 200 response type
+ * @see {@link GET_ArchiveEmailForwardLogsByEmailForwardId_Response_422} - 422 response type
+ *
+
+ */
+export type GET_ArchiveEmailForwardLogsByEmailForwardId_Response = GET_ArchiveEmailForwardLogsByEmailForwardId_Response_200 | GET_ArchiveEmailForwardLogsByEmailForwardId_Response_422;
+
+/**
+ * 200 response for GET ArchiveEmailForwardLogsByEmailForwardId endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 200 status code
+ * of the GET ArchiveEmailForwardLogsByEmailForwardId endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/archive/email-forward-logs/{email_forward_id}
+ *
+ * @see {@link GET_ArchiveEmailForwardLogsByEmailForwardId_Response} - The main response type definition
+ * @see {@link Pagination_EmailForwardLog} - The actual schema type definition
+ */
+export type GET_ArchiveEmailForwardLogsByEmailForwardId_Response_200 = Pagination_EmailForwardLog
+
+/**
+ * 422 response for GET ArchiveEmailForwardLogsByEmailForwardId endpoint
+ *
+ * @remarks
+ * This type defines the response structure for the 422 status code
+ * of the GET ArchiveEmailForwardLogsByEmailForwardId endpoint.
+ * It provides type safety for handling this specific response as defined in the OpenAPI specification.
+ *
+
+ *
+ * @path /v1/archive/email-forward-logs/{email_forward_id}
+ *
+ * @see {@link GET_ArchiveEmailForwardLogsByEmailForwardId_Response} - The main response type definition
+ * @see {@link HTTPValidationError} - The actual schema type definition
+ */
+export type GET_ArchiveEmailForwardLogsByEmailForwardId_Response_422 = HTTPValidationError
 
 /**
  * Response types for GET ArchiveObjectLogs 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, DomainForwardPatchOp, HttpRedirectList, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, EmailForwardAliasCreate, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, DomainForwardZone, Domain, EmailForwardZone, EventResponse, Invoice, ObjectLog, Organization, RequestHistory, 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, DomainForwardPatchOp, HttpRedirectList, DomainForward, DeletePolicyType, SyncOperationType, DomainContact, DomainSearchSuggestionWithPrice, DomainStatus, DomainClientStatus, EmailForwardAliasCreate, EmailForwardLogEvent, EmailForwardAlias, EmailForward, PriceInfo, ValidationError, LaunchPhaseBase, LocalPresenceRequirementType, ContactRoleType, OrganizationAttribute2, User, OrganizationAttributeCreate, UserCreate, BillingTransaction, ContactSchema, DnsZone, DomainForwardZone, Domain, EmailForwardLog, EmailForwardZone, EventResponse, Invoice, ObjectLog, Organization, RequestHistory, Period, Permission, PremiumAffectsType, Relation, TldBase, PostTransferRequirements, UserAttributeBase, DomainAvailability } from './schemas.d';
 
 /**
  * DomainDnssecDataResponse
@@ -457,6 +457,20 @@ export type DomainClientStatusArray = DomainClientStatus[];
  * @see {@link EmailForwardAliasCreate} - The individual EmailForwardAliasCreate type definition
  */
 export type EmailForwardAliasCreateArray = EmailForwardAliasCreate[];
+/**
+ * EmailForwardLogEvent
+ *
+ * @remarks
+ * Array type for EmailForwardLogEvent objects. Used when the API returns a collection of EmailForwardLogEvent instances.
+ *
+ * @example
+ * ```typescript
+ * const items: EmailForwardLogEventArray = await api.getEmailForwardLogEvents();
+ * ```
+ *
+ * @see {@link EmailForwardLogEvent} - The individual EmailForwardLogEvent type definition
+ */
+export type EmailForwardLogEventArray = EmailForwardLogEvent[];
 /**
  * EmailForwardAlias
  *
@@ -681,6 +695,20 @@ export type DomainForwardZoneArray = DomainForwardZone[];
  * @see {@link Domain} - The individual DomainResponse type definition
  */
 export type DomainArray = Domain[];
+/**
+ * EmailForwardLog
+ *
+ * @remarks
+ * Array type for EmailForwardLog objects. Used when the API returns a collection of EmailForwardLog instances.
+ *
+ * @example
+ * ```typescript
+ * const items: EmailForwardLogArray = await api.getEmailForwardLogs();
+ * ```
+ *
+ * @see {@link EmailForwardLog} - The individual EmailForwardLog type definition
+ */
+export type EmailForwardLogArray = EmailForwardLog[];
 /**
  * EmailForwardZone
  *

package/src/helpers/schemas.d.ts

@@ -1642,6 +1642,54 @@ export type EmailForwardAliasUpdate = components['schemas']['EmailForwardAliasUp
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type EmailForwardCreate = components['schemas']['EmailForwardCreate'];
+/**
+ * EmailForwardLog
+ *
+ * @remarks
+ * Type alias for the `EmailForwardLog` OpenAPI schema.
+ * This type represents emailforwardlog data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getEmailForwardLog();
+ * const item: EmailForwardLog = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type EmailForwardLog = components['schemas']['EmailForwardLog'];
+/**
+ * EmailForwardLogEvent
+ *
+ * @remarks
+ * Type alias for the `EmailForwardLogEvent` OpenAPI schema.
+ * This type represents emailforwardlogevent data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getEmailForwardLogEvent();
+ * const item: EmailForwardLogEvent = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type EmailForwardLogEvent = components['schemas']['EmailForwardLogEvent'];
+/**
+ * EmailForwardLogSortField
+ *
+ * @remarks
+ * Type alias for the `EmailForwardLogSortField` OpenAPI schema.
+ * This type represents emailforwardlogsortfield data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getEmailForwardLogSortField();
+ * const item: EmailForwardLogSortField = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type EmailForwardLogSortField = components['schemas']['EmailForwardLogSortField'];
 /**
  * EmailForwardResponse
  *
@@ -2543,6 +2591,22 @@ export type Pagination_DomainForward = components['schemas']['Pagination_DomainF
  * @see {@link components} - The OpenAPI components schema definition
  */
 export type Pagination_Domain = components['schemas']['Pagination_DomainResponse_'];
+/**
+ * Pagination[EmailForwardLog]
+ *
+ * @remarks
+ * Type alias for the `Pagination_EmailForwardLog_` OpenAPI schema.
+ * This type represents pagination[emailforwardlog] data structures used in API requests and responses.
+ *
+ * @example
+ * ```typescript
+ * const response = await api.getPagination_EmailForwardLog();
+ * const item: Pagination_EmailForwardLog = response.results;
+ * ```
+ *
+ * @see {@link components} - The OpenAPI components schema definition
+ */
+export type Pagination_EmailForwardLog = components['schemas']['Pagination_EmailForwardLog_'];
 /**
  * Pagination[EmailForwardResponse]
  *