@mxraven/admin - v2.1.0
    Preparing search index...

      @mxraven/admin - v2.1.0

      TypeScript SDK for the mxRaven control-plane admin API.

      The admin SDK manages a workspace end to end: domains, listeners, routing rules, API keys, suppressions, recipient sets, auto-reply templates, forwarding destinations, inbound routes, relays, storage integrations, webhook endpoints, identity providers, quotas, rate limits, governance, and mail analytics, plus the public auth login context.

      It is the TypeScript counterpart of the Java SDK at https://github.com/synqronlabs/mxraven-java/tree/main/admin and exposes the same capabilities behind an idiomatic TypeScript API.

      AdminClient
      ApiException
      APIKey
      ApiKeysClient
      AuthClient
      AuthenticationException
      AutoReplyTemplate
      AutoReplyTemplatesClient
      BadRequestException
      ConflictException
      Domain
      DomainsClient
      Entity
      GovernanceClient
      IdentityProvidersClient
      InboundRoute
      InboundRoutesClient
      Listener
      ListenerMtaRateLimitClient
      ListenersClient
      MailAnalyticsClient
      MtaRateLimitsClient
      MxRavenError
      NotFoundException
      Page
      Paged
      PermissionDeniedException
      QuotasClient
      RateLimitException
      RecipientSet
      RecipientSetMember
      RecipientSetMembersClient
      RecipientSetsClient
      Response
      RoutingRule
      RoutingRulesClient
      SendingDomainPoliciesClient
      ServerException
      SmtpForwardDestination
      SmtpForwardDestinationsClient
      SmtpRelay
      SmtpRelaysClient
      StorageIntegration
      StorageIntegrationsClient
      SuppressionsClient
      TenantIdentityProvider
      TenantSuppression
      ValidationException
      WebhookDeliveriesClient
      WebhookEndpoint
      WebhookEndpointsClient
      Workspace
      AdminClientOptions
      ApiExceptionOptions
      APIKeyData
      ApiKeysClientOptions
      AuditLog
      AuthClientOptions
      AutoReplySenderReadiness
      AutoReplyTemplateContentSummary
      AutoReplyTemplateData
      AutoReplyTemplateHeader
      AutoReplyTemplatesClientOptions
      BreakdownOptions
      ConfirmSmtpForwardDestinationRequest
      CreateAutoReplyTemplateRequest
      CreateDomainRequest
      CreateInboundRouteRequest
      CreateListenerRequest
      CreateRecipientSetRequest
      CreateRoutingRuleRequest
      CreateSmtpForwardDestinationRequest
      CreateSmtpRelayRequest
      CreateStorageIntegrationRequest
      CreateTenantAppleIdentityProviderRequest
      CreateTenantAzureAdIdentityProviderRequest
      CreateTenantGitHubEnterpriseServerIdentityProviderRequest
      CreateTenantGitHubIdentityProviderRequest
      CreateTenantGitLabIdentityProviderRequest
      CreateTenantGitLabSelfHostedIdentityProviderRequest
      CreateTenantGoogleIdentityProviderRequest
      CreateTenantIdentityProviderRequest
      CreateTenantJwtIdentityProviderRequest
      CreateTenantLdapIdentityProviderRequest
      CreateTenantOAuthIdentityProviderRequest
      CreateTenantSamlIdentityProviderRequest
      CreateTenantSuppressionRequest
      CreateWebhookEndpointRequest
      DnsInstructionRecord
      DomainData
      DomainLifecycleOptions
      DomainListenerGrant
      DomainsClientOptions
      EffectiveTenantQuotas
      EntityOptions
      GovernanceClientOptions
      IdentityAccessClaim
      IdentityProvidersClientOptions
      IdentityProvisioning
      InboundRouteData
      InboundRoutesClientOptions
      IntervalOptions
      IssuedAPIKey
      IssuedWebhookEndpoint
      LdapAttributes
      LifecycleOptions
      ListAuditLogOptions
      ListAutoReplyTemplatesOptions
      ListDomainsOptions
      ListenerData
      ListenerMtaRateLimitClientOptions
      ListenerNotificationSetting
      ListenerOverviewOptions
      ListenersClientOptions
      ListIdentityProvidersOptions
      ListInboundRoutesOptions
      ListListenersOptions
      ListOptions
      ListRecipientSetMembersOptions
      ListRecipientSetsOptions
      ListRoutingRulesOptions
      ListSmtpForwardDestinationsOptions
      ListSuppressionsOptions
      MailAnalyticsAcceptedMessages
      MailAnalyticsActivityHeatmap
      MailAnalyticsActivityHeatmapCell
      MailAnalyticsBreakdown
      MailAnalyticsBreakdownItem
      MailAnalyticsClientOptions
      MailAnalyticsComparison
      MailAnalyticsComparisonPeriod
      MailAnalyticsCountBin
      MailAnalyticsDomainFailureStatus
      MailAnalyticsDomainLifecycle
      MailAnalyticsDomainLifecycleItem
      MailAnalyticsFeedback
      MailAnalyticsLatencyBySize
      MailAnalyticsLatencyMetric
      MailAnalyticsLatencySet
      MailAnalyticsLatencyStatistic
      MailAnalyticsLifecycle
      MailAnalyticsLifecycleCohort
      MailAnalyticsLifecycleFunnel
      MailAnalyticsLifecycleTimePoint
      MailAnalyticsListenerBreakdown
      MailAnalyticsListenerBreakdownItem
      MailAnalyticsListenerIdentity
      MailAnalyticsListenerOverview
      MailAnalyticsListenerOverviewMetrics
      MailAnalyticsListenerOverviewTimePoint
      MailAnalyticsMessageContent
      MailAnalyticsMetrics
      MailAnalyticsOutcomeLatency
      MailAnalyticsOverview
      MailAnalyticsRate
      MailAnalyticsRatio
      MailAnalyticsRetry
      MailAnalyticsSeries
      MailAnalyticsSeriesItem
      MailAnalyticsSeriesPoint
      MailAnalyticsSMTPResponses
      MailAnalyticsTaskSizeBucket
      MailAnalyticsTaskSizeStatistics
      MailAnalyticsTerminalOutcomes
      MailAnalyticsTimePoint
      MaskedTemplateField
      ModifyHeaderOperation
      MTARateLimitOverride
      MTARateLimitPolicy
      MtaRateLimitsClientOptions
      PagedOptions
      PageOptions
      Problem
      ProblemError
      ProviderOptions
      QuotasClientOptions
      RateLimitConfig
      RecipientSetBatchResult
      RecipientSetData
      RecipientSetMemberData
      RecipientSetMemberRequest
      RecipientSetMembersBatchRequest
      RecipientSetMembersClientOptions
      RecipientSetsClientOptions
      ReorderRoutingRuleRequest
      ReplaceDomainRequest
      ReplaceRoutingRuleRequest
      ReplaceSendingDomainPolicyRequest
      RequestOptions
      ResponseOptions
      RoutingRuleAction
      RoutingRuleData
      RoutingRulePayload
      RoutingRulesClientOptions
      SearchResourcesOptions
      SendingDomainPoliciesClientOptions
      SendingDomainPolicy
      SendingDomainPolicyGrant
      SendingDomainPolicyGrantRequest
      SetAutoReplyTemplateActiveRequest
      SetIntegrationActiveRequest
      SetRoutingRuleActiveRequest
      SmtpForwardDestinationConfirmation
      SmtpForwardDestinationData
      SmtpForwardDestinationsClientOptions
      SmtpRelayData
      SmtpRelaysClientOptions
      StorageIntegrationData
      StorageIntegrationsClientOptions
      SuppressionsClientOptions
      Tenant
      TenantDedicatedIPPool
      TenantIdentityProviderData
      TenantLoginContext
      TenantQuota
      TenantQuotaGuardrailProfile
      TenantQuotaUsage
      TenantResourceSearchResult
      TenantSuppressionData
      TerminalActionPayload
      UpdateAutoReplyTemplateRequest
      UpdateIdentityProviderAutoGrantRequest
      UpdateIdentityProvisioningRequest
      UpdateInboundRouteRequest
      UpdateListenerDefaultTerminalActionRequest
      UpdateListenerNotificationsRequest
      UpdateListenerRequest
      UpdateListenerRspamdScanningRequest
      UpdateRecipientSetRequest
      UpdateSmtpRelayRequest
      UpdateStorageIntegrationRequest
      UpdateTenantSuppressionRequest
      UpdateWebhookEndpointRequest
      WebhookDeliveriesClientOptions
      WebhookDelivery
      WebhookEndpointData
      WebhookEndpointsClientOptions
      WorkspaceOptions
      AuditActorKind
      AuditStatus
      AutoReplySenderReadinessStatus
      AzureAdTenantType
      DnsRecordType
      DomainStatus
      FetchLike
      IdentityProviderLifecycleStatus
      IdentityProviderType
      IdpAutoLinking
      InboundRouteVerificationStatus
      ListenerType
      MailAnalyticsBucketGranularity
      MailAnalyticsDimension
      MailAnalyticsListenerState
      MailAnalyticsMetric
      MailAnalyticsOutcome
      MailAnalyticsResourceState
      MailAnalyticsSizeBin
      MailAnalyticsTimezone
      ModifyHeaderOp
      MtaRateLimitScope
      MtaRateLimitSource
      PageFetcher
      QueryValues
      RoutingRuleActionKind
      SamlBinding
      SamlNameIdFormat
      SamlSignatureAlgorithm
      SendingDomainSubdomainScope
      SmtpForwardDestinationVerificationMethod
      SmtpForwardDestinationVerificationStatus
      SmtpForwardVerificationDeliveryStatus
      StreamType
      SuppressionReason
      TenantProvisioningState
      TenantSearchResourceType
      TenantStatus
      TerminalActionType
      WebhookDeliveryKind
      auditActorKind
      auditStatus
      autoReplySenderReadinessStatus
      azureAdTenantType
      defaultRateLimitConfig
      disabledRateLimitConfig
      dnsRecordType
      domainStatus
      identityProviderLifecycleStatus
      identityProviderType
      idpAutoLinking
      inboundRouteVerificationStatus
      listenerType
      mailAnalyticsBucketGranularity
      mailAnalyticsDimension
      mailAnalyticsListenerState
      mailAnalyticsMetric
      mailAnalyticsOutcome
      mailAnalyticsResourceState
      mailAnalyticsSizeBin
      mailAnalyticsTimezone
      MIN_SEARCH_LENGTH
      modifyHeaderOp
      modifyHeaderOperation
      mtaRateLimitScope
      mtaRateLimitSource
      routingRuleAction
      routingRuleActionKind
      samlBinding
      samlNameIdFormat
      samlSignatureAlgorithm
      sendingDomainSubdomainScope
      smtpForwardDestinationVerificationMethod
      smtpForwardDestinationVerificationStatus
      smtpForwardVerificationDeliveryStatus
      streamType
      suppressionReason
      tenantProvisioningState
      tenantSearchResourceType
      tenantStatus
      terminalActionPayload
      terminalActionType
      webhookDeliveryKind