@slipway-systems/sdk 0.4.0 → 0.6.0

package/dist/gen/slipway/v1/identity_pb.d.ts

@@ -1,5 +1,5 @@
 import type { GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv2";
-import type { FieldMask, Timestamp } from "@bufbuild/protobuf/wkt";
+import type { Duration, FieldMask, Timestamp } from "@bufbuild/protobuf/wkt";
 import type { Actor, PageRequest, PageResponse } from "./common_pb.js";
 import type { Message } from "@bufbuild/protobuf";
 /**
@@ -425,6 +425,20 @@ export type WhoAmIResponse = Message<"slipway.v1.WhoAmIResponse"> & {
      * @generated from field: bool org_requires_mfa = 8;
      */
     orgRequiresMfa: boolean;
+    /**
+     * The current org requires a second factor this session has not verified: every RPC except the enrolment ones is
+     * refused until the caller sets one up (or, when one is already enrolled, signs in again with it).
+     *
+     * @generated from field: bool mfa_setup_required = 9;
+     */
+    mfaSetupRequired: boolean;
+    /**
+     * How long a deleted organisation can be restored before its data is erased: the instance's grace period
+     * (SLIPWAY_ORG_DELETION_GRACE, 7 days by default), for the deletion warnings.
+     *
+     * @generated from field: google.protobuf.Duration org_deletion_grace = 10;
+     */
+    orgDeletionGrace?: Duration | undefined;
 };
 /**
  * Describes the message slipway.v1.WhoAmIResponse.
@@ -524,6 +538,9 @@ export type GetOrganizationResponse = Message<"slipway.v1.GetOrganizationRespons
  */
 export declare const GetOrganizationResponseSchema: GenMessage<GetOrganizationResponse>;
 /**
+ * update_mask "slug" changes the organisation's slug (owners: org.delete); the old slug keeps working as a redirect and
+ * no other organisation can take it. An empty mask never changes the slug.
+ *
  * @generated from message slipway.v1.UpdateOrganizationRequest
  */
 export type UpdateOrganizationRequest = Message<"slipway.v1.UpdateOrganizationRequest"> & {
@@ -555,6 +572,59 @@ export type UpdateOrganizationResponse = Message<"slipway.v1.UpdateOrganizationR
  * Use `create(UpdateOrganizationResponseSchema)` to create a new message.
  */
 export declare const UpdateOrganizationResponseSchema: GenMessage<UpdateOrganizationResponse>;
+/**
+ * DeleteOrganization deletes the active organisation (org.delete). It is disabled at once: sign-ins, API tokens, runners,
+ * schedules and webhooks stop and runs in progress are cancelled. Its data is purged after the grace period, during
+ * which an operator can restore it. The caller proves who they are like any destructive step: the organisation's slug
+ * typed out, the account password (when it has one) and an authenticator code (when it has an authenticator app).
+ *
+ * @generated from message slipway.v1.DeleteOrganizationRequest
+ */
+export type DeleteOrganizationRequest = Message<"slipway.v1.DeleteOrganizationRequest"> & {
+    /**
+     * must be the active organisation
+     *
+     * @generated from field: string organization_id = 1;
+     */
+    organizationId: string;
+    /**
+     * the organisation's slug, typed by the caller
+     *
+     * @generated from field: string confirm_slug = 2;
+     */
+    confirmSlug: string;
+    /**
+     * @generated from field: string current_password = 3;
+     */
+    currentPassword: string;
+    /**
+     * authenticator or recovery code
+     *
+     * @generated from field: string code = 4;
+     */
+    code: string;
+};
+/**
+ * Describes the message slipway.v1.DeleteOrganizationRequest.
+ * Use `create(DeleteOrganizationRequestSchema)` to create a new message.
+ */
+export declare const DeleteOrganizationRequestSchema: GenMessage<DeleteOrganizationRequest>;
+/**
+ * @generated from message slipway.v1.DeleteOrganizationResponse
+ */
+export type DeleteOrganizationResponse = Message<"slipway.v1.DeleteOrganizationResponse"> & {
+    /**
+     * when the data is deleted for good
+     *
+     * @generated from field: google.protobuf.Timestamp purge_after = 1;
+     */
+    purgeAfter?: Timestamp | undefined;
+};
+/**
+ * Describes the message slipway.v1.DeleteOrganizationResponse.
+ * Use `create(DeleteOrganizationResponseSchema)` to create a new message.
+ */
+export declare const DeleteOrganizationResponseSchema: GenMessage<DeleteOrganizationResponse>;
 /**
  * @generated from message slipway.v1.ListProjectsRequest
  */
@@ -1102,6 +1172,12 @@ export type SignupRequest = Message<"slipway.v1.SignupRequest"> & {
  */
 export declare const SignupRequestSchema: GenMessage<SignupRequest>;
 /**
+ * On an instance that sends email, an open sign-up (no invitation_token) creates nothing yet: it emails a
+ * confirmation link and answers with only verification_sent, the same answer whether or not the address already has
+ * an account (that account's owner is emailed instead). The account, its organisation and a session are created when
+ * the link is opened (VerifyEmail). With an invitation, or on an instance without a mail transport, the account is
+ * created at once: user and organization are set and the response starts a session.
+ *
  * @generated from message slipway.v1.SignupResponse
  */
 export type SignupResponse = Message<"slipway.v1.SignupResponse"> & {
@@ -1152,6 +1228,17 @@ export type ListAuthProvidersResponse = Message<"slipway.v1.ListAuthProvidersRes
      * @generated from field: bool webauthn_enabled = 4;
      */
     webauthnEnabled: boolean;
+    /**
+     * The operator's terms of service and privacy policy (SLIPWAY_TERMS_URL, SLIPWAY_PRIVACY_URL). Sign-up links them
+     * where it asks for consent; empty when the installation publishes none, and then no consent is asked.
+     *
+     * @generated from field: string terms_url = 5;
+     */
+    termsUrl: string;
+    /**
+     * @generated from field: string privacy_url = 6;
+     */
+    privacyUrl: string;
 };
 /**
  * Describes the message slipway.v1.ListAuthProvidersResponse.
@@ -1206,6 +1293,17 @@ export type VerifyEmailResponse = Message<"slipway.v1.VerifyEmailResponse"> & {
      * @generated from field: slipway.v1.User user = 1;
      */
     user?: User | undefined;
+    /**
+     * Set when the link confirmed an open sign-up: the account and this organisation were just created, and the
+     * response started a session for them (signed_in).
+     *
+     * @generated from field: slipway.v1.Organization organization = 2;
+     */
+    organization?: Organization | undefined;
+    /**
+     * @generated from field: bool signed_in = 3;
+     */
+    signedIn: boolean;
 };
 /**
  * Describes the message slipway.v1.VerifyEmailResponse.
@@ -1357,6 +1455,44 @@ export type SignOutEverywhereResponse = Message<"slipway.v1.SignOutEverywhereRes
  * Use `create(SignOutEverywhereResponseSchema)` to create a new message.
  */
 export declare const SignOutEverywhereResponseSchema: GenMessage<SignOutEverywhereResponse>;
+/**
+ * DeleteAccount closes the caller's own account: it leaves every organisation, its sessions and API tokens end and its
+ * address and name are erased. Refused while the caller is the only owner of an organisation.
+ *
+ * @generated from message slipway.v1.DeleteAccountRequest
+ */
+export type DeleteAccountRequest = Message<"slipway.v1.DeleteAccountRequest"> & {
+    /**
+     * the account's address, typed by the caller
+     *
+     * @generated from field: string confirm_email = 1;
+     */
+    confirmEmail: string;
+    /**
+     * @generated from field: string current_password = 2;
+     */
+    currentPassword: string;
+    /**
+     * authenticator or recovery code
+     *
+     * @generated from field: string code = 3;
+     */
+    code: string;
+};
+/**
+ * Describes the message slipway.v1.DeleteAccountRequest.
+ * Use `create(DeleteAccountRequestSchema)` to create a new message.
+ */
+export declare const DeleteAccountRequestSchema: GenMessage<DeleteAccountRequest>;
+/**
+ * @generated from message slipway.v1.DeleteAccountResponse
+ */
+export type DeleteAccountResponse = Message<"slipway.v1.DeleteAccountResponse"> & {};
+/**
+ * Describes the message slipway.v1.DeleteAccountResponse.
+ * Use `create(DeleteAccountResponseSchema)` to create a new message.
+ */
+export declare const DeleteAccountResponseSchema: GenMessage<DeleteAccountResponse>;
 /**
  * @generated from message slipway.v1.SwitchOrganizationRequest
  */
@@ -1871,6 +2007,8 @@ export type GetInvitationResponse = Message<"slipway.v1.GetInvitationResponse">
      */
     email: string;
     /**
+     * role ID ("developer", "role_…")
+     *
      * @generated from field: string role = 4;
      */
     role: string;
@@ -1878,6 +2016,12 @@ export type GetInvitationResponse = Message<"slipway.v1.GetInvitationResponse">
      * @generated from field: bool user_exists = 5;
      */
     userExists: boolean;
+    /**
+     * the role's display name ("Developer")
+     *
+     * @generated from field: string role_name = 6;
+     */
+    roleName: string;
 };
 /**
  * Describes the message slipway.v1.GetInvitationResponse.
@@ -3636,6 +3780,14 @@ export declare const IdentityService: GenService<{
         input: typeof UpdateOrganizationRequestSchema;
         output: typeof UpdateOrganizationResponseSchema;
     };
+    /**
+     * @generated from rpc slipway.v1.IdentityService.DeleteOrganization
+     */
+    deleteOrganization: {
+        methodKind: "unary";
+        input: typeof DeleteOrganizationRequestSchema;
+        output: typeof DeleteOrganizationResponseSchema;
+    };
     /**
      * @generated from rpc slipway.v1.IdentityService.ListMembers
      */
@@ -3764,6 +3916,14 @@ export declare const IdentityService: GenService<{
         input: typeof SignOutEverywhereRequestSchema;
         output: typeof SignOutEverywhereResponseSchema;
     };
+    /**
+     * @generated from rpc slipway.v1.IdentityService.DeleteAccount
+     */
+    deleteAccount: {
+        methodKind: "unary";
+        input: typeof DeleteAccountRequestSchema;
+        output: typeof DeleteAccountResponseSchema;
+    };
     /**
      * @generated from rpc slipway.v1.IdentityService.SwitchOrganization
      */