@remit/api-openapi-types 0.0.85 → 0.0.86

package/package.json

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

package/types.d.ts

@@ -101,6 +101,14 @@ writer can reach is a vocabulary that lies about what the field means.
      * Terminal outcome of an update run. `null` while a run is in flight; `succeeded` when the new version committed, `rolledBack` when it did not and the previous version was restored, `rollbackFailed` when the restore itself failed and an operator shell is needed, `abandoned` when the run ended having changed nothing (RFC 037 R11).
      */
     export type SystemUpdateOutcome = "succeeded" | "rolledBack" | "rollbackFailed" | "abandoned";
+    /**
+     * Whether a person may sign in. A disabled person's sessions, MCP grants and calendar feeds are revoked, and every sign-in is refused.
+     */
+    export type PersonStatus = "Active" | "Disabled";
+    /**
+     * The operation a step-up token is spent on. `updatePerson` maps `Disabled` to `Disable` and `Active` to `Enable`.
+     */
+    export type StepUpAction = "SignOut" | "Disable" | "Enable" | "ResetPassword";
     /**
      * IMAP namespace types per RFC 9051 Section 6.3.10
      */
@@ -1922,6 +1930,161 @@ with `onExisting: merge` to upsert instead.
        */
       targetVersion: string;
     }
+    /**
+     * Everyone who signs in to this instance, ordered by email.
+     */
+    export interface PeopleListResponse {
+      people: Person[];
+    }
+    /**
+     * One person who signs in to this self-hosted instance.
+     */
+    export interface Person {
+      /**
+       * The person's user id.
+       */
+      userId: string;
+      /**
+       * The address the person signs in with.
+       */
+      email: string;
+      /**
+       * When the account was created, epoch milliseconds.
+       */
+      createdAt: number;
+      /**
+       * When the person last signed in, epoch milliseconds.
+       */
+      lastSignInAt: number;
+      /**
+       * Unexpired browser sessions the person holds.
+       */
+      sessionCount: number;
+      /**
+       * Whether the person may sign in.
+       */
+      status: PersonStatus;
+      /**
+       * Whether this row is the caller.
+       */
+      isCaller: boolean;
+    }
+    /**
+     * The People operation is refused for the caller. `code` is one of
+`sign_in_disabled` (the kill switch is on), `caller_disabled` (the caller's
+account is disabled or gone), `foreign_origin` (an unsafe request from an
+origin this instance does not serve), `step_up_required` (the step-up token
+is missing, spent, expired, or bound to another caller, action or person) and
+`wrong_password` (the step-up password is wrong).
+     */
+    export interface PeopleForbiddenError {
+      statusCode: 403;
+      /**
+       * Stable token naming the refusal. Branch on this, never on `message`.
+       */
+      code: string;
+      /**
+       * Human-readable error message
+       */
+      message: string;
+      /**
+       * Additional error details
+       */
+      details?: Record;
+    }
+    /**
+     * The caller's current password, and the one action on one person the token will allow.
+     */
+    export interface StepUpInput {
+      /**
+       * The caller's own current password.
+       */
+      password: string;
+      action: StepUpAction;
+      /**
+       * The person the token will act on.
+       */
+      userId: string;
+    }
+    /**
+     * A single-use token for one action on one person. Spend it at once; it is never stored by the client.
+     */
+    export interface StepUpResponse {
+      stepUpToken: string;
+      /**
+       * When the token stops working, epoch milliseconds.
+       */
+      expiresAt: number;
+    }
+    /**
+     * Five wrong step-up passwords in 15 minutes. `code` is `step_up_locked`.
+     */
+    export interface StepUpLockedError {
+      statusCode: 429;
+      /**
+       * Stable token naming the refusal. Branch on this, never on `message`.
+       */
+      code: string;
+      /**
+       * Human-readable error message
+       */
+      message: string;
+      /**
+       * Additional error details
+       */
+      details?: Record;
+    }
+    /**
+     * Sign the person out of every browser session and MCP connection.
+     */
+    export interface SignOutPersonInput {
+      stepUpToken: string;
+    }
+    /**
+     * Disable or enable the person. Disabling also revokes their sessions, MCP grants and calendar feeds.
+     */
+    export interface UpdatePersonInput {
+      status: PersonStatus;
+      stepUpToken: string;
+    }
+    /**
+     * A person cannot disable themselves. `code` is `cannot_disable_self`.
+     */
+    export interface CannotDisableSelfError {
+      statusCode: 409;
+      /**
+       * Stable token naming the refusal. Branch on this, never on `message`.
+       */
+      code: string;
+      /**
+       * Human-readable error message
+       */
+      message: string;
+      /**
+       * Additional error details
+       */
+      details?: Record;
+    }
+    /**
+     * Issue a password reset link for the person. Their old password stops working and their sessions are revoked.
+     */
+    export interface CreatePasswordResetInput {
+      stepUpToken: string;
+    }
+    /**
+     * The person, and the reset link to hand them. The link is shown once and works once.
+     */
+    export interface PasswordResetResponse {
+      person: Person;
+      /**
+       * The single-use reset link. It exists only in this response.
+       */
+      resetUrl: string;
+      /**
+       * When the link stops working, epoch milliseconds: issue time plus 24 hours.
+       */
+      expiresAt: number;
+    }
     /**
      * Represents an IMAP mailbox (folder). Contains IMAP-specific identifiers for message synchronization.
      */
@@ -7025,6 +7188,61 @@ declare namespace Paths {
       export type $422 = void;
     }
   }
+  namespace ListPeople {
+    namespace Responses {
+      export type $200 = void;
+      export type $401 = void;
+      export type $403 = void;
+      export type $404 = void;
+    }
+  }
+  namespace CreateStepUp {
+    export type RequestBody = Components.Schemas.StepUpInput;
+    namespace Responses {
+      export type $200 = void;
+      export type $401 = void;
+      export type $403 = void;
+      export type $404 = void;
+      export type $429 = void;
+    }
+  }
+  namespace SignOutPerson {
+    export interface PathParameters {
+      userId: string;
+    }
+    export type RequestBody = Components.Schemas.SignOutPersonInput;
+    namespace Responses {
+      export type $200 = void;
+      export type $401 = void;
+      export type $403 = void;
+      export type $404 = void;
+    }
+  }
+  namespace UpdatePerson {
+    export interface PathParameters {
+      userId: string;
+    }
+    export type RequestBody = Components.Schemas.UpdatePersonInput;
+    namespace Responses {
+      export type $200 = void;
+      export type $401 = void;
+      export type $403 = void;
+      export type $404 = void;
+      export type $409 = void;
+    }
+  }
+  namespace CreatePasswordReset {
+    export interface PathParameters {
+      userId: string;
+    }
+    export type RequestBody = Components.Schemas.CreatePasswordResetInput;
+    namespace Responses {
+      export type $200 = void;
+      export type $401 = void;
+      export type $403 = void;
+      export type $404 = void;
+    }
+  }
   namespace ListMailboxes {
     export interface PathParameters {
       accountId: Components.Schemas.UUID;
@@ -8071,6 +8289,46 @@ export interface OperationMethods {
     data?: Paths.ApplySystemUpdate.RequestBody,
     config?: AxiosRequestConfig
   ): OperationResponse<Paths.ApplySystemUpdate.Responses.$200>;
+  /**
+   * listPeople - List everyone who signs in to this instance, ordered by email. Self-host only, and absent (404) while self sign-up is open.
+   */
+  'listPeople'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: any,
+    config?: AxiosRequestConfig
+  ): OperationResponse<Paths.ListPeople.Responses.$200>;
+  /**
+   * createStepUp - Trade the caller's current password for a single-use token that allows one action on one person for five minutes. Five wrong passwords in 15 minutes refuse further step-ups with 429. Absent (404) while self sign-up is open, or when the person does not exist.
+   */
+  'createStepUp'(
+    parameters?: Parameters<UnknownParamsObject> | null,
+    data?: Paths.CreateStepUp.RequestBody,
+    config?: AxiosRequestConfig
+  ): OperationResponse<Paths.CreateStepUp.Responses.$200>;
+  /**
+   * signOutPerson - Sign the person out of every browser session and MCP connection. Needs a `SignOut` step-up for this person. A JWT already minted works until it expires, at most 15 minutes.
+   */
+  'signOutPerson'(
+    parameters?: Parameters<Paths.SignOutPerson.PathParameters> | null,
+    data?: Paths.SignOutPerson.RequestBody,
+    config?: AxiosRequestConfig
+  ): OperationResponse<Paths.SignOutPerson.Responses.$200>;
+  /**
+   * updatePerson - Disable or enable the person. Needs a `Disable` or `Enable` step-up for this person. Refused with 409 `cannot_disable_self` when the caller disables themselves.
+   */
+  'updatePerson'(
+    parameters?: Parameters<Paths.UpdatePerson.PathParameters> | null,
+    data?: Paths.UpdatePerson.RequestBody,
+    config?: AxiosRequestConfig
+  ): OperationResponse<Paths.UpdatePerson.Responses.$200>;
+  /**
+   * createPasswordReset - Issue a single-use password reset link for the person, valid 24 hours. Needs a `ResetPassword` step-up for this person. The person's old password stops working and their sessions are revoked.
+   */
+  'createPasswordReset'(
+    parameters?: Parameters<Paths.CreatePasswordReset.PathParameters> | null,
+    data?: Paths.CreatePasswordReset.RequestBody,
+    config?: AxiosRequestConfig
+  ): OperationResponse<Paths.CreatePasswordReset.Responses.$200>;
   /**
    * listMailboxes
    */
@@ -8942,6 +9200,56 @@ export interface PathsDictionary {
       config?: AxiosRequestConfig
     ): OperationResponse<Paths.ApplySystemUpdate.Responses.$200>;
   };
+  ['/people']: {
+    /**
+     * listPeople - List everyone who signs in to this instance, ordered by email. Self-host only, and absent (404) while self sign-up is open.
+     */
+    'get'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: any,
+      config?: AxiosRequestConfig
+    ): OperationResponse<Paths.ListPeople.Responses.$200>;
+  };
+  ['/people/step-up']: {
+    /**
+     * createStepUp - Trade the caller's current password for a single-use token that allows one action on one person for five minutes. Five wrong passwords in 15 minutes refuse further step-ups with 429. Absent (404) while self sign-up is open, or when the person does not exist.
+     */
+    'post'(
+      parameters?: Parameters<UnknownParamsObject> | null,
+      data?: Paths.CreateStepUp.RequestBody,
+      config?: AxiosRequestConfig
+    ): OperationResponse<Paths.CreateStepUp.Responses.$200>;
+  };
+  ['/people/{userId}/sign-out']: {
+    /**
+     * signOutPerson - Sign the person out of every browser session and MCP connection. Needs a `SignOut` step-up for this person. A JWT already minted works until it expires, at most 15 minutes.
+     */
+    'post'(
+      parameters?: Parameters<Paths.SignOutPerson.PathParameters> | null,
+      data?: Paths.SignOutPerson.RequestBody,
+      config?: AxiosRequestConfig
+    ): OperationResponse<Paths.SignOutPerson.Responses.$200>;
+  };
+  ['/people/{userId}']: {
+    /**
+     * updatePerson - Disable or enable the person. Needs a `Disable` or `Enable` step-up for this person. Refused with 409 `cannot_disable_self` when the caller disables themselves.
+     */
+    'patch'(
+      parameters?: Parameters<Paths.UpdatePerson.PathParameters> | null,
+      data?: Paths.UpdatePerson.RequestBody,
+      config?: AxiosRequestConfig
+    ): OperationResponse<Paths.UpdatePerson.Responses.$200>;
+  };
+  ['/people/{userId}/password-reset']: {
+    /**
+     * createPasswordReset - Issue a single-use password reset link for the person, valid 24 hours. Needs a `ResetPassword` step-up for this person. The person's old password stops working and their sessions are revoked.
+     */
+    'post'(
+      parameters?: Parameters<Paths.CreatePasswordReset.PathParameters> | null,
+      data?: Paths.CreatePasswordReset.RequestBody,
+      config?: AxiosRequestConfig
+    ): OperationResponse<Paths.CreatePasswordReset.Responses.$200>;
+  };
   ['/accounts/{accountId}/mailboxes']: {
     /**
      * listMailboxes
@@ -9880,6 +10188,17 @@ export type SystemUpdateResponse = Components.Schemas.SystemUpdateResponse;
 export type SystemUpdateCheck = Components.Schemas.SystemUpdateCheck;
 export type SystemUpdateRun = Components.Schemas.SystemUpdateRun;
 export type ApplyUpdateInput = Components.Schemas.ApplyUpdateInput;
+export type PeopleListResponse = Components.Schemas.PeopleListResponse;
+export type Person = Components.Schemas.Person;
+export type PeopleForbiddenError = Components.Schemas.PeopleForbiddenError;
+export type StepUpInput = Components.Schemas.StepUpInput;
+export type StepUpResponse = Components.Schemas.StepUpResponse;
+export type StepUpLockedError = Components.Schemas.StepUpLockedError;
+export type SignOutPersonInput = Components.Schemas.SignOutPersonInput;
+export type UpdatePersonInput = Components.Schemas.UpdatePersonInput;
+export type CannotDisableSelfError = Components.Schemas.CannotDisableSelfError;
+export type CreatePasswordResetInput = Components.Schemas.CreatePasswordResetInput;
+export type PasswordResetResponse = Components.Schemas.PasswordResetResponse;
 export type Mailbox = Components.Schemas.Mailbox;
 export type MailboxResponse = Components.Schemas.MailboxResponse;
 export type MailboxListResponse = Components.Schemas.MailboxListResponse;
@@ -10050,6 +10369,8 @@ export type ConfigImportOnExisting = Components.Schemas.ConfigImportOnExisting;
 export type SystemUpdateCheckStatus = Components.Schemas.SystemUpdateCheckStatus;
 export type SystemUpdatePhase = Components.Schemas.SystemUpdatePhase;
 export type SystemUpdateOutcome = Components.Schemas.SystemUpdateOutcome;
+export type PersonStatus = Components.Schemas.PersonStatus;
+export type StepUpAction = Components.Schemas.StepUpAction;
 export type NamespaceType = Components.Schemas.NamespaceType;
 export type MailboxSyncStatus = Components.Schemas.MailboxSyncStatus;
 export type MailboxCursorState = Components.Schemas.MailboxCursorState;