@remit/api-openapi-types 0.0.114 → 0.0.116

package/package.json

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

package/types.d.ts

@@ -356,6 +356,10 @@ member (naming the file, the size and the cap), so a refusal must be
 distinguishable from a network failure without parsing prose.
      */
     export type OutboxAttachmentRejectionReason = "EmptyFile" | "UnusableFilename" | "FileTooLarge" | "MessageTooLarge" | "TooManyAttachments" | "ReservationExpired" | "UploadMissing" | "SizeMismatch";
+    /**
+     * Names a boolean trust flag of `AddressFlags` that `GET /addresses/search` can filter on
+     */
+    export type AddressTrustFlag = "neverSpam" | "blocked" | "vip";
     /**
      * Names a key of `AddressFlags` that a client may address in `PATCH /addresses/{addressId}`. `wellknown` is deliberately absent: it is server-owned, derived from engagement counters, and is never written or removed by a client.
      */
@@ -2900,6 +2904,10 @@ recap, #1278). A distinct model, deliberately NOT a Filter: it carries no
 rule.
      */
     export interface OrganizeInput {
+      /**
+       * Start the pass at this position: the nextPosition of a finished job, to continue its selection. Send the predicate and action, or the filterId, that job ran.
+       */
+      startPosition?: string;
       /**
        * Back-apply this standing filter instead of the predicate in this body. The server reads the filter's persisted predicate and action, runs the pass over the inbox, and skips a move another active filter outranks, as index time does. The predicate and action fields of this body are ignored when it is set.
        */
@@ -3019,6 +3027,18 @@ standing to persist.
        * Number of matches the action was successfully applied to
        */
       appliedCount: number;
+      /**
+       * Where in the selection this job starts: the store position the job it continues stopped at, or empty to start at the newest message.
+       */
+      startPosition: string;
+      /**
+       * Where in the selection the next job continues, or empty when no message after this batch still matches.
+       */
+      nextPosition: string;
+      /**
+       * Number of messages after this batch that still match the selection, set when the pass completes. A job is capped, so a selection larger than the cap continues in a new job started at this job's nextPosition. Exact for a folder sweep; an upper bound for a rule, whose remaining rows are still refined by the rule.
+       */
+      remainingCount: number;
       /**
        * Number of matches whose action apply failed
        */
@@ -3088,6 +3108,14 @@ standing to persist.
        * Number of matches the action was successfully applied to
        */
       appliedCount: number;
+      /**
+       * Where in the selection the next job continues, or empty when no message after this batch still matches.
+       */
+      nextPosition: string;
+      /**
+       * Number of messages after this batch that still match the selection, set when the pass completes. A job is capped, so a selection larger than the cap continues in a new job started at this job's nextPosition. Exact for a folder sweep; an upper bound for a rule, whose remaining rows are still refined by the rule.
+       */
+      remainingCount: number;
       /**
        * Number of matches whose action apply failed
        */
@@ -8984,6 +9012,7 @@ declare namespace Paths {
     export interface QueryParameters {
       q: string;
       limit?: number;
+      flag?: Components.Schemas.AddressTrustFlag;
     }
     namespace Responses {
       export type $200 = { continuationToken?: Components.Schemas.String800; items: Components.Schemas.AddressResponse[] };
@@ -9437,7 +9466,7 @@ export interface OperationMethods {
     config?: AxiosRequestConfig
   ): OperationResponse<Paths.DeleteLabel.Responses.$204>;
   /**
-   * OrganizeOperations_createOrganizeJob - Start a one-time "all like these" back-apply: match the corpus against the given predicate and apply the action to every match, in one pass. Returns immediately with an organizeJobId; poll GET /accounts/{accountId}/organize/{organizeJobId} for state and counts. Never creates a Filter row (RFC 034 recap).
+   * OrganizeOperations_createOrganizeJob - Start a one-time "all like these" back-apply: match the corpus against the given predicate and apply the action to every match, in one pass of at most 500 messages. Returns immediately with an organizeJobId; poll GET /accounts/{accountId}/organize/{organizeJobId} for state, counts, remainingCount and the nextPosition that continues the selection. Never creates a Filter row (RFC 034 recap).
    */
   'OrganizeOperations_createOrganizeJob'(
     parameters?: Parameters<Paths.CreateOrganizeJob.PathParameters> | null,
@@ -9453,7 +9482,7 @@ export interface OperationMethods {
     config?: AxiosRequestConfig
   ): OperationResponse<Paths.PreviewOrganize.Responses.$200>;
   /**
-   * OrganizeJobDetailOperations_getOrganizeJob - Get the status of a back-apply job, including matched/applied/failed counts. Terminal states are Complete and Failed.
+   * OrganizeJobDetailOperations_getOrganizeJob - Get the status of a back-apply job, including matched/applied/failed counts, how many messages still match after this batch, and the nextPosition that continues the selection. Terminal states are Complete and Failed.
    */
   'OrganizeJobDetailOperations_getOrganizeJob'(
     parameters?: Parameters<Paths.GetOrganizeJob.PathParameters> | null,
@@ -10405,7 +10434,7 @@ export interface PathsDictionary {
   };
   ['/accounts/{accountId}/organize']: {
     /**
-     * OrganizeOperations_createOrganizeJob - Start a one-time "all like these" back-apply: match the corpus against the given predicate and apply the action to every match, in one pass. Returns immediately with an organizeJobId; poll GET /accounts/{accountId}/organize/{organizeJobId} for state and counts. Never creates a Filter row (RFC 034 recap).
+     * OrganizeOperations_createOrganizeJob - Start a one-time "all like these" back-apply: match the corpus against the given predicate and apply the action to every match, in one pass of at most 500 messages. Returns immediately with an organizeJobId; poll GET /accounts/{accountId}/organize/{organizeJobId} for state, counts, remainingCount and the nextPosition that continues the selection. Never creates a Filter row (RFC 034 recap).
      */
     'post'(
       parameters?: Parameters<Paths.CreateOrganizeJob.PathParameters> | null,
@@ -10425,7 +10454,7 @@ export interface PathsDictionary {
   };
   ['/accounts/{accountId}/organize/{organizeJobId}']: {
     /**
-     * OrganizeJobDetailOperations_getOrganizeJob - Get the status of a back-apply job, including matched/applied/failed counts. Terminal states are Complete and Failed.
+     * OrganizeJobDetailOperations_getOrganizeJob - Get the status of a back-apply job, including matched/applied/failed counts, how many messages still match after this batch, and the nextPosition that continues the selection. Terminal states are Complete and Failed.
      */
     'get'(
       parameters?: Parameters<Paths.GetOrganizeJob.PathParameters> | null,
@@ -11836,7 +11865,7 @@ export interface Operations {
   };
   'AddressOperations_searchAddresses': {
     params: {};
-    query: { q: string; limit?: number };
+    query: { q: string; limit?: number; flag?: Components.Schemas.AddressTrustFlag };
     headers: {};
     cookies: {};
     requestBody: undefined;
@@ -12341,6 +12370,7 @@ export type SpamJudgeName = Components.Schemas.SpamJudgeName;
 export type SpamFailureKind = Components.Schemas.SpamFailureKind;
 export type OutboxAttachmentState = Components.Schemas.OutboxAttachmentState;
 export type OutboxAttachmentRejectionReason = Components.Schemas.OutboxAttachmentRejectionReason;
+export type AddressTrustFlag = Components.Schemas.AddressTrustFlag;
 export type AddressFlagKey = Components.Schemas.AddressFlagKey;
 export type MessageClassificationState = Components.Schemas.MessageClassificationState;
 export type AuthResultVerdict = Components.Schemas.AuthResultVerdict;