@openfort/openfort-node 0.6.33 → 0.6.35

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

@@ -13,9 +13,6 @@ import { ContractReadResponse } from '../models/ContractReadResponse';
 import { ContractResponse } from '../models/ContractResponse';
 import { CreateAccountRequest } from '../models/CreateAccountRequest';
 import { CreateContractRequest } from '../models/CreateContractRequest';
-import { CreatePlayerAccountRequest } from '../models/CreatePlayerAccountRequest';
-import { CreatePlayerSessionRequest } from '../models/CreatePlayerSessionRequest';
-import { CreatePolicyAllowFunctionRequest } from '../models/CreatePolicyAllowFunctionRequest';
 import { CreatePolicyRequest } from '../models/CreatePolicyRequest';
 import { CreatePolicyRuleRequest } from '../models/CreatePolicyRuleRequest';
 import { CreateSessionRequest } from '../models/CreateSessionRequest';
@@ -27,6 +24,7 @@ import { DeveloperAccountDeleteResponse } from '../models/DeveloperAccountDelete
 import { DeveloperAccountGetMessageResponse } from '../models/DeveloperAccountGetMessageResponse';
 import { DeveloperAccountListResponse } from '../models/DeveloperAccountListResponse';
 import { DeveloperAccountResponse } from '../models/DeveloperAccountResponse';
+import { DeveloperAccountResponseExpandable } from '../models/DeveloperAccountResponseExpandable';
 import { EstimateTransactionIntentGasResult } from '../models/EstimateTransactionIntentGasResult';
 import { GasReport } from '../models/GasReport';
 import { GetSigninUrlResponse } from '../models/GetSigninUrlResponse';
@@ -37,7 +35,6 @@ import { OAuthConfig } from '../models/OAuthConfig';
 import { OAuthConfigListResponse } from '../models/OAuthConfigListResponse';
 import { OAuthProvider } from '../models/OAuthProvider';
 import { OAuthRequest } from '../models/OAuthRequest';
-import { ObsoleteInventoryResponse } from '../models/ObsoleteInventoryResponse';
 import { PlayerCancelTransferOwnershipRequest } from '../models/PlayerCancelTransferOwnershipRequest';
 import { PlayerCreateRequest } from '../models/PlayerCreateRequest';
 import { PlayerDeleteResponse } from '../models/PlayerDeleteResponse';
@@ -56,7 +53,6 @@ import { PolicyRuleResponse } from '../models/PolicyRuleResponse';
 import { RegisterPlayerEncryptedKeyRequest } from '../models/RegisterPlayerEncryptedKeyRequest';
 import { RegisterPlayerEncryptedKeyResponse } from '../models/RegisterPlayerEncryptedKeyResponse';
 import { RetrievePlayerEncryptedKeyResponse } from '../models/RetrievePlayerEncryptedKeyResponse';
-import { RevokeSessionPlayerRequest } from '../models/RevokeSessionPlayerRequest';
 import { RevokeSessionRequest } from '../models/RevokeSessionRequest';
 import { SessionListResponse } from '../models/SessionListResponse';
 import { SessionResponse } from '../models/SessionResponse';
@@ -86,9 +82,9 @@ export declare class PromiseAccountsApi {
     private api;
     constructor(configuration: Configuration, requestFactory?: AccountsApiRequestFactory, responseProcessor?: AccountsApiResponseProcessor);
     /**
-     * This endpoint allows you to cancel a pending transfer of ownership.
+     * Cancel a pending transfer of ownership.
      * Cancel request to transfer ownership of an account.
-     * @param id Specifies the unique account ID.
+     * @param id Specifies the unique account ID (starts with acc_).
      * @param cancelTransferOwnershipRequest
      */
     cancelTransferOwnership(id: string, cancelTransferOwnershipRequest: CancelTransferOwnershipRequest, _options?: Configuration): Promise<TransactionIntentResponse>;
@@ -99,7 +95,7 @@ export declare class PromiseAccountsApi {
      */
     completeRecovery(id: string, completeRecoveryRequest: CompleteRecoveryRequest, _options?: Configuration): Promise<TransactionIntentResponse>;
     /**
-     * This endpoint allows you to add a new account to your Openfort player. Only one account can be active per chain per player.
+     * Creates a new blockchain account for the provided player.  Account creation does not consume any gas. All accounts of a player will use the same address across blockchains.  Only one account can per chain per player.
      * Create an account object.
      * @param createAccountRequest
      */
@@ -112,14 +108,14 @@ export declare class PromiseAccountsApi {
      */
     deployAccount(id: string, deployRequest: DeployRequest, _options?: Configuration): Promise<AccountResponse>;
     /**
-     * Retrieves the details of an existing account. Supply the unique account ID from either a account creation request or the account list, and Openfort will return the corresponding account information.
+     * Retrieves the details of an existing account.  Supply the unique account ID from either a account creation request or the account list, and Openfort will return the corresponding account information.
      * Get existing account.
      * @param id Specifies the unique account ID (starts with acc_).
      * @param expand
      */
     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 ten accounts are shown per page.
+     * 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.
      * 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.
@@ -129,16 +125,16 @@ export declare class PromiseAccountsApi {
      */
     getAccounts(player: string, limit?: number, skip?: number, order?: SortOrder, expand?: Array<AccountResponseExpandable>, _options?: Configuration): Promise<AccountListResponse>;
     /**
-     * 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.
+     * 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 account ID.
+     * @param id Specifies the unique account ID (starts with acc_).
      * @param transferOwnershipRequest
      */
     requestTransferOwnership(id: string, transferOwnershipRequest: TransferOwnershipRequest, _options?: Configuration): Promise<TransactionIntentResponse>;
     /**
      * Signs the typed data value with types data structure for domain using the [EIP-712](https://eips.ethereum.org/EIPS/eip-712) specification.
      * Sign a given payload
-     * @param id Specifies the unique account ID.
+     * @param id Specifies the unique account ID (starts with acc_).
      * @param signPayloadRequest
      */
     signPayload(id: string, signPayloadRequest: SignPayloadRequest, _options?: Configuration): Promise<SignPayloadResponse>;
@@ -149,7 +145,7 @@ export declare class PromiseAccountsApi {
      */
     startRecovery(id: string, startRecoveryRequest: StartRecoveryRequest, _options?: Configuration): Promise<TransactionIntentResponse>;
     /**
-     * This endpoint updates the account state with the blockchain. Specifically, it updates the account owner and whether its deployed or not.
+     * Synchronize the account state with the blockchain. Specifically, it updates the account owner and whether its deployed or not.
      * Sync account state with the blockchain
      * @param id Specifies the unique account ID (starts with acc_).
      */
@@ -254,11 +250,6 @@ export declare class PromiseInventoriesApi {
      * @param contractId
      */
     getAccountCryptoCurrencyInventory(id: string, limit?: number, skip?: number, order?: SortOrder, contractId?: Array<string>, _options?: Configuration): Promise<InventoryListResponse>;
-    /**
-     * Get inventory of account.
-     * @param id Specifies the unique account ID (starts with acc_).
-     */
-    getAccountInventory(id: string, _options?: Configuration): Promise<ObsoleteInventoryResponse>;
     /**
      * Retrieves the native asset of an existing account.
      * @param id Specifies the unique account ID.
@@ -280,15 +271,9 @@ export declare class PromiseInventoriesApi {
      * @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 (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 (starts with pla_).
-     * @param chainId Filter by chain id.
+     * @param contract Filter by contract ID (starts with con_).
      */
-    getPlayerInventory(id: string, chainId: number, _options?: Configuration): Promise<ObsoleteInventoryResponse>;
+    getPlayerCryptoCurrencyInventory(id: string, chainId: number, limit?: number, skip?: number, order?: SortOrder, contract?: Array<string>, _options?: Configuration): Promise<InventoryListResponse>;
     /**
      * Get native token list of player.
      * @param id Specifies the unique player ID (starts with pla_).
@@ -302,9 +287,9 @@ export declare class PromiseInventoriesApi {
      * @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 (starts with con_).
+     * @param contract 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>;
+    getPlayerNftInventory(id: string, chainId: number, limit?: number, skip?: number, order?: SortOrder, contract?: Array<string>, _options?: Configuration): Promise<InventoryListResponse>;
 }
 import { OAuthApiRequestFactory, OAuthApiResponseProcessor } from "../apis/OAuthApi";
 export declare class PromiseOAuthApi {
@@ -367,23 +352,11 @@ export declare class PromisePlayersApi {
      */
     cancelTransferAccountOwnership(id: string, playerCancelTransferOwnershipRequest: PlayerCancelTransferOwnershipRequest, _options?: Configuration): Promise<TransactionIntentResponse>;
     /**
-     * Add a new player to your player list in Openfort.
+     * Creates a Player.
      * Create a player object.
      * @param playerCreateRequest
      */
     createPlayer(playerCreateRequest: PlayerCreateRequest, _options?: Configuration): Promise<PlayerResponse>;
-    /**
-     * Create account object for a player.
-     * @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 (starts with pla_).
-     * @param createPlayerSessionRequest
-     */
-    createPlayerSession(id: string, createPlayerSessionRequest: CreatePlayerSessionRequest, _options?: Configuration): Promise<SessionResponse>;
     /**
      * Deletes a player object.
      * @param id Specifies the unique player ID (starts with pla_).
@@ -395,12 +368,6 @@ export declare class PromisePlayersApi {
      * @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 (starts with pla_).
-     * @param expand Specifies the expandable fields.
-     */
-    getPlayerAccounts(id: string, expand?: Array<AccountResponseExpandable>, _options?: Configuration): Promise<AccountListResponse>;
     /**
      * By default, a maximum of ten players are shown.
      * List players.
@@ -419,12 +386,7 @@ export declare class PromisePlayersApi {
      */
     requestTransferAccountOwnership(id: string, playerTransferOwnershipRequest: PlayerTransferOwnershipRequest, _options?: Configuration): Promise<TransactionIntentResponse>;
     /**
-     * Revoke session object for a player.
-     * @param id Specifies the unique player ID (starts with pla_).
-     * @param revokeSessionPlayerRequest
-     */
-    revokePlayerSession(id: string, revokeSessionPlayerRequest: RevokeSessionPlayerRequest, _options?: Configuration): Promise<SessionResponse>;
-    /**
+     * Updates the specified Player by setting the values of the parameters passed.
      * Updates a player object.
      * @param id Specifies the unique player ID (starts with pla_).
      * @param playerUpdateRequest
@@ -462,12 +424,6 @@ export declare class PromisePoliciesApi {
      * @param createPolicyRequest
      */
     createPolicy(createPolicyRequest: CreatePolicyRequest, _options?: Configuration): Promise<PolicyResponse>;
-    /**
-     * Create a policy rule object for a policy.
-     * @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 (starts with pol_).
@@ -484,6 +440,7 @@ export declare class PromisePoliciesApi {
      */
     enablePolicy(id: string, _options?: Configuration): Promise<PolicyResponse>;
     /**
+     * Returns a list of Policies.
      * List policies.
      * @param limit Specifies the maximum number of records to return.
      * @param skip Specifies the offset for the first records to return.
@@ -496,17 +453,12 @@ 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>;
     /**
+     * Retrieves the details of a Policy that has previously been created.
      * Get a policy object.
      * @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 (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 (starts with pol_).
@@ -518,13 +470,6 @@ export declare class PromisePoliciesApi {
      * @param updatePolicyRequest
      */
     updatePolicy(id: string, updatePolicyRequest: UpdatePolicyRequest, _options?: Configuration): Promise<PolicyResponse>;
-    /**
-     * Update a policy rule object of a policy.
-     * @param policy Specifies the unique policy ID (starts with pol_).
-     * @param policyRule Specifies the unique policy rule ID (starts with afu_).
-     * @param updatePolicyRuleRequest
-     */
-    updatePolicyAllowFunction(policy: string, policyRule: string, updatePolicyRuleRequest: UpdatePolicyRuleRequest, _options?: Configuration): Promise<PolicyRuleResponse>;
 }
 import { PolicyRulesApiRequestFactory, PolicyRulesApiResponseProcessor } from "../apis/PolicyRulesApi";
 export declare class PromisePolicyRulesApi {
@@ -561,11 +506,13 @@ export declare class PromiseSessionsApi {
     private api;
     constructor(configuration: Configuration, requestFactory?: SessionsApiRequestFactory, responseProcessor?: SessionsApiResponseProcessor);
     /**
+     * Creates a Session.
      * Create a session key.
      * @param createSessionRequest
      */
     createSession(createSessionRequest: CreateSessionRequest, _options?: Configuration): Promise<SessionResponse>;
     /**
+     * Returns a list of Sessions.
      * List session keys of a player.
      * @param player The player ID (starts with pla_)
      * @param limit Specifies the maximum number of records to return.
@@ -575,6 +522,7 @@ export declare class PromiseSessionsApi {
      */
     getPlayerSessions(player: string, limit?: number, skip?: number, order?: SortOrder, expand?: Array<SessionResponseExpandable>, _options?: Configuration): Promise<SessionListResponse>;
     /**
+     * Retrieves the details of a Session that has previously been created.
      * Returns a player session by session id
      * @param id Specifies the unique session ID (starts with ses_).
      * @param expand Specifies the fields to expand.
@@ -586,7 +534,7 @@ export declare class PromiseSessionsApi {
      */
     revokeSession(revokeSessionRequest: RevokeSessionRequest, _options?: Configuration): Promise<SessionResponse>;
     /**
-     * Send signed userOpHash to create session.
+     * Send signed userOperationHash to create session.
      * @param id Specifies the unique session ID (starts with ses_).
      * @param signatureRequest
      */
@@ -610,9 +558,20 @@ export declare class PromiseSettingsApi {
     deleteDeveloperAccount(id: string, _options?: Configuration): Promise<DeveloperAccountDeleteResponse>;
     /**
      * Retrieve the list of the developer accounts for the current project.
+     * Get existing developer account.
+     * @param id
+     * @param expand
+     */
+    getDeveloperAccount(id: string, expand?: Array<DeveloperAccountResponseExpandable>, _options?: Configuration): Promise<DeveloperAccountResponse>;
+    /**
+     * Retrieve the list of the developer accounts for the current project.  By default, a maximum of 10 accounts are shown per page.
      * List of developer accounts.
+     * @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 expand Specifies the fields to expand in the response.
      */
-    getDeveloperAccounts(_options?: Configuration): Promise<DeveloperAccountListResponse>;
+    getDeveloperAccounts(limit?: number, skip?: number, order?: SortOrder, expand?: Array<DeveloperAccountResponseExpandable>, _options?: Configuration): Promise<DeveloperAccountListResponse>;
     /**
      * Generate message, which should be signed by the account your want to add as a developer account.
      * Generate message to sign
@@ -636,37 +595,39 @@ export declare class PromiseTransactionIntentsApi {
     private api;
     constructor(configuration: Configuration, requestFactory?: TransactionIntentsApiRequestFactory, responseProcessor?: TransactionIntentsApiResponseProcessor);
     /**
-     * Retrieve a transaction intent by providing their id on Openfort. Transaction intents that have not been processed yet, have the `response` attribute as undefined.
+     * Creates a TransactionIntent.  A pending TransactionIntent has the `response` attribute as undefined.  After the TransactionIntent is created and broadcasted to the blockchain, `response` will be populated with the transaction hash and a status (1 success, 0 fail).  When using a non-custodial account, a `nextAction` attribute is returned with the `userOperationHash` that must be signed by the owner of the account.
      * Create a transaction intent object.
      * @param createTransactionIntentRequest
      */
     createTransactionIntent(createTransactionIntentRequest: CreateTransactionIntentRequest, _options?: Configuration): Promise<TransactionIntentResponse>;
     /**
-     * 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 the gas cost of broadcasting a TransactionIntent.  This is a simulation, it does not send the transaction on-chain.  If a Policy ID is used that includes payment of gas in ERC-20 tokens, an extra field `estimatedTXGasFeeToken` is returned with the estimated amount of tokens that will be used.
      * Estimate gas cost of creating a transaction
      * @param createTransactionIntentRequest
      */
     estimateTransactionIntentCost(createTransactionIntentRequest: CreateTransactionIntentRequest, _options?: Configuration): Promise<EstimateTransactionIntentGasResult>;
     /**
+     * Retrieves the details of a TransactionIntent that has previously been created.
      * Get a transaction intent object.
      * @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>;
     /**
+     * Returns a list of TransactionIntents.
      * List transaction intents.
      * @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 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 (starts with pla_).
-     * @param policyId Filter by policy ID (starts with pol_).
+     * @param chainId The chain ID. Must be a [supported chain](/chains).
+     * @param account Filter by account ID or developer account (starts with acc_ or dac_ respectively).
+     * @param player Filter by player ID (starts with pla_).
+     * @param policy 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>;
+    getTransactionIntents(limit?: number, skip?: number, order?: SortOrder, expand?: Array<TransactionIntentResponseExpandable>, chainId?: number, account?: Array<string>, player?: Array<string>, policy?: Array<string>, _options?: Configuration): Promise<TransactionIntentListResponse>;
     /**
-     * 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.
+     * Broadcasts a signed TransactionIntent to the blockchain.  Use this endpoint to send the signed `userOperationHash`. Openfort will then put it on-chain.
      * Send a signed transaction userOperationHash.
      * @param id Specifies the unique transaction intent ID (starts with tin_).
      * @param signatureRequest