@remit/api-openapi-types 0.0.89 → 0.0.91

package/package.json

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

package/types.d.ts

@@ -225,6 +225,18 @@ current enum emitter anyway, so the wire contract uses the bare form.
      * The request shape a classification provider speaks. `DecisionApi` returns a calibrated probability per label; `ChatJsonSchema` is an OpenAI-compatible chat completion constrained to the label enum; `JinaClassify` is Jina's `/v1/classify`.
      */
     export type ClassificationAdapterShape = "DecisionApi" | "ChatJsonSchema" | "JinaClassify";
+    /**
+     * A label a classification provider picks for a message: the junk verdicts, priority, and the message categories.
+     */
+    export type ClassificationLabel = "Spam" | "Phishing" | "Priority" | "Personal" | "Newsletter" | "Marketing" | "Automated" | "Transactional" | "Social";
+    /**
+     * Why a classification provider call gave no usable answer.
+     */
+    export type ClassificationFailureKind = "Unauthorized" | "ModelNotFound" | "RateLimited" | "Rejected" | "ProviderError" | "Unreachable" | "TimedOut" | "Unparseable";
+    /**
+     * The classification provider form field a failure points at.
+     */
+    export type ClassificationField = "ApiKey" | "Model" | "BaseUrl";
     /**
      * Sort order for list operations
      */
@@ -375,7 +387,7 @@ distinguishable from a network failure without parsing prose.
     /**
      * Known user-setting keys. Each maps, in the registry, to a required value kind and a zod schema. New keys are added deliberately by extending this enum and the registry — never as an ad-hoc column.
      */
-    export type AccountSettingName = "Theme" | "Density" | "DefaultComposerFormat" | "PinnedFolders" | "AccountSignaturePlainText" | "AccountSignatureHtml" | "AccountDisplayName" | "AccountMuted" | "AccountComposeLanguages" | "MailboxDisplayName" | "MailboxMuted" | "FolderRoleAppointment" | "FolderRoleAppointmentLabel" | "MailboxRole" | "DefaultInvitationSenderAccountId" | "ClassificationPresetId" | "ClassificationModel" | "ClassificationBaseUrl" | "ClassificationApiKey" | "ClassificationEnabled" | "ClassificationDailyLimit";
+    export type AccountSettingName = "Theme" | "Density" | "DefaultComposerFormat" | "PinnedFolders" | "AccountSignaturePlainText" | "AccountSignatureHtml" | "AccountDisplayName" | "AccountMuted" | "AccountComposeLanguages" | "MailboxDisplayName" | "MailboxMuted" | "FolderRoleAppointment" | "FolderRoleAppointmentLabel" | "MailboxRole" | "DefaultInvitationSenderAccountId" | "ClassificationPresetId" | "ClassificationModel" | "ClassificationBaseUrl" | "ClassificationApiKey" | "ClassificationEnabled" | "ClassificationDailyLimit" | "ClassificationUsage";
     /**
      * Lifecycle of one applied configuration import. An import is Complete the moment every folder reference in the file has been bound to a real mailbox; until then it is Pending, waiting on the IMAP discovery that will produce those mailboxes.
      */
@@ -3708,6 +3720,40 @@ field on this resource rather than one more operation.
        * When the provider, model, base URL or key was last saved, in epoch milliseconds (UTC).
        */
       savedAt: number;
+      /**
+       * Today's provider calls, one row per mail account of the account config.
+       */
+      usage: ClassificationUsage[];
+    }
+    /**
+     * One mail account's classification calls today.
+     */
+    export interface ClassificationUsage {
+      accountId: UUID;
+      /**
+       * Provider calls made today (UTC). Test calls do not count.
+       */
+      calls: number;
+      /**
+       * The most calls this mail account makes per UTC day.
+       */
+      dailyLimit: number;
+      /**
+       * When `calls` restarts at zero: the next 00:00 UTC.
+       */
+      resetsAt: string;
+      cost: ClassificationCostPriced | ClassificationNoPrice;
+    }
+    /**
+     * The cost of today's calls, counting each call as 1,500 input tokens at the preset's price.
+     */
+    export interface ClassificationCostPriced {
+      state: "Priced";
+      /**
+       * ISO 4217 currency of `amount`.
+       */
+      currency: "USD";
+      amount: number;
     }
     /**
      * A change to the caller's settings. Every field is optional and absence means untouched.
@@ -3742,6 +3788,65 @@ field on this resource rather than one more operation.
        */
       classificationDailyLimit?: number;
     }
+    /**
+     * The classification provider form as it stands, saved or not.
+     */
+    export interface ClassificationTestInput {
+      presetId: ClassificationPresetId;
+      /**
+       * The model to ask for. Empty means the preset's default model.
+       */
+      model: string;
+      /**
+       * The http or https base URL to call. Empty means the preset's default base URL.
+       */
+      baseUrl: string;
+      /**
+       * The provider's API key. Empty means the key saved for this preset.
+       */
+      apiKey: string;
+    }
+    /**
+     * The provider classified the sample message.
+     */
+    export interface ClassificationTestPassed {
+      state: "Passed";
+      /**
+       * How long the provider call took, in milliseconds.
+       */
+      latencyMs: number;
+      /**
+       * The label the provider chose for the sample message.
+       */
+      label: ClassificationLabel;
+      /**
+       * The provider's confidence in `label`, between 0 and 1.
+       */
+      confidence: number;
+    }
+    /**
+     * The provider call gave no usable answer.
+     */
+    export interface ClassificationTestFailed {
+      state: "Failed";
+      /**
+       * How long the provider call took, in milliseconds.
+       */
+      latencyMs: number;
+      /**
+       * The HTTP status the provider answered with. Absent when no answer arrived.
+       */
+      status?: number;
+      kind: ClassificationFailureKind;
+      /**
+       * The form field to change. Absent when no field can fix it: a rate limit or a provider error.
+       */
+      field?: ClassificationField;
+      /**
+       * What to change so the next test passes.
+       */
+      fix: string;
+    }
     /**
      * Tasks due in the requested window, in due order. Unpaginated: the window is the bound.
      */
@@ -6603,6 +6708,23 @@ of copying it, and so a person can see what was imported after the fact.
       kind: "MutedFlag";
       value: MutedFlag;
     }
+    /**
+     * A count that restarts every UTC day.
+     */
+    export interface DailyCount {
+      /**
+       * The UTC date the count belongs to.
+       */
+      date: string;
+      calls: number;
+    }
+    /**
+     * DailyCount-valued setting: a count for one UTC date.
+     */
+    export interface DailyCountSetting {
+      kind: "DailyCount";
+      value: DailyCount;
+    }
     /**
      * A single user setting for an account configuration. One row per (accountConfigId, name); the primary key is a deterministic UUID v5 of that pair, so writes are idempotent upserts.
      */
@@ -6622,7 +6744,7 @@ of copying it, and so a person can see what was imported after the fact.
       /**
        * Typed setting value
        */
-      value: BooleanSetting | StringSetting | NumberSetting | StringListSetting | MapSetting | MutedFlagSetting;
+      value: BooleanSetting | StringSetting | NumberSetting | StringListSetting | MapSetting | MutedFlagSetting | DailyCountSetting;
       createdAt: number;
       updatedAt: number;
     }
@@ -7801,6 +7923,13 @@ declare namespace Paths {
       export type $401 = void;
     }
   }
+  namespace TestClassificationProvider {
+    export type RequestBody = Components.Schemas.ClassificationTestInput;
+    namespace Responses {
+      export type $400 = void;
+      export type $401 = void;
+    }
+  }
   namespace ListCalendarTasks {
     export interface QueryParameters {
       from: string;
@@ -8796,6 +8925,14 @@ reader organizes the event, none otherwise.
     data?: any,
     config?: AxiosRequestConfig
   ): OperationResponse<Paths.ClearClassificationProvider.Responses.$200>;
+  /**
+   * testClassificationProvider - Classify one built-in sample message with the form values, saved or not, and answer with the label or the failure. An empty key uses the saved key. Saved settings stay as they were, and the call counts toward no daily limit.
+   */
+  'testClassificationProvider'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.TestClassificationProvider.RequestBody,
+    config?: AxiosRequestConfig
+  ): OperationResponse<any>;
   /**
    * listCalendarTasks - Tasks due in a window, across every task collection the caller holds, in due order. Refused with 400 on the same window rules as the event listing.
    */
@@ -9765,6 +9902,16 @@ reader organizes the event, none otherwise.
       config?: AxiosRequestConfig
     ): OperationResponse<Paths.ClearClassificationProvider.Responses.$200>;
   };
+  ['/settings/classification-test']: {
+    /**
+     * testClassificationProvider - Classify one built-in sample message with the form values, saved or not, and answer with the label or the failure. An empty key uses the saved key. Saved settings stay as they were, and the call counts toward no daily limit.
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.TestClassificationProvider.RequestBody,
+      config?: AxiosRequestConfig
+    ): OperationResponse<any>;
+  };
   ['/calendar-tasks']: {
     /**
      * listCalendarTasks - Tasks due in a window, across every task collection the caller holds, in due order. Refused with 400 on the same window rules as the event listing.
@@ -10381,7 +10528,12 @@ export type ClassificationPriced = Components.Schemas.ClassificationPriced;
 export type ClassificationNoPrice = Components.Schemas.ClassificationNoPrice;
 export type ClassificationNotConfigured = Components.Schemas.ClassificationNotConfigured;
 export type ClassificationConfigured = Components.Schemas.ClassificationConfigured;
+export type ClassificationUsage = Components.Schemas.ClassificationUsage;
+export type ClassificationCostPriced = Components.Schemas.ClassificationCostPriced;
 export type UpdateUserSettingsInput = Components.Schemas.UpdateUserSettingsInput;
+export type ClassificationTestInput = Components.Schemas.ClassificationTestInput;
+export type ClassificationTestPassed = Components.Schemas.ClassificationTestPassed;
+export type ClassificationTestFailed = Components.Schemas.ClassificationTestFailed;
 export type CalendarTaskListResponse = Components.Schemas.CalendarTaskListResponse;
 export type CalendarTask = Components.Schemas.CalendarTask;
 export type CalendarTaskResponse = Components.Schemas.CalendarTaskResponse;
@@ -10468,6 +10620,8 @@ export type NumberSetting = Components.Schemas.NumberSetting;
 export type StringListSetting = Components.Schemas.StringListSetting;
 export type MapSetting = Components.Schemas.MapSetting;
 export type MutedFlagSetting = Components.Schemas.MutedFlagSetting;
+export type DailyCount = Components.Schemas.DailyCount;
+export type DailyCountSetting = Components.Schemas.DailyCountSetting;
 export type AccountSetting = Components.Schemas.AccountSetting;
 export type MailboxAttributeEntry = Components.Schemas.MailboxAttributeEntry;
 export type MailboxSpecialUseEntry = Components.Schemas.MailboxSpecialUseEntry;
@@ -10535,6 +10689,9 @@ export type CalendarInviteAnswer = Components.Schemas.CalendarInviteAnswer;
 export type ClassificationPresetId = Components.Schemas.ClassificationPresetId;
 export type ClassificationPresetGroup = Components.Schemas.ClassificationPresetGroup;
 export type ClassificationAdapterShape = Components.Schemas.ClassificationAdapterShape;
+export type ClassificationLabel = Components.Schemas.ClassificationLabel;
+export type ClassificationFailureKind = Components.Schemas.ClassificationFailureKind;
+export type ClassificationField = Components.Schemas.ClassificationField;
 export type SortOrder = Components.Schemas.SortOrder;
 export type StarColor = Components.Schemas.StarColor;
 export type MessageCategory = Components.Schemas.MessageCategory;