@openfort/openfort-node 0.6.44 → 0.6.46

package/dist/generated/types/PromiseAPI.d.ts

@@ -3,8 +3,10 @@ import { AccountListResponse } from '../models/AccountListResponse';
 import { AccountResponse } from '../models/AccountResponse';
 import { AccountResponseExpandable } from '../models/AccountResponseExpandable';
 import { AuthPlayerListResponse } from '../models/AuthPlayerListResponse';
+import { AuthPlayerResponse } from '../models/AuthPlayerResponse';
 import { AuthResponse } from '../models/AuthResponse';
-import { AuthorizeWithOAuthToken200Response } from '../models/AuthorizeWithOAuthToken200Response';
+import { AuthSessionResponse } from '../models/AuthSessionResponse';
+import { AuthenticateOAuthRequest } from '../models/AuthenticateOAuthRequest';
 import { CancelTransferOwnershipRequest } from '../models/CancelTransferOwnershipRequest';
 import { CompleteRecoveryRequest } from '../models/CompleteRecoveryRequest';
 import { ContractDeleteResponse } from '../models/ContractDeleteResponse';
@@ -22,6 +24,7 @@ import { CreateSessionRequest } from '../models/CreateSessionRequest';
 import { CreateTransactionIntentRequest } from '../models/CreateTransactionIntentRequest';
 import { CreateWeb3ConnectionRequest } from '../models/CreateWeb3ConnectionRequest';
 import { DeployRequest } from '../models/DeployRequest';
+import { DeprecatedAuthenticatedPlayerResponse } from '../models/DeprecatedAuthenticatedPlayerResponse';
 import { DeveloperAccountCreateRequest } from '../models/DeveloperAccountCreateRequest';
 import { DeveloperAccountDeleteResponse } from '../models/DeveloperAccountDeleteResponse';
 import { DeveloperAccountGetMessageResponse } from '../models/DeveloperAccountGetMessageResponse';
@@ -30,10 +33,11 @@ import { DeveloperAccountResponse } from '../models/DeveloperAccountResponse';
 import { DeveloperAccountResponseExpandable } from '../models/DeveloperAccountResponseExpandable';
 import { EstimateTransactionIntentGasResult } from '../models/EstimateTransactionIntentGasResult';
 import { GasReportListResponse } from '../models/GasReportListResponse';
-import { GetSigninUrlResponse } from '../models/GetSigninUrlResponse';
 import { InventoryListResponse } from '../models/InventoryListResponse';
 import { InventoryResponse } from '../models/InventoryResponse';
+import { JwtKeyResponse } from '../models/JwtKeyResponse';
 import { LoginRequest } from '../models/LoginRequest';
+import { LogoutRequest } from '../models/LogoutRequest';
 import { NotificationDeleteResponse } from '../models/NotificationDeleteResponse';
 import { NotificationListResponse } from '../models/NotificationListResponse';
 import { NotificationResponse } from '../models/NotificationResponse';
@@ -46,8 +50,10 @@ import { NotificationTriggerListResponse } from '../models/NotificationTriggerLi
 import { NotificationTriggerResponse } from '../models/NotificationTriggerResponse';
 import { OAuthConfig } from '../models/OAuthConfig';
 import { OAuthConfigListResponse } from '../models/OAuthConfigListResponse';
+import { OAuthInitRequest } from '../models/OAuthInitRequest';
 import { OAuthProvider } from '../models/OAuthProvider';
 import { OAuthRequest } from '../models/OAuthRequest';
+import { OAuthResponse } from '../models/OAuthResponse';
 import { PlayerCancelTransferOwnershipRequest } from '../models/PlayerCancelTransferOwnershipRequest';
 import { PlayerCreateRequest } from '../models/PlayerCreateRequest';
 import { PlayerDeleteResponse } from '../models/PlayerDeleteResponse';
@@ -64,10 +70,11 @@ import { PolicyResponseExpandable } from '../models/PolicyResponseExpandable';
 import { PolicyRuleDeleteResponse } from '../models/PolicyRuleDeleteResponse';
 import { PolicyRuleListResponse } from '../models/PolicyRuleListResponse';
 import { PolicyRuleResponse } from '../models/PolicyRuleResponse';
-import { RegisterPlayerEncryptedKeyRequest } from '../models/RegisterPlayerEncryptedKeyRequest';
-import { RegisterPlayerEncryptedKeyResponse } from '../models/RegisterPlayerEncryptedKeyResponse';
-import { RetrievePlayerEncryptedKeyResponse } from '../models/RetrievePlayerEncryptedKeyResponse';
+import { RefreshTokenRequest } from '../models/RefreshTokenRequest';
 import { RevokeSessionRequest } from '../models/RevokeSessionRequest';
+import { SIWEAuthenticateRequest } from '../models/SIWEAuthenticateRequest';
+import { SIWEInitResponse } from '../models/SIWEInitResponse';
+import { SIWERequest } from '../models/SIWERequest';
 import { SessionListResponse } from '../models/SessionListResponse';
 import { SessionResponse } from '../models/SessionResponse';
 import { SessionResponseExpandable } from '../models/SessionResponseExpandable';
@@ -83,6 +90,7 @@ import { TransactionIntentListResponse } from '../models/TransactionIntentListRe
 import { TransactionIntentResponse } from '../models/TransactionIntentResponse';
 import { TransactionIntentResponseExpandable } from '../models/TransactionIntentResponseExpandable';
 import { TransferOwnershipRequest } from '../models/TransferOwnershipRequest';
+import { UnlinkRequest } from '../models/UnlinkRequest';
 import { UpdateContractRequest } from '../models/UpdateContractRequest';
 import { UpdatePolicyRequest } from '../models/UpdatePolicyRequest';
 import { UpdatePolicyRuleRequest } from '../models/UpdatePolicyRuleRequest';
@@ -116,7 +124,7 @@ export declare class PromiseAccountsApi {
      */
     createAccount(createAccountRequest: CreateAccountRequest, _options?: Configuration): Promise<AccountResponse>;
     /**
-     * This endpoint can be used to deploy an account that was counterfactually generated.
+     * This endpoint can be used to deploy a smart contract account that was counterfactually generated.
      * Deploy an account.
      * @param id Specifies the unique account ID (starts with acc_).
      * @param deployRequest
@@ -130,7 +138,7 @@ export declare class PromiseAccountsApi {
      */
     getAccount(id: string, expand?: Array<AccountResponseExpandable>, _options?: Configuration): Promise<AccountResponse>;
     /**
-     * Returns a list of accounts for the given player.  The accounts are returned sorted by creation date, with the most recently created accounts appearing first.  By default, a maximum of 10 accounts are shown per page.
+     * Returns a list of accounts for the given player.  This object represents a player\'s account, which is a blockchain smart account that can be used to interact with the blockchain.  The accounts are returned sorted by creation date, with the most recently created accounts appearing first.  By default, a maximum of 10 accounts are shown per page.
      * List accounts of a player.
      * @param player Specifies the unique player ID (starts with pla_)
      * @param limit Specifies the maximum number of records to return.
@@ -166,28 +174,158 @@ export declare class PromiseAccountsApi {
      */
     syncAccount(id: string, _options?: Configuration): Promise<AccountResponse>;
 }
+import { AdminAuthenticationApiRequestFactory, AdminAuthenticationApiResponseProcessor } from "../apis/AdminAuthenticationApi";
+export declare class PromiseAdminAuthenticationApi {
+    private api;
+    constructor(configuration: Configuration, requestFactory?: AdminAuthenticationApiRequestFactory, responseProcessor?: AdminAuthenticationApiResponseProcessor);
+    /**
+     * The endpoint creates oauth configuration for the current project environment.
+     * Create oauth configuration.
+     * @param body Specifies the oauth provider specific configuration.
+     */
+    createOAuthConfig(body: OAuthConfig, _options?: Configuration): Promise<OAuthConfig>;
+    /**
+     * Deletes a player auth object.  It will delete all linked accounts the player is authenticated with.
+     * Deletes a player auth object.
+     * @param id Specifies the unique player ID (starts with pla_).
+     */
+    deleteAuthPlayer(id: string, _options?: Configuration): Promise<AuthPlayerResponse>;
+    /**
+     * The endpoint deletes oauth configuration for specified provider for the current project environment.
+     * Delete oauth configuration.
+     * @param provider Specifies the oauth provider type.
+     */
+    deleteOAuthConfig(provider: OAuthProvider, _options?: Configuration): Promise<void>;
+    /**
+     * Retrieves a list of authenticated players.  Players have linked accounts and are authenticated with a provider.
+     * List authenticated players.
+     * @param limit Specifies the maximum number of records to return.
+     * @param skip Specifies the offset for the first records to return.
+     * @param order Specifies the order in which to sort the results.
+     * @param email Specifies the email address of the user.
+     */
+    getAuthPlayers(limit?: number, skip?: number, order?: SortOrder, email?: string, _options?: Configuration): Promise<AuthPlayerListResponse>;
+    /**
+     * The endpoint retrieves oauth configuration for specified provider for the current project environment.
+     * Get oauth configuration.
+     * @param provider Specifies the oauth provider type.
+     */
+    getOAuthConfig(provider: OAuthProvider, _options?: Configuration): Promise<OAuthConfig>;
+    /**
+     * List configured OAuth methods for the current project environment.
+     * List of oauth configurations.
+     */
+    listOAuthConfig(_options?: Configuration): Promise<OAuthConfigListResponse>;
+    /**
+     * Verifies the token generated by Openfort Auth.
+     * Verify auth token.
+     * @param token Specifies the auth token.
+     */
+    verifyAuthToken(token: string, _options?: Configuration): Promise<AuthSessionResponse>;
+    /**
+     * The endpoint verifies the token generated by OAuth provider and retrieves a corresponding player.
+     * Retrieve player by token.
+     * @param provider OAuth provider
+     * @param oAuthRequest
+     */
+    verifyOAuth(provider: OAuthProvider, oAuthRequest: OAuthRequest, _options?: Configuration): Promise<PlayerResponse>;
+    /**
+     * The endpoint verifies the token generated by OAuth provider and retrieves a corresponding player.
+     * Retrieve player by oauth token.
+     * @param authenticateOAuthRequest
+     */
+    verifyOAuthToken(authenticateOAuthRequest: AuthenticateOAuthRequest, _options?: Configuration): Promise<PlayerResponse>;
+}
 import { AuthenticationApiRequestFactory, AuthenticationApiResponseProcessor } from "../apis/AuthenticationApi";
 export declare class PromiseAuthenticationApi {
     private api;
     constructor(configuration: Configuration, requestFactory?: AuthenticationApiRequestFactory, responseProcessor?: AuthenticationApiResponseProcessor);
     /**
-     * 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<AuthResponse>;
+    /**
+     * Authenticate player with SIWE
+     * @param sIWEAuthenticateRequest
+     */
+    authenticateSIWE(sIWEAuthenticateRequest: SIWEAuthenticateRequest, _options?: Configuration): Promise<void | AuthResponse>;
+    /**
+     * 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<DeprecatedAuthenticatedPlayerResponse>;
+    /**
+     * 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<JwtKeyResponse>;
+    /**
+     * Initialize OAuth.
+     * @param oAuthInitRequest
+     */
+    initOAuth(oAuthInitRequest: OAuthInitRequest, _options?: Configuration): Promise<OAuthResponse>;
+    /**
+     * Create a challenge to link external wallet to the player.
+     * Initialize SIWE.
+     * @param sIWERequest
+     */
+    initSIWE(sIWERequest: SIWERequest, _options?: Configuration): Promise<SIWEInitResponse>;
+    /**
+     * Link external wallet.
+     * @param sIWEAuthenticateRequest
+     */
+    linkSIWE(sIWEAuthenticateRequest: SIWEAuthenticateRequest, _options?: Configuration): Promise<AuthPlayerResponse | void>;
+    /**
+     * Authenticate a player based on email and password.
+     * Email and password login.
      * @param loginRequest
      */
-    login(loginRequest: LoginRequest, _options?: Configuration): Promise<AuthResponse>;
+    loginEmailPassword(loginRequest: LoginRequest, _options?: Configuration): Promise<AuthResponse>;
+    /**
+     * When using Openfort Auth, the endpoint logs out the player.
+     * Log out a player.
+     * @param logoutRequest
+     */
+    logout(logoutRequest: LogoutRequest, _options?: Configuration): Promise<void>;
+    /**
+     * 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<AuthResponse>;
     /**
-     * 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<AuthResponse>;
+    signupEmailPassword(signupRequest: SignupRequest, _options?: Configuration): Promise<AuthResponse>;
     /**
-     * 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.
+     * Unlink OAuth account
+     * @param unlinkRequest
      */
-    verifyAuthToken(token: string, _options?: Configuration): Promise<PlayerResponse>;
+    unlinkOAuth(unlinkRequest: UnlinkRequest, _options?: Configuration): Promise<AuthPlayerResponse>;
+    /**
+     * Unlink external wallet.
+     * @param sIWERequest
+     */
+    unlinkSIWE(sIWERequest: SIWERequest, _options?: Configuration): Promise<AuthPlayerResponse | void>;
+    /**
+     * The endpoint verifies the token generated by OAuth provider and retrieves a corresponding player.
+     * Retrieve player by token.
+     * @param provider OAuth provider
+     * @param oAuthRequest
+     */
+    verifyOAuth(provider: OAuthProvider, oAuthRequest: OAuthRequest, _options?: Configuration): Promise<PlayerResponse>;
+    /**
+     * The endpoint verifies the token generated by OAuth provider and retrieves a corresponding player.
+     * Retrieve player by oauth token.
+     * @param authenticateOAuthRequest
+     */
+    verifyOAuthToken(authenticateOAuthRequest: AuthenticateOAuthRequest, _options?: Configuration): Promise<PlayerResponse>;
 }
 import { ContractsApiRequestFactory, ContractsApiResponseProcessor } from "../apis/ContractsApi";
 export declare class PromiseContractsApi {
@@ -238,20 +376,6 @@ export declare class PromiseContractsApi {
      */
     updateContract(id: string, updateContractRequest: UpdateContractRequest, _options?: Configuration): Promise<ContractResponse>;
 }
-import { GoogleAuthenticationApiRequestFactory, GoogleAuthenticationApiResponseProcessor } from "../apis/GoogleAuthenticationApi";
-export declare class PromiseGoogleAuthenticationApi {
-    private api;
-    constructor(configuration: Configuration, requestFactory?: GoogleAuthenticationApiRequestFactory, responseProcessor?: GoogleAuthenticationApiResponseProcessor);
-    /**
-     * Get the google oauth signin url.
-     */
-    getSigninUrl(_options?: Configuration): Promise<GetSigninUrlResponse>;
-    /**
-     * Get the google oauth token.
-     * @param key Specifies the oauth key.
-     */
-    getToken(key: string, _options?: Configuration): Promise<AuthResponse>;
-}
 import { InventoriesApiRequestFactory, InventoriesApiResponseProcessor } from "../apis/InventoriesApi";
 export declare class PromiseInventoriesApi {
     private api;
@@ -411,55 +535,6 @@ export declare class PromiseNotificationsApi {
      */
     getNotifications(limit?: number, skip?: number, order?: SortOrder, expand?: Array<NotificationResponseExpandable>, deleted?: boolean, name?: string, _options?: Configuration): Promise<NotificationListResponse>;
 }
-import { OAuthApiRequestFactory, OAuthApiResponseProcessor } from "../apis/OAuthApi";
-export declare class PromiseOAuthApi {
-    private api;
-    constructor(configuration: Configuration, requestFactory?: OAuthApiRequestFactory, responseProcessor?: OAuthApiResponseProcessor);
-    /**
-     * 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<AuthorizeWithOAuthToken200Response>;
-    /**
-     * The endpoint creates oauth configuration for the current project environment.
-     * Create oauth configuration.
-     * @param body Specifies the oauth provider specific configuration.
-     */
-    createOAuthConfig(body: OAuthConfig, _options?: Configuration): Promise<OAuthConfig>;
-    /**
-     * The endpoint deletes oauth configuration for specified provider for the current project environment.
-     * Delete oauth configuration.
-     * @param provider Specifies the oauth provider type.
-     */
-    deleteOAuthConfig(provider: OAuthProvider, _options?: Configuration): Promise<void>;
-    /**
-     * The endpoint retrieves oauth configuration for specified provider for the current project environment.
-     * Get oauth configuration.
-     * @param provider Specifies the oauth provider type.
-     */
-    getOAuthConfig(provider: OAuthProvider, _options?: Configuration): Promise<OAuthConfig>;
-    /**
-     * Retrieves the player based on his id in the external provider system.
-     * Retrieve player by external id.
-     * @param provider OAuth provider
-     * @param externalUserId External user id
-     */
-    getPlayerByExternalId(provider: OAuthProvider, externalUserId: string, _options?: Configuration): Promise<PlayerResponse>;
-    /**
-     * The endpoint retrieves the list of oauth configurations for the current project environment.
-     * List of oauth configurations.
-     */
-    listOAuthConfig(_options?: Configuration): Promise<OAuthConfigListResponse>;
-    /**
-     * The endpoint verifies the token generated by OAuth provider and retrieves a corresponding player.
-     * Retrieve player by token.
-     * @param provider OAuth provider
-     * @param oAuthRequest
-     */
-    verifyOAuthToken(provider: OAuthProvider, oAuthRequest: OAuthRequest, _options?: Configuration): Promise<PlayerResponse>;
-}
 import { PlayersApiRequestFactory, PlayersApiResponseProcessor } from "../apis/PlayersApi";
 export declare class PromisePlayersApi {
     private api;
@@ -513,28 +588,6 @@ export declare class PromisePlayersApi {
      */
     updatePlayer(id: string, playerUpdateRequest: PlayerUpdateRequest, _options?: Configuration): Promise<PlayerResponse>;
 }
-import { PlayersAuthenticationApiRequestFactory, PlayersAuthenticationApiResponseProcessor } from "../apis/PlayersAuthenticationApi";
-export declare class PromisePlayersAuthenticationApi {
-    private api;
-    constructor(configuration: Configuration, requestFactory?: PlayersAuthenticationApiRequestFactory, responseProcessor?: PlayersAuthenticationApiResponseProcessor);
-    /**
-     * List authenticated players.
-     * @param limit Specifies the maximum number of records to return.
-     * @param skip Specifies the offset for the first records to return.
-     * @param order Specifies the order in which to sort the results.
-     * @param email Specifies the email address of the user.
-     */
-    getAuthenticatedPlayers(limit?: number, skip?: number, order?: SortOrder, email?: string, _options?: Configuration): Promise<AuthPlayerListResponse>;
-    /**
-     * Register a key for the authenticated player.
-     * @param registerPlayerEncryptedKeyRequest
-     */
-    registerKey(registerPlayerEncryptedKeyRequest: RegisterPlayerEncryptedKeyRequest, _options?: Configuration): Promise<RegisterPlayerEncryptedKeyResponse>;
-    /**
-     * Retrieve the key for the authenticated player.
-     */
-    retrieveKey(_options?: Configuration): Promise<RetrievePlayerEncryptedKeyResponse>;
-}
 import { PoliciesApiRequestFactory, PoliciesApiResponseProcessor } from "../apis/PoliciesApi";
 export declare class PromisePoliciesApi {
     private api;