@openfort/openfort-node 0.6.44 → 0.6.45

package/dist/generated/apis/AuthenticationApi.d.ts

@@ -1,56 +1,234 @@
 import { BaseAPIRequestFactory } from './baseapi';
 import { Configuration } from '../configuration';
 import { RequestContext, ResponseContext } from '../http/http';
+import { AuthPlayerResponse } from '../models/AuthPlayerResponse';
 import { AuthResponse } from '../models/AuthResponse';
+import { AuthenticateOAuthRequest } from '../models/AuthenticateOAuthRequest';
+import { DeprecatedAuthenticatedPlayerResponse } from '../models/DeprecatedAuthenticatedPlayerResponse';
+import { GetSigninUrlResponse } from '../models/GetSigninUrlResponse';
+import { JwtKeyResponse } from '../models/JwtKeyResponse';
+import { LinkRequest } from '../models/LinkRequest';
 import { LoginRequest } from '../models/LoginRequest';
+import { LogoutRequest } from '../models/LogoutRequest';
+import { OAuthInitRequest } from '../models/OAuthInitRequest';
+import { OAuthProvider } from '../models/OAuthProvider';
+import { OAuthRequest } from '../models/OAuthRequest';
 import { PlayerResponse } from '../models/PlayerResponse';
+import { RefreshTokenRequest } from '../models/RefreshTokenRequest';
+import { SIWEAuthenticateRequest } from '../models/SIWEAuthenticateRequest';
+import { SIWEInitResponse } from '../models/SIWEInitResponse';
+import { SIWERequest } from '../models/SIWERequest';
 import { SignupRequest } from '../models/SignupRequest';
 /**
  * no description
  */
 export declare class AuthenticationApiRequestFactory extends BaseAPIRequestFactory {
     /**
-     * When using Openfort Auth, the endpoint authenticates the player based on his email, and returns the jwt token for the player together with the player id.
-     * Login a player.
+     * Authenticate player with oauth token.
+     * @param authenticateOAuthRequest
+     */
+    authenticateOAuth(authenticateOAuthRequest: AuthenticateOAuthRequest, _options?: Configuration): Promise<RequestContext>;
+    /**
+     * Authenticate player with SIWE
+     * @param sIWEAuthenticateRequest
+     */
+    authenticateSIWE(sIWEAuthenticateRequest: SIWEAuthenticateRequest, _options?: Configuration): Promise<RequestContext>;
+    /**
+     * The endpoint verifies the token generated by OAuth provider, creates or retrieves a player based on his email, and returns the jwt token for the player together with the player id.
+     * Authorize player with token.
+     * @param provider OAuth provider
+     * @param oAuthRequest
+     */
+    authorizeWithOAuthToken(provider: OAuthProvider, oAuthRequest: OAuthRequest, _options?: Configuration): Promise<RequestContext>;
+    /**
+     * Get the jwks.json file.  You can use the jwks.json file to verify the signature of a JWT token issued by Openfort Auth.
+     * Get the jwks.json file.
+     * @param publishableKey Specifies the project publishable key (starts with pk_).
+     */
+    getJwks(publishableKey: string, _options?: Configuration): Promise<RequestContext>;
+    /**
+     * Initialize OAuth.
+     * @param oAuthInitRequest
+     */
+    initOAuth(oAuthInitRequest: OAuthInitRequest, _options?: Configuration): Promise<RequestContext>;
+    /**
+     * Create a challenge to link external wallet to the player.
+     * Initialize SIWE.
+     * @param sIWERequest
+     */
+    initSIWE(sIWERequest: SIWERequest, _options?: Configuration): Promise<RequestContext>;
+    /**
+     * Link external wallet.
+     * @param sIWEAuthenticateRequest
+     */
+    linkSIWE(sIWEAuthenticateRequest: SIWEAuthenticateRequest, _options?: Configuration): Promise<RequestContext>;
+    /**
+     * Authenticate a player based on email and password.
+     * Email and password login.
      * @param loginRequest
      */
-    login(loginRequest: LoginRequest, _options?: Configuration): Promise<RequestContext>;
+    loginEmailPassword(loginRequest: LoginRequest, _options?: Configuration): Promise<RequestContext>;
+    /**
+     * When using Openfort Auth, the endpoint logs out the player.
+     * Log out a player.
+     * @param logoutRequest
+     */
+    logout(logoutRequest: LogoutRequest, _options?: Configuration): Promise<RequestContext>;
+    /**
+     * Get or create a new session for the player based on the refresh token.
+     * Refresh or create auth session.
+     * @param refreshTokenRequest
+     */
+    refresh(refreshTokenRequest: RefreshTokenRequest, _options?: Configuration): Promise<RequestContext>;
     /**
-     * When using Openfort Auth, the endpoint creates a player based on his email, and returns the jwt token for the player together with the player id.
-     * Sign up a player.
+     * Create and authenticate a player based on email and password.
+     * Email and password signup.
      * @param signupRequest
      */
-    signup(signupRequest: SignupRequest, _options?: Configuration): Promise<RequestContext>;
+    signupEmailPassword(signupRequest: SignupRequest, _options?: Configuration): Promise<RequestContext>;
+    /**
+     * Unlink OAuth account
+     * @param linkRequest
+     */
+    unlinkOAuth(linkRequest: LinkRequest, _options?: Configuration): Promise<RequestContext>;
+    /**
+     * Unlink external wallet.
+     * @param sIWERequest
+     */
+    unlinkSIWE(sIWERequest: SIWERequest, _options?: Configuration): Promise<RequestContext>;
+    /**
+     * The endpoint verifies the token generated by OAuth provider and retrieves a corresponding player.
+     * Retrieve player by oauth token.
+     * @param authenticateOAuthRequest
+     */
+    verifyOAuth(authenticateOAuthRequest: AuthenticateOAuthRequest, _options?: Configuration): Promise<RequestContext>;
     /**
-     * When using Openfort Auth, the endpoint verifies the token generated by Openfort Auth and retrieves a corresponding player.
-     * Verify an auth token.
-     * @param token Specifies the auth token.
+     * The endpoint verifies the token generated by OAuth provider and retrieves a corresponding player.
+     * Retrieve player by token.
+     * @param provider OAuth provider
+     * @param oAuthRequest
      */
-    verifyAuthToken(token: string, _options?: Configuration): Promise<RequestContext>;
+    verifyOAuthToken(provider: OAuthProvider, oAuthRequest: OAuthRequest, _options?: Configuration): Promise<RequestContext>;
 }
 export declare class AuthenticationApiResponseProcessor {
     /**
      * Unwraps the actual response sent by the server from the response context and deserializes the response content
      * to the expected objects
      *
-     * @params response Response returned by the server for a request to login
+     * @params response Response returned by the server for a request to authenticateOAuth
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    authenticateOAuth(response: ResponseContext): Promise<AuthResponse>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to authenticateSIWE
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    authenticateSIWE(response: ResponseContext): Promise<void | AuthResponse>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to authorizeWithOAuthToken
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    authorizeWithOAuthToken(response: ResponseContext): Promise<DeprecatedAuthenticatedPlayerResponse>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to getJwks
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    getJwks(response: ResponseContext): Promise<JwtKeyResponse>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to initOAuth
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    initOAuth(response: ResponseContext): Promise<GetSigninUrlResponse>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to initSIWE
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    initSIWE(response: ResponseContext): Promise<SIWEInitResponse>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to linkSIWE
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    linkSIWE(response: ResponseContext): Promise<AuthPlayerResponse | void>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to loginEmailPassword
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    loginEmailPassword(response: ResponseContext): Promise<AuthResponse>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to logout
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    logout(response: ResponseContext): Promise<void>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to refresh
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    refresh(response: ResponseContext): Promise<AuthResponse>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to signupEmailPassword
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    signupEmailPassword(response: ResponseContext): Promise<AuthResponse>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to unlinkOAuth
+     * @throws ApiException if the response code was not in [200, 299]
+     */
+    unlinkOAuth(response: ResponseContext): Promise<AuthPlayerResponse>;
+    /**
+     * Unwraps the actual response sent by the server from the response context and deserializes the response content
+     * to the expected objects
+     *
+     * @params response Response returned by the server for a request to unlinkSIWE
      * @throws ApiException if the response code was not in [200, 299]
      */
-    login(response: ResponseContext): Promise<AuthResponse>;
+    unlinkSIWE(response: ResponseContext): Promise<AuthPlayerResponse | void>;
     /**
      * Unwraps the actual response sent by the server from the response context and deserializes the response content
      * to the expected objects
      *
-     * @params response Response returned by the server for a request to signup
+     * @params response Response returned by the server for a request to verifyOAuth
      * @throws ApiException if the response code was not in [200, 299]
      */
-    signup(response: ResponseContext): Promise<AuthResponse>;
+    verifyOAuth(response: ResponseContext): Promise<PlayerResponse>;
     /**
      * Unwraps the actual response sent by the server from the response context and deserializes the response content
      * to the expected objects
      *
-     * @params response Response returned by the server for a request to verifyAuthToken
+     * @params response Response returned by the server for a request to verifyOAuthToken
      * @throws ApiException if the response code was not in [200, 299]
      */
-    verifyAuthToken(response: ResponseContext): Promise<PlayerResponse>;
+    verifyOAuthToken(response: ResponseContext): Promise<PlayerResponse>;
 }