@remit/api-openapi-types 0.0.87 → 0.0.89

package/package.json

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

package/types.d.ts

@@ -213,6 +213,18 @@ current enum emitter anyway, so the wire contract uses the bare form.
      * The answer a guest gives an invitation. It is written as the reader's `ATTENDEE;PARTSTAT` on the stored event (RFC 5545 3.2.12).
      */
     export type CalendarInviteAnswer = "Accepted" | "Tentative" | "Declined";
+    /**
+     * A classification provider preset: a known provider with its adapter shape, default base URL and default model.
+     */
+    export type ClassificationPresetId = "Jev" | "Jina" | "Mistral" | "Gemini" | "OpenAiCompatible" | "Local";
+    /**
+     * How a settings screen groups the classification presets. `Hosted` is a named provider, `Custom` an endpoint the reader names, `Local` a model on the reader's own machine.
+     */
+    export type ClassificationPresetGroup = "Hosted" | "Custom" | "Local";
+    /**
+     * 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";
     /**
      * Sort order for list operations
      */
@@ -363,7 +375,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";
+    export type AccountSettingName = "Theme" | "Density" | "DefaultComposerFormat" | "PinnedFolders" | "AccountSignaturePlainText" | "AccountSignatureHtml" | "AccountDisplayName" | "AccountMuted" | "AccountComposeLanguages" | "MailboxDisplayName" | "MailboxMuted" | "FolderRoleAppointment" | "FolderRoleAppointmentLabel" | "MailboxRole" | "DefaultInvitationSenderAccountId" | "ClassificationPresetId" | "ClassificationModel" | "ClassificationBaseUrl" | "ClassificationApiKey" | "ClassificationEnabled" | "ClassificationDailyLimit";
     /**
      * 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.
      */
@@ -3615,6 +3627,87 @@ field on this resource rather than one more operation.
        * Whether `defaultInvitationSenderAccountId` is the reader's own choice rather than the account an event is on.
        */
       defaultInvitationSenderChosen: boolean;
+      /**
+       * Every classification provider the reader can pick.
+       */
+      classificationPresets: ClassificationPreset[];
+      /**
+       * The saved classification provider, or `NotConfigured`.
+       */
+      classification: ClassificationNotConfigured | ClassificationConfigured;
+    }
+    /**
+     * A classification provider the reader can pick.
+     */
+    export interface ClassificationPreset {
+      presetId: ClassificationPresetId;
+      label: string;
+      group: ClassificationPresetGroup;
+      adapterShape: ClassificationAdapterShape;
+      /**
+       * The base URL used when the reader leaves it empty. Absent when a save has to name one in `classificationBaseUrl`.
+       */
+      defaultBaseUrl?: string;
+      /**
+       * The model used when the reader leaves it empty.
+       */
+      defaultModel: string;
+      /**
+       * Whether a save needs `classificationApiKey`.
+       */
+      needsKey: boolean;
+      price: ClassificationPriced | ClassificationNoPrice;
+    }
+    /**
+     * A classification preset that has a known price per million input tokens.
+     */
+    export interface ClassificationPriced {
+      state: "Priced";
+      /**
+       * ISO 4217 currency of `perMillionInputTokens`.
+       */
+      currency: "USD";
+      /**
+       * Price of one million input tokens. Output tokens are not charged.
+       */
+      perMillionInputTokens: number;
+    }
+    /**
+     * A classification preset with no price to show: self-hosted, or a price the provider sets per model.
+     */
+    export interface ClassificationNoPrice {
+      state: "NoPrice";
+    }
+    /**
+     * No classification provider is saved, so classification is off.
+     */
+    export interface ClassificationNotConfigured {
+      state: "NotConfigured";
+    }
+    /**
+     * The saved classification provider. The API key itself is never returned.
+     */
+    export interface ClassificationConfigured {
+      state: "Configured";
+      presetId: ClassificationPresetId;
+      model: string;
+      baseUrl: string;
+      /**
+       * Whether an API key is stored for this provider.
+       */
+      apiKeySaved: boolean;
+      /**
+       * Whether classification runs.
+       */
+      enabled: boolean;
+      /**
+       * The most classification calls per mail account per UTC day.
+       */
+      dailyLimit: number;
+      /**
+       * When the provider, model, base URL or key was last saved, in epoch milliseconds (UTC).
+       */
+      savedAt: number;
     }
     /**
      * A change to the caller's settings. Every field is optional and absence means untouched.
@@ -3624,6 +3717,30 @@ field on this resource rather than one more operation.
        * The account invitations go out from by default. Refused with 400 `unknown_sender` when it is not an account of the caller's account config that sends mail. Cleared with `clearDefaultInvitationSender`.
        */
       defaultInvitationSenderAccountId?: UUID;
+      /**
+       * Save a classification provider. Saving another preset deletes the stored key. Without it, the classification fields below apply to the saved provider.
+       */
+      classificationPresetId?: ClassificationPresetId;
+      /**
+       * The model to ask for. Empty means the preset's default model.
+       */
+      classificationModel?: string;
+      /**
+       * The http or https base URL to call. Empty means the preset's default base URL. Refused with 400 `invalid_classification_base_url` when it is not a URL, or when the preset has no default base URL and none is given.
+       */
+      classificationBaseUrl?: string;
+      /**
+       * The provider's API key. Write-only: stored encrypted and never returned. Refused with 400 `classification_api_key_required` when the preset needs a key and none is stored for it.
+       */
+      classificationApiKey?: string;
+      /**
+       * Switch classification on or off. Switching on with no saved provider is refused with 400 `classification_not_configured`; switching off keeps the provider and key.
+       */
+      classificationEnabled?: boolean;
+      /**
+       * The most classification calls per mail account per UTC day. Needs a saved provider.
+       */
+      classificationDailyLimit?: number;
     }
     /**
      * Tasks due in the requested window, in due order. Unpaginated: the window is the bound.
@@ -7678,6 +7795,12 @@ declare namespace Paths {
       export type $401 = void;
     }
   }
+  namespace ClearClassificationProvider {
+    namespace Responses {
+      export type $200 = void;
+      export type $401 = void;
+    }
+  }
   namespace ListCalendarTasks {
     export interface QueryParameters {
       from: string;
@@ -8665,6 +8788,14 @@ reader organizes the event, none otherwise.
     data?: any,
     config?: AxiosRequestConfig
   ): OperationResponse<Paths.ClearDefaultInvitationSender.Responses.$200>;
+  /**
+   * clearClassificationProvider - Delete the saved classification provider, its key and every classification setting. Classification is then off. Answers with every setting as it now stands.
+   */
+  'clearClassificationProvider'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: any,
+    config?: AxiosRequestConfig
+  ): OperationResponse<Paths.ClearClassificationProvider.Responses.$200>;
   /**
    * 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.
    */
@@ -9624,6 +9755,16 @@ reader organizes the event, none otherwise.
       config?: AxiosRequestConfig
     ): OperationResponse<Paths.ClearDefaultInvitationSender.Responses.$200>;
   };
+  ['/settings/classification-provider']: {
+    /**
+     * clearClassificationProvider - Delete the saved classification provider, its key and every classification setting. Classification is then off. Answers with every setting as it now stands.
+     */
+    'delete'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: any,
+      config?: AxiosRequestConfig
+    ): OperationResponse<Paths.ClearClassificationProvider.Responses.$200>;
+  };
   ['/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.
@@ -10235,6 +10376,11 @@ export type CalendarEventDeleteResponse = Components.Schemas.CalendarEventDelete
 export type CalendarFreeBusyResponse = Components.Schemas.CalendarFreeBusyResponse;
 export type CalendarFreeBusySpan = Components.Schemas.CalendarFreeBusySpan;
 export type UserSettingsResponse = Components.Schemas.UserSettingsResponse;
+export type ClassificationPreset = Components.Schemas.ClassificationPreset;
+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 UpdateUserSettingsInput = Components.Schemas.UpdateUserSettingsInput;
 export type CalendarTaskListResponse = Components.Schemas.CalendarTaskListResponse;
 export type CalendarTask = Components.Schemas.CalendarTask;
@@ -10386,6 +10532,9 @@ export type CalendarInviteMethod = Components.Schemas.CalendarInviteMethod;
 export type OutboxMessageStatus = Components.Schemas.OutboxMessageStatus;
 export type RecurrenceScope = Components.Schemas.RecurrenceScope;
 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 SortOrder = Components.Schemas.SortOrder;
 export type StarColor = Components.Schemas.StarColor;
 export type MessageCategory = Components.Schemas.MessageCategory;