@randock/nameshift-api-client 0.0.503 → 0.0.505

package/src/apis/UsersPublicApi.ts

@@ -15,26 +15,53 @@
 
 import * as runtime from '../runtime';
 import type {
+  ConfirmLoginLocationInput,
   ForgotPasswordRequestInput,
+  LoginChallengeInput,
+  LoginCodeInput,
   LoginDto,
   LoginInput,
+  LoginPasskeyInput,
+  LoginPasskeyOptionsInput,
+  LoginPasswordInput,
+  LoginRecoveryCodeInput,
   NotificationsUnsubscribeResultDto,
+  PasskeyOptionsDto,
   SetNewPasswordInput,
+  UserLoginLocationConfirmationDetailsDto,
   UserPasswordResetDto,
   UserSignedTokenInput,
   ValidationException,
 } from '../models/index';
 import {
+    ConfirmLoginLocationInputFromJSON,
+    ConfirmLoginLocationInputToJSON,
     ForgotPasswordRequestInputFromJSON,
     ForgotPasswordRequestInputToJSON,
+    LoginChallengeInputFromJSON,
+    LoginChallengeInputToJSON,
+    LoginCodeInputFromJSON,
+    LoginCodeInputToJSON,
     LoginDtoFromJSON,
     LoginDtoToJSON,
     LoginInputFromJSON,
     LoginInputToJSON,
+    LoginPasskeyInputFromJSON,
+    LoginPasskeyInputToJSON,
+    LoginPasskeyOptionsInputFromJSON,
+    LoginPasskeyOptionsInputToJSON,
+    LoginPasswordInputFromJSON,
+    LoginPasswordInputToJSON,
+    LoginRecoveryCodeInputFromJSON,
+    LoginRecoveryCodeInputToJSON,
     NotificationsUnsubscribeResultDtoFromJSON,
     NotificationsUnsubscribeResultDtoToJSON,
+    PasskeyOptionsDtoFromJSON,
+    PasskeyOptionsDtoToJSON,
     SetNewPasswordInputFromJSON,
     SetNewPasswordInputToJSON,
+    UserLoginLocationConfirmationDetailsDtoFromJSON,
+    UserLoginLocationConfirmationDetailsDtoToJSON,
     UserPasswordResetDtoFromJSON,
     UserPasswordResetDtoToJSON,
     UserSignedTokenInputFromJSON,
@@ -43,6 +70,11 @@ import {
     ValidationExceptionToJSON,
 } from '../models/index';
 
+export interface UsersPublicApiConfirmLoginLocationRequest {
+    confirmationId: string;
+    confirmLoginLocationInput: ConfirmLoginLocationInput;
+}
+
 export interface UsersPublicApiForgotPasswordRequestRequest {
     forgotPasswordRequestInput: ForgotPasswordRequestInput;
 }
@@ -51,10 +83,43 @@ export interface UsersPublicApiGetForgotPasswordRequestRequest {
     passwordRequestId: string;
 }
 
+export interface UsersPublicApiGetLoginLocationConfirmationDetailsRequest {
+    confirmationId: string;
+    confirmLoginLocationInput: ConfirmLoginLocationInput;
+}
+
+export interface UsersPublicApiGetLoginLocationConfirmationStatusRequest {
+    loginChallengeInput: LoginChallengeInput;
+}
+
+export interface UsersPublicApiGetLoginPasskeyOptionsRequest {
+    loginPasskeyOptionsInput: LoginPasskeyOptionsInput;
+}
+
 export interface UsersPublicApiLoginRequest {
     loginInput: LoginInput;
 }
 
+export interface UsersPublicApiLoginWithPasskeyRequest {
+    loginPasskeyInput: LoginPasskeyInput;
+}
+
+export interface UsersPublicApiLoginWithPasswordStepRequest {
+    loginPasswordInput: LoginPasswordInput;
+}
+
+export interface UsersPublicApiLoginWithRecoveryCodeRequest {
+    loginCodeInput: LoginCodeInput;
+}
+
+export interface UsersPublicApiLoginWithRecoveryCodeInsteadOfPasskeyRequest {
+    loginRecoveryCodeInput: LoginRecoveryCodeInput;
+}
+
+export interface UsersPublicApiLoginWithTotpRequest {
+    loginCodeInput: LoginCodeInput;
+}
+
 export interface UsersPublicApiPostNewPasswordRequest {
     passwordRequestId: string;
     setNewPasswordInput: SetNewPasswordInput;
@@ -69,6 +134,50 @@ export interface UsersPublicApiUnsubscribeFromNotificationsByTokenRequest {
  */
 export class UsersPublicApi extends runtime.BaseAPI {
 
+    /**
+     * Called by the page the email links to. It only approves the sign-in: no session is returned here.
+     * Approve a sign-in from a new location
+     */
+    async confirmLoginLocationRaw(requestParameters: UsersPublicApiConfirmLoginLocationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        if (requestParameters['confirmationId'] == null) {
+            throw new runtime.RequiredError(
+                'confirmationId',
+                'Required parameter "confirmationId" was null or undefined when calling confirmLoginLocation().'
+            );
+        }
+
+        if (requestParameters['confirmLoginLocationInput'] == null) {
+            throw new runtime.RequiredError(
+                'confirmLoginLocationInput',
+                'Required parameter "confirmLoginLocationInput" was null or undefined when calling confirmLoginLocation().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        const response = await this.request({
+            path: `/users/login/location-confirmation/{confirmationId}/confirm`.replace(`{${"confirmationId"}}`, encodeURIComponent(String(requestParameters['confirmationId']))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ConfirmLoginLocationInputToJSON(requestParameters['confirmLoginLocationInput']),
+        }, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Called by the page the email links to. It only approves the sign-in: no session is returned here.
+     * Approve a sign-in from a new location
+     */
+    async confirmLoginLocation(requestParameters: UsersPublicApiConfirmLoginLocationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.confirmLoginLocationRaw(requestParameters, initOverrides);
+    }
+
     /**
      * Creates a password reset request and sends a reset link to the provided email address.
      * Request a password reset email
@@ -142,7 +251,128 @@ export class UsersPublicApi extends runtime.BaseAPI {
     }
 
     /**
-     * Validates email and password credentials and returns a JWT token with the user locale.
+     * Approves nothing: the page the email links to shows these details and approves only when the user says so, so that mail scanners opening the link approve nothing.
+     * See the sign-in an email link asks to approve
+     */
+    async getLoginLocationConfirmationDetailsRaw(requestParameters: UsersPublicApiGetLoginLocationConfirmationDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<UserLoginLocationConfirmationDetailsDto>> {
+        if (requestParameters['confirmationId'] == null) {
+            throw new runtime.RequiredError(
+                'confirmationId',
+                'Required parameter "confirmationId" was null or undefined when calling getLoginLocationConfirmationDetails().'
+            );
+        }
+
+        if (requestParameters['confirmLoginLocationInput'] == null) {
+            throw new runtime.RequiredError(
+                'confirmLoginLocationInput',
+                'Required parameter "confirmLoginLocationInput" was null or undefined when calling getLoginLocationConfirmationDetails().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        const response = await this.request({
+            path: `/users/login/location-confirmation/{confirmationId}/details`.replace(`{${"confirmationId"}}`, encodeURIComponent(String(requestParameters['confirmationId']))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ConfirmLoginLocationInputToJSON(requestParameters['confirmLoginLocationInput']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => UserLoginLocationConfirmationDetailsDtoFromJSON(jsonValue));
+    }
+
+    /**
+     * Approves nothing: the page the email links to shows these details and approves only when the user says so, so that mail scanners opening the link approve nothing.
+     * See the sign-in an email link asks to approve
+     */
+    async getLoginLocationConfirmationDetails(requestParameters: UsersPublicApiGetLoginLocationConfirmationDetailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<UserLoginLocationConfirmationDetailsDto> {
+        const response = await this.getLoginLocationConfirmationDetailsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Polled by the browser that started the sign-in. It, and only it, gets the session once the user opens the link in the email.
+     * Wait for the email confirming a new location
+     */
+    async getLoginLocationConfirmationStatusRaw(requestParameters: UsersPublicApiGetLoginLocationConfirmationStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LoginDto>> {
+        if (requestParameters['loginChallengeInput'] == null) {
+            throw new runtime.RequiredError(
+                'loginChallengeInput',
+                'Required parameter "loginChallengeInput" was null or undefined when calling getLoginLocationConfirmationStatus().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        const response = await this.request({
+            path: `/users/login/location-confirmation/status`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: LoginChallengeInputToJSON(requestParameters['loginChallengeInput']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => LoginDtoFromJSON(jsonValue));
+    }
+
+    /**
+     * Polled by the browser that started the sign-in. It, and only it, gets the session once the user opens the link in the email.
+     * Wait for the email confirming a new location
+     */
+    async getLoginLocationConfirmationStatus(requestParameters: UsersPublicApiGetLoginLocationConfirmationStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LoginDto> {
+        const response = await this.getLoginLocationConfirmationStatusRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Without a challenge token, any passkey of the site on the device can answer, for users whose first sign-in step accepts a passkey. With one, the passkey proves the next step of that sign-in.
+     * Start signing in with a passkey
+     */
+    async getLoginPasskeyOptionsRaw(requestParameters: UsersPublicApiGetLoginPasskeyOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<PasskeyOptionsDto>> {
+        if (requestParameters['loginPasskeyOptionsInput'] == null) {
+            throw new runtime.RequiredError(
+                'loginPasskeyOptionsInput',
+                'Required parameter "loginPasskeyOptionsInput" was null or undefined when calling getLoginPasskeyOptions().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        const response = await this.request({
+            path: `/users/login/passkey/options`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: LoginPasskeyOptionsInputToJSON(requestParameters['loginPasskeyOptionsInput']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => PasskeyOptionsDtoFromJSON(jsonValue));
+    }
+
+    /**
+     * Without a challenge token, any passkey of the site on the device can answer, for users whose first sign-in step accepts a passkey. With one, the passkey proves the next step of that sign-in.
+     * Start signing in with a passkey
+     */
+    async getLoginPasskeyOptions(requestParameters: UsersPublicApiGetLoginPasskeyOptionsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<PasskeyOptionsDto> {
+        const response = await this.getLoginPasskeyOptionsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Validates email and password. Returns the session token, or a challenge token and the next step: a second factor, setting up an authenticator app, or confirming a new location by email.
      * Authenticate a seller user
      */
     async loginRaw(requestParameters: UsersPublicApiLoginRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LoginDto>> {
@@ -171,7 +401,7 @@ export class UsersPublicApi extends runtime.BaseAPI {
     }
 
     /**
-     * Validates email and password credentials and returns a JWT token with the user locale.
+     * Validates email and password. Returns the session token, or a challenge token and the next step: a second factor, setting up an authenticator app, or confirming a new location by email.
      * Authenticate a seller user
      */
     async login(requestParameters: UsersPublicApiLoginRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LoginDto> {
@@ -179,6 +409,194 @@ export class UsersPublicApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Sign in with a passkey, or prove a later step with one
+     */
+    async loginWithPasskeyRaw(requestParameters: UsersPublicApiLoginWithPasskeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LoginDto>> {
+        if (requestParameters['loginPasskeyInput'] == null) {
+            throw new runtime.RequiredError(
+                'loginPasskeyInput',
+                'Required parameter "loginPasskeyInput" was null or undefined when calling loginWithPasskey().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        const response = await this.request({
+            path: `/users/login/passkey`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: LoginPasskeyInputToJSON(requestParameters['loginPasskeyInput']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => LoginDtoFromJSON(jsonValue));
+    }
+
+    /**
+     * Sign in with a passkey, or prove a later step with one
+     */
+    async loginWithPasskey(requestParameters: UsersPublicApiLoginWithPasskeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LoginDto> {
+        const response = await this.loginWithPasskeyRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * For users who enter the password after another step, e.g. a passkey first. Wrong passwords count towards the lock of the later steps.
+     * Prove a later sign-in step with the password
+     */
+    async loginWithPasswordStepRaw(requestParameters: UsersPublicApiLoginWithPasswordStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LoginDto>> {
+        if (requestParameters['loginPasswordInput'] == null) {
+            throw new runtime.RequiredError(
+                'loginPasswordInput',
+                'Required parameter "loginPasswordInput" was null or undefined when calling loginWithPasswordStep().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        const response = await this.request({
+            path: `/users/login/password`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: LoginPasswordInputToJSON(requestParameters['loginPasswordInput']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => LoginDtoFromJSON(jsonValue));
+    }
+
+    /**
+     * For users who enter the password after another step, e.g. a passkey first. Wrong passwords count towards the lock of the later steps.
+     * Prove a later sign-in step with the password
+     */
+    async loginWithPasswordStep(requestParameters: UsersPublicApiLoginWithPasswordStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LoginDto> {
+        const response = await this.loginWithPasswordStepRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Each recovery code works once.
+     * Prove the second factor with a recovery code
+     */
+    async loginWithRecoveryCodeRaw(requestParameters: UsersPublicApiLoginWithRecoveryCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LoginDto>> {
+        if (requestParameters['loginCodeInput'] == null) {
+            throw new runtime.RequiredError(
+                'loginCodeInput',
+                'Required parameter "loginCodeInput" was null or undefined when calling loginWithRecoveryCode().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        const response = await this.request({
+            path: `/users/login/recovery-code`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: LoginCodeInputToJSON(requestParameters['loginCodeInput']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => LoginDtoFromJSON(jsonValue));
+    }
+
+    /**
+     * Each recovery code works once.
+     * Prove the second factor with a recovery code
+     */
+    async loginWithRecoveryCode(requestParameters: UsersPublicApiLoginWithRecoveryCodeRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LoginDto> {
+        const response = await this.loginWithRecoveryCodeRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * For users whose first sign-in step is a passkey alone: the recovery code stands in for it, and the next steps are still asked for. Users who can start with the password enter it first, then the recovery code in a later step; here they get the same error as for a wrong code.
+     * Sign in with a recovery code instead of a lost passkey
+     */
+    async loginWithRecoveryCodeInsteadOfPasskeyRaw(requestParameters: UsersPublicApiLoginWithRecoveryCodeInsteadOfPasskeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LoginDto>> {
+        if (requestParameters['loginRecoveryCodeInput'] == null) {
+            throw new runtime.RequiredError(
+                'loginRecoveryCodeInput',
+                'Required parameter "loginRecoveryCodeInput" was null or undefined when calling loginWithRecoveryCodeInsteadOfPasskey().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        const response = await this.request({
+            path: `/users/login/recovery-code-instead-of-passkey`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: LoginRecoveryCodeInputToJSON(requestParameters['loginRecoveryCodeInput']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => LoginDtoFromJSON(jsonValue));
+    }
+
+    /**
+     * For users whose first sign-in step is a passkey alone: the recovery code stands in for it, and the next steps are still asked for. Users who can start with the password enter it first, then the recovery code in a later step; here they get the same error as for a wrong code.
+     * Sign in with a recovery code instead of a lost passkey
+     */
+    async loginWithRecoveryCodeInsteadOfPasskey(requestParameters: UsersPublicApiLoginWithRecoveryCodeInsteadOfPasskeyRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LoginDto> {
+        const response = await this.loginWithRecoveryCodeInsteadOfPasskeyRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+    /**
+     * Accepts the code of the current period, the previous or the next one, never twice.
+     * Prove the second factor with an authenticator app code
+     */
+    async loginWithTotpRaw(requestParameters: UsersPublicApiLoginWithTotpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<LoginDto>> {
+        if (requestParameters['loginCodeInput'] == null) {
+            throw new runtime.RequiredError(
+                'loginCodeInput',
+                'Required parameter "loginCodeInput" was null or undefined when calling loginWithTotp().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        const response = await this.request({
+            path: `/users/login/totp`,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: LoginCodeInputToJSON(requestParameters['loginCodeInput']),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => LoginDtoFromJSON(jsonValue));
+    }
+
+    /**
+     * Accepts the code of the current period, the previous or the next one, never twice.
+     * Prove the second factor with an authenticator app code
+     */
+    async loginWithTotp(requestParameters: UsersPublicApiLoginWithTotpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<LoginDto> {
+        const response = await this.loginWithTotpRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Completes the password reset flow by setting a new password for the user linked to the reset request.
      * Set a new password from reset request

package/src/models/ActivateUserTotpInput.ts

@@ -0,0 +1,66 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Nameshift
+ * Nameshift domain marketplace and management API.  ## Authentication - **Bearer JWT** — Seller and buyer sessions obtained via login endpoints. - **API key** — Pass the `apikey` header for programmatic seller access.  ## Audiences - **(public)** tags — Unauthenticated or buyer-facing endpoints. - **Accounts / Domains / Leads / Buyers** — Seller or buyer resources. - **Partner** — Partner integrations.
+ *
+ * The version of the OpenAPI document: 1.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface ActivateUserTotpInput
+ */
+export interface ActivateUserTotpInput {
+    /**
+     * Code the authenticator app shows, to prove it was set up.
+     * @type {string}
+     * @memberof ActivateUserTotpInput
+     */
+    code: string;
+}
+
+/**
+ * Check if a given object implements the ActivateUserTotpInput interface.
+ */
+export function instanceOfActivateUserTotpInput(value: object): value is ActivateUserTotpInput {
+    if (!('code' in value) || value['code'] === undefined) return false;
+    return true;
+}
+
+export function ActivateUserTotpInputFromJSON(json: any): ActivateUserTotpInput {
+    return ActivateUserTotpInputFromJSONTyped(json, false);
+}
+
+export function ActivateUserTotpInputFromJSONTyped(json: any, ignoreDiscriminator: boolean): ActivateUserTotpInput {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'code': json['code'],
+    };
+}
+
+export function ActivateUserTotpInputToJSON(json: any): ActivateUserTotpInput {
+    return ActivateUserTotpInputToJSONTyped(json, false);
+}
+
+export function ActivateUserTotpInputToJSONTyped(value?: ActivateUserTotpInput | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'code': value['code'],
+    };
+}
+