@madewithremy/admin 0.1.0 → 0.1.1

package/dist/index.d.ts

@@ -1907,7 +1907,10 @@ declare namespace domains {
  *   src/http/routes/V2Apps/manage/emailDomains.ts
  *   src/http/routes/V2Apps/manage/requestLog.ts (inbox route only)
  *   src/common/Db/v2Apps/V2EmailMessagesDao/index.ts
+ *   src/common/Db/v2Apps/V2EmailBatchesDao/index.ts
+ *   src/common/Db/v2Apps/V2EmailTenantStateDao/index.ts
  *   src/common/Db/v2Apps/AppEmailSuppressionsDao/index.ts
+ *   src/common/OutboundEmail/batchView.ts
  *   src/common/Aws/SesIdentityService.ts
  *   src/common/Db/v2Apps/RequestLogDao.ts
  */
@@ -1959,7 +1962,20 @@ interface EmailSummary {
     }>;
 }
 /**
- * One fan-out blast, aggregated (V2EmailMessagesDao.listBatches / getBatch).
+ * Lifecycle of a QUEUED send (batchView.ts / V2EmailBatchesDao). Large or
+ * marketing sends are accepted immediately and delivered by a worker in
+ * chunks, so a blast can legitimately be observed mid-flight.
+ *
+ *   accepted   queued, nothing delivered yet
+ *   sending    chunks are draining
+ *   completed  every recipient was handed to the provider
+ *   partial    finished, but some recipients were not sent to
+ *   failed     finished and nothing was sent
+ */
+type EmailBatchLifecycle = 'accepted' | 'sending' | 'completed' | 'partial' | 'failed';
+/**
+ * One fan-out blast, aggregated (batchView.ts — the per-recipient aggregate
+ * enriched with the queued-send lifecycle where one exists).
  * `recipients` is every row in the blast including ones that never reached SES;
  * `accepted` is only those SES took and is the denominator for any rate.
  */
@@ -1970,6 +1986,17 @@ interface EmailBatchSummary {
     recipients: number;
     accepted: number;
     counts: Record<EmailMessageStatus, number>;
+    /**
+     * Lifecycle of the send, when it was QUEUED. `null` for a send delivered
+     * inline (small transactional) and for blasts predating the send queue —
+     * that is a normal, finished send with no in-flight state, NOT an error.
+     */
+    status: EmailBatchLifecycle | null;
+    /** Delivery-chunk progress, when queued. Null otherwise. */
+    chunksTotal: number | null;
+    chunksDone: number | null;
+    /** Recipients not yet attempted, when queued. Null otherwise. */
+    pending: number | null;
 }
 /** One row from app_email_suppressions (AppEmailSuppressionsDao). */
 interface AppEmailSuppression {
@@ -2095,12 +2122,85 @@ interface EmailSuppressionsResult {
 interface EmailSuppressResult {
     ok: true;
 }
-/** email unsuppress → POST /outbound-email/suppressions/remove */
+/**
+ * email unsuppress → POST /outbound-email/suppressions/remove
+ *
+ * Three independent outcomes, and only the tenant entry decides deliverability:
+ *   removed              this app's own suppression row is gone
+ *   tenantEntryRemoved   the app's SES TENANT suppression entry (a prior hard
+ *                        bounce or spam report against THIS app) is gone — this
+ *                        is what actually unblocks mail
+ *   platformSuppression  non-null = still on SES's ACCOUNT-wide list, which is
+ *                        never cleared; removal changed nothing about delivery
+ */
 interface EmailUnsuppressResult {
     ok: true;
     removed: boolean;
+    tenantEntryRemoved: boolean;
     platformSuppression: PlatformSuppression | null;
 }
+/**
+ * email status → GET /outbound-email/status
+ *
+ * Whether this app can send right now, and up to what. Two independent
+ * verdicts, deliberately not collapsed: `ses` is Amazon's view of the app's
+ * tenant and `enforcement` is the platform's own. The fields that decide what
+ * to tell the owner:
+ *
+ *   sending.source        'ses' = AMAZON paused it (we cannot lift it; it
+ *                         clears when the finding clears); 'platform' = we did
+ *   enforcement.origin    'operator' = a person placed the hold — it will NOT
+ *                         lift itself when rates recover; 'platform' = the
+ *                         automatic sweep, which steps down on its own
+ *   ses.status            'REINSTATED' still sends — it means "resuming with
+ *                         findings open" and returns to ENABLED on recovery
+ */
+interface EmailSendingStatusResult {
+    sending: {
+        allowed: boolean;
+        reason: string | null;
+        source: 'ses' | 'platform' | null;
+    };
+    enforcement: {
+        level: 'none' | 'throttled' | 'paused';
+        origin: 'platform' | 'operator' | null;
+        reason: string | null;
+        at: string | null;
+    };
+    ses: {
+        status: 'ENABLED' | 'DISABLED' | 'REINSTATED' | null;
+        origin: 'CUSTOMER_MANAGED' | 'AWS_SES_MANAGED' | null;
+        cause: string | null;
+        at: string | null;
+    };
+    /**
+     * The enforcement sweep's last measurement, with its denominator — a rate
+     * without `accepted` is unreadable (1 bounce in 10 sends is "10%" and means
+     * nothing). All null until the sweep has evaluated this app.
+     */
+    evaluation: {
+        accepted: number | null;
+        bounceRate: number | null;
+        complaintRate: number | null;
+        at: string | null;
+    };
+    quota: {
+        unit: string;
+        window: 'day' | 'month' | 'total';
+        /** `null` = unlimited. */
+        limit: number | null;
+        used: number;
+        remaining: number | null;
+        resetsAt: string | null;
+        /**
+         * Where the limit came from: 'platform' is the default; 'app'/'org'/'plan'
+         * is an override — support-granted, or the sweep's automatic throttle.
+         */
+        source: 'app' | 'org' | 'plan' | 'platform';
+        /** When an override lapses and the limit reverts. */
+        expiresAt: string | null;
+    };
+}
 /** email inbox → GET /inbox */
 interface EmailInboxResult {
     emails: InboxEmailPreview[];
@@ -2155,9 +2255,10 @@ interface EmailListParams {
     /**
      * Comma-separated statuses to include. Values: `suppressed`, `failed`,
      * `sent`, `delivered`, `blocked`, `bounced`, `complained`, `delayed`,
-     * `rejected`. Default: all statuses. `blocked` means the platform-wide SES
-     * suppression list dropped the message — usually from another tenant's hard
-     * bounce — not the app's own suppression list.
+     * `rejected`. Default: all statuses. `blocked` means an SES suppression list
+     * dropped the message before delivery — usually this app's OWN tenant list
+     * (a prior hard bounce or spam report from that address), occasionally the
+     * shared account-wide list. `unsuppress` reports which.
      */
     status?: string;
     /** Origin to filter by: `method` (app-sent) or `auth` (sign-in codes). Default: all. */
@@ -4985,6 +5086,7 @@ declare function buildClient(ctx: AdminContext): {
         list: (params?: EmailListParams | undefined) => Promise<EmailListResult>;
         get: (messageId: string) => Promise<V2EmailMessage>;
         stats: (params?: EmailWindowParams | undefined) => Promise<EmailSummary>;
+        status: () => Promise<EmailSendingStatusResult>;
         batches: (params?: EmailBatchesParams | undefined) => Promise<EmailBatchesResult>;
         batch: (batchId: string) => Promise<EmailBatchSummary>;
         suppressions: (params?: EmailSuppressionsParams | undefined) => Promise<EmailSuppressionsResult>;
@@ -5047,4 +5149,4 @@ declare class AdminTimeoutError extends Error {
 
 declare const admin: AdminClient;
 
-export { AdminApiError, type AdminClient, type AdminClientOptions, type AdminContext, AdminTimeoutError, type AnalyticsAiHostRow, type AnalyticsAiSourcesResult, type AnalyticsAiVendorRow, type AnalyticsBatchResult, type AnalyticsCrawlersOverviewResult, type AnalyticsCrawlersRecentResult, type AnalyticsCrawlersRecentRow, type AnalyticsCrawlersResult, type AnalyticsCrawlersTimeseriesBucket, type AnalyticsCrawlersTimeseriesResult, type AnalyticsLiveResult, type AnalyticsMapPoint, type AnalyticsMapResult, type AnalyticsMetric, type AnalyticsQueryResult, type AnalyticsQueryResultRow, type AnalyticsSourceRow, type AnalyticsSourcesResult, type AppCronJobStatus, type AppCronJobStatusReason, type AppCronRunState, type AppEmailSuppression, type AppSecretRow, type CrashGroup, type CrashOccurrenceRow, type CrashesGetResult, type CrashesListResult, type CrashesOccurrencesResult, type CrashesStatsBucket, type CrashesStatsResult, type CronJobDecorated, type CronOverviewResult, type CronRunResult, type CronRunSummary, type DashboardLiveRelease, type DashboardReleaseMethod, type DashboardResult, type DataLiftFromDevResult, type DataLiftFromLiveResult, type DataSourcesBuildProgress, type DataSourcesChunkingConfig, type DataSourcesConfigResult, type DataSourcesConfigUpdateResult, type DataSourcesDeleteResult, type DataSourcesDocument, type DataSourcesDocumentConfirmResult, type DataSourcesDocumentDeleteResult, type DataSourcesDocumentStatus, type DataSourcesDocumentsResult, type DataSourcesDropResult, type DataSourcesIngestConfig, type DataSourcesIngestUpdate, type DataSourcesListEntry, type DataSourcesListResult, type DataSourcesPromoteResult, type DataSourcesRetrievalConfig, type DataSourcesRetrievalUpdate, type DataSourcesRevectorizeResult, type DataSourcesSearchCitation, type DataSourcesSearchResult, type DataSourcesSearchResultItem, type DataSourcesUploadTokenResult, type DatasetFile, type DbQueryResult, type DiagnosticsAuditEnvironment, type DiagnosticsDashboardResult, type DiagnosticsFinding, type DiagnosticsLighthouseScores, type DiagnosticsPayload, type DiagnosticsReleaseResult, type DiagnosticsRuntimeFindings, type DomainsCheckResult, type DomainsCustomAddResult, type DomainsCustomCheckResult, type DomainsCustomHostnameUiStatus, type DomainsCustomHostnameView, type DomainsCustomListResult, type DomainsCustomRemoveResult, type DomainsCustomRetryResult, type DomainsDnsInstructions, type DomainsGetResult, type DomainsSetResult, type EmailBatchResult, type EmailBatchSummary, type EmailBatchesResult, type EmailDomainBase, type EmailEffectiveSender, type EmailInboxResult, type EmailListResult, type EmailMessageKind, type EmailMessageResult, type EmailMessageStatus, type EmailSenderTier, type EmailStatsResult, type EmailSummary, type EmailSuppressResult, type EmailSuppressionsResult, type EmailUnsuppressResult, type FilesDeleteResult, type FilesFileMeta, type FilesListEntry, type FilesListResult, type FilesLsResult, type FilesScanBadge, type FilesScanFlagged, type FilesScanStore, type FilesStatResult, type FilesStoreSummaryEntry, type FilesUploadUrlResult, type FilesUrlResult, type FrontendErrorType, type InboundDnsInstructions, type InboundEmailDomainAddResult, type InboundEmailDomainCheckResult, type InboundEmailDomainDeleteResult, type InboundEmailDomainUiStatus, type InboundEmailDomainVerifyResult, type InboundEmailDomainView, type InboundEmailDomainsListResult, type InboxEmailPreview, type IssueAuthorKind, type IssueCommentRow, type IssueEventType, type IssueKind, type IssueRow, type IssueStatus, type IssuesCommentResult, type IssuesCreateResult, type IssuesDeleteResult, type IssuesGetResult, type IssuesListResult, type IssuesUpdateResult, type JewelPairRow, type JewelPairSummaryRow, type JewelVerdict, type JewelsDatasetSummary, type JewelsDryrunResult, type JewelsExportResult, type JewelsGradeResult, type JewelsGrading, type JewelsOverviewResult, type JewelsPairResult, type JewelsPairsResult, type JewelsQueueResult, type JewelsResolveResult, type JewelsRunResult, type JewelsRunsResult, type JewelsTimeseriesBucket, type JewelsTimeseriesResult, type JewelsTrainResult, type LiftedDatabase, type MethodsInvokeResult, type OutboundDnsInstructions, type OutboundEmailDomainAddResult, type OutboundEmailDomainCheckResult, type OutboundEmailDomainDeleteResult, type OutboundEmailDomainUiStatus, type OutboundEmailDomainVerifyResult, type OutboundEmailDomainView, type OutboundEmailDomainsListResult, type PlatformSuppression, type PrerenderGetResult, type PrerenderInvalidateResult, type PrerenderPage, type PrerenderPagesResult, type PrerenderViewResult, type ReleaseFragment, type ReleasesByCommitResult, type ReleasesGetResult, type ReleasesListResult, type RequestsGetResult, type RequestsListResult, type RequestsListRow, type RequestsStatsMethodBucket, type RequestsStatsMethodResult, type RequestsStatsSummaryBucket, type RequestsStatsSummaryResult, type SecretsDeleteResult, type SecretsGetResult, type SecretsListResult, type SecretsSetResult, type SettingsResult, type SuppressionSource, type TrainingLogEntry, type TrainingRunRow, type TrainingRunStatus, type UserAuthProvider, type UserListItem, type UserRecord, type UsersCreateApiKeyResult, type UsersListResult, type UsersRevokeApiKeyResult, type UsersSetRoleResult, type V2AppSettings, type V2BuildLogEntry, type V2BuildStats, type V2CommitInfo, type V2EmailMessage, type V2ReleaseStatus, type VoiceAvailableNumber, type VoiceNumbersBuyResult, type VoiceNumbersListResult, type VoiceNumbersReleaseResult, type VoiceNumbersSearchResult, type VoiceNumbersSetNameResult, type VoicePhoneNumberStatus, type VoicePhoneNumberView, type VoiceResolvedPolicy, type VoiceSessionChannel, type VoiceSessionCost, type VoiceSessionCostLine, type VoiceSessionDetail, type VoiceSessionGetResult, type VoiceSessionListItem, type VoiceSessionSip, type VoiceSessionSpeechEntry, type VoiceSessionStatus, type VoiceSessionToolEntry, type VoiceSessionTranscriptEntry, type VoiceSessionsListResult, type VoiceSettingsCeilings, type VoiceSettingsGetResult, type VoiceSettingsOverrides, type VoiceSettingsSetResult, admin, createAdminClient, admin as default };
+export { AdminApiError, type AdminClient, type AdminClientOptions, type AdminContext, AdminTimeoutError, type AnalyticsAiHostRow, type AnalyticsAiSourcesResult, type AnalyticsAiVendorRow, type AnalyticsBatchResult, type AnalyticsCrawlersOverviewResult, type AnalyticsCrawlersRecentResult, type AnalyticsCrawlersRecentRow, type AnalyticsCrawlersResult, type AnalyticsCrawlersTimeseriesBucket, type AnalyticsCrawlersTimeseriesResult, type AnalyticsLiveResult, type AnalyticsMapPoint, type AnalyticsMapResult, type AnalyticsMetric, type AnalyticsQueryResult, type AnalyticsQueryResultRow, type AnalyticsSourceRow, type AnalyticsSourcesResult, type AppCronJobStatus, type AppCronJobStatusReason, type AppCronRunState, type AppEmailSuppression, type AppSecretRow, type CrashGroup, type CrashOccurrenceRow, type CrashesGetResult, type CrashesListResult, type CrashesOccurrencesResult, type CrashesStatsBucket, type CrashesStatsResult, type CronJobDecorated, type CronOverviewResult, type CronRunResult, type CronRunSummary, type DashboardLiveRelease, type DashboardReleaseMethod, type DashboardResult, type DataLiftFromDevResult, type DataLiftFromLiveResult, type DataSourcesBuildProgress, type DataSourcesChunkingConfig, type DataSourcesConfigResult, type DataSourcesConfigUpdateResult, type DataSourcesDeleteResult, type DataSourcesDocument, type DataSourcesDocumentConfirmResult, type DataSourcesDocumentDeleteResult, type DataSourcesDocumentStatus, type DataSourcesDocumentsResult, type DataSourcesDropResult, type DataSourcesIngestConfig, type DataSourcesIngestUpdate, type DataSourcesListEntry, type DataSourcesListResult, type DataSourcesPromoteResult, type DataSourcesRetrievalConfig, type DataSourcesRetrievalUpdate, type DataSourcesRevectorizeResult, type DataSourcesSearchCitation, type DataSourcesSearchResult, type DataSourcesSearchResultItem, type DataSourcesUploadTokenResult, type DatasetFile, type DbQueryResult, type DiagnosticsAuditEnvironment, type DiagnosticsDashboardResult, type DiagnosticsFinding, type DiagnosticsLighthouseScores, type DiagnosticsPayload, type DiagnosticsReleaseResult, type DiagnosticsRuntimeFindings, type DomainsCheckResult, type DomainsCustomAddResult, type DomainsCustomCheckResult, type DomainsCustomHostnameUiStatus, type DomainsCustomHostnameView, type DomainsCustomListResult, type DomainsCustomRemoveResult, type DomainsCustomRetryResult, type DomainsDnsInstructions, type DomainsGetResult, type DomainsSetResult, type EmailBatchLifecycle, type EmailBatchResult, type EmailBatchSummary, type EmailBatchesResult, type EmailDomainBase, type EmailEffectiveSender, type EmailInboxResult, type EmailListResult, type EmailMessageKind, type EmailMessageResult, type EmailMessageStatus, type EmailSenderTier, type EmailSendingStatusResult, type EmailStatsResult, type EmailSummary, type EmailSuppressResult, type EmailSuppressionsResult, type EmailUnsuppressResult, type FilesDeleteResult, type FilesFileMeta, type FilesListEntry, type FilesListResult, type FilesLsResult, type FilesScanBadge, type FilesScanFlagged, type FilesScanStore, type FilesStatResult, type FilesStoreSummaryEntry, type FilesUploadUrlResult, type FilesUrlResult, type FrontendErrorType, type InboundDnsInstructions, type InboundEmailDomainAddResult, type InboundEmailDomainCheckResult, type InboundEmailDomainDeleteResult, type InboundEmailDomainUiStatus, type InboundEmailDomainVerifyResult, type InboundEmailDomainView, type InboundEmailDomainsListResult, type InboxEmailPreview, type IssueAuthorKind, type IssueCommentRow, type IssueEventType, type IssueKind, type IssueRow, type IssueStatus, type IssuesCommentResult, type IssuesCreateResult, type IssuesDeleteResult, type IssuesGetResult, type IssuesListResult, type IssuesUpdateResult, type JewelPairRow, type JewelPairSummaryRow, type JewelVerdict, type JewelsDatasetSummary, type JewelsDryrunResult, type JewelsExportResult, type JewelsGradeResult, type JewelsGrading, type JewelsOverviewResult, type JewelsPairResult, type JewelsPairsResult, type JewelsQueueResult, type JewelsResolveResult, type JewelsRunResult, type JewelsRunsResult, type JewelsTimeseriesBucket, type JewelsTimeseriesResult, type JewelsTrainResult, type LiftedDatabase, type MethodsInvokeResult, type OutboundDnsInstructions, type OutboundEmailDomainAddResult, type OutboundEmailDomainCheckResult, type OutboundEmailDomainDeleteResult, type OutboundEmailDomainUiStatus, type OutboundEmailDomainVerifyResult, type OutboundEmailDomainView, type OutboundEmailDomainsListResult, type PlatformSuppression, type PrerenderGetResult, type PrerenderInvalidateResult, type PrerenderPage, type PrerenderPagesResult, type PrerenderViewResult, type ReleaseFragment, type ReleasesByCommitResult, type ReleasesGetResult, type ReleasesListResult, type RequestsGetResult, type RequestsListResult, type RequestsListRow, type RequestsStatsMethodBucket, type RequestsStatsMethodResult, type RequestsStatsSummaryBucket, type RequestsStatsSummaryResult, type SecretsDeleteResult, type SecretsGetResult, type SecretsListResult, type SecretsSetResult, type SettingsResult, type SuppressionSource, type TrainingLogEntry, type TrainingRunRow, type TrainingRunStatus, type UserAuthProvider, type UserListItem, type UserRecord, type UsersCreateApiKeyResult, type UsersListResult, type UsersRevokeApiKeyResult, type UsersSetRoleResult, type V2AppSettings, type V2BuildLogEntry, type V2BuildStats, type V2CommitInfo, type V2EmailMessage, type V2ReleaseStatus, type VoiceAvailableNumber, type VoiceNumbersBuyResult, type VoiceNumbersListResult, type VoiceNumbersReleaseResult, type VoiceNumbersSearchResult, type VoiceNumbersSetNameResult, type VoicePhoneNumberStatus, type VoicePhoneNumberView, type VoiceResolvedPolicy, type VoiceSessionChannel, type VoiceSessionCost, type VoiceSessionCostLine, type VoiceSessionDetail, type VoiceSessionGetResult, type VoiceSessionListItem, type VoiceSessionSip, type VoiceSessionSpeechEntry, type VoiceSessionStatus, type VoiceSessionToolEntry, type VoiceSessionTranscriptEntry, type VoiceSessionsListResult, type VoiceSettingsCeilings, type VoiceSettingsGetResult, type VoiceSettingsOverrides, type VoiceSettingsSetResult, admin, createAdminClient, admin as default };

package/dist/index.js

@@ -72,11 +72,11 @@ __export(analytics_exports, {
 
 // src/errors.ts
 var AdminApiError = class extends Error {
-  constructor(method, path3, status, body) {
-    super(`API ${method} ${path3} returned ${status}: ${JSON.stringify(body)}`);
+  constructor(method, path3, status2, body) {
+    super(`API ${method} ${path3} returned ${status2}: ${JSON.stringify(body)}`);
     this.method = method;
     this.path = path3;
-    this.status = status;
+    this.status = status2;
     this.body = body;
     this.name = "AdminApiError";
   }
@@ -833,6 +833,7 @@ __export(email_exports, {
   listDomains: () => listDomains,
   removeDomain: () => removeDomain,
   stats: () => stats2,
+  status: () => status,
   suppress: () => suppress,
   suppressions: () => suppressions,
   unsuppress: () => unsuppress,
@@ -884,6 +885,13 @@ function stats2(ctx, params = {}) {
     `/_internal/v2/apps/${ctx.appId}/outbound-email/summary${qs(params)}`
   );
 }
+function status(ctx) {
+  return call(
+    ctx,
+    "GET",
+    `/_internal/v2/apps/${ctx.appId}/outbound-email/status`
+  );
+}
 function batches(ctx, params = {}) {
   return call(
     ctx,