@remit/api-openapi-types 0.0.93 → 0.0.95

package/package.json

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

package/types.d.ts

@@ -225,6 +225,14 @@ 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";
+    /**
+     * Where a classification setting's value comes from.
+     */
+    export type ClassificationValueSource = "Saved" | "Deployment" | "Default";
+    /**
+     * Why a classification provider cannot run.
+     */
+    export type ClassificationUnrunnableReason = "NoBaseUrl" | "NoApiKey";
     /**
      * A label a classification provider picks for a message: the junk verdicts, priority, and the message categories.
      */
@@ -3644,9 +3652,9 @@ field on this resource rather than one more operation.
        */
       classificationPresets: ClassificationPreset[];
       /**
-       * The saved classification provider, or `NotConfigured`.
+       * The classification provider in effect, `Unrunnable` when one is chosen but cannot run, or `NotConfigured`.
        */
-      classification: ClassificationNotConfigured | ClassificationConfigured;
+      classification: ClassificationNotConfigured | ClassificationConfigured | ClassificationUnrunnable;
     }
     /**
      * A classification provider the reader can pick.
@@ -3697,7 +3705,7 @@ field on this resource rather than one more operation.
       state: "NotConfigured";
     }
     /**
-     * The saved classification provider. The API key itself is never returned.
+     * The classification provider in effect, saved or inherited from the deployment. No API key is ever returned.
      */
     export interface ClassificationConfigured {
       state: "Configured";
@@ -3705,7 +3713,7 @@ field on this resource rather than one more operation.
       model: string;
       baseUrl: string;
       /**
-       * Whether an API key is stored for this provider.
+       * Deprecated: read `sources.apiKey` instead. Whether an API key is saved or inherited from the deployment. Removed once reader-ui reads `sources`.
        */
       apiKeySaved: boolean;
       /**
@@ -3717,14 +3725,28 @@ field on this resource rather than one more operation.
        */
       dailyLimit: number;
       /**
-       * When the provider, model, base URL or key was last saved, in epoch milliseconds (UTC).
+       * Where each value comes from. A reader overrides one field by saving it, and inherits it again by saving it empty.
        */
-      savedAt: number;
+      sources: ClassificationSources;
       /**
        * Today's provider calls, one row per mail account of the account config.
        */
       usage: ClassificationUsage[];
     }
+    /**
+     * Where each classification setting's value comes from.
+     */
+    export interface ClassificationSources {
+      presetId: ClassificationValueSource;
+      model: ClassificationValueSource;
+      baseUrl: ClassificationValueSource;
+      /**
+       * `Saved` for a key the reader saved, `Deployment` for the deployment's key, `Default` for no key.
+       */
+      apiKey: ClassificationValueSource;
+      enabled: ClassificationValueSource;
+      dailyLimit: ClassificationValueSource;
+    }
     /**
      * One mail account's classification calls today.
      */
@@ -3755,6 +3777,14 @@ field on this resource rather than one more operation.
       currency: "USD";
       amount: number;
     }
+    /**
+     * A classification provider is chosen but cannot run, so classification is off.
+     */
+    export interface ClassificationUnrunnable {
+      state: "Unrunnable";
+      presetId: ClassificationPresetId;
+      reason: ClassificationUnrunnableReason;
+    }
     /**
      * A change to the caller's settings. Every field is optional and absence means untouched.
      */
@@ -3764,27 +3794,27 @@ field on this resource rather than one more operation.
        */
       defaultInvitationSenderAccountId?: UUID;
       /**
-       * Save a classification provider. Saving another preset deletes the stored key. Without it, the classification fields below apply to the saved provider.
+       * Save a classification provider. Saving another preset deletes the stored key, model and base URL. Without it, the classification fields below apply to the provider in effect, saved or inherited from the deployment.
        */
       classificationPresetId?: ClassificationPresetId;
       /**
-       * The model to ask for. Empty means the preset's default model.
+       * The model to ask for. Empty deletes the saved model, so it is inherited again.
        */
       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.
+       * The http or https base URL to call. Empty deletes the saved base URL, so it is inherited again. Refused with 400 `invalid_classification_base_url` when it is not a URL, or when no base URL is saved, inherited or given by the preset.
        */
       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.
+       * 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 saved, or inherited from the deployment for the same preset and base URL.
        */
       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.
+       * Switch classification on or off. Switching on with no provider in effect 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.
+       * The most classification calls per mail account per UTC day. Needs a provider in effect, saved or inherited.
        */
       classificationDailyLimit?: number;
     }
@@ -3794,15 +3824,15 @@ field on this resource rather than one more operation.
     export interface ClassificationTestInput {
       presetId: ClassificationPresetId;
       /**
-       * The model to ask for. Empty means the preset's default model.
+       * The model to ask for. Empty means the inherited model.
        */
       model: string;
       /**
-       * The http or https base URL to call. Empty means the preset's default base URL.
+       * The http or https base URL to call. Empty means the inherited base URL.
        */
       baseUrl: string;
       /**
-       * The provider's API key. Empty means the key saved for this preset.
+       * The provider's API key. Empty means the key saved for this preset, or the deployment's key when the preset and base URL match the deployment's.
        */
       apiKey: string;
     }
@@ -4571,11 +4601,11 @@ every reader of either would otherwise narrow on the kind first.
        */
       dkimMismatch: boolean;
       /**
-       * How the From display name relates to the From domain. Present only for a message the provider's own filter already classified as spam, and only when the sender is not bulk-shaped (no List-Unsubscribe) — absence means the comparison was never made, never that it found nothing.
+       * How the From display name relates to the From domain. Display-only: it never decides placement. Present only when the sender is not bulk-shaped (no List-Unsubscribe) — absence means the comparison was never made, never that it found nothing.
        */
       displayNameCorrespondence?: DisplayNameCorrespondence;
       /**
-       * Registrable domains (eTLD+1) the body's links point at, excluding the From address's own registrable domain. Present only for a message the provider's own filter already classified as spam; an empty array means every link stayed on the sender's domain, absence means the comparison was never made.
+       * Registrable domains (eTLD+1) the body's links point at, excluding the From address's own registrable domain. Display-only: it never decides placement. An empty array means every link stayed on the sender's domain, absence means the comparison was never made.
        */
       offDomainLinkDomains?: string[];
       /**
@@ -10522,8 +10552,10 @@ 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 ClassificationSources = Components.Schemas.ClassificationSources;
 export type ClassificationUsage = Components.Schemas.ClassificationUsage;
 export type ClassificationCostPriced = Components.Schemas.ClassificationCostPriced;
+export type ClassificationUnrunnable = Components.Schemas.ClassificationUnrunnable;
 export type UpdateUserSettingsInput = Components.Schemas.UpdateUserSettingsInput;
 export type ClassificationTestInput = Components.Schemas.ClassificationTestInput;
 export type ClassificationTestPassed = Components.Schemas.ClassificationTestPassed;
@@ -10683,6 +10715,8 @@ 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 ClassificationValueSource = Components.Schemas.ClassificationValueSource;
+export type ClassificationUnrunnableReason = Components.Schemas.ClassificationUnrunnableReason;
 export type ClassificationLabel = Components.Schemas.ClassificationLabel;
 export type ClassificationFailureKind = Components.Schemas.ClassificationFailureKind;
 export type ClassificationField = Components.Schemas.ClassificationField;