@openfort/openfort-node 0.6.10 → 0.6.12

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

@@ -25,6 +25,11 @@ import { GetSigninUrlResponse } from '../models/GetSigninUrlResponse';
 import { InventoryListResponse } from '../models/InventoryListResponse';
 import { InventoryResponse } from '../models/InventoryResponse';
 import { LoginRequest } from '../models/LoginRequest';
+import { OAuthConfigListResponse } from '../models/OAuthConfigListResponse';
+import { OAuthConfigRequest } from '../models/OAuthConfigRequest';
+import { OAuthConfigResponse } from '../models/OAuthConfigResponse';
+import { OAuthProvider } from '../models/OAuthProvider';
+import { OAuthRequest } from '../models/OAuthRequest';
 import { ObsoleteInventoryResponse } from '../models/ObsoleteInventoryResponse';
 import { PlayerCancelTransferOwnershipRequest } from '../models/PlayerCancelTransferOwnershipRequest';
 import { PlayerListResponse } from '../models/PlayerListResponse';
@@ -92,7 +97,7 @@ export declare class PromiseAccountsApi {
     /**
      * 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 ten accounts are shown per page.
      * List accounts of a player.
-     * @param player Specifies the unique player ID
+     * @param player Specifies the unique player ID (starts with pla_)
      * @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.
@@ -167,13 +172,13 @@ export declare class PromiseContractsApi {
     /**
      * Delete a contract from the project by providing its contract id.
      * Deletes a contract object.
-     * @param id Specifies the unique contract ID.
+     * @param id Specifies the unique contract ID (starts with con_).
      */
     deleteContract(id: string, _options?: Configuration): Promise<ContractDeleteResponse>;
     /**
      * Retrieve a contract by providing their contract id.
      * Get a contract.
-     * @param id Specifies the unique contract ID.
+     * @param id Specifies the unique contract ID (starts with con_).
      */
     getContract(id: string, _options?: Configuration): Promise<ContractResponse>;
     /**
@@ -190,7 +195,7 @@ export declare class PromiseContractsApi {
     getContracts(limit?: number, skip?: number, order?: SortOrder, name?: string, deleted?: boolean, chainId?: number, address?: string, _options?: Configuration): Promise<ContractListResponse>;
     /**
      * Updates a contract object.
-     * @param id Specifies the unique contract ID.
+     * @param id Specifies the unique contract ID (starts with con_).
      * @param updateContractRequest
      */
     updateContract(id: string, updateContractRequest: UpdateContractRequest, _options?: Configuration): Promise<ContractResponse>;
@@ -243,37 +248,80 @@ export declare class PromiseInventoriesApi {
     getAccountNftInventory(id: string, limit?: number, skip?: number, order?: SortOrder, contractId?: Array<string>, _options?: Configuration): Promise<InventoryListResponse>;
     /**
      * Get cryptocurrency list of player.
-     * @param id Specifies the unique player ID.
+     * @param id Specifies the unique player ID (starts with pla_).
      * @param chainId Filter by chain id.
      * @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 contractId Filter by contract ID.
+     * @param contractId Filter by contract ID (starts with con_).
      */
     getPlayerCryptoCurrencyInventory(id: string, chainId: number, limit?: number, skip?: number, order?: SortOrder, contractId?: Array<string>, _options?: Configuration): Promise<InventoryListResponse>;
     /**
      * Get inventory of player.
-     * @param id Specifies the unique player ID.
+     * @param id Specifies the unique player ID (starts with pla_).
      * @param chainId Filter by chain id.
      */
     getPlayerInventory(id: string, chainId: number, _options?: Configuration): Promise<ObsoleteInventoryResponse>;
     /**
      * Get native token list of player.
-     * @param id Specifies the unique player ID.
+     * @param id Specifies the unique player ID (starts with pla_).
      * @param chainId Filter by chain id.
      */
     getPlayerNativeInventory(id: string, chainId: number, _options?: Configuration): Promise<InventoryResponse>;
     /**
      * Get NFTs list of player.
-     * @param id Specifies the unique player ID.
+     * @param id Specifies the unique player ID (starts with pla_).
      * @param chainId Filter by chain id.
      * @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 contractId Filter by contract ID.
+     * @param contractId Filter by contract ID (starts with con_).
      */
     getPlayerNftInventory(id: string, chainId: number, limit?: number, skip?: number, order?: SortOrder, contractId?: Array<string>, _options?: Configuration): Promise<InventoryListResponse>;
 }
+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 user with token.
+     * @param provider OAuth provider
+     * @param oAuthRequest Request body
+     */
+    auth(provider: OAuthProvider, oAuthRequest: OAuthRequest, _options?: Configuration): Promise<AuthResponse>;
+    /**
+     * The endpoint creates oauth configuration for the current project environment.
+     * Create oauth configuration.
+     * @param provider Specifies the oauth provider type.
+     * @param oAuthConfigRequest Specifies the oauth provider specific configuration.
+     */
+    createOAuthConfig(provider: OAuthProvider, oAuthConfigRequest: OAuthConfigRequest, _options?: Configuration): Promise<void>;
+    /**
+     * 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<OAuthConfigResponse>;
+    /**
+     * The endpoint retrieves the list of oauth configurations for the current project environment.
+     * List of oauth configurations.
+     */
+    listOAuthConfig(_options?: Configuration): Promise<OAuthConfigListResponse>;
+    /**
+     * The endpoint updates oauth configuration for specified provider for the current project environment.
+     * Update oauth configuration.
+     * @param provider Specifies the oauth provider type.
+     * @param oAuthConfigRequest Specifies the oauth provider specific configuration.
+     */
+    updateOAuthConfig(provider: OAuthProvider, oAuthConfigRequest: OAuthConfigRequest, _options?: Configuration): Promise<void>;
+}
 import { PlayersApiRequestFactory, PlayersApiResponseProcessor } from "../apis/PlayersApi";
 export declare class PromisePlayersApi {
     private api;
@@ -293,25 +341,25 @@ export declare class PromisePlayersApi {
     createPlayer(createPlayerRequest: CreatePlayerRequest, _options?: Configuration): Promise<PlayerResponse>;
     /**
      * Create account object for a player.
-     * @param id Specifies the unique player ID.
+     * @param id Specifies the unique player ID (starts with pla_).
      * @param createPlayerAccountRequest
      */
     createPlayerAccount(id: string, createPlayerAccountRequest: CreatePlayerAccountRequest, _options?: Configuration): Promise<AccountResponse>;
     /**
      * Create session object for a player.
-     * @param id Specifies the unique player ID.
+     * @param id Specifies the unique player ID (starts with pla_).
      * @param createPlayerSessionRequest
      */
     createPlayerSession(id: string, createPlayerSessionRequest: CreatePlayerSessionRequest, _options?: Configuration): Promise<SessionResponse>;
     /**
      * Retrieves the details of an existing player.
-     * @param id Specifies the unique player ID.
+     * @param id Specifies the unique player ID (starts with pla_).
      * @param expand Specifies the expandable fields.
      */
     getPlayer(id: string, expand?: Array<PlayerResponseExpandable>, _options?: Configuration): Promise<PlayerResponse>;
     /**
      * List of accounts of a player.
-     * @param id Specifies the unique player ID.
+     * @param id Specifies the unique player ID (starts with pla_).
      * @param expand Specifies the expandable fields.
      */
     getPlayerAccounts(id: string, expand?: Array<AccountResponseExpandable>, _options?: Configuration): Promise<AccountListResponse>;
@@ -335,26 +383,26 @@ export declare class PromisePlayersApi {
     /**
      * This endpoint allows you to perform a request to change the owner of an account. To perform an update on the owner of an account, first you must provide a new owner address. Once requested, the owner must accept to take ownership by calling `acceptOwnership()` in the smart contract account.
      * Request transfer ownership of account.
-     * @param id Specifies the unique player ID.
+     * @param id Specifies the unique player ID (starts with pla_).
      * @param playerTransferOwnershipRequest
      */
     obsoleteRequestTransferAccountOwnership(id: string, playerTransferOwnershipRequest: PlayerTransferOwnershipRequest, _options?: Configuration): Promise<TransactionIntentResponse>;
     /**
      * This endpoint allows you to perform a request to change the owner of an account. To perform an update on the owner of an account, first you must provide a new owner address. Once requested, the owner must accept to take ownership by calling `acceptOwnership()` in the smart contract account.
      * Request transfer ownership of account.
-     * @param id Specifies the unique player ID.
+     * @param id Specifies the unique player ID (starts with pla_).
      * @param playerTransferOwnershipRequest
      */
     requestTransferAccountOwnership(id: string, playerTransferOwnershipRequest: PlayerTransferOwnershipRequest, _options?: Configuration): Promise<TransactionIntentResponse>;
     /**
      * Revoke session object for a player.
-     * @param id Specifies the unique player ID.
+     * @param id Specifies the unique player ID (starts with pla_).
      * @param revokeSessionPlayerRequest
      */
     revokePlayerSession(id: string, revokeSessionPlayerRequest: RevokeSessionPlayerRequest, _options?: Configuration): Promise<SessionResponse>;
     /**
      * Updates a player object.
-     * @param id Specifies the unique player ID.
+     * @param id Specifies the unique player ID (starts with pla_).
      * @param playerRequest
      */
     updatePlayer(id: string, playerRequest: PlayerRequest, _options?: Configuration): Promise<PlayerResponse>;
@@ -383,23 +431,23 @@ export declare class PromisePoliciesApi {
     createPolicy(createPolicyRequest: CreatePolicyRequest, _options?: Configuration): Promise<PolicyResponse>;
     /**
      * Create a policy rule object for a policy.
-     * @param id Specifies the unique policy ID.
+     * @param id Specifies the unique policy ID (starts with pol_).
      * @param createPolicyAllowFunctionRequest
      */
     createPolicyAllowFunction(id: string, createPolicyAllowFunctionRequest: CreatePolicyAllowFunctionRequest, _options?: Configuration): Promise<PolicyRuleResponse>;
     /**
      * Delete a policy object.
-     * @param id Specifies the unique policy ID.
+     * @param id Specifies the unique policy ID (starts with pol_).
      */
     deletePolicy(id: string, _options?: Configuration): Promise<PolicyDeleteResponse>;
     /**
      * Disable a policy object.
-     * @param id Specifies the unique policy ID.
+     * @param id Specifies the unique policy ID (starts with pol_).
      */
     disablePolicy(id: string, _options?: Configuration): Promise<PolicyResponse>;
     /**
      * Enable a policy object.
-     * @param id Specifies the unique policy ID.
+     * @param id Specifies the unique policy ID (starts with pol_).
      */
     enablePolicy(id: string, _options?: Configuration): Promise<PolicyResponse>;
     /**
@@ -416,24 +464,24 @@ export declare class PromisePoliciesApi {
     getPolicies(limit?: number, skip?: number, order?: SortOrder, expand?: Array<PolicyResponseExpandable>, name?: string, deleted?: boolean, chainId?: number, enabled?: boolean, _options?: Configuration): Promise<PolicyListResponse>;
     /**
      * Get a policy object.
-     * @param id Specifies the unique policy ID.
+     * @param id Specifies the unique policy ID (starts with pol_).
      * @param expand Specifies the fields to expand.
      */
     getPolicy(id: string, expand?: Array<PolicyResponseExpandable>, _options?: Configuration): Promise<PolicyResponse>;
     /**
      * List policy rules of a policy.
-     * @param id Specifies the unique policy ID.
+     * @param id Specifies the unique policy ID (starts with pol_).
      * @param expand Specifies the fields to expand.
      */
     getPolicyAllowFunctions(id: string, expand?: Array<'contract'>, _options?: Configuration): Promise<PolicyRuleListResponse>;
     /**
      * List all gas reports of a policy.
-     * @param id Specifies the unique policy ID.
+     * @param id Specifies the unique policy ID (starts with pol_).
      */
     getPolicyTotalGasUsage(id: string, _options?: Configuration): Promise<GasReport>;
     /**
      * Update a policy object.
-     * @param id Specifies the unique policy ID.
+     * @param id Specifies the unique policy ID (starts with pol_).
      * @param updatePolicyRequest
      */
     updatePolicy(id: string, updatePolicyRequest: UpdatePolicyRequest, _options?: Configuration): Promise<PolicyResponse>;
@@ -461,7 +509,7 @@ export declare class PromisePolicyRulesApi {
     deletePolicyRules(id: string, _options?: Configuration): Promise<PolicyRuleDeleteResponse>;
     /**
      * List policy rules of a policy.
-     * @param policy Specifies the unique policy ID.
+     * @param policy Specifies the unique policy ID (starts with pol_).
      * @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.
@@ -486,7 +534,7 @@ export declare class PromiseSessionsApi {
     createSession(createSessionRequest: CreateSessionRequest, _options?: Configuration): Promise<SessionResponse>;
     /**
      * List session keys of a player.
-     * @param player The player ID
+     * @param player The player ID (starts with pla_)
      * @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.
@@ -495,7 +543,7 @@ export declare class PromiseSessionsApi {
     getPlayerSessions(player: string, limit?: number, skip?: number, order?: SortOrder, expand?: Array<SessionResponseExpandable>, _options?: Configuration): Promise<SessionListResponse>;
     /**
      * Returns a player session by session id
-     * @param id Specifies the unique session ID.
+     * @param id Specifies the unique session ID (starts with ses_).
      * @param expand Specifies the fields to expand.
      */
     getSession(id: string, expand?: Array<SessionResponseExpandable>, _options?: Configuration): Promise<SessionResponse>;
@@ -506,7 +554,7 @@ export declare class PromiseSessionsApi {
     revokeSession(revokeSessionRequest: RevokeSessionRequest, _options?: Configuration): Promise<SessionResponse>;
     /**
      * Confirms the creation of a session with an external owner.
-     * @param id Specifies the unique session ID.
+     * @param id Specifies the unique session ID (starts with ses_).
      * @param signatureRequest
      */
     signatureSession(id: string, signatureRequest: SignatureRequest, _options?: Configuration): Promise<SessionResponse>;
@@ -522,14 +570,14 @@ export declare class PromiseTransactionIntentsApi {
      */
     createTransactionIntent(createTransactionIntentRequest: CreateTransactionIntentRequest, _options?: Configuration): Promise<TransactionIntentResponse>;
     /**
-     * Estimate the gas cost of creating a transaction intent and putting it onchain.
+     * Estimate the gas cost of creating a transaction intent and putting it on chain. If a policy that includes payment of gas in ERC-20 tokens is provided, an extra field `estimatedTXGasFeeToken` is returned with the estimated amount of tokens.
      * Estimate gas cost of creating a transaction
      * @param createTransactionIntentRequest
      */
     estimateTransactionIntentCost(createTransactionIntentRequest: CreateTransactionIntentRequest, _options?: Configuration): Promise<EstimateTransactionIntentGasResult>;
     /**
      * Get a transaction intent object.
-     * @param id Specifies the unique transaction intent ID.
+     * @param id Specifies the unique transaction intent ID (starts with tin_).
      * @param expand Specifies the expandable fields.
      */
     getTransactionIntent(id: string, expand?: Array<TransactionIntentResponseExpandable>, _options?: Configuration): Promise<TransactionIntentResponse>;
@@ -541,14 +589,14 @@ export declare class PromiseTransactionIntentsApi {
      * @param expand Specifies the fields to expand in the response.
      * @param chainId The chain ID.
      * @param accountId Filter by account ID.
-     * @param playerId Filter by player ID.
-     * @param policyId Filter by policy ID.
+     * @param playerId Filter by player ID (starts with pla_).
+     * @param policyId Filter by policy ID (starts with pol_).
      */
     getTransactionIntents(limit?: number, skip?: number, order?: SortOrder, expand?: Array<TransactionIntentResponseExpandable>, chainId?: number, accountId?: Array<string>, playerId?: Array<string>, policyId?: Array<string>, _options?: Configuration): Promise<TransactionIntentListResponse>;
     /**
-     * This endpoint is used to put a userOperationHash signature on-chain. This means players that have informed (and use) an [externally-owned account (EOA)](https://ethereum.org/en/developers/docs/accounts/) to authorize operations, such as registering a session key, for their gaming accounts.  Given that players with non-custodial accounts are the only ones in possession of the private key, they must sign the information inside the `nextAction` value received from the `POST` API endpoint that creates a transaction_intent, even with their session-keys. Once signed, the client needs to send the signed message using the `/signature` endpoint or use one of the available client-side libraries to do so.
+     * This endpoint is used to send the signed userOperationHash.  For non-custodial smart accounts, each on chain action using their wallet, they must sign the userOperationHash received from the `POST` API endpoint that creates a transactionIntent.
      * Confirms the creation of a transaction intent with an external owner.
-     * @param id Specifies the unique transaction intent ID.
+     * @param id Specifies the unique transaction intent ID (starts with tin_).
      * @param signatureRequest
      */
     signature(id: string, signatureRequest: SignatureRequest, _options?: Configuration): Promise<TransactionIntentResponse>;