@openfort/openfort-node 0.6.35 → 0.6.38

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

@@ -13,6 +13,9 @@ import { ContractReadResponse } from '../models/ContractReadResponse';
 import { ContractResponse } from '../models/ContractResponse';
 import { CreateAccountRequest } from '../models/CreateAccountRequest';
 import { CreateContractRequest } from '../models/CreateContractRequest';
+import { CreateNotificationRequest } from '../models/CreateNotificationRequest';
+import { CreateNotificationSubscriptionRequest } from '../models/CreateNotificationSubscriptionRequest';
+import { CreateNotificationTriggerRequest } from '../models/CreateNotificationTriggerRequest';
 import { CreatePolicyRequest } from '../models/CreatePolicyRequest';
 import { CreatePolicyRuleRequest } from '../models/CreatePolicyRuleRequest';
 import { CreateSessionRequest } from '../models/CreateSessionRequest';
@@ -26,11 +29,21 @@ import { DeveloperAccountListResponse } from '../models/DeveloperAccountListResp
 import { DeveloperAccountResponse } from '../models/DeveloperAccountResponse';
 import { DeveloperAccountResponseExpandable } from '../models/DeveloperAccountResponseExpandable';
 import { EstimateTransactionIntentGasResult } from '../models/EstimateTransactionIntentGasResult';
-import { GasReport } from '../models/GasReport';
+import { GasReportListResponse } from '../models/GasReportListResponse';
 import { GetSigninUrlResponse } from '../models/GetSigninUrlResponse';
 import { InventoryListResponse } from '../models/InventoryListResponse';
 import { InventoryResponse } from '../models/InventoryResponse';
 import { LoginRequest } from '../models/LoginRequest';
+import { NotificationDeleteResponse } from '../models/NotificationDeleteResponse';
+import { NotificationListResponse } from '../models/NotificationListResponse';
+import { NotificationResponse } from '../models/NotificationResponse';
+import { NotificationResponseExpandable } from '../models/NotificationResponseExpandable';
+import { NotificationSubscription } from '../models/NotificationSubscription';
+import { NotificationSubscriptionDeleteResponse } from '../models/NotificationSubscriptionDeleteResponse';
+import { NotificationSubscriptionListResponse } from '../models/NotificationSubscriptionListResponse';
+import { NotificationTriggerDeleteResponse } from '../models/NotificationTriggerDeleteResponse';
+import { NotificationTriggerListResponse } from '../models/NotificationTriggerListResponse';
+import { NotificationTriggerResponse } from '../models/NotificationTriggerResponse';
 import { OAuthConfig } from '../models/OAuthConfig';
 import { OAuthConfigListResponse } from '../models/OAuthConfigListResponse';
 import { OAuthProvider } from '../models/OAuthProvider';
@@ -43,6 +56,7 @@ import { PlayerResponse } from '../models/PlayerResponse';
 import { PlayerResponseExpandable } from '../models/PlayerResponseExpandable';
 import { PlayerTransferOwnershipRequest } from '../models/PlayerTransferOwnershipRequest';
 import { PlayerUpdateRequest } from '../models/PlayerUpdateRequest';
+import { PolicyBalanceWithdrawResponse } from '../models/PolicyBalanceWithdrawResponse';
 import { PolicyDeleteResponse } from '../models/PolicyDeleteResponse';
 import { PolicyListResponse } from '../models/PolicyListResponse';
 import { PolicyResponse } from '../models/PolicyResponse';
@@ -77,6 +91,7 @@ import { Web3ActionResponse } from '../models/Web3ActionResponse';
 import { Web3ConnectionListResponse } from '../models/Web3ConnectionListResponse';
 import { Web3ConnectionResponse } from '../models/Web3ConnectionResponse';
 import { Web3ConnectionResponseExpandable } from '../models/Web3ConnectionResponseExpandable';
+import { WithdrawalPolicyRequest } from '../models/WithdrawalPolicyRequest';
 import { AccountsApiRequestFactory, AccountsApiResponseProcessor } from "../apis/AccountsApi";
 export declare class PromiseAccountsApi {
     private api;
@@ -95,7 +110,7 @@ export declare class PromiseAccountsApi {
      */
     completeRecovery(id: string, completeRecoveryRequest: CompleteRecoveryRequest, _options?: Configuration): Promise<TransactionIntentResponse>;
     /**
-     * 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.
+     * 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.  Each player can only have one account per chain.
      * Create an account object.
      * @param createAccountRequest
      */
@@ -242,6 +257,7 @@ export declare class PromiseInventoriesApi {
     private api;
     constructor(configuration: Configuration, requestFactory?: InventoriesApiRequestFactory, responseProcessor?: InventoriesApiResponseProcessor);
     /**
+     * For development purposes only.  Under higher load scenarios, this endpoint may be rate limited.
      * Retrieves the cryptocurrency assets of an existing account.
      * @param id Specifies the unique account ID.
      * @param limit Specifies the maximum number of records to return.
@@ -251,11 +267,13 @@ export declare class PromiseInventoriesApi {
      */
     getAccountCryptoCurrencyInventory(id: string, limit?: number, skip?: number, order?: SortOrder, contractId?: Array<string>, _options?: Configuration): Promise<InventoryListResponse>;
     /**
+     * For development purposes only.  Under higher load scenarios, this endpoint may be rate limited.
      * Retrieves the native asset of an existing account.
      * @param id Specifies the unique account ID.
      */
     getAccountNativeInventory(id: string, _options?: Configuration): Promise<InventoryResponse>;
     /**
+     * For development purposes only.  Under higher load scenarios, this endpoint may be rate limited.
      * Retrieves the NFT assets of an existing account.
      * @param id Specifies the unique account ID.
      * @param limit Specifies the maximum number of records to return.
@@ -265,6 +283,7 @@ export declare class PromiseInventoriesApi {
      */
     getAccountNftInventory(id: string, limit?: number, skip?: number, order?: SortOrder, contractId?: Array<string>, _options?: Configuration): Promise<InventoryListResponse>;
     /**
+     * For development purposes only.  Under higher load scenarios, this endpoint may be rate limited.
      * Get cryptocurrency list of player.
      * @param id Specifies the unique player ID (starts with pla_).
      * @param chainId Filter by chain id.
@@ -275,12 +294,14 @@ export declare class PromiseInventoriesApi {
      */
     getPlayerCryptoCurrencyInventory(id: string, chainId: number, limit?: number, skip?: number, order?: SortOrder, contract?: Array<string>, _options?: Configuration): Promise<InventoryListResponse>;
     /**
+     * For development purposes only.  Under higher load scenarios, this endpoint may be rate limited.
      * Get native token list of player.
      * @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>;
     /**
+     * For development purposes only.  Under higher load scenarios, this endpoint may be rate limited.
      * Get NFTs list of player.
      * @param id Specifies the unique player ID (starts with pla_).
      * @param chainId Filter by chain id.
@@ -291,6 +312,105 @@ export declare class PromiseInventoriesApi {
      */
     getPlayerNftInventory(id: string, chainId: number, limit?: number, skip?: number, order?: SortOrder, contract?: Array<string>, _options?: Configuration): Promise<InventoryListResponse>;
 }
+import { NotificationSubscriptionsApiRequestFactory, NotificationSubscriptionsApiResponseProcessor } from "../apis/NotificationSubscriptionsApi";
+export declare class PromiseNotificationSubscriptionsApi {
+    private api;
+    constructor(configuration: Configuration, requestFactory?: NotificationSubscriptionsApiRequestFactory, responseProcessor?: NotificationSubscriptionsApiResponseProcessor);
+    /**
+     * Create a subscription for the provided notification.
+     * Create a notification subscription object.
+     * @param createNotificationSubscriptionRequest
+     */
+    createNotificationSubscription(createNotificationSubscriptionRequest: CreateNotificationSubscriptionRequest, _options?: Configuration): Promise<NotificationSubscription>;
+    /**
+     * Delete a notification subscription by providing its notification subscription id.
+     * Deletes a notification subscription object.
+     * @param id Specifies the unique notification subscription ID (starts with ntr_).
+     */
+    deleteNotificationSubscription(id: string, _options?: Configuration): Promise<NotificationSubscriptionDeleteResponse>;
+    /**
+     * Retrieves the details of an existing notification subscription.  Supply the unique notification subscription ID.
+     * Get existing notification subscription.
+     * @param id Specifies the unique notification subscription ID (starts with not_).
+     */
+    getNotificationSubscription(id: string, _options?: Configuration): Promise<NotificationSubscription>;
+    /**
+     * Returns a list of subscriptions of a notification.  Subscriptions define the the way you will get notified and the target of the notification.  Subscriptions are returned sorted by creation date, with the most recently created accounts appearing first.  By default, a maximum of 10 notification subscriptions are shown per page.
+     * List notification subscriptions of a notification.
+     * @param notification Specifies the unique notification ID (starts with not_).
+     * @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.
+     */
+    getNotificationSubscriptions(notification: string, limit?: number, skip?: number, order?: SortOrder, _options?: Configuration): Promise<NotificationSubscriptionListResponse>;
+}
+import { NotificationTriggersApiRequestFactory, NotificationTriggersApiResponseProcessor } from "../apis/NotificationTriggersApi";
+export declare class PromiseNotificationTriggersApi {
+    private api;
+    constructor(configuration: Configuration, requestFactory?: NotificationTriggersApiRequestFactory, responseProcessor?: NotificationTriggersApiResponseProcessor);
+    /**
+     * Create a trigger for the provided notification.
+     * Create a notification trigger object.
+     * @param createNotificationTriggerRequest
+     */
+    createNotificationTrigger(createNotificationTriggerRequest: CreateNotificationTriggerRequest, _options?: Configuration): Promise<NotificationTriggerResponse>;
+    /**
+     * Delete a notification trigger by providing its notification trigger id.
+     * Deletes a notification trigger object.
+     * @param id Specifies the unique notification trigger ID (starts with ntr_).
+     */
+    deleteNotificationTrigger(id: string, _options?: Configuration): Promise<NotificationTriggerDeleteResponse>;
+    /**
+     * Retrieves the details of an existing notification trigger.  Supply the unique notification trigger ID.
+     * Get existing notification trigger.
+     * @param id Specifies the unique notification trigger ID (starts with ntr_).
+     */
+    getNotificationTrigger(id: string, _options?: Configuration): Promise<NotificationTriggerResponse>;
+    /**
+     * Returns a list of triggers of a notification.  Triggers define the conditions that will trigger a notification.  Triggers are returned sorted by creation date, with the most recently created accounts appearing first.  By default, a maximum of 10 notification triggers are shown per page.
+     * List notification triggers of a notification.
+     * @param notification Specifies the unique notification ID (starts with not_).
+     * @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.
+     */
+    getNotificationTriggers(notification: string, limit?: number, skip?: number, order?: SortOrder, _options?: Configuration): Promise<NotificationTriggerListResponse>;
+}
+import { NotificationsApiRequestFactory, NotificationsApiResponseProcessor } from "../apis/NotificationsApi";
+export declare class PromiseNotificationsApi {
+    private api;
+    constructor(configuration: Configuration, requestFactory?: NotificationsApiRequestFactory, responseProcessor?: NotificationsApiResponseProcessor);
+    /**
+     * Create a notification object.
+     * Create a notification object.
+     * @param createNotificationRequest
+     */
+    createNotification(createNotificationRequest: CreateNotificationRequest, _options?: Configuration): Promise<NotificationResponse>;
+    /**
+     * Delete a notification by providing its notification id.
+     * Deletes a notification object.
+     * @param id Specifies the unique notification ID (starts with not_).
+     */
+    deleteNotification(id: string, _options?: Configuration): Promise<NotificationDeleteResponse>;
+    /**
+     * Retrieves the details of an existing notification.  Supply the unique notification ID.
+     * Get existing notification.
+     * @param id Specifies the unique notification ID (starts with not_).
+     * @param expand
+     */
+    getNotification(id: string, expand?: Array<NotificationResponseExpandable>, _options?: Configuration): Promise<NotificationResponse>;
+    /**
+     * Returns a list of notifications.  Notifications are useful to get notified about events that happen on-chain or in your Openfort account.  Notifications are returned sorted by creation date, with the most recently created notifications appearing first.  By default, a maximum of 10 notifications are shown per page.
+     * List notifications.
+     * @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 deleted Specifies whether to include deleted notifications.
+     * @param name Specifies the name of the notifications.
+     */
+    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;
@@ -424,6 +544,12 @@ export declare class PromisePoliciesApi {
      * @param createPolicyRequest
      */
     createPolicy(createPolicyRequest: CreatePolicyRequest, _options?: Configuration): Promise<PolicyResponse>;
+    /**
+     * List all gas reports of a policy.
+     * @param id Specifies the unique policy ID (starts with pol_).
+     * @param withdrawalPolicyRequest
+     */
+    createPolicyWithdrawal(id: string, withdrawalPolicyRequest: WithdrawalPolicyRequest, _options?: Configuration): Promise<TransactionIntentResponse>;
     /**
      * Delete a policy object.
      * @param id Specifies the unique policy ID (starts with pol_).
@@ -447,9 +573,9 @@ export declare class PromisePoliciesApi {
      * @param order Specifies the order in which to sort the results.
      * @param expand Specifies the fields to expand in the response.
      * @param name Specifies the name of the policy.
-     * @param deleted Specifies whether to include deleted contracts.
+     * @param deleted Specifies whether to include deleted policies.
      * @param chainId The chain ID of the policy.
-     * @param enabled Specifies whether to include enabled contracts.
+     * @param enabled Specifies whether to include enabled policies.
      */
     getPolicies(limit?: number, skip?: number, order?: SortOrder, expand?: Array<PolicyResponseExpandable>, name?: string, deleted?: boolean, chainId?: number, enabled?: boolean, _options?: Configuration): Promise<PolicyListResponse>;
     /**
@@ -463,7 +589,12 @@ export declare class PromisePoliciesApi {
      * List all gas reports of a policy.
      * @param id Specifies the unique policy ID (starts with pol_).
      */
-    getPolicyTotalGasUsage(id: string, _options?: Configuration): Promise<GasReport>;
+    getPolicyBalance(id: string, _options?: Configuration): Promise<PolicyBalanceWithdrawResponse>;
+    /**
+     * List all gas reports of a policy.
+     * @param id Specifies the unique policy ID (starts with pol_).
+     */
+    getPolicyTotalGasUsage(id: string, _options?: Configuration): Promise<GasReportListResponse>;
     /**
      * Update a policy object.
      * @param id Specifies the unique policy ID (starts with pol_).
@@ -479,13 +610,14 @@ export declare class PromisePolicyRulesApi {
      * Create a policy rule object.
      * @param createPolicyRuleRequest
      */
-    createPolicyRules(createPolicyRuleRequest: CreatePolicyRuleRequest, _options?: Configuration): Promise<PolicyRuleResponse>;
+    createPolicyRule(createPolicyRuleRequest: CreatePolicyRuleRequest, _options?: Configuration): Promise<PolicyRuleResponse>;
     /**
      * Deletes a policy rule object.
      * @param id Specifies the unique policy rule ID (starts with afu_).
      */
-    deletePolicyRules(id: string, _options?: Configuration): Promise<PolicyRuleDeleteResponse>;
+    deletePolicyRule(id: string, _options?: Configuration): Promise<PolicyRuleDeleteResponse>;
     /**
+     * Returns a list of policy rules of a policy.  The policy rules are returned sorted by creation date, with the most recently created policy rules appearing first.  By default, a maximum of 10 policy rules are shown per page.
      * List policy rules of a policy.
      * @param policy Specifies the unique policy ID (starts with pol_).
      * @param limit Specifies the maximum number of records to return.
@@ -499,7 +631,7 @@ export declare class PromisePolicyRulesApi {
      * @param id Specifies the unique policy rule ID (starts with afu_).
      * @param updatePolicyRuleRequest
      */
-    updatePolicyRules(id: string, updatePolicyRuleRequest: UpdatePolicyRuleRequest, _options?: Configuration): Promise<PolicyRuleResponse>;
+    updatePolicyRule(id: string, updatePolicyRuleRequest: UpdatePolicyRuleRequest, _options?: Configuration): Promise<PolicyRuleResponse>;
 }
 import { SessionsApiRequestFactory, SessionsApiResponseProcessor } from "../apis/SessionsApi";
 export declare class PromiseSessionsApi {
@@ -553,13 +685,13 @@ export declare class PromiseSettingsApi {
     /**
      * Delete a developer account from the current project.
      * Delete a developer account.
-     * @param id Specifies a unique developer account.
+     * @param id Specifies a unique developer account (starts with dac_).
      */
     deleteDeveloperAccount(id: string, _options?: Configuration): Promise<DeveloperAccountDeleteResponse>;
     /**
-     * Retrieve the list of the developer accounts for the current project.
+     * Retrieve a developer account.
      * Get existing developer account.
-     * @param id
+     * @param id Specifies the unique developer account ID (starts with dac_).
      * @param expand
      */
     getDeveloperAccount(id: string, expand?: Array<DeveloperAccountResponseExpandable>, _options?: Configuration): Promise<DeveloperAccountResponse>;
@@ -570,8 +702,9 @@ export declare class PromiseSettingsApi {
      * @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 deleted Specifies whether to include deleted dev accounts.
      */
-    getDeveloperAccounts(limit?: number, skip?: number, order?: SortOrder, expand?: Array<DeveloperAccountResponseExpandable>, _options?: Configuration): Promise<DeveloperAccountListResponse>;
+    getDeveloperAccounts(limit?: number, skip?: number, order?: SortOrder, expand?: Array<DeveloperAccountResponseExpandable>, deleted?: boolean, _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
@@ -623,9 +756,10 @@ export declare class PromiseTransactionIntentsApi {
      * @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 status Filter by successful (1) or failed (0) transaction intents.
      * @param policy Filter by policy ID (starts with pol_).
      */
-    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>;
+    getTransactionIntents(limit?: number, skip?: number, order?: SortOrder, expand?: Array<TransactionIntentResponseExpandable>, chainId?: number, account?: Array<string>, player?: Array<string>, status?: number, policy?: Array<string>, _options?: Configuration): Promise<TransactionIntentListResponse>;
     /**
      * 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.