@parsrun/types 0.1.28 → 0.1.30

package/dist/index.d.ts

@@ -69,7 +69,12 @@ declare const cursorPaginationMeta: arktype_internal_variants_object_ts.ObjectTy
     nextCursor?: string;
     prevCursor?: string;
 }, {}>;
-/** Success response wrapper */
+/**
+ * Creates a success response schema wrapper for any data type.
+ * @template T - The data schema type
+ * @param dataSchema - The ArkType schema for the response data
+ * @returns An ArkType schema for a success response containing the data
+ */
 declare const successResponse: <T>(dataSchema: T) => arktype_internal_variants_object_ts.ObjectType<{
     success: "true";
     data: never;
@@ -85,7 +90,12 @@ declare const errorResponse: arktype_internal_variants_object_ts.ObjectType<{
     };
     message?: string;
 }, {}>;
-/** Paginated response wrapper */
+/**
+ * Creates a paginated response schema wrapper for offset-based pagination.
+ * @template T - The data schema type (typically an array schema)
+ * @param dataSchema - The ArkType schema for the paginated data array
+ * @returns An ArkType schema for a paginated response with pagination metadata
+ */
 declare const paginatedResponse: <T>(dataSchema: T) => arktype_internal_variants_object_ts.ObjectType<{
     success: boolean;
     data: never;
@@ -99,7 +109,12 @@ declare const paginatedResponse: <T>(dataSchema: T) => arktype_internal_variants
     };
     message?: string;
 }, {}>;
-/** Cursor paginated response wrapper */
+/**
+ * Creates a cursor-paginated response schema wrapper for cursor-based pagination.
+ * @template T - The data schema type (typically an array schema)
+ * @param dataSchema - The ArkType schema for the paginated data array
+ * @returns An ArkType schema for a cursor-paginated response with cursor metadata
+ */
 declare const cursorPaginatedResponse: <T>(dataSchema: T) => arktype_internal_variants_object_ts.ObjectType<{
     success: boolean;
     data: never;
@@ -126,37 +141,85 @@ declare const validationErrorDetail: arktype_internal_variants_object_ts.ObjectT
     expected?: string;
     received?: unknown;
 }, {}>;
-/** UUID v4 string type */
+/**
+ * UUID v4 string type.
+ * Represents a universally unique identifier in the standard UUID v4 format.
+ */
 type UUID = typeof uuid.infer;
-/** ISO 8601 timestamp string type */
+/**
+ * ISO 8601 timestamp string type.
+ * Represents a date-time value in ISO 8601 format (e.g., "2024-01-15T10:30:00Z").
+ */
 type Timestamp = typeof timestamp.infer;
-/** Valid email address string type */
+/**
+ * Valid email address string type.
+ * Represents a properly formatted email address.
+ */
 type Email = typeof email.infer;
-/** Valid URL string type */
+/**
+ * Valid URL string type.
+ * Represents a properly formatted URL.
+ */
 type Url = typeof url.infer;
-/** Non-empty string type (length >= 1) */
+/**
+ * Non-empty string type (length >= 1).
+ * Ensures the string contains at least one character.
+ */
 type NonEmptyString = typeof nonEmptyString.infer;
-/** Positive integer type (> 0) */
+/**
+ * Positive integer type (> 0).
+ * Represents whole numbers greater than zero.
+ */
 type PositiveInt = typeof positiveInt.infer;
-/** Non-negative integer type (>= 0) */
+/**
+ * Non-negative integer type (>= 0).
+ * Represents whole numbers that are zero or greater.
+ */
 type NonNegativeInt = typeof nonNegativeInt.infer;
-/** Entity status: 'active' | 'inactive' | 'suspended' | 'deleted' */
+/**
+ * Entity status type.
+ * Common lifecycle states for entities: 'active' | 'inactive' | 'suspended' | 'deleted'.
+ */
 type Status = typeof status.infer;
-/** Session status: 'active' | 'expired' | 'revoked' */
+/**
+ * Session status type.
+ * Represents the current state of a user session: 'active' | 'expired' | 'revoked'.
+ */
 type SessionStatus = typeof sessionStatus.infer;
-/** Pagination request parameters */
+/**
+ * Pagination request parameters type.
+ * Contains page number, limit, and optional ordering for offset-based pagination.
+ */
 type Pagination = typeof pagination.infer;
-/** Pagination metadata in responses */
+/**
+ * Pagination metadata type for responses.
+ * Contains page info, totals, and navigation flags for offset-based pagination.
+ */
 type PaginationMeta = typeof paginationMeta.infer;
-/** Cursor-based pagination request */
+/**
+ * Cursor-based pagination request type.
+ * Contains cursor, limit, and direction for cursor-based pagination.
+ */
 type CursorPagination = typeof cursorPagination.infer;
-/** Cursor-based pagination metadata */
+/**
+ * Cursor-based pagination metadata type.
+ * Contains current/next/prev cursors and hasMore flag for cursor-based pagination.
+ */
 type CursorPaginationMeta = typeof cursorPaginationMeta.infer;
-/** Standard error response structure */
+/**
+ * Standard error response structure type.
+ * Contains success flag, error object with code/message/details, and optional message.
+ */
 type ErrorResponse = typeof errorResponse.infer;
-/** Pars framework error structure */
+/**
+ * Pars framework error structure type.
+ * Contains message, HTTP status code, optional error code, and optional details.
+ */
 type ParsError = typeof parsError.infer;
-/** Validation error detail with path and message */
+/**
+ * Validation error detail type.
+ * Contains the field path, error message, and optional expected/received values.
+ */
 type ValidationErrorDetail = typeof validationErrorDetail.infer;
 /** Generic API response wrapper */
 interface ApiResponse<T = unknown> {
@@ -592,6 +655,7 @@ declare const verifyEmailRequest: arktype_internal_variants_object_ts.ObjectType
 declare const checkVerificationStatusRequest: arktype_internal_variants_object_ts.ObjectType<{
     email: string;
 }, {}>;
+/** Check verification status response */
 declare const checkVerificationStatusResponse: arktype_internal_variants_object_ts.ObjectType<{
     success: boolean;
     verified: boolean;
@@ -1006,52 +1070,240 @@ declare const parsAuthConfig: arktype_internal_variants_object_ts.ObjectType<{
     };
     callbacks?: object;
 }, {}>;
+/**
+ * User entity type.
+ * Represents a user account with display name, 2FA settings, and status.
+ */
 type User = typeof user.infer;
+/**
+ * Authentication method type.
+ * Represents how a user authenticates (email, phone, OAuth providers).
+ */
 type AuthMethod = typeof authMethod.infer;
+/**
+ * Session entity type.
+ * Represents an active user session with tokens, device info, and expiry.
+ */
 type Session = typeof session.infer;
+/**
+ * Tenant membership type.
+ * Represents a user's membership and role within a specific tenant.
+ */
 type TenantMembership = typeof tenantMembership.infer;
+/**
+ * Request OTP request type.
+ * Contains email or phone number for OTP delivery.
+ */
 type RequestOTPRequest = typeof requestOTPRequest.infer;
+/**
+ * Request OTP response type.
+ * Contains success status, expiry, and optional tenant selection info.
+ */
 type RequestOTPResponse = typeof requestOTPResponse.infer;
+/**
+ * Verify OTP request type.
+ * Contains email/phone, OTP code, and optional tenant ID.
+ */
 type VerifyOTPRequest = typeof verifyOTPRequest.infer;
+/**
+ * Resend OTP request type.
+ * Contains email or phone number to resend OTP to.
+ */
 type ResendOTPRequest = typeof resendOTPRequest.infer;
+/**
+ * Login response data type.
+ * Contains user, session tokens, auth method, and membership info.
+ */
 type LoginResponseData = typeof loginResponseData.infer;
+/**
+ * Login response type.
+ * Wrapper containing success status and login response data.
+ */
 type LoginResponse = typeof loginResponse.infer;
+/**
+ * Current user response data type.
+ * Contains user details, auth method, memberships, roles, and permissions.
+ */
 type CurrentUserResponseData = typeof currentUserResponseData.infer;
+/**
+ * Current user response type.
+ * Wrapper containing success status and current user data.
+ */
 type CurrentUserResponse = typeof currentUserResponse.infer;
+/**
+ * Refresh token request type.
+ * Contains the refresh token for obtaining new access tokens.
+ */
 type RefreshTokenRequest = typeof refreshTokenRequest.infer;
+/**
+ * Token info type for client storage.
+ * Contains access token, optional refresh token, expiry, and CSRF token.
+ */
 type TokenInfo = typeof tokenInfo.infer;
+/**
+ * JWT payload type.
+ * Contains subject (user ID), tenant ID, session ID, roles, permissions, and timing claims.
+ */
 type JwtPayload = typeof jwtPayload.infer;
+/**
+ * Permission entity type.
+ * Defines an action that can be performed on a resource within a scope.
+ */
 type Permission = typeof permission.infer;
+/**
+ * Role entity type.
+ * Groups permissions together for assignment to users within a tenant.
+ */
 type Role = typeof role.infer;
+/**
+ * Permission check request type.
+ * Used to verify if a user has permission for a specific resource/action.
+ */
 type PermissionCheck = typeof permissionCheck.infer;
+/**
+ * Logout request type.
+ * Contains refresh token and flag for logging out all devices.
+ */
 type LogoutRequest = typeof logoutRequest.infer;
+/**
+ * Revoke session request type.
+ * Contains optional reason for session revocation.
+ */
 type RevokeSessionRequest = typeof revokeSessionRequest.infer;
+/**
+ * Revoke all sessions request type.
+ * Contains reason and option to exclude the current session.
+ */
 type RevokeAllSessionsRequest = typeof revokeAllSessionsRequest.infer;
+/**
+ * Revoke all sessions response type.
+ * Contains success status, message, and count of revoked sessions.
+ */
 type RevokeAllSessionsResponse = typeof revokeAllSessionsResponse.infer;
+/**
+ * Send verification email request type.
+ * Contains the email address to send verification to.
+ */
 type SendVerificationEmailRequest = typeof sendVerificationEmailRequest.infer;
+/**
+ * Verify email request type.
+ * Contains the verification token from the email link.
+ */
 type VerifyEmailRequest = typeof verifyEmailRequest.infer;
+/**
+ * Check verification status request type.
+ * Contains email address to check verification status for.
+ */
 type CheckVerificationStatusRequest = typeof checkVerificationStatusRequest.infer;
+/**
+ * Check verification status response type.
+ * Contains verification status and optional timing information.
+ */
 type CheckVerificationStatusResponse = typeof checkVerificationStatusResponse.infer;
+/**
+ * CSRF token request type.
+ * Contains the CSRF token for validation.
+ */
 type CSRFTokenRequest = typeof csrfTokenRequest.infer;
+/**
+ * Session configuration type.
+ * Controls token expiry, sliding window, max sessions, and invalidation rules.
+ */
 type SessionConfig = typeof sessionConfig.infer;
+/**
+ * JWT configuration type.
+ * Controls algorithm, issuer, and audience for JWT tokens.
+ */
 type JwtConfig = typeof jwtConfig.infer;
+/**
+ * Cookie configuration type.
+ * Controls cookie naming, domain, path, and security settings.
+ */
 type CookieConfig = typeof cookieConfig.infer;
+/**
+ * CSRF configuration type.
+ * Controls CSRF protection settings including header and cookie names.
+ */
 type CsrfConfig = typeof csrfConfig.infer;
+/**
+ * Rate limit configuration type.
+ * Controls login attempt limits and window size.
+ */
 type RateLimitConfig = typeof rateLimitConfig.infer;
+/**
+ * Lockout configuration type.
+ * Controls account lockout after failed attempts.
+ */
 type LockoutConfig = typeof lockoutConfig.infer;
+/**
+ * Security configuration type.
+ * Groups rate limit, lockout, and CSRF settings.
+ */
 type SecurityConfig = typeof securityConfig.infer;
+/**
+ * Tenant configuration type.
+ * Controls multi-tenancy strategy and resolution method.
+ */
 type TenantConfig = typeof tenantConfig.infer;
+/**
+ * OAuth provider configuration type.
+ * Contains client credentials and callback URL for an OAuth provider.
+ */
 type OAuthProviderConfig = typeof oauthProviderConfig.infer;
+/**
+ * OTP email configuration type.
+ * Controls email OTP settings including expiry, length, and rate limits.
+ */
 type OtpEmailConfig = typeof otpEmailConfig.infer;
+/**
+ * OTP SMS configuration type.
+ * Controls SMS OTP settings including expiry, length, and rate limits.
+ */
 type OtpSmsConfig = typeof otpSmsConfig.infer;
+/**
+ * OTP configuration type.
+ * Groups email and SMS OTP settings.
+ */
 type OtpConfig = typeof otpConfig.infer;
+/**
+ * Magic link configuration type.
+ * Controls magic link expiry and send function.
+ */
 type MagicLinkConfig = typeof magicLinkConfig.infer;
+/**
+ * TOTP configuration type.
+ * Controls time-based OTP settings for 2FA including issuer and backup codes.
+ */
 type TotpConfig = typeof totpConfig.infer;
+/**
+ * WebAuthn configuration type.
+ * Controls WebAuthn/FIDO2 settings including relying party info.
+ */
 type WebAuthnConfig = typeof webauthnConfig.infer;
+/**
+ * Password configuration type.
+ * Controls password requirements including length and character requirements.
+ */
 type PasswordConfig = typeof passwordConfig.infer;
+/**
+ * OAuth providers configuration type.
+ * Maps OAuth provider names to their configurations.
+ */
 type OAuthProvidersConfig = typeof oauthProvidersConfig.infer;
+/**
+ * Auth providers configuration type.
+ * Groups all authentication provider settings.
+ */
 type ProvidersConfig = typeof providersConfig.infer;
+/**
+ * Auth storage configuration type.
+ * Controls session/token storage backend selection.
+ */
 type StorageConfig = typeof storageConfig.infer;
+/**
+ * Main Pars auth configuration type.
+ * Complete configuration object for the Pars authentication system.
+ */
 type ParsAuthConfig = typeof parsAuthConfig.infer;
 
 /**
@@ -1130,11 +1382,35 @@ declare const tenantMemberListQuery: arktype_internal_variants_object_ts.ObjectT
 declare const switchTenantRequest: arktype_internal_variants_object_ts.ObjectType<{
     tenantId: string;
 }, {}>;
+/**
+ * Tenant entity type.
+ * Represents an organization/workspace with branding, settings, and localization.
+ */
 type Tenant = typeof tenant.infer;
+/**
+ * Create tenant request type.
+ * Contains required name and optional branding/localization settings.
+ */
 type CreateTenantRequest = typeof createTenantRequest.infer;
+/**
+ * Update tenant request type.
+ * Contains optional fields for updating tenant properties.
+ */
 type UpdateTenantRequest = typeof updateTenantRequest.infer;
+/**
+ * Invite tenant member request type.
+ * Contains email, role, access level, and optional expiry for invitations.
+ */
 type InviteTenantMemberRequest = typeof inviteTenantMemberRequest.infer;
+/**
+ * Tenant member list query type.
+ * Contains pagination, filtering, and search options for listing members.
+ */
 type TenantMemberListQuery = typeof tenantMemberListQuery.infer;
+/**
+ * Switch tenant request type.
+ * Contains the target tenant ID for switching the user's active tenant.
+ */
 type SwitchTenantRequest = typeof switchTenantRequest.infer;
 
 /**
@@ -1286,17 +1562,65 @@ declare const emailConfig: arktype_internal_variants_object_ts.ObjectType<{
     };
     templates?: object;
 }, {}>;
+/**
+ * Email address type with optional display name.
+ * Contains email and optional name for formatted addresses like "John Doe <john@example.com>".
+ */
 type EmailAddress = typeof emailAddress.infer;
+/**
+ * Email recipient type.
+ * Accepts either a simple email string or an EmailAddress object.
+ */
 type EmailRecipient = typeof emailRecipient.infer;
+/**
+ * Email attachment type.
+ * Contains filename, content, encoding, and disposition for email attachments.
+ */
 type EmailAttachment = typeof emailAttachment.infer;
+/**
+ * Send email options type.
+ * Contains recipients, subject, body content (text/html), attachments, and metadata.
+ */
 type SendEmailOptions = typeof sendEmailOptions.infer;
+/**
+ * Send template email options type.
+ * Contains recipients, template name, template data, and attachments.
+ */
 type SendTemplateEmailOptions = typeof sendTemplateEmailOptions.infer;
+/**
+ * Email send result type.
+ * Contains success status, message ID, and lists of accepted/rejected/pending recipients.
+ */
 type EmailSendResult = typeof emailSendResult.infer;
+/**
+ * SMTP configuration type.
+ * Contains host, port, authentication, and TLS settings for SMTP servers.
+ */
 type SmtpConfig = typeof smtpConfig.infer;
+/**
+ * Resend configuration type.
+ * Contains API key and optional domain for the Resend email service.
+ */
 type ResendConfig = typeof resendConfig.infer;
+/**
+ * SendGrid configuration type.
+ * Contains API key for the SendGrid email service.
+ */
 type SendgridConfig = typeof sendgridConfig.infer;
+/**
+ * AWS SES configuration type.
+ * Contains region and optional credentials for Amazon Simple Email Service.
+ */
 type SesConfig = typeof sesConfig.infer;
+/**
+ * Postmark configuration type.
+ * Contains server token for the Postmark email service.
+ */
 type PostmarkConfig = typeof postmarkConfig.infer;
+/**
+ * Email configuration type.
+ * Contains provider selection and provider-specific configuration.
+ */
 type EmailConfig = typeof emailConfig.infer;
 
 /**
@@ -1445,15 +1769,55 @@ declare const storageProviderConfig: arktype_internal_variants_object_ts.ObjectT
         keyFilename?: string;
     };
 }, {}>;
+/**
+ * File metadata type.
+ * Contains file information including name, MIME type, size, path, and upload details.
+ */
 type FileMetadata = typeof fileMetadata.infer;
+/**
+ * Upload options type.
+ * Contains optional path, filename, content type, ACL, and caching settings for uploads.
+ */
 type UploadOptions = typeof uploadOptions.infer;
+/**
+ * Signed URL options type.
+ * Contains expiry, HTTP method, and content type settings for generating signed URLs.
+ */
 type SignedUrlOptions = typeof signedUrlOptions.infer;
+/**
+ * List files options type.
+ * Contains prefix filter, pagination limit, cursor, and delimiter for file listing.
+ */
 type ListFilesOptions = typeof listFilesOptions.infer;
+/**
+ * List files result type.
+ * Contains array of file metadata, pagination cursor, and hasMore flag.
+ */
 type ListFilesResult = typeof listFilesResult.infer;
+/**
+ * Local storage configuration type.
+ * Contains base path, optional base URL, and file permissions for local file storage.
+ */
 type LocalStorageConfig = typeof localStorageConfig.infer;
+/**
+ * S3 storage configuration type.
+ * Contains bucket, region, endpoint, credentials, and ACL settings for Amazon S3.
+ */
 type S3StorageConfig = typeof s3StorageConfig.infer;
+/**
+ * Cloudflare R2 storage configuration type.
+ * Contains account ID, bucket, credentials, and optional public URL for R2.
+ */
 type R2StorageConfig = typeof r2StorageConfig.infer;
+/**
+ * Google Cloud Storage configuration type.
+ * Contains bucket, project ID, and credentials for GCS.
+ */
 type GcsStorageConfig = typeof gcsStorageConfig.infer;
+/**
+ * Storage provider configuration type.
+ * Contains provider selection and provider-specific configuration.
+ */
 type StorageProviderConfig = typeof storageProviderConfig.infer;
 
 /**
@@ -1623,15 +1987,55 @@ declare const queueConfig: arktype_internal_variants_object_ts.ObjectType<{
         maxStalledCount?: number;
     };
 }, {}>;
+/**
+ * Job status type.
+ * Represents job lifecycle states: 'pending' | 'active' | 'completed' | 'failed' | 'delayed' | 'paused'.
+ */
 type JobStatus = typeof jobStatus.infer;
+/**
+ * Job entity type.
+ * Represents a background job with data, status, attempts, priority, and timing information.
+ */
 type Job = typeof job.infer;
+/**
+ * Job options type.
+ * Contains priority, delay, retry attempts, backoff strategy, timeout, and repeat settings.
+ */
 type JobOptions = typeof jobOptions.infer;
+/**
+ * Add job request type.
+ * Contains job name, data payload, and optional job options.
+ */
 type AddJobRequest = typeof addJobRequest.infer;
+/**
+ * Job progress update type.
+ * Contains progress percentage, optional message, and additional data.
+ */
 type JobProgressUpdate = typeof jobProgressUpdate.infer;
+/**
+ * Queue stats type.
+ * Contains counts of jobs in each state and pause status for a queue.
+ */
 type QueueStats = typeof queueStats.infer;
+/**
+ * Queue list options type.
+ * Contains status filter, pagination range, and sort order for listing jobs.
+ */
 type QueueListOptions = typeof queueListOptions.infer;
+/**
+ * Redis queue configuration type.
+ * Contains Redis connection settings including host, port, password, and TLS.
+ */
 type RedisQueueConfig = typeof redisQueueConfig.infer;
+/**
+ * Worker options type.
+ * Contains concurrency, rate limiting, lock settings, and stalled job handling.
+ */
 type WorkerOptions = typeof workerOptions.infer;
+/**
+ * Queue configuration type.
+ * Contains provider selection, default job options, and provider-specific settings.
+ */
 type QueueConfig = typeof queueConfig.infer;
 
 /**
@@ -1757,14 +2161,50 @@ declare const cacheConfig: arktype_internal_variants_object_ts.ObjectType<{
         readThrough?: boolean;
     };
 }, {}>;
+/**
+ * Cache set options type.
+ * Contains optional TTL, tags for invalidation, and metadata.
+ */
 type CacheSetOptions = typeof cacheSetOptions.infer;
+/**
+ * Cache get result type.
+ * Contains the cached value, remaining TTL, creation time, and tags.
+ */
 type CacheGetResult = typeof cacheGetResult.infer;
+/**
+ * Cache stats type.
+ * Contains hit/miss counts, total keys, and optional memory usage.
+ */
 type CacheStats = typeof cacheStats.infer;
+/**
+ * Memory cache configuration type.
+ * Contains max size, default TTL, cleanup interval, and stale serving options.
+ */
 type MemoryCacheConfig = typeof memoryCacheConfig.infer;
+/**
+ * Redis cache configuration type.
+ * Contains Redis connection settings, key prefix, and default TTL.
+ */
 type RedisCacheConfig = typeof redisCacheConfig.infer;
+/**
+ * Upstash cache configuration type.
+ * Contains Upstash URL, token, key prefix, and default TTL.
+ */
 type UpstashCacheConfig = typeof upstashCacheConfig.infer;
+/**
+ * Cloudflare KV configuration type.
+ * Contains namespace ID, account credentials, and key prefix.
+ */
 type CloudflareKvConfig = typeof cloudflareKvConfig.infer;
+/**
+ * Multi-tier cache configuration type.
+ * Contains array of cache tiers with priorities and write-through/read-through settings.
+ */
 type MultiTierCacheConfig = typeof multiTierCacheConfig.infer;
+/**
+ * Cache configuration type.
+ * Contains provider selection and provider-specific configuration.
+ */
 type CacheConfig = typeof cacheConfig.infer;
 
 /**
@@ -1988,28 +2428,120 @@ declare const paymentsConfig: arktype_internal_variants_object_ts.ObjectType<{
     };
     webhookPath?: string;
 }, {}>;
+/**
+ * ISO 4217 currency code type.
+ * Represents a 3-letter currency code (e.g., "USD", "EUR", "GBP").
+ */
 type CurrencyCode = typeof currencyCode.infer;
+/**
+ * Money type with amount and currency.
+ * Represents a monetary value with its currency code.
+ */
 type Money = typeof money.infer;
+/**
+ * Payment customer type.
+ * Represents a customer in the payment system with email, name, and metadata.
+ */
 type PaymentCustomer = typeof paymentCustomer.infer;
+/**
+ * Create customer request type.
+ * Contains email, optional name, phone, and metadata for creating customers.
+ */
 type CreateCustomerRequest = typeof createCustomerRequest.infer;
+/**
+ * Card details type.
+ * Contains card brand, last 4 digits, expiration, and optional fingerprint.
+ */
 type CardDetails = typeof cardDetails.infer;
+/**
+ * Payment method type.
+ * Represents a stored payment method (card, bank account, etc.) for a customer.
+ */
 type PaymentMethod = typeof paymentMethod.infer;
+/**
+ * Payment intent status type.
+ * Represents payment lifecycle: 'created' | 'processing' | 'requires_action' | 'succeeded' | 'failed' | 'canceled'.
+ */
 type PaymentIntentStatus = typeof paymentIntentStatus.infer;
+/**
+ * Payment intent type.
+ * Represents a payment attempt with amount, currency, status, and customer info.
+ */
 type PaymentIntent = typeof paymentIntent.infer;
+/**
+ * Create payment intent request type.
+ * Contains customer ID, amount, currency, and optional payment method.
+ */
 type CreatePaymentIntentRequest = typeof createPaymentIntentRequest.infer;
+/**
+ * Subscription status type.
+ * Represents subscription states: 'active' | 'past_due' | 'canceled' | 'incomplete' | 'trialing' | 'paused'.
+ */
 type SubscriptionStatus = typeof subscriptionStatus.infer;
+/**
+ * Price interval type.
+ * Represents billing frequency: 'day' | 'week' | 'month' | 'year'.
+ */
 type PriceInterval = typeof priceInterval.infer;
+/**
+ * Price type.
+ * Represents a recurring price with amount, currency, interval, and trial settings.
+ */
 type Price = typeof price.infer;
+/**
+ * Subscription type.
+ * Represents a recurring subscription with status, billing period, and trial info.
+ */
 type Subscription = typeof subscription.infer;
+/**
+ * Create subscription request type.
+ * Contains customer ID, price ID, optional payment method, and trial days.
+ */
 type CreateSubscriptionRequest = typeof createSubscriptionRequest.infer;
+/**
+ * Refund status type.
+ * Represents refund states: 'pending' | 'succeeded' | 'failed' | 'canceled'.
+ */
 type RefundStatus = typeof refundStatus.infer;
+/**
+ * Refund type.
+ * Represents a refund for a payment with amount, status, and reason.
+ */
 type Refund = typeof refund.infer;
+/**
+ * Create refund request type.
+ * Contains payment intent ID, optional amount for partial refunds, and reason.
+ */
 type CreateRefundRequest = typeof createRefundRequest.infer;
+/**
+ * Webhook event type.
+ * Represents payment webhook event types like payment.succeeded, subscription.created, etc.
+ */
 type WebhookEventType = typeof webhookEventType.infer;
+/**
+ * Webhook event type.
+ * Represents a payment provider webhook event with type, data, and timestamp.
+ */
 type WebhookEvent = typeof webhookEvent.infer;
+/**
+ * Stripe configuration type.
+ * Contains Stripe API keys and webhook secret.
+ */
 type StripeConfig = typeof stripeConfig.infer;
+/**
+ * Paddle configuration type.
+ * Contains Paddle vendor credentials and webhook settings.
+ */
 type PaddleConfig = typeof paddleConfig.infer;
+/**
+ * iyzico configuration type.
+ * Contains iyzico API credentials and base URL.
+ */
 type IyzicoConfig = typeof iyzicoConfig.infer;
+/**
+ * Payments configuration type.
+ * Contains provider selection and provider-specific configuration.
+ */
 type PaymentsConfig = typeof paymentsConfig.infer;
 
 /**
@@ -2155,18 +2687,70 @@ declare const requestContext: arktype_internal_variants_object_ts.ObjectType<{
         permissions?: string[];
     };
 }, {}>;
+/**
+ * UUID path parameter type.
+ * Contains an 'id' field for extracting UUID parameters from URL paths.
+ */
 type UuidParam = typeof uuidParam.infer;
+/**
+ * Pagination query type for URL query parameters.
+ * Contains page, limit, orderBy, and orderDirection as strings for parsing.
+ */
 type PaginationQuery = typeof paginationQuery.infer;
+/**
+ * Cursor pagination query type for URL query parameters.
+ * Contains cursor, limit, and direction as strings for parsing.
+ */
 type CursorPaginationQuery = typeof cursorPaginationQuery.infer;
+/**
+ * Search query type for URL query parameters.
+ * Contains q, search, and filter fields for search endpoints.
+ */
 type SearchQuery = typeof searchQuery.infer;
+/**
+ * Date range query type for URL query parameters.
+ * Contains startDate and endDate as ISO 8601 strings.
+ */
 type DateRangeQuery = typeof dateRangeQuery.infer;
+/**
+ * Health check response type.
+ * Contains overall status, timestamp, version, uptime, and individual check results.
+ */
 type HealthResponse = typeof healthResponse.infer;
+/**
+ * API info response type.
+ * Contains API name, version, description, environment, and documentation URL.
+ */
 type ApiInfoResponse = typeof apiInfoResponse.infer;
+/**
+ * CORS configuration type.
+ * Contains origin, methods, headers, credentials, and max age settings.
+ */
 type CorsConfig = typeof corsConfig.infer;
+/**
+ * Server rate limit configuration type.
+ * Contains window size, max requests, key generator, and skip function.
+ */
 type ServerRateLimitConfig = typeof serverRateLimitConfig.infer;
+/**
+ * Logger configuration type.
+ * Contains log level, format, fields to redact, and timestamp settings.
+ */
 type LoggerConfig = typeof loggerConfig.infer;
+/**
+ * Server configuration type.
+ * Contains port, host, base path, CORS, rate limiting, and logging settings.
+ */
 type ServerConfig = typeof serverConfig.infer;
+/**
+ * Auth context type (available after auth middleware).
+ * Contains user ID, tenant ID, session ID, roles, and permissions.
+ */
 type AuthContext = typeof authContext.infer;
+/**
+ * Request context type.
+ * Contains request ID, start time, client IP, user agent, and auth context.
+ */
 type RequestContext = typeof requestContext.infer;
 
 /**