@remit/api-openapi-types 0.0.108 → 0.0.110

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@remit/api-openapi-types",
-  "version": "0.0.108",
+  "version": "0.0.110",
   "type": "module",
   "main": "types.d.ts",
   "types": "types.d.ts",

package/types.d.ts

@@ -327,7 +327,11 @@ explained to the user as a failed delete.
     /**
      * The stable name of one check the spam service ran and found something with (RFC 041). A client holds one sentence per name.
      */
-    export type SpamReasonName = "DmarcFail" | "SignerMismatch" | "ReplyToMismatch" | "LinkTextMismatch" | "LinkDomainDistant" | "PunycodeDomain" | "MixedScriptDomain" | "ConfusableDomains" | "SingleOffDomainLink" | "GeneratedName" | "FirstContactDomain" | "RecentlyRegisteredDomain" | "UnknownRegistrationDate" | "ClassifierSpam" | "ClassifierPhishing" | "ProviderSpam" | "DisplayNameForeignAddress" | "DisplayNameLookalike" | "BackendSymbol";
+    export type SpamReasonName = "DmarcFail" | "SignerMismatch" | "ReplyToMismatch" | "LinkTextMismatch" | "LinkDomainDistant" | "PunycodeDomain" | "MixedScriptDomain" | "ConfusableDomains" | "SingleOffDomainLink" | "GeneratedName" | "FirstContactDomain" | "RecentlyRegisteredDomain" | "UnknownRegistrationDate" | "ClassifierSpam" | "ClassifierPhishing" | "ProviderSpam" | "DisplayNameForeignAddress" | "DisplayNameLookalike" | "ModelImpersonation" | "ModelSpam" | "ModelClean" | "ListedPhishingLink" | "BackendSymbol";
+    /**
+     * What happened to the model call for one checked message (RFC 041 stage 3).
+     */
+    export type SpamModelOutcome = "Answered" | "NotConfigured" | "DailyLimit" | "RateLimited" | "OutOfBand";
     /**
      * Why a spam service gave no verdict (RFC 041).
      */
@@ -388,6 +392,10 @@ distinguishable from a network failure without parsing prose.
      * Message reference types per RFC 2822 Section 3.6.4
      */
     export type ReferenceType = "in_reply_to" | "references";
+    /**
+     * Why a rescan left one message unchecked (RFC 041). A caller retries only the retryable codes.
+     */
+    export type RescanFailureCode = "RateLimited" | "DailyCap" | "NotSettled" | "NotFound" | "NotPermitted";
     /**
      * Manual bulk label action (issue #26) — apply or remove a label on a `just these` selection. Never sets `appliedByFilterId`: that field is reserved for filter-driven applies (RFC 034 Decision 3.3).
      */
@@ -4983,9 +4991,9 @@ every reader of either would otherwise narrow on the kind first.
       kind: SpamKind;
       reasons: SpamReason[];
       /**
-       * The service called a model, so Remit counts the call against the daily cap.
+       * What happened to the model call: `Answered`, or why no answer shaped the verdict.
        */
-      modelCalled: boolean;
+      modelOutcome: SpamModelOutcome;
     }
     /**
      * One check that found something, shaped like an rspamd symbol.
@@ -6573,6 +6581,48 @@ either way and cannot tell which it received.
        */
       starColor?: StarColor;
     }
+    /**
+     * Messages to check again for spam and category (RFC 041).
+     */
+    export interface RescanInput {
+      /**
+       * The messages to check, all in the account the path names. At most 10 per call; a backfill sends ten per call.
+       */
+      messageIds: UUID[];
+      /**
+       * Also apply placement, moving a message the verdict sends to Junk. Without it a rescan writes verdicts, scores and labels only.
+       */
+      move?: boolean;
+    }
+    /**
+     * The outcome per message, as SQS `SendMessageBatch` answers. The call succeeds when some messages fail.
+     */
+    export interface RescanResult {
+      successful: RescanSuccess[];
+      failed: RescanFailure[];
+    }
+    /**
+     * One message the rescan checked.
+     */
+    export interface RescanSuccess {
+      messageId: UUID;
+      verdict: SpamVerdictNotChecked | SpamVerdictScreenedOut | SpamChecked | SpamFailed;
+      /**
+       * Names of the labels the rescan applied to the message.
+       */
+      labels: string[];
+    }
+    /**
+     * One message the rescan left unchecked.
+     */
+    export interface RescanFailure {
+      messageId: UUID;
+      code: RescanFailureCode;
+      /**
+       * Whether the same id may succeed on a later call: true for `RateLimited` and `DailyCap`.
+       */
+      retryable: boolean;
+    }
     /**
      * Input for bulk flag update operations
      */
@@ -7276,13 +7326,17 @@ of copying it, and so a person can see what was imported after the fact.
        */
       rcpt: string[];
       /**
-       * The connecting IP from the receiving server's Received header, or empty.
+       * The sending server's IP: the hop the provider's SPF check judged, else the first hop from a public address, or empty.
        */
       ip: string;
       /**
-       * The HELO name from the receiving server's Received header, or empty.
+       * The HELO name the sending server gave, or empty.
        */
       helo: string;
+      /**
+       * The sending server's reverse DNS name as the receiving server recorded it, or empty.
+       */
+      hostname: string;
     }
     /**
      * The provider's authentication results, read from its Authentication-Results.
@@ -8878,6 +8932,19 @@ declare namespace Paths {
       export type $401 = Components.Schemas.ApiError;
     }
   }
+  namespace RescanMessages {
+    export interface PathParameters {
+      accountId: Components.Schemas.UUID;
+    }
+    export type RequestBody = Components.Schemas.RescanInput;
+    namespace Responses {
+      export type $200 = Components.Schemas.RescanResult;
+      export type $400 = Components.Schemas.ValidationError;
+      export type $404 = Components.Schemas.ApiError;
+      export type $403 = Components.Schemas.ApiError;
+      export type $401 = Components.Schemas.ApiError;
+    }
+  }
   namespace UpdateFlags {
     export type RequestBody = Components.Schemas.BulkUpdateFlagsInput;
     namespace Responses {
@@ -9792,6 +9859,14 @@ Counting: `count=true` answers how many CONVERSATIONS match, over the whole scop
     data?: Paths.UpdateMessageFlags.RequestBody,
     config?: AxiosRequestConfig
   ): OperationResponse<Paths.UpdateMessageFlags.Responses.$200>;
+  /**
+   * AccountMessageOperations_rescanMessages - Check up to 10 messages again with the category classifier and the spam service (RFC 041), and answer once they are done. Sets a category only on mail that is still uncategorized, and never labels a message the owner marked Not spam. Writes verdicts and labels; with `move` it also applies placement. The call succeeds when some messages fail: each lands in `successful` or `failed`.
+   */
+  'AccountMessageOperations_rescanMessages'(
+    parameters?: Parameters<Paths.RescanMessages.PathParameters> | null,
+    data?: Paths.RescanMessages.RequestBody,
+    config?: AxiosRequestConfig
+  ): OperationResponse<Paths.RescanMessages.Responses.$200>;
   /**
    * MessageBulkOperations_updateFlags - Update flags on multiple messages
    */
@@ -10829,6 +10904,16 @@ Counting: `count=true` answers how many CONVERSATIONS match, over the whole scop
       config?: AxiosRequestConfig
     ): OperationResponse<Paths.UpdateMessageFlags.Responses.$200>;
   };
+  ['/accounts/{accountId}/messages/rescan']: {
+    /**
+     * AccountMessageOperations_rescanMessages - Check up to 10 messages again with the category classifier and the spam service (RFC 041), and answer once they are done. Sets a category only on mail that is still uncategorized, and never labels a message the owner marked Not spam. Writes verdicts and labels; with `move` it also applies placement. The call succeeds when some messages fail: each lands in `successful` or `failed`.
+     */
+    'post'(
+      parameters?: Parameters<Paths.RescanMessages.PathParameters> | null,
+      data?: Paths.RescanMessages.RequestBody,
+      config?: AxiosRequestConfig
+    ): OperationResponse<Paths.RescanMessages.Responses.$200>;
+  };
   ['/messages/flags']: {
     /**
      * MessageBulkOperations_updateFlags - Update flags on multiple messages
@@ -11684,6 +11769,14 @@ export interface Operations {
     requestBody: Components.Schemas.UpdateFlagsInput;
     responses: { 200: { messageId: Components.Schemas.UUID; isRead: boolean; isStarred: boolean }; 404: Components.Schemas.ApiError; 403: Components.Schemas.ApiError; 401: Components.Schemas.ApiError };
   };
+  'AccountMessageOperations_rescanMessages': {
+    params: { accountId: Components.Schemas.UUID };
+    query: {};
+    headers: {};
+    cookies: {};
+    requestBody: Components.Schemas.RescanInput;
+    responses: { 200: Components.Schemas.RescanResult; 400: Components.Schemas.ValidationError; 404: Components.Schemas.ApiError; 403: Components.Schemas.ApiError; 401: Components.Schemas.ApiError };
+  };
   'MessageBulkOperations_updateFlags': {
     params: {};
     query: {};
@@ -11999,6 +12092,10 @@ export type MessageReference = Components.Schemas.MessageReference;
 export type MessageReferenceResponse = Components.Schemas.MessageReferenceResponse;
 export type RawMessageResponse = Components.Schemas.RawMessageResponse;
 export type UpdateFlagsInput = Components.Schemas.UpdateFlagsInput;
+export type RescanInput = Components.Schemas.RescanInput;
+export type RescanResult = Components.Schemas.RescanResult;
+export type RescanSuccess = Components.Schemas.RescanSuccess;
+export type RescanFailure = Components.Schemas.RescanFailure;
 export type BulkUpdateFlagsInput = Components.Schemas.BulkUpdateFlagsInput;
 export type MessageBulkOperationResult = Components.Schemas.MessageBulkOperationResult;
 export type DeleteMessagesInput = Components.Schemas.DeleteMessagesInput;
@@ -12126,6 +12223,7 @@ export type SpamSenderScreenRule = Components.Schemas.SpamSenderScreenRule;
 export type SpamAction = Components.Schemas.SpamAction;
 export type SpamKind = Components.Schemas.SpamKind;
 export type SpamReasonName = Components.Schemas.SpamReasonName;
+export type SpamModelOutcome = Components.Schemas.SpamModelOutcome;
 export type SpamFailureKind = Components.Schemas.SpamFailureKind;
 export type OutboxAttachmentState = Components.Schemas.OutboxAttachmentState;
 export type OutboxAttachmentRejectionReason = Components.Schemas.OutboxAttachmentRejectionReason;
@@ -12139,6 +12237,7 @@ export type TransferEncoding = Components.Schemas.TransferEncoding;
 export type ContentDisposition = Components.Schemas.ContentDisposition;
 export type MultipartSubtype = Components.Schemas.MultipartSubtype;
 export type ReferenceType = Components.Schemas.ReferenceType;
+export type RescanFailureCode = Components.Schemas.RescanFailureCode;
 export type LabelAction = Components.Schemas.LabelAction;
 export type CalendarSuggestionState = Components.Schemas.CalendarSuggestionState;
 export type CalendarSuggestionSource = Components.Schemas.CalendarSuggestionSource;