@openfort/openfort-node 0.6.32 → 0.6.34

package/dist/generated/types/ObjectParamAPI.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';
@@ -37,7 +34,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 +52,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';
@@ -84,7 +79,7 @@ import { Web3ConnectionResponseExpandable } from '../models/Web3ConnectionRespon
 import { AccountsApiRequestFactory, AccountsApiResponseProcessor } from "../apis/AccountsApi";
 export interface AccountsApiCancelTransferOwnershipRequest {
     /**
-     * Specifies the unique account ID.
+     * Specifies the unique account ID (starts with acc_).
      * @type string
      * @memberof AccountsApicancelTransferOwnership
      */
@@ -180,7 +175,7 @@ export interface AccountsApiGetAccountsRequest {
 }
 export interface AccountsApiRequestTransferOwnershipRequest {
     /**
-     * Specifies the unique account ID.
+     * Specifies the unique account ID (starts with acc_).
      * @type string
      * @memberof AccountsApirequestTransferOwnership
      */
@@ -194,7 +189,7 @@ export interface AccountsApiRequestTransferOwnershipRequest {
 }
 export interface AccountsApiSignPayloadRequest {
     /**
-     * Specifies the unique account ID.
+     * Specifies the unique account ID (starts with acc_).
      * @type string
      * @memberof AccountsApisignPayload
      */
@@ -232,7 +227,7 @@ export declare class ObjectAccountsApi {
     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 param the request object
      */
@@ -243,7 +238,7 @@ export declare class ObjectAccountsApi {
      */
     completeRecovery(param: AccountsApiCompleteRecoveryRequest, 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 param the request object
      */
@@ -255,19 +250,19 @@ export declare class ObjectAccountsApi {
      */
     deployAccount(param: AccountsApiDeployAccountRequest, 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 param the request object
      */
     getAccount(param: AccountsApiGetAccountRequest, 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 param the request object
      */
     getAccounts(param: AccountsApiGetAccountsRequest, 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 param the request object
      */
@@ -284,7 +279,7 @@ export declare class ObjectAccountsApi {
      */
     startRecovery(param: AccountsApiStartRecoveryRequest, 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 param the request object
      */
@@ -537,14 +532,6 @@ export interface InventoriesApiGetAccountCryptoCurrencyInventoryRequest {
      */
     contractId?: Array<string>;
 }
-export interface InventoriesApiGetAccountInventoryRequest {
-    /**
-     * Specifies the unique account ID (starts with acc_).
-     * @type string
-     * @memberof InventoriesApigetAccountInventory
-     */
-    id: string;
-}
 export interface InventoriesApiGetAccountNativeInventoryRequest {
     /**
      * Specifies the unique account ID.
@@ -623,20 +610,6 @@ export interface InventoriesApiGetPlayerCryptoCurrencyInventoryRequest {
      */
     contractId?: Array<string>;
 }
-export interface InventoriesApiGetPlayerInventoryRequest {
-    /**
-     * Specifies the unique player ID (starts with pla_).
-     * @type string
-     * @memberof InventoriesApigetPlayerInventory
-     */
-    id: string;
-    /**
-     * Filter by chain id.
-     * @type number
-     * @memberof InventoriesApigetPlayerInventory
-     */
-    chainId: number;
-}
 export interface InventoriesApiGetPlayerNativeInventoryRequest {
     /**
      * Specifies the unique player ID (starts with pla_).
@@ -697,11 +670,6 @@ export declare class ObjectInventoriesApi {
      * @param param the request object
      */
     getAccountCryptoCurrencyInventory(param: InventoriesApiGetAccountCryptoCurrencyInventoryRequest, options?: Configuration): Promise<InventoryListResponse>;
-    /**
-     * Get inventory of account.
-     * @param param the request object
-     */
-    getAccountInventory(param: InventoriesApiGetAccountInventoryRequest, options?: Configuration): Promise<ObsoleteInventoryResponse>;
     /**
      * Retrieves the native asset of an existing account.
      * @param param the request object
@@ -717,11 +685,6 @@ export declare class ObjectInventoriesApi {
      * @param param the request object
      */
     getPlayerCryptoCurrencyInventory(param: InventoriesApiGetPlayerCryptoCurrencyInventoryRequest, options?: Configuration): Promise<InventoryListResponse>;
-    /**
-     * Get inventory of player.
-     * @param param the request object
-     */
-    getPlayerInventory(param: InventoriesApiGetPlayerInventoryRequest, options?: Configuration): Promise<ObsoleteInventoryResponse>;
     /**
      * Get native token list of player.
      * @param param the request object
@@ -871,34 +834,6 @@ export interface PlayersApiCreatePlayerRequest {
      */
     playerCreateRequest: PlayerCreateRequest;
 }
-export interface PlayersApiCreatePlayerAccountRequest {
-    /**
-     * Specifies the unique player ID (starts with pla_).
-     * @type string
-     * @memberof PlayersApicreatePlayerAccount
-     */
-    id: string;
-    /**
-     *
-     * @type CreatePlayerAccountRequest
-     * @memberof PlayersApicreatePlayerAccount
-     */
-    createPlayerAccountRequest: CreatePlayerAccountRequest;
-}
-export interface PlayersApiCreatePlayerSessionRequest {
-    /**
-     * Specifies the unique player ID (starts with pla_).
-     * @type string
-     * @memberof PlayersApicreatePlayerSession
-     */
-    id: string;
-    /**
-     *
-     * @type CreatePlayerSessionRequest
-     * @memberof PlayersApicreatePlayerSession
-     */
-    createPlayerSessionRequest: CreatePlayerSessionRequest;
-}
 export interface PlayersApiDeletePlayerRequest {
     /**
      * Specifies the unique player ID (starts with pla_).
@@ -921,20 +856,6 @@ export interface PlayersApiGetPlayerRequest {
      */
     expand?: Array<PlayerResponseExpandable>;
 }
-export interface PlayersApiGetPlayerAccountsRequest {
-    /**
-     * Specifies the unique player ID (starts with pla_).
-     * @type string
-     * @memberof PlayersApigetPlayerAccounts
-     */
-    id: string;
-    /**
-     * Specifies the expandable fields.
-     * @type Array&lt;AccountResponseExpandable&gt;
-     * @memberof PlayersApigetPlayerAccounts
-     */
-    expand?: Array<AccountResponseExpandable>;
-}
 export interface PlayersApiGetPlayersRequest {
     /**
      * Specifies the maximum number of records to return.
@@ -981,20 +902,6 @@ export interface PlayersApiRequestTransferAccountOwnershipRequest {
      */
     playerTransferOwnershipRequest: PlayerTransferOwnershipRequest;
 }
-export interface PlayersApiRevokePlayerSessionRequest {
-    /**
-     * Specifies the unique player ID (starts with pla_).
-     * @type string
-     * @memberof PlayersApirevokePlayerSession
-     */
-    id: string;
-    /**
-     *
-     * @type RevokeSessionPlayerRequest
-     * @memberof PlayersApirevokePlayerSession
-     */
-    revokeSessionPlayerRequest: RevokeSessionPlayerRequest;
-}
 export interface PlayersApiUpdatePlayerRequest {
     /**
      * Specifies the unique player ID (starts with pla_).
@@ -1019,21 +926,11 @@ export declare class ObjectPlayersApi {
      */
     cancelTransferAccountOwnership(param: PlayersApiCancelTransferAccountOwnershipRequest, options?: Configuration): Promise<TransactionIntentResponse>;
     /**
-     * Add a new player to your player list in Openfort.
+     * Creates a Player.
      * Create a player object.
      * @param param the request object
      */
     createPlayer(param: PlayersApiCreatePlayerRequest, options?: Configuration): Promise<PlayerResponse>;
-    /**
-     * Create account object for a player.
-     * @param param the request object
-     */
-    createPlayerAccount(param: PlayersApiCreatePlayerAccountRequest, options?: Configuration): Promise<AccountResponse>;
-    /**
-     * Create session object for a player.
-     * @param param the request object
-     */
-    createPlayerSession(param: PlayersApiCreatePlayerSessionRequest, options?: Configuration): Promise<SessionResponse>;
     /**
      * Deletes a player object.
      * @param param the request object
@@ -1044,11 +941,6 @@ export declare class ObjectPlayersApi {
      * @param param the request object
      */
     getPlayer(param: PlayersApiGetPlayerRequest, options?: Configuration): Promise<PlayerResponse>;
-    /**
-     * List of accounts of a player.
-     * @param param the request object
-     */
-    getPlayerAccounts(param: PlayersApiGetPlayerAccountsRequest, options?: Configuration): Promise<AccountListResponse>;
     /**
      * By default, a maximum of ten players are shown.
      * List players.
@@ -1062,11 +954,7 @@ export declare class ObjectPlayersApi {
      */
     requestTransferAccountOwnership(param: PlayersApiRequestTransferAccountOwnershipRequest, options?: Configuration): Promise<TransactionIntentResponse>;
     /**
-     * Revoke session object for a player.
-     * @param param the request object
-     */
-    revokePlayerSession(param: PlayersApiRevokePlayerSessionRequest, options?: Configuration): Promise<SessionResponse>;
-    /**
+     * Updates the specified Player by setting the values of the parameters passed.
      * Updates a player object.
      * @param param the request object
      */
@@ -1137,20 +1025,6 @@ export interface PoliciesApiCreatePolicyRequest {
      */
     createPolicyRequest: CreatePolicyRequest;
 }
-export interface PoliciesApiCreatePolicyAllowFunctionRequest {
-    /**
-     * Specifies the unique policy ID (starts with pol_).
-     * @type string
-     * @memberof PoliciesApicreatePolicyAllowFunction
-     */
-    id: string;
-    /**
-     *
-     * @type CreatePolicyAllowFunctionRequest
-     * @memberof PoliciesApicreatePolicyAllowFunction
-     */
-    createPolicyAllowFunctionRequest: CreatePolicyAllowFunctionRequest;
-}
 export interface PoliciesApiDeletePolicyRequest {
     /**
      * Specifies the unique policy ID (starts with pol_).
@@ -1239,20 +1113,6 @@ export interface PoliciesApiGetPolicyRequest {
      */
     expand?: Array<PolicyResponseExpandable>;
 }
-export interface PoliciesApiGetPolicyAllowFunctionsRequest {
-    /**
-     * Specifies the unique policy ID (starts with pol_).
-     * @type string
-     * @memberof PoliciesApigetPolicyAllowFunctions
-     */
-    id: string;
-    /**
-     * Specifies the fields to expand.
-     * @type Array&lt;&#39;contract&#39;&gt;
-     * @memberof PoliciesApigetPolicyAllowFunctions
-     */
-    expand?: Array<'contract'>;
-}
 export interface PoliciesApiGetPolicyTotalGasUsageRequest {
     /**
      * Specifies the unique policy ID (starts with pol_).
@@ -1275,26 +1135,6 @@ export interface PoliciesApiUpdatePolicyRequest {
      */
     updatePolicyRequest: UpdatePolicyRequest;
 }
-export interface PoliciesApiUpdatePolicyAllowFunctionRequest {
-    /**
-     * Specifies the unique policy ID (starts with pol_).
-     * @type string
-     * @memberof PoliciesApiupdatePolicyAllowFunction
-     */
-    policy: string;
-    /**
-     * Specifies the unique policy rule ID (starts with afu_).
-     * @type string
-     * @memberof PoliciesApiupdatePolicyAllowFunction
-     */
-    policyRule: string;
-    /**
-     *
-     * @type UpdatePolicyRuleRequest
-     * @memberof PoliciesApiupdatePolicyAllowFunction
-     */
-    updatePolicyRuleRequest: UpdatePolicyRuleRequest;
-}
 export declare class ObjectPoliciesApi {
     private api;
     constructor(configuration: Configuration, requestFactory?: PoliciesApiRequestFactory, responseProcessor?: PoliciesApiResponseProcessor);
@@ -1303,11 +1143,6 @@ export declare class ObjectPoliciesApi {
      * @param param the request object
      */
     createPolicy(param: PoliciesApiCreatePolicyRequest, options?: Configuration): Promise<PolicyResponse>;
-    /**
-     * Create a policy rule object for a policy.
-     * @param param the request object
-     */
-    createPolicyAllowFunction(param: PoliciesApiCreatePolicyAllowFunctionRequest, options?: Configuration): Promise<PolicyRuleResponse>;
     /**
      * Delete a policy object.
      * @param param the request object
@@ -1324,20 +1159,17 @@ export declare class ObjectPoliciesApi {
      */
     enablePolicy(param: PoliciesApiEnablePolicyRequest, options?: Configuration): Promise<PolicyResponse>;
     /**
+     * Returns a list of Policies.
      * List policies.
      * @param param the request object
      */
     getPolicies(param?: PoliciesApiGetPoliciesRequest, options?: Configuration): Promise<PolicyListResponse>;
     /**
+     * Retrieves the details of a Policy that has previously been created.
      * Get a policy object.
      * @param param the request object
      */
     getPolicy(param: PoliciesApiGetPolicyRequest, options?: Configuration): Promise<PolicyResponse>;
-    /**
-     * List policy rules of a policy.
-     * @param param the request object
-     */
-    getPolicyAllowFunctions(param: PoliciesApiGetPolicyAllowFunctionsRequest, options?: Configuration): Promise<PolicyRuleListResponse>;
     /**
      * List all gas reports of a policy.
      * @param param the request object
@@ -1348,11 +1180,6 @@ export declare class ObjectPoliciesApi {
      * @param param the request object
      */
     updatePolicy(param: PoliciesApiUpdatePolicyRequest, options?: Configuration): Promise<PolicyResponse>;
-    /**
-     * Update a policy rule object of a policy.
-     * @param param the request object
-     */
-    updatePolicyAllowFunction(param: PoliciesApiUpdatePolicyAllowFunctionRequest, options?: Configuration): Promise<PolicyRuleResponse>;
 }
 import { PolicyRulesApiRequestFactory, PolicyRulesApiResponseProcessor } from "../apis/PolicyRulesApi";
 export interface PolicyRulesApiCreatePolicyRulesRequest {
@@ -1522,16 +1349,19 @@ export declare class ObjectSessionsApi {
     private api;
     constructor(configuration: Configuration, requestFactory?: SessionsApiRequestFactory, responseProcessor?: SessionsApiResponseProcessor);
     /**
+     * Creates a Session.
      * Create a session key.
      * @param param the request object
      */
     createSession(param: SessionsApiCreateSessionRequest, options?: Configuration): Promise<SessionResponse>;
     /**
+     * Returns a list of Sessions.
      * List session keys of a player.
      * @param param the request object
      */
     getPlayerSessions(param: SessionsApiGetPlayerSessionsRequest, options?: Configuration): Promise<SessionListResponse>;
     /**
+     * Retrieves the details of a Session that has previously been created.
      * Returns a player session by session id
      * @param param the request object
      */
@@ -1542,7 +1372,7 @@ export declare class ObjectSessionsApi {
      */
     revokeSession(param: SessionsApiRevokeSessionRequest, options?: Configuration): Promise<SessionResponse>;
     /**
-     * Send signed userOpHash to create session.
+     * Send signed userOperationHash to create session.
      * @param param the request object
      */
     signatureSession(param: SessionsApiSignatureSessionRequest, options?: Configuration): Promise<SessionResponse>;
@@ -1681,7 +1511,7 @@ export interface TransactionIntentsApiGetTransactionIntentsRequest {
      */
     expand?: Array<TransactionIntentResponseExpandable>;
     /**
-     * The chain ID.
+     * The chain ID. Must be a [supported chain](/chains).
      * @type number
      * @memberof TransactionIntentsApigetTransactionIntents
      */
@@ -1723,29 +1553,31 @@ export declare class ObjectTransactionIntentsApi {
     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 param the request object
      */
     createTransactionIntent(param: TransactionIntentsApiCreateTransactionIntentRequest, 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 param the request object
      */
     estimateTransactionIntentCost(param: TransactionIntentsApiEstimateTransactionIntentCostRequest, options?: Configuration): Promise<EstimateTransactionIntentGasResult>;
     /**
+     * Retrieves the details of a TransactionIntent that has previously been created.
      * Get a transaction intent object.
      * @param param the request object
      */
     getTransactionIntent(param: TransactionIntentsApiGetTransactionIntentRequest, options?: Configuration): Promise<TransactionIntentResponse>;
     /**
+     * Returns a list of TransactionIntents.
      * List transaction intents.
      * @param param the request object
      */
     getTransactionIntents(param?: TransactionIntentsApiGetTransactionIntentsRequest, 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 param the request object
      */