@openfort/openfort-node 0.6.32 → 0.6.34

package/dist/generated/types/ObservableAPI.js

@@ -11,9 +11,9 @@ class ObservableAccountsApi {
         this.responseProcessor = responseProcessor || new AccountsApi_1.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, cancelTransferOwnershipRequest, _options) {
@@ -54,7 +54,7 @@ class ObservableAccountsApi {
         }));
     }
     /**
-     * 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
      */
@@ -97,7 +97,7 @@ class ObservableAccountsApi {
         }));
     }
     /**
-     * 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
@@ -119,7 +119,7 @@ class ObservableAccountsApi {
         }));
     }
     /**
-     * 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.
@@ -144,9 +144,9 @@ class ObservableAccountsApi {
         }));
     }
     /**
-     * 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, transferOwnershipRequest, _options) {
@@ -168,7 +168,7 @@ class ObservableAccountsApi {
     /**
      * 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, signPayloadRequest, _options) {
@@ -209,7 +209,7 @@ class ObservableAccountsApi {
         }));
     }
     /**
-     * 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_).
      */
@@ -525,26 +525,6 @@ class ObservableInventoriesApi {
             return middlewarePostObservable.pipe((0, rxjsStub_2.map)((rsp) => this.responseProcessor.getAccountCryptoCurrencyInventory(rsp)));
         }));
     }
-    /**
-     * Get inventory of account.
-     * @param id Specifies the unique account ID (starts with acc_).
-     */
-    getAccountInventory(id, _options) {
-        const requestContextPromise = this.requestFactory.getAccountInventory(id, _options);
-        // build promise chain
-        let middlewarePreObservable = (0, rxjsStub_1.from)(requestContextPromise);
-        for (let middleware of this.configuration.middleware) {
-            middlewarePreObservable = middlewarePreObservable.pipe((0, rxjsStub_2.mergeMap)((ctx) => middleware.pre(ctx)));
-        }
-        return middlewarePreObservable.pipe((0, rxjsStub_2.mergeMap)((ctx) => this.configuration.httpApi.send(ctx))).
-            pipe((0, rxjsStub_2.mergeMap)((response) => {
-            let middlewarePostObservable = (0, rxjsStub_1.of)(response);
-            for (let middleware of this.configuration.middleware) {
-                middlewarePostObservable = middlewarePostObservable.pipe((0, rxjsStub_2.mergeMap)((rsp) => middleware.post(rsp)));
-            }
-            return middlewarePostObservable.pipe((0, rxjsStub_2.map)((rsp) => this.responseProcessor.getAccountInventory(rsp)));
-        }));
-    }
     /**
      * Retrieves the native asset of an existing account.
      * @param id Specifies the unique account ID.
@@ -614,27 +594,6 @@ class ObservableInventoriesApi {
             return middlewarePostObservable.pipe((0, rxjsStub_2.map)((rsp) => this.responseProcessor.getPlayerCryptoCurrencyInventory(rsp)));
         }));
     }
-    /**
-     * Get inventory of player.
-     * @param id Specifies the unique player ID (starts with pla_).
-     * @param chainId Filter by chain id.
-     */
-    getPlayerInventory(id, chainId, _options) {
-        const requestContextPromise = this.requestFactory.getPlayerInventory(id, chainId, _options);
-        // build promise chain
-        let middlewarePreObservable = (0, rxjsStub_1.from)(requestContextPromise);
-        for (let middleware of this.configuration.middleware) {
-            middlewarePreObservable = middlewarePreObservable.pipe((0, rxjsStub_2.mergeMap)((ctx) => middleware.pre(ctx)));
-        }
-        return middlewarePreObservable.pipe((0, rxjsStub_2.mergeMap)((ctx) => this.configuration.httpApi.send(ctx))).
-            pipe((0, rxjsStub_2.mergeMap)((response) => {
-            let middlewarePostObservable = (0, rxjsStub_1.of)(response);
-            for (let middleware of this.configuration.middleware) {
-                middlewarePostObservable = middlewarePostObservable.pipe((0, rxjsStub_2.mergeMap)((rsp) => middleware.post(rsp)));
-            }
-            return middlewarePostObservable.pipe((0, rxjsStub_2.map)((rsp) => this.responseProcessor.getPlayerInventory(rsp)));
-        }));
-    }
     /**
      * Get native token list of player.
      * @param id Specifies the unique player ID (starts with pla_).
@@ -871,7 +830,7 @@ class ObservablePlayersApi {
         }));
     }
     /**
-     * Add a new player to your player list in Openfort.
+     * Creates a Player.
      * Create a player object.
      * @param playerCreateRequest
      */
@@ -891,48 +850,6 @@ class ObservablePlayersApi {
             return middlewarePostObservable.pipe((0, rxjsStub_2.map)((rsp) => this.responseProcessor.createPlayer(rsp)));
         }));
     }
-    /**
-     * Create account object for a player.
-     * @param id Specifies the unique player ID (starts with pla_).
-     * @param createPlayerAccountRequest
-     */
-    createPlayerAccount(id, createPlayerAccountRequest, _options) {
-        const requestContextPromise = this.requestFactory.createPlayerAccount(id, createPlayerAccountRequest, _options);
-        // build promise chain
-        let middlewarePreObservable = (0, rxjsStub_1.from)(requestContextPromise);
-        for (let middleware of this.configuration.middleware) {
-            middlewarePreObservable = middlewarePreObservable.pipe((0, rxjsStub_2.mergeMap)((ctx) => middleware.pre(ctx)));
-        }
-        return middlewarePreObservable.pipe((0, rxjsStub_2.mergeMap)((ctx) => this.configuration.httpApi.send(ctx))).
-            pipe((0, rxjsStub_2.mergeMap)((response) => {
-            let middlewarePostObservable = (0, rxjsStub_1.of)(response);
-            for (let middleware of this.configuration.middleware) {
-                middlewarePostObservable = middlewarePostObservable.pipe((0, rxjsStub_2.mergeMap)((rsp) => middleware.post(rsp)));
-            }
-            return middlewarePostObservable.pipe((0, rxjsStub_2.map)((rsp) => this.responseProcessor.createPlayerAccount(rsp)));
-        }));
-    }
-    /**
-     * Create session object for a player.
-     * @param id Specifies the unique player ID (starts with pla_).
-     * @param createPlayerSessionRequest
-     */
-    createPlayerSession(id, createPlayerSessionRequest, _options) {
-        const requestContextPromise = this.requestFactory.createPlayerSession(id, createPlayerSessionRequest, _options);
-        // build promise chain
-        let middlewarePreObservable = (0, rxjsStub_1.from)(requestContextPromise);
-        for (let middleware of this.configuration.middleware) {
-            middlewarePreObservable = middlewarePreObservable.pipe((0, rxjsStub_2.mergeMap)((ctx) => middleware.pre(ctx)));
-        }
-        return middlewarePreObservable.pipe((0, rxjsStub_2.mergeMap)((ctx) => this.configuration.httpApi.send(ctx))).
-            pipe((0, rxjsStub_2.mergeMap)((response) => {
-            let middlewarePostObservable = (0, rxjsStub_1.of)(response);
-            for (let middleware of this.configuration.middleware) {
-                middlewarePostObservable = middlewarePostObservable.pipe((0, rxjsStub_2.mergeMap)((rsp) => middleware.post(rsp)));
-            }
-            return middlewarePostObservable.pipe((0, rxjsStub_2.map)((rsp) => this.responseProcessor.createPlayerSession(rsp)));
-        }));
-    }
     /**
      * Deletes a player object.
      * @param id Specifies the unique player ID (starts with pla_).
@@ -974,27 +891,6 @@ class ObservablePlayersApi {
             return middlewarePostObservable.pipe((0, rxjsStub_2.map)((rsp) => this.responseProcessor.getPlayer(rsp)));
         }));
     }
-    /**
-     * List of accounts of a player.
-     * @param id Specifies the unique player ID (starts with pla_).
-     * @param expand Specifies the expandable fields.
-     */
-    getPlayerAccounts(id, expand, _options) {
-        const requestContextPromise = this.requestFactory.getPlayerAccounts(id, expand, _options);
-        // build promise chain
-        let middlewarePreObservable = (0, rxjsStub_1.from)(requestContextPromise);
-        for (let middleware of this.configuration.middleware) {
-            middlewarePreObservable = middlewarePreObservable.pipe((0, rxjsStub_2.mergeMap)((ctx) => middleware.pre(ctx)));
-        }
-        return middlewarePreObservable.pipe((0, rxjsStub_2.mergeMap)((ctx) => this.configuration.httpApi.send(ctx))).
-            pipe((0, rxjsStub_2.mergeMap)((response) => {
-            let middlewarePostObservable = (0, rxjsStub_1.of)(response);
-            for (let middleware of this.configuration.middleware) {
-                middlewarePostObservable = middlewarePostObservable.pipe((0, rxjsStub_2.mergeMap)((rsp) => middleware.post(rsp)));
-            }
-            return middlewarePostObservable.pipe((0, rxjsStub_2.map)((rsp) => this.responseProcessor.getPlayerAccounts(rsp)));
-        }));
-    }
     /**
      * By default, a maximum of ten players are shown.
      * List players.
@@ -1043,27 +939,7 @@ class ObservablePlayersApi {
         }));
     }
     /**
-     * Revoke session object for a player.
-     * @param id Specifies the unique player ID (starts with pla_).
-     * @param revokeSessionPlayerRequest
-     */
-    revokePlayerSession(id, revokeSessionPlayerRequest, _options) {
-        const requestContextPromise = this.requestFactory.revokePlayerSession(id, revokeSessionPlayerRequest, _options);
-        // build promise chain
-        let middlewarePreObservable = (0, rxjsStub_1.from)(requestContextPromise);
-        for (let middleware of this.configuration.middleware) {
-            middlewarePreObservable = middlewarePreObservable.pipe((0, rxjsStub_2.mergeMap)((ctx) => middleware.pre(ctx)));
-        }
-        return middlewarePreObservable.pipe((0, rxjsStub_2.mergeMap)((ctx) => this.configuration.httpApi.send(ctx))).
-            pipe((0, rxjsStub_2.mergeMap)((response) => {
-            let middlewarePostObservable = (0, rxjsStub_1.of)(response);
-            for (let middleware of this.configuration.middleware) {
-                middlewarePostObservable = middlewarePostObservable.pipe((0, rxjsStub_2.mergeMap)((rsp) => middleware.post(rsp)));
-            }
-            return middlewarePostObservable.pipe((0, rxjsStub_2.map)((rsp) => this.responseProcessor.revokePlayerSession(rsp)));
-        }));
-    }
-    /**
+     * 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
@@ -1184,27 +1060,6 @@ class ObservablePoliciesApi {
             return middlewarePostObservable.pipe((0, rxjsStub_2.map)((rsp) => this.responseProcessor.createPolicy(rsp)));
         }));
     }
-    /**
-     * Create a policy rule object for a policy.
-     * @param id Specifies the unique policy ID (starts with pol_).
-     * @param createPolicyAllowFunctionRequest
-     */
-    createPolicyAllowFunction(id, createPolicyAllowFunctionRequest, _options) {
-        const requestContextPromise = this.requestFactory.createPolicyAllowFunction(id, createPolicyAllowFunctionRequest, _options);
-        // build promise chain
-        let middlewarePreObservable = (0, rxjsStub_1.from)(requestContextPromise);
-        for (let middleware of this.configuration.middleware) {
-            middlewarePreObservable = middlewarePreObservable.pipe((0, rxjsStub_2.mergeMap)((ctx) => middleware.pre(ctx)));
-        }
-        return middlewarePreObservable.pipe((0, rxjsStub_2.mergeMap)((ctx) => this.configuration.httpApi.send(ctx))).
-            pipe((0, rxjsStub_2.mergeMap)((response) => {
-            let middlewarePostObservable = (0, rxjsStub_1.of)(response);
-            for (let middleware of this.configuration.middleware) {
-                middlewarePostObservable = middlewarePostObservable.pipe((0, rxjsStub_2.mergeMap)((rsp) => middleware.post(rsp)));
-            }
-            return middlewarePostObservable.pipe((0, rxjsStub_2.map)((rsp) => this.responseProcessor.createPolicyAllowFunction(rsp)));
-        }));
-    }
     /**
      * Delete a policy object.
      * @param id Specifies the unique policy ID (starts with pol_).
@@ -1266,6 +1121,7 @@ class ObservablePoliciesApi {
         }));
     }
     /**
+     * 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.
@@ -1293,6 +1149,7 @@ class ObservablePoliciesApi {
         }));
     }
     /**
+     * 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.
@@ -1313,27 +1170,6 @@ class ObservablePoliciesApi {
             return middlewarePostObservable.pipe((0, rxjsStub_2.map)((rsp) => this.responseProcessor.getPolicy(rsp)));
         }));
     }
-    /**
-     * 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, expand, _options) {
-        const requestContextPromise = this.requestFactory.getPolicyAllowFunctions(id, expand, _options);
-        // build promise chain
-        let middlewarePreObservable = (0, rxjsStub_1.from)(requestContextPromise);
-        for (let middleware of this.configuration.middleware) {
-            middlewarePreObservable = middlewarePreObservable.pipe((0, rxjsStub_2.mergeMap)((ctx) => middleware.pre(ctx)));
-        }
-        return middlewarePreObservable.pipe((0, rxjsStub_2.mergeMap)((ctx) => this.configuration.httpApi.send(ctx))).
-            pipe((0, rxjsStub_2.mergeMap)((response) => {
-            let middlewarePostObservable = (0, rxjsStub_1.of)(response);
-            for (let middleware of this.configuration.middleware) {
-                middlewarePostObservable = middlewarePostObservable.pipe((0, rxjsStub_2.mergeMap)((rsp) => middleware.post(rsp)));
-            }
-            return middlewarePostObservable.pipe((0, rxjsStub_2.map)((rsp) => this.responseProcessor.getPolicyAllowFunctions(rsp)));
-        }));
-    }
     /**
      * List all gas reports of a policy.
      * @param id Specifies the unique policy ID (starts with pol_).
@@ -1375,28 +1211,6 @@ class ObservablePoliciesApi {
             return middlewarePostObservable.pipe((0, rxjsStub_2.map)((rsp) => this.responseProcessor.updatePolicy(rsp)));
         }));
     }
-    /**
-     * 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, policyRule, updatePolicyRuleRequest, _options) {
-        const requestContextPromise = this.requestFactory.updatePolicyAllowFunction(policy, policyRule, updatePolicyRuleRequest, _options);
-        // build promise chain
-        let middlewarePreObservable = (0, rxjsStub_1.from)(requestContextPromise);
-        for (let middleware of this.configuration.middleware) {
-            middlewarePreObservable = middlewarePreObservable.pipe((0, rxjsStub_2.mergeMap)((ctx) => middleware.pre(ctx)));
-        }
-        return middlewarePreObservable.pipe((0, rxjsStub_2.mergeMap)((ctx) => this.configuration.httpApi.send(ctx))).
-            pipe((0, rxjsStub_2.mergeMap)((response) => {
-            let middlewarePostObservable = (0, rxjsStub_1.of)(response);
-            for (let middleware of this.configuration.middleware) {
-                middlewarePostObservable = middlewarePostObservable.pipe((0, rxjsStub_2.mergeMap)((rsp) => middleware.post(rsp)));
-            }
-            return middlewarePostObservable.pipe((0, rxjsStub_2.map)((rsp) => this.responseProcessor.updatePolicyAllowFunction(rsp)));
-        }));
-    }
 }
 exports.ObservablePoliciesApi = ObservablePoliciesApi;
 const PolicyRulesApi_1 = require("../apis/PolicyRulesApi");
@@ -1501,6 +1315,7 @@ class ObservableSessionsApi {
         this.responseProcessor = responseProcessor || new SessionsApi_1.SessionsApiResponseProcessor();
     }
     /**
+     * Creates a Session.
      * Create a session key.
      * @param createSessionRequest
      */
@@ -1521,6 +1336,7 @@ class ObservableSessionsApi {
         }));
     }
     /**
+     * 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.
@@ -1545,6 +1361,7 @@ class ObservableSessionsApi {
         }));
     }
     /**
+     * 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.
@@ -1586,7 +1403,7 @@ class ObservableSessionsApi {
         }));
     }
     /**
-     * Send signed userOpHash to create session.
+     * Send signed userOperationHash to create session.
      * @param id Specifies the unique session ID (starts with ses_).
      * @param signatureRequest
      */
@@ -1749,7 +1566,7 @@ class ObservableTransactionIntentsApi {
         this.responseProcessor = responseProcessor || new TransactionIntentsApi_1.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
      */
@@ -1770,7 +1587,7 @@ class ObservableTransactionIntentsApi {
         }));
     }
     /**
-     * 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
      */
@@ -1791,6 +1608,7 @@ class ObservableTransactionIntentsApi {
         }));
     }
     /**
+     * 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.
@@ -1812,12 +1630,13 @@ class ObservableTransactionIntentsApi {
         }));
     }
     /**
+     * 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 chainId The chain ID. Must be a [supported chain](/chains).
      * @param accountId Filter by account ID.
      * @param playerId Filter by player ID (starts with pla_).
      * @param policyId Filter by policy ID (starts with pol_).
@@ -1839,7 +1658,7 @@ class ObservableTransactionIntentsApi {
         }));
     }
     /**
-     * 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