@randock/nameshift-api-client 0.0.502 → 0.0.504

package/dist/apis/UsersApi.d.ts

@@ -10,22 +10,94 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { ChangeUserEmailWithOtpInput, RegisterUserPushTokenInput, RequestUserEmailChangeOtpInput, StoreUserLocaleInput, UpdateUserNotificationSettingsInput, UserNotificationSettingsDto } from '../models/index';
+import type { ActivateUserTotpInput, ChangeUserAuthenticationMethodInput, ChangeUserEmailWithOtpInput, ChangeUserLoginLocationVerificationInput, ChangeUserPasswordInput, CurrentPasswordInput, ListUserLoginAttempts200Response, PasskeyOptionsDto, ReauthenticateWithPasskeyInput, ReauthenticationDto, RecoveryCodesDto, RegisterUserPasskeyInput, RegisterUserPushTokenInput, RemoveUserPasskeyInput, RenameUserPasskeyInput, RequestUserEmailChangeOtpInput, StoreUserLocaleInput, TotpCodeInput, TotpEnrolmentDto, UpdateUserNotificationSettingsInput, UserNotificationSettingsDto, UserSecurityDto } from '../models/index';
+export interface UsersApiActivateUserTotpRequest {
+    activateUserTotpInput: ActivateUserTotpInput;
+}
+export interface UsersApiActivateUserTotpReplacementRequest {
+    activateUserTotpInput: ActivateUserTotpInput;
+}
+export interface UsersApiChangeUserAuthenticationMethodRequest {
+    xReauthenticationToken: string;
+    changeUserAuthenticationMethodInput: ChangeUserAuthenticationMethodInput;
+}
 export interface UsersApiChangeUserEmailWithOtpRequest {
     changeUserEmailWithOtpInput: ChangeUserEmailWithOtpInput;
 }
+export interface UsersApiChangeUserLoginLocationVerificationRequest {
+    changeUserLoginLocationVerificationInput: ChangeUserLoginLocationVerificationInput;
+    xReauthenticationToken?: string;
+}
+export interface UsersApiChangeUserPasswordRequest {
+    changeUserPasswordInput: ChangeUserPasswordInput;
+}
+export interface UsersApiDisableUserRecoveryCodesRequest {
+    xReauthenticationToken: string;
+}
+export interface UsersApiDisableUserTotpRequest {
+    totpCodeInput: TotpCodeInput;
+}
+export interface UsersApiEnableUserRecoveryCodesRequest {
+    xReauthenticationToken: string;
+}
+export interface UsersApiGetUserPasskeyRegistrationOptionsRequest {
+    xReauthenticationToken: string;
+}
+export interface UsersApiGetUserPasskeyVerificationOptionsRequest {
+    passkeyId: string;
+}
+export interface UsersApiListUserLoginAttemptsRequest {
+    filter?: {
+        [key: string]: string;
+    };
+    page?: number;
+    limit?: number;
+    sortBy?: Array<string>;
+    filterResult?: string;
+    filterMethod?: string;
+}
+export interface UsersApiReauthenticateWithPasskeyRequest {
+    reauthenticateWithPasskeyInput: ReauthenticateWithPasskeyInput;
+}
+export interface UsersApiReauthenticateWithPasswordRequest {
+    currentPasswordInput: CurrentPasswordInput;
+}
+export interface UsersApiReauthenticateWithTotpRequest {
+    activateUserTotpInput: ActivateUserTotpInput;
+}
+export interface UsersApiRegenerateUserRecoveryCodesRequest {
+    xReauthenticationToken: string;
+}
+export interface UsersApiRegisterUserPasskeyRequest {
+    xReauthenticationToken: string;
+    registerUserPasskeyInput: RegisterUserPasskeyInput;
+}
 export interface UsersApiRegisterUserPushTokenRequest {
     registerUserPushTokenInput: RegisterUserPushTokenInput;
 }
+export interface UsersApiRemoveUserPasskeyRequest {
+    passkeyId: string;
+    removeUserPasskeyInput: RemoveUserPasskeyInput;
+}
 export interface UsersApiRemoveUserPushTokenRequest {
     token: string;
 }
+export interface UsersApiRenameUserPasskeyRequest {
+    passkeyId: string;
+    renameUserPasskeyInput: RenameUserPasskeyInput;
+}
 export interface UsersApiRequestUserEmailChangeOtpRequest {
     requestUserEmailChangeOtpInput: RequestUserEmailChangeOtpInput;
 }
 export interface UsersApiSetLocaleRequest {
     storeUserLocaleInput: StoreUserLocaleInput;
 }
+export interface UsersApiStartUserTotpEnrolmentRequest {
+    xReauthenticationToken: string;
+}
+export interface UsersApiStartUserTotpReplacementRequest {
+    xReauthenticationToken: string;
+}
 export interface UsersApiUpdateUserNotificationSettingsRequest {
     updateUserNotificationSettingsInput: UpdateUserNotificationSettingsInput;
 }
@@ -33,6 +105,34 @@ export interface UsersApiUpdateUserNotificationSettingsRequest {
  *
  */
 export declare class UsersApi extends runtime.BaseAPI {
+    /**
+     * Turn the authenticator app on with one of its codes
+     */
+    activateUserTotpRaw(requestParameters: UsersApiActivateUserTotpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Turn the authenticator app on with one of its codes
+     */
+    activateUserTotp(requestParameters: UsersApiActivateUserTotpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * The new app replaces the current one. The sign-in method and the recovery codes stay as they are.
+     * Move to the new authenticator app with one of its codes
+     */
+    activateUserTotpReplacementRaw(requestParameters: UsersApiActivateUserTotpReplacementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * The new app replaces the current one. The sign-in method and the recovery codes stay as they are.
+     * Move to the new authenticator app with one of its codes
+     */
+    activateUserTotpReplacement(requestParameters: UsersApiActivateUserTotpReplacementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Only to a method the factors set up allow (see allowedAuthenticationMethods). Needs the reauthentication token: a stronger method can also lock the user out of a sign-in they rely on.
+     * Change the method the user signs in with
+     */
+    changeUserAuthenticationMethodRaw(requestParameters: UsersApiChangeUserAuthenticationMethodRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserSecurityDto>>;
+    /**
+     * Only to a method the factors set up allow (see allowedAuthenticationMethods). Needs the reauthentication token: a stronger method can also lock the user out of a sign-in they rely on.
+     * Change the method the user signs in with
+     */
+    changeUserAuthenticationMethod(requestParameters: UsersApiChangeUserAuthenticationMethodRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserSecurityDto>;
     /**
      * Changes the seller user email after validating the OTP sent to the new address.  **API key scope required:** `USER_EMAIL_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Change user email with OTP
@@ -43,6 +143,64 @@ export declare class UsersApi extends runtime.BaseAPI {
      * Change user email with OTP
      */
     changeUserEmailWithOtp(requestParameters: UsersApiChangeUserEmailWithOtpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Turning it off needs the reauthentication token.
+     * Turn the email confirmation of new locations on or off
+     */
+    changeUserLoginLocationVerificationRaw(requestParameters: UsersApiChangeUserLoginLocationVerificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserSecurityDto>>;
+    /**
+     * Turning it off needs the reauthentication token.
+     * Turn the email confirmation of new locations on or off
+     */
+    changeUserLoginLocationVerification(requestParameters: UsersApiChangeUserLoginLocationVerificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserSecurityDto>;
+    /**
+     * Requires the current password.
+     * Change the password
+     */
+    changeUserPasswordRaw(requestParameters: UsersApiChangeUserPasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Requires the current password.
+     * Change the password
+     */
+    changeUserPassword(requestParameters: UsersApiChangeUserPasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * The current codes stop working.
+     * Turn recovery codes off
+     */
+    disableUserRecoveryCodesRaw(requestParameters: UsersApiDisableUserRecoveryCodesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * The current codes stop working.
+     * Turn recovery codes off
+     */
+    disableUserRecoveryCodes(requestParameters: UsersApiDisableUserRecoveryCodesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Needs a code of the app being turned off. Wrong codes count towards locking the verification step.
+     * Turn the authenticator app off
+     */
+    disableUserTotpRaw(requestParameters: UsersApiDisableUserTotpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Needs a code of the app being turned off. Wrong codes count towards locking the verification step.
+     * Turn the authenticator app off
+     */
+    disableUserTotp(requestParameters: UsersApiDisableUserTotpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Returns the codes, only this once. Needs an authenticator app or a passkey for them to stand in for.
+     * Turn recovery codes on
+     */
+    enableUserRecoveryCodesRaw(requestParameters: UsersApiEnableUserRecoveryCodesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RecoveryCodesDto>>;
+    /**
+     * Returns the codes, only this once. Needs an authenticator app or a passkey for them to stand in for.
+     * Turn recovery codes on
+     */
+    enableUserRecoveryCodes(requestParameters: UsersApiEnableUserRecoveryCodesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RecoveryCodesDto>;
+    /**
+     * Start confirming it is you with a passkey
+     */
+    getReauthenticationPasskeyOptionsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PasskeyOptionsDto>>;
+    /**
+     * Start confirming it is you with a passkey
+     */
+    getReauthenticationPasskeyOptions(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PasskeyOptionsDto>;
     /**
      * Returns the notification preferences configured for the seller user.  **API key scope required:** `USERS_READ`. Requests authenticated with a seller session do not need any scope.
      * Get user notification settings
@@ -53,6 +211,94 @@ export declare class UsersApi extends runtime.BaseAPI {
      * Get user notification settings
      */
     getUserNotificationSettings(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserNotificationSettingsDto>;
+    /**
+     * Needs the reauthentication token: a passkey signs in on its own.
+     * Start adding a passkey
+     */
+    getUserPasskeyRegistrationOptionsRaw(requestParameters: UsersApiGetUserPasskeyRegistrationOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PasskeyOptionsDto>>;
+    /**
+     * Needs the reauthentication token: a passkey signs in on its own.
+     * Start adding a passkey
+     */
+    getUserPasskeyRegistrationOptions(requestParameters: UsersApiGetUserPasskeyRegistrationOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PasskeyOptionsDto>;
+    /**
+     * Only that passkey can answer.
+     * Start using a passkey to prove it, before removing it
+     */
+    getUserPasskeyVerificationOptionsRaw(requestParameters: UsersApiGetUserPasskeyVerificationOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PasskeyOptionsDto>>;
+    /**
+     * Only that passkey can answer.
+     * Start using a passkey to prove it, before removing it
+     */
+    getUserPasskeyVerificationOptions(requestParameters: UsersApiGetUserPasskeyVerificationOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PasskeyOptionsDto>;
+    /**
+     * Get how the user signs in
+     */
+    getUserSecurityRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserSecurityDto>>;
+    /**
+     * Get how the user signs in
+     */
+    getUserSecurity(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserSecurityDto>;
+    /**
+     * Every step of every sign-in, successful or not, newest first by default.
+     * List the sign-ins of the user
+     */
+    listUserLoginAttemptsRaw(requestParameters: UsersApiListUserLoginAttemptsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ListUserLoginAttempts200Response>>;
+    /**
+     * Every step of every sign-in, successful or not, newest first by default.
+     * List the sign-ins of the user
+     */
+    listUserLoginAttempts(requestParameters?: UsersApiListUserLoginAttemptsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ListUserLoginAttempts200Response>;
+    /**
+     * For the next ten minutes, sensitive changes accept the returned token.
+     * Confirm it is you with a passkey
+     */
+    reauthenticateWithPasskeyRaw(requestParameters: UsersApiReauthenticateWithPasskeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReauthenticationDto>>;
+    /**
+     * For the next ten minutes, sensitive changes accept the returned token.
+     * Confirm it is you with a passkey
+     */
+    reauthenticateWithPasskey(requestParameters: UsersApiReauthenticateWithPasskeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReauthenticationDto>;
+    /**
+     * For the next ten minutes, sensitive changes accept the returned token.
+     * Confirm it is you with your password
+     */
+    reauthenticateWithPasswordRaw(requestParameters: UsersApiReauthenticateWithPasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReauthenticationDto>>;
+    /**
+     * For the next ten minutes, sensitive changes accept the returned token.
+     * Confirm it is you with your password
+     */
+    reauthenticateWithPassword(requestParameters: UsersApiReauthenticateWithPasswordRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReauthenticationDto>;
+    /**
+     * For the next ten minutes, sensitive changes accept the returned token. Wrong codes count towards locking the verification step.
+     * Confirm it is you with the code from your authenticator app
+     */
+    reauthenticateWithTotpRaw(requestParameters: UsersApiReauthenticateWithTotpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReauthenticationDto>>;
+    /**
+     * For the next ten minutes, sensitive changes accept the returned token. Wrong codes count towards locking the verification step.
+     * Confirm it is you with the code from your authenticator app
+     */
+    reauthenticateWithTotp(requestParameters: UsersApiReauthenticateWithTotpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReauthenticationDto>;
+    /**
+     * The previous codes stop working. Only while recovery codes are on.
+     * Replace the recovery codes
+     */
+    regenerateUserRecoveryCodesRaw(requestParameters: UsersApiRegenerateUserRecoveryCodesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RecoveryCodesDto>>;
+    /**
+     * The previous codes stop working. Only while recovery codes are on.
+     * Replace the recovery codes
+     */
+    regenerateUserRecoveryCodes(requestParameters: UsersApiRegenerateUserRecoveryCodesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RecoveryCodesDto>;
+    /**
+     * Needs the reauthentication token: a passkey signs in on its own.
+     * Add a passkey
+     */
+    registerUserPasskeyRaw(requestParameters: UsersApiRegisterUserPasskeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Needs the reauthentication token: a passkey signs in on its own.
+     * Add a passkey
+     */
+    registerUserPasskey(requestParameters: UsersApiRegisterUserPasskeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Registers (or refreshes) an Expo push token for the current user and device. Seller session only.
      * Register a push token
@@ -63,6 +309,16 @@ export declare class UsersApi extends runtime.BaseAPI {
      * Register a push token
      */
     registerUserPushToken(requestParameters: UsersApiRegisterUserPushTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Needs that very passkey, used one last time (see the verification options).
+     * Remove a passkey
+     */
+    removeUserPasskeyRaw(requestParameters: UsersApiRemoveUserPasskeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Needs that very passkey, used one last time (see the verification options).
+     * Remove a passkey
+     */
+    removeUserPasskey(requestParameters: UsersApiRemoveUserPasskeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Unregisters an Expo push token for the current user, e.g. on logout. Seller session only.
      * Remove a push token
@@ -73,6 +329,14 @@ export declare class UsersApi extends runtime.BaseAPI {
      * Remove a push token
      */
     removeUserPushToken(requestParameters: UsersApiRemoveUserPushTokenRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Rename a passkey
+     */
+    renameUserPasskeyRaw(requestParameters: UsersApiRenameUserPasskeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Rename a passkey
+     */
+    renameUserPasskey(requestParameters: UsersApiRenameUserPasskeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Sends a one-time password to the new email address to verify ownership before changing the account email.  **API key scope required:** `USER_EMAIL_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Request email change OTP
@@ -93,6 +357,26 @@ export declare class UsersApi extends runtime.BaseAPI {
      * Store user locale preference
      */
     setLocale(requestParameters: UsersApiSetLocaleRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Returns the QR code URI and the secret to type by hand. The app is only turned on once a code of it is checked; a new call replaces the secret. Needs the reauthentication token: whoever sets up the app holds the verification step.
+     * Start setting up an authenticator app
+     */
+    startUserTotpEnrolmentRaw(requestParameters: UsersApiStartUserTotpEnrolmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TotpEnrolmentDto>>;
+    /**
+     * Returns the QR code URI and the secret to type by hand. The app is only turned on once a code of it is checked; a new call replaces the secret. Needs the reauthentication token: whoever sets up the app holds the verification step.
+     * Start setting up an authenticator app
+     */
+    startUserTotpEnrolment(requestParameters: UsersApiStartUserTotpEnrolmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TotpEnrolmentDto>;
+    /**
+     * Returns the QR code URI and the secret of the new app. The current app keeps working until a code of the new one is checked.
+     * Start moving to another authenticator app
+     */
+    startUserTotpReplacementRaw(requestParameters: UsersApiStartUserTotpReplacementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TotpEnrolmentDto>>;
+    /**
+     * Returns the QR code URI and the secret of the new app. The current app keeps working until a code of the new one is checked.
+     * Start moving to another authenticator app
+     */
+    startUserTotpReplacement(requestParameters: UsersApiStartUserTotpReplacementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TotpEnrolmentDto>;
     /**
      * Updates one or more notification preferences for the seller user.  **API key scope required:** `USERS_WRITE`. Requests authenticated with a seller session do not need any scope.
      * Update user notification settings