import { ethers, Interface } from 'ethers'; import { NetworkConfigs } from '@unlock-protocol/types'; import { SiweMessage } from 'siwe'; import * as axios from 'axios'; import { AxiosInstance, AxiosRequestConfig, AxiosPromise } from 'axios'; import { RequestConfig } from 'graphql-request/build/legacy/helpers/types'; /** * UnlockService is class which implements shared behavior between web3Service and walletService. * It is not meant to be instantiated (only subclasses should) */ declare class UnlockService { networks: NetworkConfigs; versionForAddress: Record; [key: string]: any; constructor(networks: NetworkConfigs); providerForNetwork(networkId: number): ethers.Provider | ethers.JsonRpcProvider; /** * Checks if the contract has been deployed at the address. * Invokes the callback with the result. * Addresses which do not have a contract attached will return 0x */ isUnlockContractDeployed(network: number): Promise; /** * @param {string} address contract address * @param {string} versionRetrievalMethodName the method to call to retrieve the contract version */ contractAbiVersion(address: string, versionRetrievalMethodName: any, provider: ethers.Provider): Promise; unlockContractAbiVersion(address: string, provider: ethers.Provider): Promise; /** * Returns the ABI for the Lock contract deployed at the provided address * @param {*} address */ lockContractAbiVersion(address: string, provider: ethers.Provider): Promise; /** * Private method, which given an address will query the lock and return the version of the lock * @param {*} address */ _getPublicLockVersionFromContract(address: string, provider: ethers.Provider): Promise; /** * Private method, which given an address will query the unlock contract to get its version * @param {*} address */ _getUnlockVersionFromContract(address: string, provider: ethers.Provider): Promise; getContract(address: string, contractAbi: ethers.InterfaceAbi, provider: ethers.Provider): ethers.Contract; getLockContract(lockAddress: string, provider: ethers.Provider | ethers.JsonRpcApiProvider): Promise; getUnlockContract(unlockAddress: string, provider: ethers.Provider): Promise; getHookContract({ network, address, abi, }: { network: number; address: string; abi: Interface; }): Promise; } type WalletServiceCallback = (_error: Error | null, _hash: string | null, _transaction?: any | null) => unknown; interface TransactionOptions { returnCalldata?: boolean; nonce?: number; gasLimit?: ethers.BigNumberish; gasPrice?: ethers.BigNumberish; maxFeePerGas?: ethers.BigNumberish; maxPriorityFeePerGas?: ethers.BigNumberish; runEstimate?: boolean; value?: ethers.BigNumberish; } interface CreateLockOptions { publicLockVersion?: number | string; name: string; expirationDuration?: number | string; maxNumberOfKeys?: number | string; currencyContractAddress?: string | null; keyPrice?: string | number; creator?: string; } interface PurchaseKeyParams { lockAddress: string; owner?: string; keyPrice?: string; data?: string | null; erc20Address?: string; decimals?: number; recurringPayments?: number; referrer?: string; protocolReferrer?: string; additionalPeriods?: number; totalApproval?: string; keyManager?: string; } interface PurchaseKeysParams { lockAddress: string; owners: string[]; keyPrices?: string[]; data?: string[] | null; erc20Address?: string; decimals?: number; referrers?: (string | null)[]; protocolReferrers?: (string | null)[]; additionalPeriods?: number[]; recurringPayments?: number[]; totalApproval?: string; keyManagers?: string[]; } interface ExtendKeyParams { lockAddress: string; tokenId?: string; owner?: string; referrer?: string; data?: string; decimals?: number; erc20Address?: string; keyPrice?: string; recurringPayment?: string | number; totalApproval?: string; } interface GetAndSignAuthorizationsForTransferAndPurchaseParams { amount: string; lockAddress: string; network: number; } interface PurchaseWithCardPurchaserParams { transfer: any; purchase: any; callData: string; } /** * This service reads data from the RPC endpoint. * All transactions should be sent via the WalletService. */ /** * Constructor is called with an object * { * [networkId]: { * provider: string, * unlockAddress: string, * }, * [networkId2]: { * provider: string, * unlockAddress: string, * } * [networkId3]: { * provider: string, * unlockAddress: string, * } * } */ declare class Web3Service extends UnlockService { /** * Method which returns the create2 address based on the factory contract (unlock), the lock template, * the account and lock salt (both used to create a unique salt) * 0x3d602d80600a3d3981f3363d3d373d3d3d363d73 and 5af43d82803e903d91602b57fd5bf3 are the * bytecode for eip-1167 (which defines proxies for locks). * @private */ _create2Address(unlockAddress: string, templateAddress: string, account: string, lockSalt: string): string; /** * Returns details about a transaction * @param {*} hash * @param {*} network * @returns */ getTransaction(hash: string, network: number): Promise; /** * This retrieves the balance of an address (contract or account) * and formats it to a string of ether. * Returns a promise with the balance */ getAddressBalance(address: string, network: number, tokenAddress?: string): Promise; /** * Refresh the lock's data. * We use the block version * @return Promise */ getLock(address: string, network: number, options?: { fields: string[]; }): Promise; /** * Tell whether a user is a manager for the lock * @param {string} lockAddress * @param {string} manager * @return Promise */ isLockManager(lockAddress: string, manager: string, network: number): Promise; /** * Returns the key to the lock by the token Id. * @param {PropTypes.string} lockAddress * @param {PropTypes.number} tokenId */ getKeyByTokenId(lockAddress: string, tokenId: string, network: number): Promise<{ tokenId: string; lock: string; owner: any; expiration: number; }>; /** * Returns the key expiration to the lock by the account. * @private * @param {PropTypes.string} lockAddress * @param {number} tokenId * @return Promise<> */ getKeyExpirationByTokenId(lockAddress: string, tokenId: string, network: number): Promise; /** * Returns the key to the lock by the account. * @param {PropTypes.string} lockAddress * @param {PropTypes.string} owner */ getKeyByLockForOwner(lockAddress: string, owner: string, network: number): Promise<{ lock: string; owner: string; expiration: number; tokenId: number; }>; /** * Returns true if the address has a valid key (will call the hook when applicable!) * @param lockAddress * @param owner * @param network */ getHasValidKey(lockAddress: string, owner: string, network: number): Promise; /** * Returns the key expiration to the lock by the account. * @private * @param {PropTypes.string} lockAddress * @param {PropTypes.string} owner * @return Promise<> */ getKeyExpirationByLockForOwner(lockAddress: string, owner: string, network: number): Promise; /** * Returns the key expiration to the lock by the account. * @private * @param {PropTypes.string} lockAddress * @param {PropTypes.string} owner * @return Promise<> */ getTokenIdForOwner(lockAddress: string, owner: string, network: number): Promise; /** * Given some data and a signed version of the same, returns the address of the account that signed it * @param data * @param signedData * @returns {Promise<*>} */ recoverAccountFromSignedData(data: T, signedData: ethers.Signature): Promise; /** * Given an ERC20 token contract address, resolve with the symbol that identifies that token. * @param {string} contractAddress * @returns {Promise} */ getTokenSymbol(contractAddress: string, network: number): Promise; /** * Given an ERC20 token contract address, resolve with the provided user's balance of that token. * @param {string} contractAddress * @param {string} userWalletAddress * @returns {Promise} */ getTokenBalance(contractAddress: string, userWalletAddress: string, network: number): Promise; getTokenDecimals(contractAddress: string, network: number): Promise; /** * Yields true if an address is key granter on a lock */ isKeyGranter(lockAddress: string, address: string, network: number): Promise; /** * Retrieves the key manager for a key * @param {*} lockAddress * @param {*} tokenId * @param {*} network */ keyManagerOf(lockAddress: string, tokenId: string, network: number): Promise; /** * Returns the owner of a key * @param {*} lockAddress * @param {*} tokenId * @param {*} network */ ownerOf(lockAddress: string, tokenId: string, network: number): Promise; /** * Returns id a key is valid or not * @param {*} lockAddress * @param {*} tokenId * @param {*} network */ isValidKey(lockAddress: string, tokenId: string, network: number): Promise; /** * Returns the Ethers contract 'connected' (should be used with care) * @param {*} lockAddress * @param {*} network */ lockContract(lockAddress: string, network: number): Promise; /** * Returns numbers of owners for a specific lock * @param {*} lockAddress * @param {*} network */ numberOfOwners(lockAddress: string, network: number): Promise; /** * Returns transfer fee for lock * @param {*} lockAddress * @param {*} network */ transferFeeBasisPoints(lockAddress: string, network: number): Promise; /** * Returns total of key for a specific address * @param {String} lockAddress * @param {String} address * @param {Number} network */ totalKeys(lockAddress: string, owner: string, network: number): Promise; /** * Returns lock version * @param {String} lockAddress * @param {Number} network */ publicLockVersion(lockAddress: string, network: number): Promise; tokenURI(lockAddress: string, tokenId: string, network: number): Promise; /** * Returns the number of keys available for sale * @param lockAddress * @param network * @returns */ keysAvailable(lockAddress: string, network: number): Promise; /** * Returns how much of a refund a key owner would receive * @param lockAddress * @param network * @param owner * @param tokenAddress * @param tokenId * @returns */ getCancelAndRefundValueFor(params: { lockAddress: string; owner: string; tokenAddress: string; network: number; tokenId: string; }, transactionOptions?: TransactionOptions, callback?: WalletServiceCallback): Promise; balanceOf(lockAddress: string, owner: string, network: number): Promise; tokenOfOwnerByIndex(lockAddress: string, owner: string, index: number, network: number): Promise; latestTokenOfOwner(lockAddress: string, owner: string, network: number): Promise; /** * Returns the number of keys already sold * @param lockAddress * @param network * @returns */ totalSupply(lockAddress: string, network: number): Promise; /** * Returns the purchase price for the user on the lock */ purchasePriceFor({ lockAddress, userAddress, data, referrer, network, }: { lockAddress: string; network: number; data: string; userAddress: string; referrer: string; }): Promise; /** * Returns freeTrialLength value */ freeTrialLength({ lockAddress, network, }: { lockAddress: string; network: number; }): Promise; /** * Returns refundPenaltyBasisPoints value */ refundPenaltyBasisPoints({ lockAddress, network, }: { lockAddress: string; network: number; }): Promise; /** * Returns onKeyCancelHook value */ onKeyCancelHook({ lockAddress, network, }: { lockAddress: string; network: number; }): Promise; /** * Returns onKeyPurchaseHook value */ onKeyPurchaseHook({ lockAddress, network, }: { lockAddress: string; network: number; }): Promise; /** * Returns onKeyTransferHook value */ onKeyTransferHook({ lockAddress, network, }: { lockAddress: string; network: number; }): Promise; /** * Returns onTokenURIHook value */ onTokenURIHook({ lockAddress, network, }: { lockAddress: string; network: number; }): Promise; /** * Returns onValidKeyHook value */ onValidKeyHook({ lockAddress, network, }: { lockAddress: string; network: number; }): Promise; /** * Returns onKeyExtendHook value */ onKeyExtendHook({ lockAddress, network, }: { lockAddress: string; network: number; }): Promise; /** * Returns onKeyGrantHook value */ onKeyGrantHook({ lockAddress, network, }: { lockAddress: string; network: number; }): Promise; /** * Returns last lock version * @param {Number} network */ publicLockLatestVersion(network: number): Promise; /** * Returns referrer fees */ referrerFees({ lockAddress, network, address, }: { lockAddress: string; network: number; address: string; }): Promise; getBaseTokenURI({ lockAddress, network, }: { lockAddress: string; network: number; }): Promise; /** * Returns an object the contains the resolved address or ens * name of the input address with it's type */ resolveName(addressOrEns: string): Promise<"" | { input: string; address: string; name: string; type: string; } | { input: never; name: never; address: string | null; type: string; }>; /** * Get signer for `Password hook contract` */ getPasswordHookSigners(params: { lockAddress: string; contractAddress: string; network: number; }): Promise; getTokenIdsFromTx({ params: { hash, network, lockAddress }, }: { params: { hash: string; network: number; lockAddress: string; }; }): Promise; getGasRefundValue({ network, lockAddress, }: { network: number; lockAddress: string; }): Promise; /** * Get signer for `Password hook contract` */ getDiscountHookValues(params: { lockAddress: string; contractAddress: string; network: number; signerAddress: string; }): Promise; /** * Get signer for `Password hook contract` */ getDiscountHookWithCapValues(params: { lockAddress: string; contractAddress: string; network: number; signerAddress: string; }): Promise<{ discount: any; cap: any; count: any; }>; /** * Get signer for `Password hook contract` */ getPasswordHookWithCapValues(params: { lockAddress: string; contractAddress: string; network: number; signerAddress: string; }): Promise<{ cap: any; count: any; }>; getMerkleRootFromAllowListHook(params: { lockAddress: string; hookAddress: string; network: number; }): Promise; /** * Data-only signatures */ purchaseKey({ lockAddress, network, params, }: { lockAddress: string; network: number; params: PurchaseKeyParams; }): Promise; purchaseKeys({ lockAddress, network, params, }: { lockAddress: string; network: number; params: PurchaseKeysParams; }): Promise; } /** * This service interacts with the user's wallet. * The functionality is on purpose only about sending transaction and returning the corresponding * hashes. Another service (which does not depend on the user;s wallet) will be in charge of * actually retrieving the data from the chain/smart contracts */ declare class WalletService extends UnlockService { /** * This needs to be called with a ethers.providers which includes a signer or with a signer */ connect(provider: ethers.JsonRpcProvider, signer?: ethers.Signer): Promise; /** * Function which yields the address of the account on the provider */ getAccount(): Promise; /** * This function submits a web3 transaction and will trigger an event as soon as it receives its * hash. We then use the web3Service to handle the ongoing transaction (watch for confirmation * receipt... etc) * A the moment the dispatcher relies on the strict emission, it is imperitive that the emission * of these fields not change for the time being! * @private * @param {Promise} the result of calling a contract method (ethersjs contract) * @param {string} the Unlock protocol transaction type * @param {Function} a standard node callback that accepts the transaction hash */ _handleMethodCall(methodCall: any): Promise; /** * Updates the key price on a lock * @param {PropTypes.address} lockAddress : address of the lock for which we update the price * @param {string} price : new price for the lock * @param {function} callback : callback invoked with the transaction hash * @return Promise newKeyPrice */ updateKeyPrice(params: { lockAddress: string; keyPrice: string; }, transactionOptions?: TransactionOptions, callback?: WalletServiceCallback): Promise; /** * Creates a lock on behalf of the user. * @param {PropTypes.lock} lock * @param {function} callback : callback invoked with the transaction hash * @return Promise lockAddress */ createLock(lock: CreateLockOptions, transactionOptions?: TransactionOptions, callback?: WalletServiceCallback): Promise; unlockContractAbiVersion(): Promise; lockContractAbiVersion(address: string): Promise; getUnlockContract(): Promise; getLockContract(address: string): Promise; /** * Then we need to call initialize on it. This is critical because otherwise anyone can claim it and then self-destruct it, killing all locks which use the same contract after this. * @param {*} params * @param {*} callback */ initializeTemplate(params: { templateAddress: string; }, transactionOptions?: TransactionOptions, callback?: WalletServiceCallback): Promise; /** * Purchase a key to a lock by account. * The key object is passed so we can keep track of it from the application * - {PropTypes.address} lockAddress * - {PropTypes.address} owner * - {string} keyPrice * - {string} data * - {PropTypes.address} erc20Address * - {number} decimals * @param {function} callback : callback invoked with the transaction hash */ purchaseKey(params: PurchaseKeyParams, transactionOptions?: TransactionOptions, callback?: WalletServiceCallback): Promise; /** * Purchase several keys to a lock by account. * The key object is passed so we can keep track of it from the application * - {PropTypes.address} lockAddress * - {PropTypes.arrayOf(PropTypes.address)} owners * - {PropTypes.arrayOf(string)} keyPrices * - {PropTypes.arrayOf(string)} data * - {PropTypes.address} erc20Address * - {number} decimals * @param {function} callback : callback invoked with the transaction hash */ purchaseKeys(params: PurchaseKeysParams, transactionOptions?: TransactionOptions, callback?: WalletServiceCallback): Promise; /** * Function to renew a membership, callable by anyone. * This is only useful for ERC20 locks for which the key owner has approved * a large enough token amount! * @param params * @param callback * @returns */ renewMembershipFor(params: { lockAddress: string; referrer: string | null; tokenId: string; }, transactionOptions?: TransactionOptions, callback?: WalletServiceCallback): Promise; /** * Extends an expired key * @param {*} params * @param {*} callback */ extendKey(params: ExtendKeyParams, transactionOptions?: TransactionOptions, callback?: WalletServiceCallback): Promise; /** * Purchase key function. This implementation requires the following * @param {object} params: * - {PropTypes.address} lockAddress * - {number} tokenIdFrom * - {number} tokenIdTo * - {number} amount if null, will take the entire remaining time of the from key * @param {function} callback invoked with the transaction hash */ mergeKeys(params: { lockAddress: string; tokenIdFrom: string; tokenIdTo: string; amount?: number; }, transactionOptions?: TransactionOptions, callback?: WalletServiceCallback): Promise; /** * Set ERC20 allowance to the beneficary * @param {object} params: * - {PropTypes.address} lockAddress * - {string} spender the address of the spender * - {number} amount the amount to approve * @param {function} callback invoked with the transaction hash */ approveBeneficiary(params: { lockAddress: string; spender: string; amount: number; }, transactionOptions?: TransactionOptions, callback?: WalletServiceCallback): Promise; /** * Grants permission to grant keys to address * @param {*} params * @param {*} callback */ addKeyGranter(params: { lockAddress: string; keyGranter: string; }, transactionOptions?: TransactionOptions, callback?: WalletServiceCallback): Promise; /** * Revokes permission to grant keys to an address * @param {*} params * @param {*} callback */ removeKeyGranter(params: { lockAddress: string; keyGranter: string; }, transactionOptions?: TransactionOptions, callback?: WalletServiceCallback): Promise; /** * Expire and refunds (optional) a key by lock manager * @param {*} params * @param {*} callback */ expireAndRefundFor(params: { lockAddress: string; keyOwner: string; tokenId: string; amount?: string; decimals?: number; erc20Address?: string; }, transactionOptions?: TransactionOptions, callback?: WalletServiceCallback): Promise; /** * Cancels a membership and receive a refund (called by key manager) * @param {*} params * @param {*} callback */ cancelAndRefund(params: { lockAddress: string; tokenId: string; }, transactionOptions?: TransactionOptions, callback?: WalletServiceCallback): Promise; /** * Shares a key by transfering time from key to another key * @param {*} params * - {PropTypes.address} lockAddress * - {PropTypes.address } recipient * - {string}: tokenId the token to share time from * - {string}: duration time to share in seconds * @param {*} callback */ shareKey(params: { lockAddress: string; recipient: string; tokenId: string; duration?: string; }, transactionOptions?: TransactionOptions, callback?: WalletServiceCallback): Promise; /** * Lends a key to another address * @param {function} callback : callback invoked with the transaction hash */ lendKey(params: { lockAddress: string; from: string; to: string; tokenId: string; }, transactionOptions?: TransactionOptions, callback?: WalletServiceCallback): Promise; /** * Grants a key to an address * @param {function} callback : callback invoked with the transaction hash */ grantKey(params: { lockAddress: string; recipient: string; expiration?: string; transactionOptions?: unknown; }, transactionOptions?: TransactionOptions, callback?: WalletServiceCallback): Promise; /** * Grant keys to multiple recipient addresses with custom expiration * @param {function} callback : callback invoked with the transaction hash */ grantKeys(params: { lockAddress: string; recipients: string[]; expirations?: string[]; keyManagers?: string[]; }, transactionOptions?: TransactionOptions, callback?: WalletServiceCallback): Promise; /** * Grant key extension. This implementation requires the following * @param {object} params: * - {PropTypes.address} lockAddress * - {number} tokenId * - {number} duration default to 0, which will extend the key by the * default duration of the lock * @param {function} callback invoked with the transaction hash */ grantKeyExtension(params: { lockAddress: string; tokenId: string; duration: number; }, transactionOptions?: TransactionOptions, callback?: WalletServiceCallback): Promise; /** * Update the name of a lock * @param {object} params: * - {PropTypes.address} lockAddress * - {string} name the new name of the lock * @param {function} callback invoked with the transaction hash */ updateLockName(params: { lockAddress: string; name: string; }, transactionOptions?: TransactionOptions, callback?: WalletServiceCallback): Promise; /** * Update the symbol of a lock * @param {object} params: * - {PropTypes.address} lockAddress * - {string} symbol the new symbol of the lock * @param {function} callback invoked with the transaction hash */ updateLockSymbol(params: { lockAddress: string; symbol: string; }, transactionOptions?: TransactionOptions, callback?: WalletServiceCallback): Promise; /** * Update the base URI used to parse the tokenURI * @param {object} params: * - {PropTypes.address} lockAddress * - {string} baseTokenURI the new baseTokenURI of the lock * @param {function} callback invoked with the transaction hash */ setBaseTokenURI(params: { lockAddress: string; baseTokenURI: string; }, transactionOptions?: TransactionOptions, callback?: WalletServiceCallback): Promise; /** * Triggers a transaction to withdraw funds from the lock and assign them to the owner. * @param {object} params * - {PropTypes.address} lockAddress * - {string} amount the amount to withdraw (0 to withdraw the entire balance) * - {string} Erc20Address the address of the ERC20 currency to withdraw * - {number} decimals the number of decimals of the ERC20 * - {string} beneficary the address that will receive the funds (only v12+) * @param {function} callback : callback invoked with the transaction hash */ withdrawFromLock(params: { lockAddress: string; amount?: string; decimals?: number; erc20Address?: string; beneficiary?: string; }, transactionOptions?: TransactionOptions, callback?: WalletServiceCallback): Promise; /** * Tries multiple approaches for eth_signTypedData * @param {*} account * @param {*} data */ unformattedSignTypedData(account: string, data: any): Promise; signMessage(data: any, method: any): Promise; setMaxNumberOfKeys(params: { lockAddress: string; maxNumberOfKeys: string; }, transactionOptions?: TransactionOptions, callback?: WalletServiceCallback): Promise; setMaxKeysPerAddress(params: { lockAddress: string; maxKeysPerAddress: string; }, transactionOptions?: TransactionOptions, callback?: WalletServiceCallback): Promise; setExpirationDuration(params: { lockAddress: string; expirationDuration: number | string; }, transactionOptions?: TransactionOptions, callback?: WalletServiceCallback): Promise; /** * Add lock manager to Contact * @param {*} params * @param {*} callback */ addLockManager(params: { lockAddress: string; userAddress: string; }, transactionOptions?: TransactionOptions, callback?: WalletServiceCallback): Promise; /** * Renounce lock manager status for Contract * @param {*} params * @param {*} callback */ renounceLockManager(params: { lockAddress: string; }, transactionOptions?: TransactionOptions, callback?: WalletServiceCallback): Promise; /** * Update Refund Penalty: Allow the owner to change the refund penalty. * @param {*} params * @param {*} callback */ updateRefundPenalty(params: { lockAddress: string; freeTrialLength: number; refundPenaltyBasisPoints: number; }, transactionOptions?: TransactionOptions, callback?: WalletServiceCallback): Promise; /** * Allows a Lock manager to update or remove an event hook * @param {*} params * @param {*} callback */ setEventHooks(params: { lockAddress: string; keyPurchase?: string; keyCancel?: string; validKey?: string; tokenURI?: string; keyTransfer?: string; keyExtend?: string; keyGrant?: string; roleHook?: string; }, transactionOptions?: TransactionOptions, callback?: WalletServiceCallback): Promise; /** * Allow a Lock manager to change the transfer fee. * @param {*} params * @param {*} callback */ updateTransferFee(params: { lockAddress: string; transferFeeBasisPoints: number; }, transactionOptions?: TransactionOptions, callback?: WalletServiceCallback): Promise; upgradeLock(params: { lockAddress: string; lockVersion: bigint; }, transactionOptions?: TransactionOptions, callback?: WalletServiceCallback): Promise; /** * Update referrer fee * @param {*} params * @param {*} callback */ setReferrerFee(params: { lockAddress: string; address: string; feeBasisPoint: number; }, transactionOptions?: TransactionOptions, callback?: WalletServiceCallback): Promise; /** * Set signer for `Password hook contract` */ setPasswordHookSigner(params: { lockAddress: string; signerAddress: string; contractAddress: string; network: number; }, signer: ethers.Wallet | ethers.JsonRpcSigner): Promise; /** * Set signer for `Password with cap hook contract` */ setPasswordWithCapHookSigner(params: { lockAddress: string; signerAddress: string; contractAddress: string; cap: number; network: number; }): Promise; /** * Change lock manager for a specific key * @param {*} params * @param {*} callback */ setKeyManagerOf(params: { lockAddress: string; managerAddress: string; tokenId: string; }, transactionOptions?: TransactionOptions, callback?: WalletServiceCallback): Promise; /** * This yields the authorizations required to spend USDC on behalf of the user * to buy a key from a specific lock. This is mostly used for the universal * card support! * @param param0 * @returns */ getAndSignAuthorizationsForTransferAndPurchase({ amount, lockAddress, network, }: GetAndSignAuthorizationsForTransferAndPurchaseParams): Promise<{ transferSignature: string; transferMessage: { from: any; to: string; value: string; validAfter: number; validBefore: number; nonce: string; }; purchaseSignature: string; purchaseMessage: { sender: string; lock: string; expiration: number; }; }>; /** * Performs a purchase using the CardPurchaser contract * @param param0 * @returns */ purchaseWithCardPurchaser({ transfer, purchase, callData, }: PurchaseWithCardPurchaserParams): Promise; /** * Transfers a specific NFT from one account to another * @returns */ transferFrom(params: { keyOwner: string; to: string; tokenId: string; lockAddress: string; }, transactionOptions?: TransactionOptions, callback?: WalletServiceCallback): Promise; setGasRefund(params: { lockAddress: string; gasRefundValue: string; }, transactionOptions?: TransactionOptions, callback?: WalletServiceCallback): Promise; /** * Set signer for `Discount code` hook contract */ setDiscountCodeHookSigner(params: { lockAddress: string; signerAddress: string; contractAddress: string; network: number; discountPercentage: number; }): Promise; /** * Set signer for `Discount code` hook contract with cap */ setDiscountCodeWithCapHookSigner(params: { lockAddress: string; signerAddress: string; contractAddress: string; network: number; discountPercentage: number; cap: number; }): Promise; setMerkleRoot({ network, lockAddress, hookAddress, root, }: { network: number; lockAddress: string; hookAddress: string; root: string; }): Promise; } declare function getCurrentProvider(environment: any): "Opera" | "Metamask" | "Trust" | "Coinbase Wallet" | "Cipher" | "Mist" | "Parity" | "Infura" | "localhost" | "UnknownProvider"; declare function getWeb3Provider(url: string): string; /** * Unlock Locksmith * Locksmith provides backend functionality for enabling ticketing, metadata storage, and notification hooks. * * The version of the OpenAPI document: 2 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ interface ConfigurationParameters { apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); username?: string; password?: string; accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); basePath?: string; baseOptions?: any; formDataCtor?: new () => any; } declare class Configuration { /** * parameter for apiKey security * @param name security name * @memberof Configuration */ apiKey?: string | Promise | ((name: string) => string) | ((name: string) => Promise); /** * parameter for basic security * * @type {string} * @memberof Configuration */ username?: string; /** * parameter for basic security * * @type {string} * @memberof Configuration */ password?: string; /** * parameter for oauth2 security * @param name security name * @param scopes oauth2 scope * @memberof Configuration */ accessToken?: string | Promise | ((name?: string, scopes?: string[]) => string) | ((name?: string, scopes?: string[]) => Promise); /** * override base path * * @type {string} * @memberof Configuration */ basePath?: string; /** * base options for axios calls * * @type {any} * @memberof Configuration */ baseOptions?: any; /** * The FormData constructor that will be used to create multipart form data * requests. You can inject this here so that execution environments that * do not support the FormData class can still run the generated client. * * @type {new () => FormData} */ formDataCtor?: new () => any; constructor(param?: ConfigurationParameters); /** * Check if the given MIME is a JSON MIME. * JSON MIME examples: * application/json * application/json; charset=UTF8 * APPLICATION/JSON * application/vnd.company+json * @param mime - MIME (Multipurpose Internet Mail Extensions) * @return True if the given MIME is JSON, false otherwise. */ isJsonMime(mime: string): boolean; } /** * Unlock Locksmith * Locksmith provides backend functionality for enabling ticketing, metadata storage, and notification hooks. * * The version of the OpenAPI document: 2 * * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ /** * * @export * @interface RequestArgs */ interface RequestArgs { url: string; options: AxiosRequestConfig; } /** * * @export * @class BaseAPI */ declare class BaseAPI { protected basePath: string; protected axios: AxiosInstance; protected configuration: Configuration | undefined; constructor(configuration?: Configuration, basePath?: string, axios?: AxiosInstance); } /** * * @export * @interface AddEventToCollectionBody */ interface AddEventToCollectionBody { /** * * @type {string} * @memberof AddEventToCollectionBody */ 'eventSlug': string; } /** * * @export * @interface AddManagerBody */ interface AddManagerBody { /** * * @type {string} * @memberof AddManagerBody */ 'newManagerAddress': string; } /** * * @export * @interface Application */ interface Application { /** * * @type {number} * @memberof Application */ 'id'?: number; /** * * @type {string} * @memberof Application */ 'name'?: string; /** * * @type {string} * @memberof Application */ 'key'?: string | null; /** * * @type {string} * @memberof Application */ 'walletAddress'?: string; } /** * * @export * @interface ApplicationBody */ interface ApplicationBody { /** * * @type {string} * @memberof ApplicationBody */ 'name'?: string; /** * * @type {string} * @memberof ApplicationBody */ 'key'?: string | null; /** * * @type {string} * @memberof ApplicationBody */ 'walletAddress'?: string; } /** * * @export * @interface Applications200Response */ interface Applications200Response { /** * * @type {Array} * @memberof Applications200Response */ 'results'?: Array; } /** * * @export * @interface ApproveAttendeesRsvpRequest */ interface ApproveAttendeesRsvpRequest { /** * * @type {Array} * @memberof ApproveAttendeesRsvpRequest */ 'recipients'?: Array; } /** * * @export * @interface ApproveEventBody */ interface ApproveEventBody { /** * Slug of the event to approve. * @type {string} * @memberof ApproveEventBody */ 'eventSlug': string; } /** * * @export * @interface ApproveRefunds201Response */ interface ApproveRefunds201Response { /** * * @type {string} * @memberof ApproveRefunds201Response */ 'format': string; /** * * @type {Array} * @memberof ApproveRefunds201Response */ 'values': Array; /** * * @type {Array} * @memberof ApproveRefunds201Response */ 'tree': Array; } /** * * @export * @interface ApproveRefundsRequest */ interface ApproveRefundsRequest { /** * * @type {number} * @memberof ApproveRefundsRequest */ 'amount': number; /** * * @type {string} * @memberof ApproveRefundsRequest */ 'currency'?: string | null; /** * * @type {number} * @memberof ApproveRefundsRequest */ 'network': number; } /** * * @export * @interface ApprovedRefunds200Response */ interface ApprovedRefunds200Response { /** * * @type {string} * @memberof ApprovedRefunds200Response */ 'format': ApprovedRefunds200ResponseFormatEnum; /** * * @type {Array} * @memberof ApprovedRefunds200Response */ 'leafEncoding'?: Array; /** * * @type {Array} * @memberof ApprovedRefunds200Response */ 'values': Array; /** * * @type {Array} * @memberof ApprovedRefunds200Response */ 'tree': Array; } declare const ApprovedRefunds200ResponseFormatEnum: { readonly StandardV1: "standard-v1"; }; type ApprovedRefunds200ResponseFormatEnum = typeof ApprovedRefunds200ResponseFormatEnum[keyof typeof ApprovedRefunds200ResponseFormatEnum]; /** * * @export * @interface ApprovedRefunds200ResponseValuesInner */ interface ApprovedRefunds200ResponseValuesInner { /** * * @type {Array} * @memberof ApprovedRefunds200ResponseValuesInner */ 'value'?: Array; /** * * @type {number} * @memberof ApprovedRefunds200ResponseValuesInner */ 'treeIndex'?: number; } /** * * @export * @interface Auth */ interface Auth { /** * * @type {string} * @memberof Auth */ 'walletAddress': string; } /** * * @export * @interface AuthResult */ interface AuthResult { /** * * @type {string} * @memberof AuthResult */ 'walletAddress': string | null; /** * * @type {string} * @memberof AuthResult */ 'accessToken': string; } /** * * @export * @interface Balance200ResponseValue */ interface Balance200ResponseValue { /** * * @type {string} * @memberof Balance200ResponseValue */ 'address'?: string; /** * * @type {string} * @memberof Balance200ResponseValue */ 'name'?: string; /** * * @type {string} * @memberof Balance200ResponseValue */ 'balance'?: string; } /** * * @export * @interface BulkApproveEventsBody */ interface BulkApproveEventsBody { /** * Array of event slugs to approve. * @type {Array} * @memberof BulkApproveEventsBody */ 'eventSlugs': Array; } /** * * @export * @interface BulkRemoveEventsBody */ interface BulkRemoveEventsBody { /** * Array of event slugs to remove. * @type {Array} * @memberof BulkRemoveEventsBody */ 'eventSlugs': Array; } /** * * @export * @interface CapturePurchaseRequest */ interface CapturePurchaseRequest { /** * * @type {Array} * @memberof CapturePurchaseRequest */ 'recipients'?: Array; /** * * @type {number} * @memberof CapturePurchaseRequest */ 'network': number; /** * * @type {string} * @memberof CapturePurchaseRequest */ 'lock': string; /** * * @type {string} * @memberof CapturePurchaseRequest */ 'userAddress': string; /** * * @type {string} * @memberof CapturePurchaseRequest */ 'paymentIntent': string; /** * * @type {Array} * @memberof CapturePurchaseRequest */ 'data'?: Array; /** * * @type {Array} * @memberof CapturePurchaseRequest */ 'referrers'?: Array; /** * whether to extend or purchase membership for the recipient. * @type {string} * @memberof CapturePurchaseRequest */ 'purchaseType'?: CapturePurchaseRequestPurchaseTypeEnum; } declare const CapturePurchaseRequestPurchaseTypeEnum: { readonly Extend: "extend"; readonly Purchase: "purchase"; }; type CapturePurchaseRequestPurchaseTypeEnum = typeof CapturePurchaseRequestPurchaseTypeEnum[keyof typeof CapturePurchaseRequestPurchaseTypeEnum]; /** * * @export * @interface CheckClaim200Response */ interface CheckClaim200Response { /** * * @type {boolean} * @memberof CheckClaim200Response */ 'canClaim'?: boolean; } /** * * @export * @interface CheckClaimRequest */ interface CheckClaimRequest { /** * * @type {Array} * @memberof CheckClaimRequest */ 'recipients'?: Array; /** * * @type {Array} * @memberof CheckClaimRequest */ 'data'?: Array; } /** * * @export * @interface CheckPrivyUser400Response */ interface CheckPrivyUser400Response { /** * * @type {string} * @memberof CheckPrivyUser400Response */ 'error': string; } /** * * @export * @interface CheckPrivyUser500Response */ interface CheckPrivyUser500Response { /** * * @type {string} * @memberof CheckPrivyUser500Response */ 'error': string; } /** * * @export * @interface CheckoutConfig */ interface CheckoutConfig { /** * * @type {string} * @memberof CheckoutConfig */ 'id'?: string; /** * * @type {string} * @memberof CheckoutConfig */ 'name': string; /** * * @type {string} * @memberof CheckoutConfig */ 'by'?: string; /** * * @type {CheckoutConfigConfig} * @memberof CheckoutConfig */ 'config': CheckoutConfigConfig; /** * * @type {string} * @memberof CheckoutConfig */ 'createdAt'?: string; /** * * @type {string} * @memberof CheckoutConfig */ 'updatedAt'?: string; } /** * * @export * @interface CheckoutConfigConfig */ interface CheckoutConfigConfig { [key: string]: any; /** * * @type {{ [key: string]: any; }} * @memberof CheckoutConfigConfig */ 'locks': { [key: string]: any; }; } /** * * @export * @interface Claim200Response */ interface Claim200Response { /** * * @type {string} * @memberof Claim200Response */ 'transactionHash'?: string; /** * * @type {string} * @memberof Claim200Response */ 'owner'?: string; } /** * * @export * @interface ClaimRequest */ interface ClaimRequest { /** * * @type {string} * @memberof ClaimRequest */ 'data'?: string; /** * Email address of the recipient * @type {string} * @memberof ClaimRequest */ 'email'?: string; /** * Recipient address for key * @type {string} * @memberof ClaimRequest */ 'recipient'?: string; /** * Referrer address used to mint. This may get overwritten. * @type {string} * @memberof ClaimRequest */ 'referrer'?: string; } /** * * @export * @interface ConnectStripeAccount200Response */ interface ConnectStripeAccount200Response { /** * * @type {string} * @memberof ConnectStripeAccount200Response */ 'url'?: string; /** * * @type {number} * @memberof ConnectStripeAccount200Response */ 'created'?: number; /** * * @type {number} * @memberof ConnectStripeAccount200Response */ 'expiresAt'?: number; /** * * @type {string} * @memberof ConnectStripeAccount200Response */ 'object'?: string; } /** * * @export * @interface ConnectStripeAccountRequest */ interface ConnectStripeAccountRequest { /** * * @type {string} * @memberof ConnectStripeAccountRequest */ 'baseUrl': string; /** * * @type {string} * @memberof ConnectStripeAccountRequest */ 'stripeAccount'?: string; } /** * * @export * @interface CreateDownloadReceiptsRequest200Response */ interface CreateDownloadReceiptsRequest200Response { /** * * @type {string} * @memberof CreateDownloadReceiptsRequest200Response */ 'status': CreateDownloadReceiptsRequest200ResponseStatusEnum; } declare const CreateDownloadReceiptsRequest200ResponseStatusEnum: { readonly Pending: "pending"; }; type CreateDownloadReceiptsRequest200ResponseStatusEnum = typeof CreateDownloadReceiptsRequest200ResponseStatusEnum[keyof typeof CreateDownloadReceiptsRequest200ResponseStatusEnum]; /** * * @export * @interface CreateLockContract201Response */ interface CreateLockContract201Response { /** * * @type {string} * @memberof CreateLockContract201Response */ 'transactionHash'?: string; } /** * * @export * @interface CreateTransferCode200Response */ interface CreateTransferCode200Response { /** * * @type {string} * @memberof CreateTransferCode200Response */ 'owner': string; /** * * @type {string} * @memberof CreateTransferCode200Response */ 'lock': string; /** * * @type {string} * @memberof CreateTransferCode200Response */ 'token': string; /** * * @type {number} * @memberof CreateTransferCode200Response */ 'deadline': number; /** * Part of the transfer code that is required to be used with the part sent to the recipient. * @type {string} * @memberof CreateTransferCode200Response */ 'transferCode': string; } /** * * @export * @interface CreateTransferCode404Response */ interface CreateTransferCode404Response { /** * * @type {string} * @memberof CreateTransferCode404Response */ 'message': string; } /** * * @export * @interface CreateVerifierRequest */ interface CreateVerifierRequest { /** * optional verifier name * @type {string} * @memberof CreateVerifierRequest */ 'verifierName'?: string; } /** * * @export * @interface EjectUser200Response */ interface EjectUser200Response { /** * * @type {string} * @memberof EjectUser200Response */ 'publicKey'?: string; } /** * * @export * @interface EmailTicket200Response */ interface EmailTicket200Response { /** * * @type {boolean} * @memberof EmailTicket200Response */ 'sent'?: boolean; } /** * * @export * @interface Event */ interface Event { /** * * @type {string} * @memberof Event */ 'name': string; /** * * @type {string} * @memberof Event */ 'slug': string; /** * * @type {string} * @memberof Event */ 'image': string; /** * * @type {string} * @memberof Event */ 'description': string; /** * * @type {string} * @memberof Event */ 'status'?: EventStatusEnum; /** * * @type {string} * @memberof Event */ 'transactionHash'?: string; /** * * @type {Array} * @memberof Event */ 'attributes': Array; } declare const EventStatusEnum: { readonly Pending: "pending"; readonly Deployed: "deployed"; }; type EventStatusEnum = typeof EventStatusEnum[keyof typeof EventStatusEnum]; /** * * @export * @interface EventAttributesInner */ interface EventAttributesInner { /** * * @type {string} * @memberof EventAttributesInner */ 'trait_type': string; /** * * @type {string} * @memberof EventAttributesInner */ 'value': string; } /** * * @export * @interface EventCollection */ interface EventCollection { /** * * @type {string} * @memberof EventCollection */ 'slug'?: string; /** * * @type {string} * @memberof EventCollection */ 'title'?: string; /** * * @type {string} * @memberof EventCollection */ 'description'?: string; /** * * @type {string} * @memberof EventCollection */ 'coverImage'?: string; /** * * @type {string} * @memberof EventCollection */ 'banner'?: string; /** * * @type {{ [key: string]: string; }} * @memberof EventCollection */ 'links'?: { [key: string]: string; }; /** * * @type {Array} * @memberof EventCollection */ 'managerAddresses'?: Array; /** * * @type {string} * @memberof EventCollection */ 'createdAt'?: string; /** * * @type {string} * @memberof EventCollection */ 'updatedAt'?: string; /** * * @type {Array} * @memberof EventCollection */ 'events'?: Array; } /** * * @export * @interface EventCollectionAssociation */ interface EventCollectionAssociation { /** * * @type {number} * @memberof EventCollectionAssociation */ 'id'?: number; /** * * @type {string} * @memberof EventCollectionAssociation */ 'eventSlug'?: string; /** * * @type {string} * @memberof EventCollectionAssociation */ 'collectionSlug'?: string; /** * * @type {boolean} * @memberof EventCollectionAssociation */ 'isApproved'?: boolean; /** * * @type {string} * @memberof EventCollectionAssociation */ 'createdAt'?: string; /** * * @type {string} * @memberof EventCollectionAssociation */ 'updatedAt'?: string; } /** * * @export * @interface EventCollectionBody */ interface EventCollectionBody { /** * * @type {string} * @memberof EventCollectionBody */ 'title': string; /** * * @type {string} * @memberof EventCollectionBody */ 'description': string; /** * * @type {string} * @memberof EventCollectionBody */ 'coverImage'?: string; /** * * @type {string} * @memberof EventCollectionBody */ 'banner'?: string; /** * * @type {Array} * @memberof EventCollectionBody */ 'links'?: Array; /** * * @type {Array} * @memberof EventCollectionBody */ 'managerAddresses': Array; } /** * * @export * @interface EventCollectionBodyLinksInner */ interface EventCollectionBodyLinksInner { /** * * @type {string} * @memberof EventCollectionBodyLinksInner */ 'type'?: string; /** * * @type {string} * @memberof EventCollectionBodyLinksInner */ 'url'?: string; } /** * * @export * @interface EventDetails */ interface EventDetails { /** * * @type {string} * @memberof EventDetails */ 'eventName'?: string; /** * * @type {string} * @memberof EventDetails */ 'eventDescription'?: string; /** * * @type {string} * @memberof EventDetails */ 'eventDate'?: string; /** * * @type {string} * @memberof EventDetails */ 'eventTime'?: string; /** * * @type {string} * @memberof EventDetails */ 'eventAddress'?: string; /** * * @type {string} * @memberof EventDetails */ 'startDate'?: string; /** * * @type {string} * @memberof EventDetails */ 'endDate'?: string; /** * * @type {string} * @memberof EventDetails */ 'eventUrl'?: string; } /** * * @export * @interface EventsInCollection */ interface EventsInCollection { /** * * @type {Array} * @memberof EventsInCollection */ 'events'?: Array; /** * * @type {number} * @memberof EventsInCollection */ 'totalCount'?: number; /** * * @type {number} * @memberof EventsInCollection */ 'currentPage'?: number; /** * * @type {number} * @memberof EventsInCollection */ 'totalPages'?: number; } /** * * @export * @interface ExportKeys200Response */ interface ExportKeys200Response { /** * * @type {string} * @memberof ExportKeys200Response */ 'jobId'?: string; } /** * * @export * @interface GenerateGoogleWalletPass200Response */ interface GenerateGoogleWalletPass200Response { /** * * @type {string} * @memberof GenerateGoogleWalletPass200Response */ 'passObjectUrl'?: string; } /** * * @export * @interface GenericInvalidBodyError */ interface GenericInvalidBodyError { /** * * @type {string} * @memberof GenericInvalidBodyError */ 'message'?: string; /** * * @type {string} * @memberof GenericInvalidBodyError */ 'error'?: string | null; } /** * * @export * @interface GenericNotFound */ interface GenericNotFound { /** * * @type {string} * @memberof GenericNotFound */ 'message'?: string; } /** * * @export * @interface GenericServerError */ interface GenericServerError { /** * * @type {string} * @memberof GenericServerError */ 'message'?: string; } /** * * @export * @interface GenericSuccess */ interface GenericSuccess { /** * * @type {string} * @memberof GenericSuccess */ 'message'?: string; } /** * * @export * @interface GetChargesForLock200Response */ interface GetChargesForLock200Response { /** * * @type {number} * @memberof GetChargesForLock200Response */ 'total': number; /** * * @type {string} * @memberof GetChargesForLock200Response */ 'symbol'?: string; /** * * @type {number} * @memberof GetChargesForLock200Response */ 'creditCardProcessingFee'?: number; /** * * @type {number} * @memberof GetChargesForLock200Response */ 'unlockServiceFee': number; /** * * @type {number} * @memberof GetChargesForLock200Response */ 'gasCost': number; /** * * @type {Array} * @memberof GetChargesForLock200Response */ 'prices'?: Array; } /** * * @export * @interface GetChargesForLock200ResponsePricesInner */ interface GetChargesForLock200ResponsePricesInner { /** * * @type {string} * @memberof GetChargesForLock200ResponsePricesInner */ 'userAddress': string; /** * * @type {string} * @memberof GetChargesForLock200ResponsePricesInner */ 'amount': string; /** * * @type {string} * @memberof GetChargesForLock200ResponsePricesInner */ 'symbol': string; } /** * * @export * @interface GetCustomEmailContent200Response */ interface GetCustomEmailContent200Response { /** * * @type {string} * @memberof GetCustomEmailContent200Response */ 'lockAddress'?: string; /** * * @type {number} * @memberof GetCustomEmailContent200Response */ 'network'?: number; /** * * @type {string} * @memberof GetCustomEmailContent200Response */ 'template'?: string; /** * * @type {string} * @memberof GetCustomEmailContent200Response */ 'content'?: string; } /** * * @export * @interface GetDataForRecipientsAndCaptcha200Response */ interface GetDataForRecipientsAndCaptcha200Response { /** * * @type {Array} * @memberof GetDataForRecipientsAndCaptcha200Response */ 'messages'?: Array; /** * * @type {string} * @memberof GetDataForRecipientsAndCaptcha200Response */ 'signer'?: string; /** * * @type {Array} * @memberof GetDataForRecipientsAndCaptcha200Response */ 'signatures'?: Array; } /** * * @export * @interface GetDataForRecipientsAndGuild200Response */ interface GetDataForRecipientsAndGuild200Response { /** * * @type {Array} * @memberof GetDataForRecipientsAndGuild200Response */ 'result'?: Array; } /** * * @export * @interface GetEvent200Response */ interface GetEvent200Response { /** * * @type {number} * @memberof GetEvent200Response */ 'id'?: number; /** * * @type {Event} * @memberof GetEvent200Response */ 'data'?: Event; /** * * @type {CheckoutConfig} * @memberof GetEvent200Response */ 'checkoutConfig'?: CheckoutConfig; /** * * @type {string} * @memberof GetEvent200Response */ 'slug'?: string; } /** * * @export * @interface GetEventTicket200Response */ interface GetEventTicket200Response { /** * * @type {string} * @memberof GetEventTicket200Response */ 'keyId': string; /** * * @type {string} * @memberof GetEventTicket200Response */ 'name': string; /** * * @type {string} * @memberof GetEventTicket200Response */ 'owner': string; /** * * @type {string} * @memberof GetEventTicket200Response */ 'manager': string; /** * * @type {string} * @memberof GetEventTicket200Response */ 'lockAddress': string; /** * * @type {string} * @memberof GetEventTicket200Response */ 'image': string; /** * * @type {string} * @memberof GetEventTicket200Response */ 'description': string; /** * * @type {number} * @memberof GetEventTicket200Response */ 'checkedInAt'?: number; /** * * @type {{ [key: string]: any; }} * @memberof GetEventTicket200Response */ 'userMetadata': { [key: string]: any; }; /** * * @type {string} * @memberof GetEventTicket200Response */ 'expiration': string; /** * * @type {Array} * @memberof GetEventTicket200Response */ 'attributes': Array; /** * * @type {string} * @memberof GetEventTicket200Response */ 'publicLockVersion': string; /** * Whether the user who requested the ticket can verify the ticket. * @type {boolean} * @memberof GetEventTicket200Response */ 'isVerifier': boolean; } /** * * @export * @interface GetEventTicket200ResponseAttributesInner */ interface GetEventTicket200ResponseAttributesInner { /** * * @type {string} * @memberof GetEventTicket200ResponseAttributesInner */ 'trait_type'?: string; /** * * @type {string} * @memberof GetEventTicket200ResponseAttributesInner */ 'value': string; /** * * @type {string} * @memberof GetEventTicket200ResponseAttributesInner */ 'display_type'?: string; } /** * * @export * @interface GetLockStripeConnectionDetails200Response */ interface GetLockStripeConnectionDetails200Response { /** * * @type {GetLockStripeConnectionDetails200ResponseCountrySpec} * @memberof GetLockStripeConnectionDetails200Response */ 'countrySpec'?: GetLockStripeConnectionDetails200ResponseCountrySpec; /** * * @type {GetLockStripeConnectionDetails200ResponseAccount} * @memberof GetLockStripeConnectionDetails200Response */ 'account'?: GetLockStripeConnectionDetails200ResponseAccount; /** * * @type {number} * @memberof GetLockStripeConnectionDetails200Response */ 'connected'?: number; } /** * * @export * @interface GetLockStripeConnectionDetails200ResponseAccount */ interface GetLockStripeConnectionDetails200ResponseAccount { /** * * @type {string} * @memberof GetLockStripeConnectionDetails200ResponseAccount */ 'id'?: string; /** * * @type {boolean} * @memberof GetLockStripeConnectionDetails200ResponseAccount */ 'charges_enabled'?: boolean; /** * * @type {boolean} * @memberof GetLockStripeConnectionDetails200ResponseAccount */ 'payouts_enabled'?: boolean; /** * * @type {GetLockStripeConnectionDetails200ResponseAccountRequirements} * @memberof GetLockStripeConnectionDetails200ResponseAccount */ 'requirements'?: GetLockStripeConnectionDetails200ResponseAccountRequirements; } /** * * @export * @interface GetLockStripeConnectionDetails200ResponseAccountRequirements */ interface GetLockStripeConnectionDetails200ResponseAccountRequirements { /** * * @type {string} * @memberof GetLockStripeConnectionDetails200ResponseAccountRequirements */ 'disabled_reason'?: string; } /** * * @export * @interface GetLockStripeConnectionDetails200ResponseCountrySpec */ interface GetLockStripeConnectionDetails200ResponseCountrySpec { /** * * @type {Array} * @memberof GetLockStripeConnectionDetails200ResponseCountrySpec */ 'supported_payment_currencies'?: Array; } /** * * @export * @interface GetReceipt200Response */ interface GetReceipt200Response { /** * * @type {GetReceipt200ResponsePurchaser} * @memberof GetReceipt200Response */ 'purchaser'?: GetReceipt200ResponsePurchaser; /** * * @type {GetReceipt200ResponseSupplier} * @memberof GetReceipt200Response */ 'supplier'?: GetReceipt200ResponseSupplier; /** * * @type {GetReceipt200ResponseReceipt} * @memberof GetReceipt200Response */ 'receipt'?: GetReceipt200ResponseReceipt; } /** * * @export * @interface GetReceipt200ResponsePurchaser */ interface GetReceipt200ResponsePurchaser { /** * * @type {string} * @memberof GetReceipt200ResponsePurchaser */ 'email'?: string; /** * * @type {string} * @memberof GetReceipt200ResponsePurchaser */ 'fullname'?: string; /** * * @type {string} * @memberof GetReceipt200ResponsePurchaser */ 'businessName'?: string; /** * * @type {string} * @memberof GetReceipt200ResponsePurchaser */ 'addressLine1'?: string; /** * * @type {string} * @memberof GetReceipt200ResponsePurchaser */ 'addressLine2'?: string; /** * * @type {string} * @memberof GetReceipt200ResponsePurchaser */ 'city'?: string; /** * * @type {string} * @memberof GetReceipt200ResponsePurchaser */ 'state'?: string; /** * * @type {string} * @memberof GetReceipt200ResponsePurchaser */ 'zip'?: string; /** * * @type {string} * @memberof GetReceipt200ResponsePurchaser */ 'country'?: string; } /** * * @export * @interface GetReceipt200ResponseReceipt */ interface GetReceipt200ResponseReceipt { /** * * @type {string} * @memberof GetReceipt200ResponseReceipt */ 'id'?: string; /** * * @type {number} * @memberof GetReceipt200ResponseReceipt */ 'timestamp'?: number; /** * * @type {string} * @memberof GetReceipt200ResponseReceipt */ 'sender'?: string; /** * * @type {string} * @memberof GetReceipt200ResponseReceipt */ 'payer'?: string; /** * * @type {string} * @memberof GetReceipt200ResponseReceipt */ 'recipient'?: string; /** * * @type {string} * @memberof GetReceipt200ResponseReceipt */ 'lockAddress'?: string; /** * * @type {string} * @memberof GetReceipt200ResponseReceipt */ 'tokenAddress'?: string; /** * * @type {number} * @memberof GetReceipt200ResponseReceipt */ 'gasTotal'?: number; /** * * @type {number} * @memberof GetReceipt200ResponseReceipt */ 'amountTransferred'?: number; } /** * * @export * @interface GetReceipt200ResponseSupplier */ interface GetReceipt200ResponseSupplier { /** * * @type {string} * @memberof GetReceipt200ResponseSupplier */ 'supplierName'?: string; /** * * @type {string} * @memberof GetReceipt200ResponseSupplier */ 'vat'?: string; /** * * @type {string} * @memberof GetReceipt200ResponseSupplier */ 'servicePerformed'?: string; /** * * @type {string} * @memberof GetReceipt200ResponseSupplier */ 'addressLine1'?: string; /** * * @type {string} * @memberof GetReceipt200ResponseSupplier */ 'addressLine2'?: string; /** * * @type {string} * @memberof GetReceipt200ResponseSupplier */ 'city'?: string; /** * * @type {string} * @memberof GetReceipt200ResponseSupplier */ 'state'?: string; /** * * @type {string} * @memberof GetReceipt200ResponseSupplier */ 'zip'?: string; /** * * @type {string} * @memberof GetReceipt200ResponseSupplier */ 'country'?: string; } /** * * @export * @interface GetReceipts200Response */ interface GetReceipts200Response { /** * * @type {Array} * @memberof GetReceipts200Response */ 'items'?: Array; } /** * * @export * @interface GetReceipts200ResponseItemsInner */ interface GetReceipts200ResponseItemsInner { /** * * @type {string} * @memberof GetReceipts200ResponseItemsInner */ 'id'?: string; /** * * @type {string} * @memberof GetReceipts200ResponseItemsInner */ 'receiptNumber'?: string; /** * * @type {string} * @memberof GetReceipts200ResponseItemsInner */ 'timestamp'?: string; /** * * @type {string} * @memberof GetReceipts200ResponseItemsInner */ 'sender'?: string; /** * * @type {string} * @memberof GetReceipts200ResponseItemsInner */ 'payer'?: string; /** * * @type {string} * @memberof GetReceipts200ResponseItemsInner */ 'recipient'?: string; /** * * @type {string} * @memberof GetReceipts200ResponseItemsInner */ 'lockAddress'?: string; /** * * @type {string} * @memberof GetReceipts200ResponseItemsInner */ 'tokenAddress'?: string; /** * * @type {string} * @memberof GetReceipts200ResponseItemsInner */ 'gasTotal'?: string; /** * * @type {string} * @memberof GetReceipts200ResponseItemsInner */ 'amountTransferred'?: string; /** * * @type {number} * @memberof GetReceipts200ResponseItemsInner */ 'network'?: number; /** * * @type {string} * @memberof GetReceipts200ResponseItemsInner */ 'supplierAddress'?: string; } /** * * @export * @interface GetReceiptsBase200Response */ interface GetReceiptsBase200Response { /** * * @type {string} * @memberof GetReceiptsBase200Response */ 'supplierName'?: string; /** * * @type {string} * @memberof GetReceiptsBase200Response */ 'vat'?: string; /** * * @type {number} * @memberof GetReceiptsBase200Response */ 'vatBasisPointsRate'?: number; /** * * @type {string} * @memberof GetReceiptsBase200Response */ 'servicePerformed'?: string; /** * * @type {string} * @memberof GetReceiptsBase200Response */ 'addressLine1'?: string; /** * * @type {string} * @memberof GetReceiptsBase200Response */ 'addressLine2'?: string; /** * * @type {string} * @memberof GetReceiptsBase200Response */ 'city'?: string; /** * * @type {string} * @memberof GetReceiptsBase200Response */ 'state'?: string; /** * * @type {string} * @memberof GetReceiptsBase200Response */ 'zip'?: string; /** * * @type {string} * @memberof GetReceiptsBase200Response */ 'country'?: string; } /** * * @export * @interface GetReceiptsStatus200Response */ interface GetReceiptsStatus200Response { /** * * @type {Array} * @memberof GetReceiptsStatus200Response */ 'items'?: Array; } /** * * @export * @interface GetReceiptsStatus200ResponseItemsInner */ interface GetReceiptsStatus200ResponseItemsInner { /** * * @type {string} * @memberof GetReceiptsStatus200ResponseItemsInner */ 'id'?: string; /** * * @type {GetReceiptsStatus200ResponseItemsInnerPayload} * @memberof GetReceiptsStatus200ResponseItemsInner */ 'payload'?: GetReceiptsStatus200ResponseItemsInnerPayload; /** * * @type {string} * @memberof GetReceiptsStatus200ResponseItemsInner */ 'createdAt'?: string; /** * * @type {string} * @memberof GetReceiptsStatus200ResponseItemsInner */ 'updatedAt'?: string; } /** * * @export * @interface GetReceiptsStatus200ResponseItemsInnerPayload */ interface GetReceiptsStatus200ResponseItemsInnerPayload { /** * * @type {string} * @memberof GetReceiptsStatus200ResponseItemsInnerPayload */ 'status'?: GetReceiptsStatus200ResponseItemsInnerPayloadStatusEnum; /** * * @type {string} * @memberof GetReceiptsStatus200ResponseItemsInnerPayload */ 'key'?: string; /** * * @type {Array} * @memberof GetReceiptsStatus200ResponseItemsInnerPayload */ 'result'?: Array; } declare const GetReceiptsStatus200ResponseItemsInnerPayloadStatusEnum: { readonly Pending: "pending"; readonly Success: "success"; readonly Failed: "failed"; }; type GetReceiptsStatus200ResponseItemsInnerPayloadStatusEnum = typeof GetReceiptsStatus200ResponseItemsInnerPayloadStatusEnum[keyof typeof GetReceiptsStatus200ResponseItemsInnerPayloadStatusEnum]; /** * * @export * @interface GetStripeConnections200Response */ interface GetStripeConnections200Response { /** * * @type {Array} * @memberof GetStripeConnections200Response */ 'result'?: Array; /** * * @type {string} * @memberof GetStripeConnections200Response */ 'error'?: string | null; } /** * * @export * @interface GetSubscription200Response */ interface GetSubscription200Response { /** * * @type {Array} * @memberof GetSubscription200Response */ 'subscriptions'?: Array; } /** * * @export * @interface GetSubscription200ResponseSubscriptionsInner */ interface GetSubscription200ResponseSubscriptionsInner { /** * * @type {number} * @memberof GetSubscription200ResponseSubscriptionsInner */ 'next'?: number | null; /** * * @type {GetSubscription200ResponseSubscriptionsInnerBalance} * @memberof GetSubscription200ResponseSubscriptionsInner */ 'balance'?: GetSubscription200ResponseSubscriptionsInnerBalance; /** * * @type {GetSubscription200ResponseSubscriptionsInnerBalance} * @memberof GetSubscription200ResponseSubscriptionsInner */ 'price'?: GetSubscription200ResponseSubscriptionsInnerBalance; /** * Approved number of renewals by user. * @type {string} * @memberof GetSubscription200ResponseSubscriptionsInner */ 'approvedRenewals'?: string; /** * Possible number of renewals based on the user account balance. * @type {string} * @memberof GetSubscription200ResponseSubscriptionsInner */ 'possibleRenewals'?: string; /** * The type of payment method used for the subscription. * @type {string} * @memberof GetSubscription200ResponseSubscriptionsInner */ 'type'?: GetSubscription200ResponseSubscriptionsInnerTypeEnum; } declare const GetSubscription200ResponseSubscriptionsInnerTypeEnum: { readonly Crypto: "crypto"; readonly Fiat: "fiat"; }; type GetSubscription200ResponseSubscriptionsInnerTypeEnum = typeof GetSubscription200ResponseSubscriptionsInnerTypeEnum[keyof typeof GetSubscription200ResponseSubscriptionsInnerTypeEnum]; /** * * @export * @interface GetSubscription200ResponseSubscriptionsInnerBalance */ interface GetSubscription200ResponseSubscriptionsInnerBalance { /** * * @type {string} * @memberof GetSubscription200ResponseSubscriptionsInnerBalance */ 'symbol'?: string; /** * * @type {string} * @memberof GetSubscription200ResponseSubscriptionsInnerBalance */ 'amount'?: string; /** * * @type {number} * @memberof GetSubscription200ResponseSubscriptionsInnerBalance */ 'decimals'?: number; } /** * * @export * @interface GetUserAccountType200Response */ interface GetUserAccountType200Response { /** * * @type {Array} * @memberof GetUserAccountType200Response */ 'userAccountType'?: Array; } declare const GetUserAccountType200ResponseUserAccountTypeEnum: { readonly UnlockAccount: "UNLOCK_ACCOUNT"; readonly GoogleAccount: "GOOGLE_ACCOUNT"; readonly PasskeyAccount: "PASSKEY_ACCOUNT"; readonly EmailCode: "EMAIL_CODE"; }; type GetUserAccountType200ResponseUserAccountTypeEnum = typeof GetUserAccountType200ResponseUserAccountTypeEnum[keyof typeof GetUserAccountType200ResponseUserAccountTypeEnum]; /** * * @export * @interface GetUserPrivateKey200Response */ interface GetUserPrivateKey200Response { /** * * @type {string} * @memberof GetUserPrivateKey200Response */ 'passwordEncryptedPrivateKey'?: string; } /** * * @export * @interface GetUserRecoveryPhrase200Response */ interface GetUserRecoveryPhrase200Response { /** * * @type {string} * @memberof GetUserRecoveryPhrase200Response */ 'emailAddress'?: string; /** * * @type {string} * @memberof GetUserRecoveryPhrase200Response */ 'recoveryPhrase'?: string; } /** * * @export * @interface GetWaasToken400Response */ interface GetWaasToken400Response { /** * * @type {string} * @memberof GetWaasToken400Response */ 'error'?: string; } /** * * @export * @interface GetWaasTokenRequest */ interface GetWaasTokenRequest { /** * * @type {string} * @memberof GetWaasTokenRequest */ 'token'?: string; } /** * * @export * @interface IsCardPaymentEnabledForLock200Response */ interface IsCardPaymentEnabledForLock200Response { /** * * @type {boolean} * @memberof IsCardPaymentEnabledForLock200Response */ 'creditCardEnabled'?: boolean; } /** * * @export * @interface Key */ interface Key$1 { /** * * @type {string} * @memberof Key */ 'token'?: string; /** * * @type {string} * @memberof Key */ 'lockName'?: string; /** * * @type {string} * @memberof Key */ 'expiration'?: string; /** * * @type {string} * @memberof Key */ 'keyholderAddress'?: string; /** * * @type {string} * @memberof Key */ 'keyManager'?: string; /** * * @type {string} * @memberof Key */ 'lockAddress'?: string; /** * * @type {Array} * @memberof Key */ 'transactionsHash'?: Array; /** * * @type {string} * @memberof Key */ 'email'?: string; } /** * * @export * @interface KeyMetadata */ interface KeyMetadata { /** * * @type {string} * @memberof KeyMetadata */ 'token'?: string; /** * * @type {string} * @memberof KeyMetadata */ 'lockName'?: string; /** * * @type {string} * @memberof KeyMetadata */ 'lockAddress'?: string; /** * * @type {number} * @memberof KeyMetadata */ 'expiration'?: number; /** * * @type {string} * @memberof KeyMetadata */ 'keyHolderAddress'?: string; } /** * * @export * @interface KeyMetadata200Response */ interface KeyMetadata200Response { [key: string]: any; /** * * @type {string} * @memberof KeyMetadata200Response */ 'keyId'?: string; /** * * @type {string} * @memberof KeyMetadata200Response */ 'lockAddress'?: string; /** * * @type {number} * @memberof KeyMetadata200Response */ 'network'?: number; } /** * * @export * @interface KeysByPage200Response */ interface KeysByPage200Response { /** * * @type {KeysByPage200ResponseMeta} * @memberof KeysByPage200Response */ 'meta'?: KeysByPage200ResponseMeta; /** * * @type {Array} * @memberof KeysByPage200Response */ 'keys'?: Array; } /** * * @export * @interface KeysByPage200ResponseMeta */ interface KeysByPage200ResponseMeta { /** * * @type {number} * @memberof KeysByPage200ResponseMeta */ 'total'?: number; /** * * @type {number} * @memberof KeysByPage200ResponseMeta */ 'page'?: number; /** * * @type {number} * @memberof KeysByPage200ResponseMeta */ 'byPage'?: number; } /** * * @export * @interface ListCheckoutConfigs200Response */ interface ListCheckoutConfigs200Response { /** * * @type {Array} * @memberof ListCheckoutConfigs200Response */ 'results'?: Array; } /** * * @export * @interface ListPaymentMethods200Response */ interface ListPaymentMethods200Response { /** * * @type {Array} * @memberof ListPaymentMethods200Response */ 'methods'?: Array; } /** * * @export * @interface LockContractOptions */ interface LockContractOptions { /** * * @type {string} * @memberof LockContractOptions */ 'name'?: string; /** * * @type {string} * @memberof LockContractOptions */ 'expirationDuration'?: string | null; /** * * @type {string} * @memberof LockContractOptions */ 'maxNumberOfKeys'?: string | null; /** * * @type {string} * @memberof LockContractOptions */ 'keyPrice'?: string; /** * * @type {string} * @memberof LockContractOptions */ 'creator'?: string | null; /** * * @type {string} * @memberof LockContractOptions */ 'currencyContractAddress'?: string | null; /** * * @type {number} * @memberof LockContractOptions */ 'publicLockVersion'?: number | null; } /** * * @export * @interface LockSettings */ interface LockSettings { /** * * @type {string} * @memberof LockSettings */ 'lockAddress'?: string; /** * * @type {number} * @memberof LockSettings */ 'network'?: number; /** * * @type {boolean} * @memberof LockSettings */ 'sendEmail'?: boolean; /** * * @type {string} * @memberof LockSettings */ 'slug'?: string; /** * * @type {string} * @memberof LockSettings */ 'replyTo'?: string | null; /** * * @type {number} * @memberof LockSettings */ 'creditCardPrice'?: number | null; /** * * @type {string} * @memberof LockSettings */ 'emailSender'?: string | null; /** * * @type {string} * @memberof LockSettings */ 'checkoutConfigId'?: string | null; /** * * @type {string} * @memberof LockSettings */ 'hookGuildId'?: string | null; /** * * @type {boolean} * @memberof LockSettings */ 'unlockFeeChargedToUser'?: boolean; /** * * @type {string} * @memberof LockSettings */ 'creditCardCurrency'?: string; /** * * @type {string} * @memberof LockSettings */ 'crossmintClientId'?: string | null; /** * * @type {Array} * @memberof LockSettings */ 'promoCodes'?: Array; /** * * @type {Array} * @memberof LockSettings */ 'passwords'?: Array; /** * * @type {number} * @memberof LockSettings */ 'requiredGitcoinPassportScore'?: number | null; /** * * @type {Array} * @memberof LockSettings */ 'allowList'?: Array | null; } /** * * @export * @interface LoginRequest */ interface LoginRequest { /** * * @type {string} * @memberof LoginRequest */ 'message'?: string; /** * * @type {string} * @memberof LoginRequest */ 'signature'?: string; } /** * * @export * @interface LoginWithPrivyRequest */ interface LoginWithPrivyRequest { /** * The Privy access token to verify * @type {string} * @memberof LoginWithPrivyRequest */ 'accessToken': string; /** * The wallet address from the user * @type {string} * @memberof LoginWithPrivyRequest */ 'walletAddress': string; } /** * * @export * @interface NotAuthenticated */ interface NotAuthenticated { /** * * @type {string} * @memberof NotAuthenticated */ 'message'?: string; } /** * * @export * @interface PaymentMethod */ interface PaymentMethod { /** * * @type {string} * @memberof PaymentMethod */ 'id'?: string; /** * * @type {string} * @memberof PaymentMethod */ 'object'?: string; /** * * @type {PaymentMethodBillingDetails} * @memberof PaymentMethod */ 'billing_details'?: PaymentMethodBillingDetails; /** * * @type {PaymentMethodCard} * @memberof PaymentMethod */ 'card'?: PaymentMethodCard; /** * * @type {number} * @memberof PaymentMethod */ 'created'?: number; /** * * @type {string} * @memberof PaymentMethod */ 'customer'?: string; /** * * @type {boolean} * @memberof PaymentMethod */ 'livemode'?: boolean; /** * * @type {{ [key: string]: any; }} * @memberof PaymentMethod */ 'metadata'?: { [key: string]: any; }; /** * * @type {string} * @memberof PaymentMethod */ 'type'?: string; } /** * * @export * @interface PaymentMethodBillingDetails */ interface PaymentMethodBillingDetails { /** * * @type {PaymentMethodBillingDetailsAddress} * @memberof PaymentMethodBillingDetails */ 'address'?: PaymentMethodBillingDetailsAddress; /** * * @type {string} * @memberof PaymentMethodBillingDetails */ 'email'?: string; /** * * @type {string} * @memberof PaymentMethodBillingDetails */ 'name'?: string; /** * * @type {string} * @memberof PaymentMethodBillingDetails */ 'phone'?: string; } /** * * @export * @interface PaymentMethodBillingDetailsAddress */ interface PaymentMethodBillingDetailsAddress { /** * * @type {string} * @memberof PaymentMethodBillingDetailsAddress */ 'city'?: string; /** * * @type {string} * @memberof PaymentMethodBillingDetailsAddress */ 'country'?: string; /** * * @type {string} * @memberof PaymentMethodBillingDetailsAddress */ 'line1'?: string; /** * * @type {string} * @memberof PaymentMethodBillingDetailsAddress */ 'line2'?: string; /** * * @type {string} * @memberof PaymentMethodBillingDetailsAddress */ 'postal_code'?: string; /** * * @type {string} * @memberof PaymentMethodBillingDetailsAddress */ 'state'?: string; } /** * * @export * @interface PaymentMethodCard */ interface PaymentMethodCard { /** * * @type {string} * @memberof PaymentMethodCard */ 'brand'?: string; /** * * @type {PaymentMethodCardChecks} * @memberof PaymentMethodCard */ 'checks'?: PaymentMethodCardChecks; /** * * @type {string} * @memberof PaymentMethodCard */ 'country'?: string; /** * * @type {number} * @memberof PaymentMethodCard */ 'exp_month'?: number; /** * * @type {number} * @memberof PaymentMethodCard */ 'exp_year'?: number; /** * * @type {string} * @memberof PaymentMethodCard */ 'fingerprint'?: string; /** * * @type {string} * @memberof PaymentMethodCard */ 'funding'?: string; /** * * @type {string} * @memberof PaymentMethodCard */ 'generated_from'?: string; /** * * @type {string} * @memberof PaymentMethodCard */ 'last4'?: string; /** * * @type {PaymentMethodCardNetworks} * @memberof PaymentMethodCard */ 'networks'?: PaymentMethodCardNetworks; /** * * @type {PaymentMethodCardThreeDSecureUsage} * @memberof PaymentMethodCard */ 'three_d_secure_usage'?: PaymentMethodCardThreeDSecureUsage; /** * * @type {string} * @memberof PaymentMethodCard */ 'wallet'?: string; } /** * * @export * @interface PaymentMethodCardChecks */ interface PaymentMethodCardChecks { /** * * @type {string} * @memberof PaymentMethodCardChecks */ 'address_line1_check'?: string; /** * * @type {string} * @memberof PaymentMethodCardChecks */ 'address_postal_code_check'?: string; /** * * @type {string} * @memberof PaymentMethodCardChecks */ 'cvc_check'?: string; } /** * * @export * @interface PaymentMethodCardNetworks */ interface PaymentMethodCardNetworks { /** * * @type {Array} * @memberof PaymentMethodCardNetworks */ 'available'?: Array; /** * * @type {string} * @memberof PaymentMethodCardNetworks */ 'preferred'?: string; } /** * * @export * @interface PaymentMethodCardThreeDSecureUsage */ interface PaymentMethodCardThreeDSecureUsage { /** * * @type {boolean} * @memberof PaymentMethodCardThreeDSecureUsage */ 'supported'?: boolean; } /** * * @export * @interface Price200Response */ interface Price200Response { /** * * @type {Price200ResponseResult} * @memberof Price200Response */ 'result'?: Price200ResponseResult; } /** * * @export * @interface Price200ResponseResult */ interface Price200ResponseResult { /** * * @type {number} * @memberof Price200ResponseResult */ 'decimals'?: number | null; /** * * @type {number} * @memberof Price200ResponseResult */ 'price'?: number; /** * * @type {number} * @memberof Price200ResponseResult */ 'timestamp'?: number; /** * * @type {string} * @memberof Price200ResponseResult */ 'symbol'?: string; /** * * @type {number} * @memberof Price200ResponseResult */ 'confidence'?: number; /** * * @type {number} * @memberof Price200ResponseResult */ 'priceInAmount'?: number | null; } /** * @type PrivyUserCheckBody * @export */ type PrivyUserCheckBody = any; /** * * @export * @interface PrivyUserResponse */ interface PrivyUserResponse { /** * Whether the user exists in Privy * @type {boolean} * @memberof PrivyUserResponse */ 'exists': boolean; /** * * @type {PrivyUserResponseUser} * @memberof PrivyUserResponse */ 'user': PrivyUserResponseUser | null; } /** * * @export * @interface PrivyUserResponseUser */ interface PrivyUserResponseUser { /** * * @type {string} * @memberof PrivyUserResponseUser */ 'id'?: string; /** * * @type {string} * @memberof PrivyUserResponseUser */ 'createdAt'?: string; /** * * @type {boolean} * @memberof PrivyUserResponseUser */ 'isGuest'?: boolean; /** * * @type {object} * @memberof PrivyUserResponseUser */ 'customMetadata'?: object; /** * * @type {Array} * @memberof PrivyUserResponseUser */ 'linkedAccounts'?: Array; /** * * @type {PrivyUserResponseUserEmail} * @memberof PrivyUserResponseUser */ 'email'?: PrivyUserResponseUserEmail; /** * * @type {PrivyUserResponseUserWallet} * @memberof PrivyUserResponseUser */ 'wallet'?: PrivyUserResponseUserWallet; } /** * * @export * @interface PrivyUserResponseUserEmail */ interface PrivyUserResponseUserEmail { /** * * @type {string} * @memberof PrivyUserResponseUserEmail */ 'address'?: string; /** * * @type {string} * @memberof PrivyUserResponseUserEmail */ 'verifiedAt'?: string; /** * * @type {string} * @memberof PrivyUserResponseUserEmail */ 'firstVerifiedAt'?: string; /** * * @type {string} * @memberof PrivyUserResponseUserEmail */ 'latestVerifiedAt'?: string; } /** * * @export * @interface PrivyUserResponseUserWallet */ interface PrivyUserResponseUserWallet { /** * * @type {string} * @memberof PrivyUserResponseUserWallet */ 'address'?: string; /** * * @type {string} * @memberof PrivyUserResponseUserWallet */ 'chainType'?: string; /** * * @type {string} * @memberof PrivyUserResponseUserWallet */ 'verifiedAt'?: string; /** * * @type {string} * @memberof PrivyUserResponseUserWallet */ 'firstVerifiedAt'?: string; /** * * @type {string} * @memberof PrivyUserResponseUserWallet */ 'latestVerifiedAt'?: string; } /** * * @export * @interface Purchase200Response */ interface Purchase200Response { /** * * @type {string} * @memberof Purchase200Response */ 'clientSecret'?: string; /** * * @type {string} * @memberof Purchase200Response */ 'stripeAccount'?: string; /** * * @type {number} * @memberof Purchase200Response */ 'totalPriceInDents'?: number; /** * * @type {Purchase200ResponsePricing} * @memberof Purchase200Response */ 'pricing'?: Purchase200ResponsePricing | null; } /** * * @export * @interface Purchase200ResponsePricing */ interface Purchase200ResponsePricing { /** * * @type {number} * @memberof Purchase200ResponsePricing */ 'keyPrice'?: number | null; /** * * @type {number} * @memberof Purchase200ResponsePricing */ 'unlockServiceFee'?: number | null; /** * * @type {number} * @memberof Purchase200ResponsePricing */ 'creditCardProcessing'?: number | null; } /** * * @export * @interface PurchaseRequest */ interface PurchaseRequest { /** * * @type {Array} * @memberof PurchaseRequest */ 'recipients': Array; /** * * @type {string} * @memberof PurchaseRequest */ 'stripeTokenId': string; /** * * @type {number} * @memberof PurchaseRequest */ 'pricing': number; /** * * @type {number} * @memberof PurchaseRequest */ 'recurring'?: number | null; /** * * @type {Array} * @memberof PurchaseRequest */ 'data'?: Array; /** * * @type {Array} * @memberof PurchaseRequest */ 'referrers'?: Array; } /** * * @export * @interface RemoveEventBody */ interface RemoveEventBody { /** * Slug of the event to remove. * @type {string} * @memberof RemoveEventBody */ 'eventSlug': string; } /** * * @export * @interface RemoveManagerBody */ interface RemoveManagerBody { /** * * @type {string} * @memberof RemoveManagerBody */ 'managerAddressToRemove': string; } /** * * @export * @interface RemovePaymentMethods200Response */ interface RemovePaymentMethods200Response { /** * * @type {boolean} * @memberof RemovePaymentMethods200Response */ 'success'?: boolean; } /** * * @export * @interface Rsvp */ interface Rsvp { /** * * @type {string} * @memberof Rsvp */ 'lockAddress'?: string; /** * * @type {string} * @memberof Rsvp */ 'userAddress'?: string; /** * * @type {string} * @memberof Rsvp */ 'approval'?: string; /** * * @type {number} * @memberof Rsvp */ 'network'?: number; } /** * * @export * @interface RsvpRequest */ interface RsvpRequest { /** * * @type {string} * @memberof RsvpRequest */ 'recipient'?: string; /** * * @type {string} * @memberof RsvpRequest */ 'email'?: string; /** * * @type {{ [key: string]: any; }} * @memberof RsvpRequest */ 'data'?: { [key: string]: any; }; } /** * * @export * @interface SaveEventDataRequest */ interface SaveEventDataRequest { /** * * @type {{ [key: string]: any; }} * @memberof SaveEventDataRequest */ 'data'?: { [key: string]: any; }; /** * * @type {string} * @memberof SaveEventDataRequest */ 'status'?: SaveEventDataRequestStatusEnum; /** * * @type {string} * @memberof SaveEventDataRequest */ 'transactionHash'?: string; /** * * @type {CheckoutConfig} * @memberof SaveEventDataRequest */ 'checkoutConfig'?: CheckoutConfig; } declare const SaveEventDataRequestStatusEnum: { readonly Pending: "pending"; readonly Deployed: "deployed"; }; type SaveEventDataRequestStatusEnum = typeof SaveEventDataRequestStatusEnum[keyof typeof SaveEventDataRequestStatusEnum]; /** * * @export * @interface SaveLockSetting200Response */ interface SaveLockSetting200Response { /** * * @type {boolean} * @memberof SaveLockSetting200Response */ 'sendEmail'?: boolean; } /** * * @export * @interface SaveMerkleTree200Response */ interface SaveMerkleTree200Response { /** * The merkle tree root hash * @type {string} * @memberof SaveMerkleTree200Response */ 'root': string; } /** * * @export * @interface SaveMerkleTree400Response */ interface SaveMerkleTree400Response { /** * * @type {SaveMerkleTree400ResponseError} * @memberof SaveMerkleTree400Response */ 'error': SaveMerkleTree400ResponseError; } /** * * @export * @interface SaveMerkleTree400ResponseError */ interface SaveMerkleTree400ResponseError { /** * * @type {Array} * @memberof SaveMerkleTree400ResponseError */ 'issues': Array; } /** * * @export * @interface SaveMerkleTree400ResponseErrorIssuesInner */ interface SaveMerkleTree400ResponseErrorIssuesInner { /** * * @type {string} * @memberof SaveMerkleTree400ResponseErrorIssuesInner */ 'code'?: string; /** * * @type {string} * @memberof SaveMerkleTree400ResponseErrorIssuesInner */ 'message'?: string; /** * * @type {Array} * @memberof SaveMerkleTree400ResponseErrorIssuesInner */ 'path'?: Array; } /** * @type SaveMerkleTreeRequestInner * @export */ type SaveMerkleTreeRequestInner = Array | string; /** * @type SaveMerkleTreeRequestInnerOneOfInner * @export */ type SaveMerkleTreeRequestInnerOneOfInner = SaveMerkleTreeRequestInnerOneOfInnerOneOf | string; /** * * @export * @interface SaveMerkleTreeRequestInnerOneOfInnerOneOf */ interface SaveMerkleTreeRequestInnerOneOfInnerOneOf { /** * * @type {SaveMerkleTreeRequestInnerOneOfInnerOneOfAmount} * @memberof SaveMerkleTreeRequestInnerOneOfInnerOneOf */ 'amount'?: SaveMerkleTreeRequestInnerOneOfInnerOneOfAmount; } /** * @type SaveMerkleTreeRequestInnerOneOfInnerOneOfAmount * @export */ type SaveMerkleTreeRequestInnerOneOfInnerOneOfAmount = number | string; /** * * @export * @interface SaveReceipt200Response */ interface SaveReceipt200Response { /** * * @type {string} * @memberof SaveReceipt200Response */ 'fullname'?: string; /** * * @type {string} * @memberof SaveReceipt200Response */ 'businessName'?: string; /** * * @type {string} * @memberof SaveReceipt200Response */ 'addressLine1'?: string; /** * * @type {string} * @memberof SaveReceipt200Response */ 'addressLine2'?: string; /** * * @type {string} * @memberof SaveReceipt200Response */ 'city'?: string; /** * * @type {string} * @memberof SaveReceipt200Response */ 'state'?: string; /** * * @type {string} * @memberof SaveReceipt200Response */ 'zip'?: string; /** * * @type {string} * @memberof SaveReceipt200Response */ 'country'?: string; } /** * * @export * @interface SendCustomEmail200Response */ interface SendCustomEmail200Response { /** * * @type {boolean} * @memberof SendCustomEmail200Response */ 'sent'?: boolean; } /** * * @export * @interface SendCustomEmailRequest */ interface SendCustomEmailRequest { /** * * @type {string} * @memberof SendCustomEmailRequest */ 'subject'?: string; /** * * @type {string} * @memberof SendCustomEmailRequest */ 'content'?: string; } /** * * @export * @interface SendEventInvitesRequest */ interface SendEventInvitesRequest { /** * * @type {Array} * @memberof SendEventInvitesRequest */ 'recipients'?: Array; } /** * * @export * @interface SendVerificationCode200Response */ interface SendVerificationCode200Response { /** * * @type {string} * @memberof SendVerificationCode200Response */ 'message'?: string; } /** * * @export * @interface SetupPayment200Response */ interface SetupPayment200Response { /** * * @type {string} * @memberof SetupPayment200Response */ 'clientSecret'?: string; } /** * * @export * @interface SignTicket200Response */ interface SignTicket200Response { /** * * @type {string} * @memberof SignTicket200Response */ 'payload'?: string; /** * * @type {string} * @memberof SignTicket200Response */ 'signature'?: string; } /** * * @export * @interface TicketVerificationUrl200Response */ interface TicketVerificationUrl200Response { /** * * @type {string} * @memberof TicketVerificationUrl200Response */ 'verificationUrl'?: string; } /** * * @export * @interface TransferDoneRequest */ interface TransferDoneRequest { /** * The signature of the transfer code sent to the recipient. * @type {string} * @memberof TransferDoneRequest */ 'transferSignature': string; /** * * @type {string} * @memberof TransferDoneRequest */ 'owner': string; /** * * @type {string} * @memberof TransferDoneRequest */ 'lock': string; /** * * @type {string} * @memberof TransferDoneRequest */ 'token': string; /** * * @type {number} * @memberof TransferDoneRequest */ 'network': number; /** * * @type {number} * @memberof TransferDoneRequest */ 'deadline': number; } /** * * @export * @interface UpdateCheckoutConfigRequest */ interface UpdateCheckoutConfigRequest { /** * * @type {string} * @memberof UpdateCheckoutConfigRequest */ 'name': string; /** * * @type {{ [key: string]: any; }} * @memberof UpdateCheckoutConfigRequest */ 'config': { [key: string]: any; }; } /** * * @export * @interface UpdateEventData200Response */ interface UpdateEventData200Response { /** * * @type {string} * @memberof UpdateEventData200Response */ 'slug'?: string; /** * * @type {string} * @memberof UpdateEventData200Response */ 'status'?: string; /** * * @type {string} * @memberof UpdateEventData200Response */ 'transactionHash'?: string; } /** * * @export * @interface UpdateEventDataRequest */ interface UpdateEventDataRequest { /** * * @type {string} * @memberof UpdateEventDataRequest */ 'status'?: UpdateEventDataRequestStatusEnum; /** * * @type {string} * @memberof UpdateEventDataRequest */ 'transactionHash'?: string; /** * * @type {CheckoutConfig} * @memberof UpdateEventDataRequest */ 'checkoutConfig'?: CheckoutConfig; } declare const UpdateEventDataRequestStatusEnum: { readonly Pending: "pending"; readonly Deployed: "deployed"; }; type UpdateEventDataRequestStatusEnum = typeof UpdateEventDataRequestStatusEnum[keyof typeof UpdateEventDataRequestStatusEnum]; /** * JSON metadata inside metadata field will be saved. * @export * @interface UpdateLockMetadataRequest */ interface UpdateLockMetadataRequest { /** * * @type {{ [key: string]: any; }} * @memberof UpdateLockMetadataRequest */ 'metadata'?: { [key: string]: any; }; } /** * * @export * @interface UpdateUserEncryptedPrivateKey200Response */ interface UpdateUserEncryptedPrivateKey200Response { /** * * @type {string} * @memberof UpdateUserEncryptedPrivateKey200Response */ 'emailAddress'?: string; /** * * @type {string} * @memberof UpdateUserEncryptedPrivateKey200Response */ 'user'?: string; } /** * * @export * @interface UpdateUserEncryptedPrivateKeyRequest */ interface UpdateUserEncryptedPrivateKeyRequest { /** * * @type {string} * @memberof UpdateUserEncryptedPrivateKeyRequest */ 'user'?: string; /** * * @type {string} * @memberof UpdateUserEncryptedPrivateKeyRequest */ 'token'?: string; } /** * * @export * @interface UpdateUserMetadataRequest */ interface UpdateUserMetadataRequest { /** * * @type {UserMetadataInput} * @memberof UpdateUserMetadataRequest */ 'metadata'?: UserMetadataInput; } /** * * @export * @interface UpdateUsersMetadata201Response */ interface UpdateUsersMetadata201Response { /** * * @type {Array} * @memberof UpdateUsersMetadata201Response */ 'result'?: Array; /** * Array containing user addresses for which metadata was not created. * @type {Array} * @memberof UpdateUsersMetadata201Response */ 'error'?: Array; } /** * * @export * @interface UpdateUsersMetadataRequest */ interface UpdateUsersMetadataRequest { /** * * @type {Array} * @memberof UpdateUsersMetadataRequest */ 'users'?: Array; } /** * * @export * @interface UploadImages201Response */ interface UploadImages201Response { /** * * @type {Array} * @memberof UploadImages201Response */ 'results'?: Array; } /** * * @export * @interface UploadImages201ResponseResultsInner */ interface UploadImages201ResponseResultsInner { /** * * @type {string} * @memberof UploadImages201ResponseResultsInner */ 'url'?: string; /** * * @type {string} * @memberof UploadImages201ResponseResultsInner */ 'publicUrl'?: string; /** * * @type {string} * @memberof UploadImages201ResponseResultsInner */ 'originamName'?: string; /** * * @type {string} * @memberof UploadImages201ResponseResultsInner */ 'mimetype'?: string; /** * * @type {string} * @memberof UploadImages201ResponseResultsInner */ 'contentType'?: string; /** * * @type {number} * @memberof UploadImages201ResponseResultsInner */ 'size'?: number; /** * * @type {string} * @memberof UploadImages201ResponseResultsInner */ 'key'?: string; /** * * @type {UploadImages201ResponseResultsInnerMetadata} * @memberof UploadImages201ResponseResultsInner */ 'metadata'?: UploadImages201ResponseResultsInnerMetadata; /** * * @type {string} * @memberof UploadImages201ResponseResultsInner */ 'encoding'?: string; } /** * * @export * @interface UploadImages201ResponseResultsInnerMetadata */ interface UploadImages201ResponseResultsInnerMetadata { /** * * @type {string} * @memberof UploadImages201ResponseResultsInnerMetadata */ 'fieldName'?: string; /** * * @type {string} * @memberof UploadImages201ResponseResultsInnerMetadata */ 'createdBy'?: string; } /** * * @export * @interface UserMetadata */ interface UserMetadata { /** * * @type {number} * @memberof UserMetadata */ 'network': number; /** * * @type {string} * @memberof UserMetadata */ 'lockAddress': string; /** * * @type {string} * @memberof UserMetadata */ 'userAddress': string; /** * * @type {UserMetadataInput} * @memberof UserMetadata */ 'metadata': UserMetadataInput; } /** * * @export * @interface UserMetadataInput */ interface UserMetadataInput { /** * * @type {{ [key: string]: any; }} * @memberof UserMetadataInput */ 'public'?: { [key: string]: any; } | null; /** * * @type {{ [key: string]: any; }} * @memberof UserMetadataInput */ 'protected'?: { [key: string]: any; } | null; } /** * * @export * @interface Verifier */ interface Verifier { /** * * @type {string} * @memberof Verifier */ 'address': string; /** * * @type {string} * @memberof Verifier */ 'lockAddress'?: string; /** * * @type {string} * @memberof Verifier */ 'lockManager'?: string; /** * * @type {number} * @memberof Verifier */ 'network'?: number; /** * * @type {string} * @memberof Verifier */ 'name'?: string | null; } /** * * @export * @interface Verifier200Response */ interface Verifier200Response { /** * * @type {boolean} * @memberof Verifier200Response */ 'enabled'?: boolean; } /** * * @export * @interface Verifiers200Response */ interface Verifiers200Response { /** * * @type {Array} * @memberof Verifiers200Response */ 'results'?: Array; } /** * * @export * @interface VerifyEmailCode200Response */ interface VerifyEmailCode200Response { /** * * @type {string} * @memberof VerifyEmailCode200Response */ 'message'?: string; /** * * @type {string} * @memberof VerifyEmailCode200Response */ 'token'?: string; } /** * * @export * @interface VerifyEmailCodeRequest */ interface VerifyEmailCodeRequest { /** * * @type {string} * @memberof VerifyEmailCodeRequest */ 'code'?: string; } /** * DefaultApi - axios parameter creator * @export */ declare const DefaultApiAxiosParamCreator: (configuration?: Configuration) => { /** * Add an event to a collection * @param {string} slug * @param {AddEventToCollectionBody} addEventToCollectionBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ addEventToCollection: (slug: string, addEventToCollectionBody: AddEventToCollectionBody, options?: AxiosRequestConfig) => Promise; /** * Adds a verifier for an event. * @param {string} slug Slug * @param {string} verifierAddress User address to use as verifier * @param {CreateVerifierRequest} [createVerifierRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addEventVerifier: (slug: string, verifierAddress: string, createVerifierRequest?: CreateVerifierRequest, options?: AxiosRequestConfig) => Promise; /** * Add a new manager address to an event collection * @param {string} slug * @param {AddManagerBody} addManagerBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ addManagerToEventCollection: (slug: string, addManagerBody: AddManagerBody, options?: AxiosRequestConfig) => Promise; /** * List applications created the user. * @param {*} [options] Override http request option. * @throws {RequiredError} */ applications: (options?: AxiosRequestConfig) => Promise; /** * Approves users to attend an event. (does not airdrop!) * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {ApproveAttendeesRsvpRequest} approveAttendeesRsvpRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ approveAttendeesRsvp: (network: number, lockAddress: string, approveAttendeesRsvpRequest: ApproveAttendeesRsvpRequest, options?: AxiosRequestConfig) => Promise; /** * Approve a single event within an event collection. * @param {string} slug Slug of the event collection. * @param {ApproveEventBody} approveEventBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ approveEvent: (slug: string, approveEventBody: ApproveEventBody, options?: AxiosRequestConfig) => Promise; /** * Approves refunds for an event. * @param {string} slug Slug * @param {ApproveRefundsRequest} approveRefundsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ approveRefunds: (slug: string, approveRefundsRequest: ApproveRefundsRequest, options?: AxiosRequestConfig) => Promise; /** * Approves a user to attend an event. (does not airdrop!) * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} userAddress User address. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ approveRsvp: (network: number, lockAddress: string, userAddress: string, options?: AxiosRequestConfig) => Promise; /** * Returns the merkle proof of an approved refund. * @param {string} slug Slug * @param {*} [options] Override http request option. * @throws {RequiredError} */ approvedRefunds: (slug: string, options?: AxiosRequestConfig) => Promise; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ balance: (options?: AxiosRequestConfig) => Promise; /** * Bulk approve multiple events within an event collection. * @param {string} slug Slug of the event collection. * @param {BulkApproveEventsBody} bulkApproveEventsBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ bulkApproveEvents: (slug: string, bulkApproveEventsBody: BulkApproveEventsBody, options?: AxiosRequestConfig) => Promise; /** * Bulk remove multiple events from an event collection. * @param {string} slug Slug of the event collection. * @param {BulkRemoveEventsBody} bulkRemoveEventsBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ bulkRemoveEvents: (slug: string, bulkRemoveEventsBody: BulkRemoveEventsBody, options?: AxiosRequestConfig) => Promise; /** * Cancel a fiat subscription. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelSubscription: (network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig) => Promise; /** * Capture a purchase * @param {CapturePurchaseRequest} [capturePurchaseRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ capturePurchase: (capturePurchaseRequest?: CapturePurchaseRequest, options?: AxiosRequestConfig) => Promise; /** * Check if claim is possible for a given purchase * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {CheckClaimRequest} [checkClaimRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ checkClaim: (network: number, lockAddress: string, checkClaimRequest?: CheckClaimRequest, options?: AxiosRequestConfig) => Promise; /** * Mark an event ticket as checked in. * @param {string} slug Slug * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ checkEventTicket: (slug: string, network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig) => Promise; /** * Check if a user exists in Privy by email or wallet address * @param {PrivyUserCheckBody} privyUserCheckBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ checkPrivyUser: (privyUserCheckBody: PrivyUserCheckBody, options?: AxiosRequestConfig) => Promise; /** * Mark a lock ticket as checked in. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ checkTicket: (network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig) => Promise; /** * Claim a membership key for a lock. If not authenticated, requires an email in the body. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} captcha Recaptcha value to pass. * @param {ClaimRequest} claimRequest * @param {string} [recipient] Recipient address for key * @param {*} [options] Override http request option. * @throws {RequiredError} */ claim: (network: number, lockAddress: string, captcha: string, claimRequest: ClaimRequest, recipient?: string, options?: AxiosRequestConfig) => Promise; /** * Connect a stripe account to a lock * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {ConnectStripeAccountRequest} [connectStripeAccountRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ connectStripeAccount: (network: number, lockAddress: string, connectStripeAccountRequest?: ConnectStripeAccountRequest, options?: AxiosRequestConfig) => Promise; /** * Create application associated with user wallet. * @param {ApplicationBody} applicationBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ createApplication: (applicationBody: ApplicationBody, options?: AxiosRequestConfig) => Promise; /** * Request the creation of a ZIP file containing all receipts for a lock. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDownloadReceiptsRequest: (network: number, lockAddress: string, options?: AxiosRequestConfig) => Promise; /** * Create a new event collection * @param {EventCollectionBody} eventCollectionBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ createEventCollection: (eventCollectionBody: EventCollectionBody, options?: AxiosRequestConfig) => Promise; /** * * @param {number} network Network id. * @param {string} captcha Recaptcha value to pass. * @param {LockContractOptions} lockContractOptions * @param {*} [options] Override http request option. * @throws {RequiredError} */ createLockContract: (network: number, captcha: string, lockContractOptions: LockContractOptions, options?: AxiosRequestConfig) => Promise; /** * Create a transfer code to transfer an airdropped key to an email address. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTransferCode: (network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig) => Promise; /** * Create verifier. (deprecated in favor of addEventVerifier) * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} verifierAddress User address to use as verifier * @param {CreateVerifierRequest} [createVerifierRequest] * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ createVerifier: (network: number, lockAddress: string, verifierAddress: string, createVerifierRequest?: CreateVerifierRequest, options?: AxiosRequestConfig) => Promise; /** * Delete application by id. * @param {string} id Application id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteApplication: (id: string, options?: AxiosRequestConfig) => Promise; /** * Delete a checkout config * @param {string} id The id of the checkout config * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteCheckoutConfig: (id: string, options?: AxiosRequestConfig) => Promise; /** * Removes a verifier for an event. * @param {string} slug Slug * @param {string} verifierAddress User address to use as verifier * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteEventVerifier: (slug: string, verifierAddress: string, options?: AxiosRequestConfig) => Promise; /** * Remove verifier. (deprecated in favor of deleteEventVerifier) * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} verifierAddress User address to use as verifier * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ deleteVerifier: (network: number, lockAddress: string, verifierAddress: string, options?: AxiosRequestConfig) => Promise; /** * Denies users to attend an event. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {ApproveAttendeesRsvpRequest} approveAttendeesRsvpRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ denyAttendeesRsvp: (network: number, lockAddress: string, approveAttendeesRsvpRequest: ApproveAttendeesRsvpRequest, options?: AxiosRequestConfig) => Promise; /** * Denies a user to attend an event. (does not airdrop!) * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} userAddress User address. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ denyRsvp: (network: number, lockAddress: string, userAddress: string, options?: AxiosRequestConfig) => Promise; /** * Disconnect stripe account. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ disconnectStripe: (network: number, lockAddress: string, options?: AxiosRequestConfig) => Promise; /** * Download the ZIP file containing all receipts for a lock. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ downloadReceipts: (network: number, lockAddress: string, options?: AxiosRequestConfig) => Promise; /** * Ejects a user given their public key. In the case of failure, a rejected promise is returned to the caller. * @param {string} publicKey * @param {{ [key: string]: any; }} requestBody Structured data used to generate the signature * @param {*} [options] Override http request option. * @throws {RequiredError} */ ejectUser: (publicKey: string, requestBody: { [key: string]: any; }, options?: AxiosRequestConfig) => Promise; /** * Send QR code by email. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ emailTicket: (network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig) => Promise; /** * List of verifiers for an event. * @param {string} slug Slug * @param {*} [options] Override http request option. * @throws {RequiredError} */ eventVerifiers: (slug: string, options?: AxiosRequestConfig) => Promise; /** * Starts Job process to get all the keys for the given lock * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} query Query you want to search for. * @param {string} filterKey The key you want to search on. * @param {string} [expiration] Expiration time * @param {string} [approval] Approval status (relevant for offchain approvals on events for example) * @param {*} [options] Override http request option. * @throws {RequiredError} */ exportKeys: (network: number, lockAddress: string, query: string, filterKey: string, expiration?: string, approval?: string, options?: AxiosRequestConfig) => Promise; /** * Generate and return an Apple Wallet pass for a specified key associated with a lock. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ generateAppleWalletPass: (network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig) => Promise; /** * Generate certificate for specific key * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ generateCertificate: (network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig) => Promise; /** * Generate and return a Google Wallet pass for a specified key associated with a lock. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ generateGoogleWalletPass: (network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig) => Promise; /** * Generate a ticket for a key. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ generateTicket: (network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig) => Promise; /** * Get the price breakdown for recipients & total charges with fees for a specific lock * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {Array} purchaseData The purchase data passed to the purchase function * @param {Array} recipients The recipients passed to the purchase function * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChargesForLock: (network: number, lockAddress: string, purchaseData: Array, recipients: Array, options?: AxiosRequestConfig) => Promise; /** * * @param {string} id The id of the checkout config * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCheckoutConfig: (id: string, options?: AxiosRequestConfig) => Promise; /** * Get custom email content for a specific template and lock details * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} template Template id for email * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCustomEmailContent: (network: number, lockAddress: string, template: string, options?: AxiosRequestConfig) => Promise; /** * Retrieves data for recipients and captcha. * @param {Array} recipients * @param {string} captchaValue * @param {string} lockAddress * @param {number} network * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDataForRecipientsAndCaptcha: (recipients: Array, captchaValue: string, lockAddress: string, network: number, options?: AxiosRequestConfig) => Promise; /** * Get the data for recipients and gitcoin passport. This is to be used in conjunction with the Gitcoin passport scorer. * @param {number} network The network the lock is on * @param {string} [lockAddress] The address of the lock * @param {Array} [recipients] The list of recipients for the purchase * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDataForRecipientsAndGitcoinPassport: (network: number, lockAddress?: string, recipients?: Array, options?: AxiosRequestConfig) => Promise; /** * Get the data for recipients and guild. This is to be used in conjunction with the Guild * @param {number} network The network the lock is on * @param {string} [lockAddress] The address of the lock * @param {Array} [recipients] The list of recipients for the purchase * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDataForRecipientsAndGuild: (network: number, lockAddress?: string, recipients?: Array, options?: AxiosRequestConfig) => Promise; /** * Retrieves an event based on its slug. The event data including status and transactionHash can be accessed through the `data` property. * @param {string} slug Slug * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEvent: (slug: string, options?: AxiosRequestConfig) => Promise; /** * Get details of an event collection * @param {string} slug * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEventCollection: (slug: string, options?: AxiosRequestConfig) => Promise; /** * Get the event details from lock * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ getEventDetails: (network: number, lockAddress: string, options?: AxiosRequestConfig) => Promise; /** * get a ticket for a key by event. * @param {string} slug Slug * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEventTicket: (slug: string, network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig) => Promise; /** * Get events in a collection * @param {string} slug * @param {number} [page] * @param {number} [pageSize] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEventsInCollection: (slug: string, page?: number, pageSize?: number, options?: AxiosRequestConfig) => Promise; /** * Get job result by job id * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} jobId Id of the exported job. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExportedKeys: (network: number, lockAddress: string, jobId: string, options?: AxiosRequestConfig) => Promise; /** * Get saved lock settings * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLockSettings: (network: number, lockAddress: string, options?: AxiosRequestConfig) => Promise; /** * Get lock setting by slug * @param {string} slug Slug * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLockSettingsBySlug: (slug: string, options?: AxiosRequestConfig) => Promise; /** * Returns Stripe connection details * @param {string} lockAddress Lock address. * @param {number} chain Lock network * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLockStripeConnectionDetails: (lockAddress: string, chain: number, options?: AxiosRequestConfig) => Promise; /** * Get receipt details * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} hash Hash * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReceipt: (network: number, lockAddress: string, hash: string, options?: AxiosRequestConfig) => Promise; /** * Get all receipts for a lock * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReceipts: (network: number, lockAddress: string, options?: AxiosRequestConfig) => Promise; /** * Get supplier details * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReceiptsBase: (network: number, lockAddress: string, options?: AxiosRequestConfig) => Promise; /** * Retrieve the status of receipt generation for a lock. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReceiptsStatus: (network: number, lockAddress: string, options?: AxiosRequestConfig) => Promise; /** * Lists the locks connected to Stripe for a user * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStripeConnections: (options?: AxiosRequestConfig) => Promise; /** * Get an active subscription associated with the key. It can be fiat or crypto. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSubscription: (network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig) => Promise; /** * get a ticket for a key by lock. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTicket: (network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig) => Promise; /** * Get unapproved events for a collection * @param {string} slug * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUnapprovedEventsForCollection: (slug: string, options?: AxiosRequestConfig) => Promise; /** * Gets User account type by email. * @param {string} emailAddress * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserAccountType: (emailAddress: string, options?: AxiosRequestConfig) => Promise; /** * get user metadata for a lock. * @param {string} lockAddress Lock address. * @param {string} userAddress User address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserMetadata: (lockAddress: string, userAddress: string, options?: AxiosRequestConfig) => Promise; /** * Given a user\'s email address, retrieves their private key. In the case of failure a rejected promise is returned to the caller. * @param {string} emailAddress * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserPrivateKey: (emailAddress: string, options?: AxiosRequestConfig) => Promise; /** * Given a user\'s email address, retrieves their recovery phrase. In the case of failure a rejected promise is returned to the caller. * @param {string} emailAddress * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserRecoveryPhrase: (emailAddress: string, options?: AxiosRequestConfig) => Promise; /** * Gets Coinbase WAAS token for user by email and selected provider. * @param {string} captcha Recaptcha value to pass. * @param {string} emailAddress * @param {string} selectedProvider * @param {GetWaasTokenRequest} getWaasTokenRequest JSON object containing sign in token * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWaasToken: (captcha: string, emailAddress: string, selectedProvider: string, getWaasTokenRequest: GetWaasTokenRequest, options?: AxiosRequestConfig) => Promise; /** * Returns if credit card payment are enable for a lock * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ isCardPaymentEnabledForLock: (network: number, lockAddress: string, options?: AxiosRequestConfig) => Promise; /** * Get key and user metadata. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ keyMetadata: (network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig) => Promise; /** * List of lock keys by network with additional metadata if the caller is the lockManager (deprecated, use keys-by-page) * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} query Query you want to search for. * @param {string} filterKey The key you want to search on. * @param {string} [expiration] Expiration time * @param {string} [approval] Approval status (relevant for offchain approvals on events for example) * @param {number} [page] Page number when paginating * @param {number} [max] Maximum number of items to get by page * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ keys: (network: number, lockAddress: string, query: string, filterKey: string, expiration?: string, approval?: string, page?: number, max?: number, options?: AxiosRequestConfig) => Promise; /** * List of lock keys by network with additional metadata if the caller is the lockManager * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} query Query you want to search for. * @param {string} filterKey The key you want to search on. * @param {string} [expiration] Expiration time * @param {string} [approval] Approval status (relevant for offchain approvals on events for example) * @param {number} [page] Page number when paginating * @param {number} [max] Maximum number of items to get by page * @param {*} [options] Override http request option. * @throws {RequiredError} */ keysByPage: (network: number, lockAddress: string, query: string, filterKey: string, expiration?: string, approval?: string, page?: number, max?: number, options?: AxiosRequestConfig) => Promise; /** * A list of all checkout configs created by the user * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCheckoutConfigs: (options?: AxiosRequestConfig) => Promise; /** * List payment methods for user. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPaymentMethods: (options?: AxiosRequestConfig) => Promise; /** * Get metadata for lock address. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ lockMetadata: (network: number, lockAddress: string, options?: AxiosRequestConfig) => Promise; /** * Login as a user using Sign in with Ethereum message signed by the wallet address. * @param {LoginRequest} loginRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ login: (loginRequest: LoginRequest, options?: AxiosRequestConfig) => Promise; /** * Verify an access token using Privy\'s library and authenticate the user * @param {LoginWithPrivyRequest} loginWithPrivyRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ loginWithPrivy: (loginWithPrivyRequest: LoginWithPrivyRequest, options?: AxiosRequestConfig) => Promise; /** * Logout from locksmith. This will invalidate all your session tokens. * @param {*} [options] Override http request option. * @throws {RequiredError} */ logout: (options?: AxiosRequestConfig) => Promise; /** * Provide a unique nonce for using in sign in with ethereum * @param {*} [options] Override http request option. * @throws {RequiredError} */ nonce: (options?: AxiosRequestConfig) => Promise; /** * * @param {number} network Network id. * @param {number} [amount] Amount of tokens you want to get the price for in USD. * @param {string} [address] The erc20 address you want to get the price for. If nothing is passed, the API will return the native token price. * @param {*} [options] Override http request option. * @throws {RequiredError} */ price: (network: number, amount?: number, address?: string, options?: AxiosRequestConfig) => Promise; /** * Create purchase intent for stripe. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {PurchaseRequest} purchaseRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ purchase: (network: number, lockAddress: string, purchaseRequest: PurchaseRequest, options?: AxiosRequestConfig) => Promise; /** * resubscribe emails from lock * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ reSubscribeEmail: (network: number, lockAddress: string, options?: AxiosRequestConfig) => Promise; /** * Remove a single event from an event collection. * @param {string} slug Slug of the event collection. * @param {RemoveEventBody} removeEventBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeEventFromCollection: (slug: string, removeEventBody: RemoveEventBody, options?: AxiosRequestConfig) => Promise; /** * Remove a manager address from an event collection * @param {string} slug * @param {RemoveManagerBody} removeManagerBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeManagerFromEventCollection: (slug: string, removeManagerBody: RemoveManagerBody, options?: AxiosRequestConfig) => Promise; /** * Remove all payment methods for a user * @param {*} [options] Override http request option. * @throws {RequiredError} */ removePaymentMethods: (options?: AxiosRequestConfig) => Promise; /** * Invalidate a session. * @param {*} [options] Override http request option. * @throws {RequiredError} */ revoke: (options?: AxiosRequestConfig) => Promise; /** * User applies to attend an event. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} captcha Recaptcha value to pass. * @param {RsvpRequest} [rsvpRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ rsvp: (network: number, lockAddress: string, captcha: string, rsvpRequest?: RsvpRequest, options?: AxiosRequestConfig) => Promise; /** * Save custom email content for a specif lock. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} template Template id for email * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveCustomEmailContent: (network: number, lockAddress: string, template: string, options?: AxiosRequestConfig) => Promise; /** * Save event data * @param {SaveEventDataRequest} saveEventDataRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveEventData: (saveEventDataRequest: SaveEventDataRequest, options?: AxiosRequestConfig) => Promise; /** * Save lock settings * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {LockSettings} [lockSettings] * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveLockSetting: (network: number, lockAddress: string, lockSettings?: LockSettings, options?: AxiosRequestConfig) => Promise; /** * Saves a merkle tree from either a list of addresses or a list of [address, amount] tuples. * @param {Array} saveMerkleTreeRequestInner * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveMerkleTree: (saveMerkleTreeRequestInner: Array, options?: AxiosRequestConfig) => Promise; /** * Create purchaser details * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} hash Hash * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveReceipt: (network: number, lockAddress: string, hash: string, options?: AxiosRequestConfig) => Promise; /** * Create supplier details. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveReceiptsBase: (network: number, lockAddress: string, options?: AxiosRequestConfig) => Promise; /** * Send custom email to recipients * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {SendCustomEmailRequest} [sendCustomEmailRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendCustomEmail: (network: number, lockAddress: string, sendCustomEmailRequest?: SendCustomEmailRequest, options?: AxiosRequestConfig) => Promise; /** * Send event invites to a list of recipients * @param {string} slug Slug * @param {SendEventInvitesRequest} [sendEventInvitesRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendEventInvites: (slug: string, sendEventInvitesRequest?: SendEventInvitesRequest, options?: AxiosRequestConfig) => Promise; /** * Sends a verification code to the user\'s email if the current code is expired or does not exist. * @param {string} captcha Recaptcha value to pass. * @param {string} emailAddress * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendVerificationCode: (captcha: string, emailAddress: string, options?: AxiosRequestConfig) => Promise; /** * Setup a payment method for user. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setupPayment: (options?: AxiosRequestConfig) => Promise; /** * Generate signature to prove validity of token. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ signTicket: (network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig) => Promise; /** * Get QR code for the key. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ ticketQRCode: (network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig) => Promise; /** * Get the verification URL for the key. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ ticketVerificationUrl: (network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig) => Promise; /** * Finalize the transfer of a key to a recipient. This is to copy over any locksmith related data to the recipient\'s account. * @param {TransferDoneRequest} [transferDoneRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ transferDone: (transferDoneRequest?: TransferDoneRequest, options?: AxiosRequestConfig) => Promise; /** * Unsubscribe email from lock * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ unsubscribeEmail: (network: number, lockAddress: string, options?: AxiosRequestConfig) => Promise; /** * Update application by id. * @param {string} id Application id. * @param {ApplicationBody} [applicationBody] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateApplication: (id: string, applicationBody?: ApplicationBody, options?: AxiosRequestConfig) => Promise; /** * A new checkout config is created or updated if it already exists * @param {string} id This is optional. If you don\'t pass an ID, a new config will be created. If you pass an ID, the config will be created. * @param {UpdateCheckoutConfigRequest} [updateCheckoutConfigRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCheckoutConfig: (id: string, updateCheckoutConfigRequest?: UpdateCheckoutConfigRequest, options?: AxiosRequestConfig) => Promise; /** * Update an existing event collection * @param {string} slug * @param {EventCollectionBody} eventCollectionBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateEventCollection: (slug: string, eventCollectionBody: EventCollectionBody, options?: AxiosRequestConfig) => Promise; /** * Update event data * @param {string} slug * @param {UpdateEventDataRequest} [updateEventDataRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateEventData: (slug: string, updateEventDataRequest?: UpdateEventDataRequest, options?: AxiosRequestConfig) => Promise; /** * Update or create metadata for key. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {UpdateLockMetadataRequest} updateLockMetadataRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateKeyMetadata: (network: number, lockAddress: string, keyId: string, updateLockMetadataRequest: UpdateLockMetadataRequest, options?: AxiosRequestConfig) => Promise; /** * Update or create metadata for lock address. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {UpdateLockMetadataRequest} updateLockMetadataRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateLockMetadata: (network: number, lockAddress: string, updateLockMetadataRequest: UpdateLockMetadataRequest, options?: AxiosRequestConfig) => Promise; /** * Updates a user\'s private key, using their email address as key. In the case of failure a rejected promise is returned to the caller. * @param {string} emailAddress * @param {UpdateUserEncryptedPrivateKeyRequest} updateUserEncryptedPrivateKeyRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateUserEncryptedPrivateKey: (emailAddress: string, updateUserEncryptedPrivateKeyRequest: UpdateUserEncryptedPrivateKeyRequest, options?: AxiosRequestConfig) => Promise; /** * Update or create user metadata for lock. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} userAddress User address. * @param {UpdateUserMetadataRequest} updateUserMetadataRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateUserMetadata: (network: number, lockAddress: string, userAddress: string, updateUserMetadataRequest: UpdateUserMetadataRequest, options?: AxiosRequestConfig) => Promise; /** * Update or create user metadata for lock. * @param {UpdateUsersMetadataRequest} updateUsersMetadataRequest users array containing user metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateUsersMetadata: (updateUsersMetadataRequest: UpdateUsersMetadataRequest, options?: AxiosRequestConfig) => Promise; /** * Upload images to locksmith * @param {Array} [images] * @param {*} [options] Override http request option. * @throws {RequiredError} */ uploadImages: (images?: Array, options?: AxiosRequestConfig) => Promise; /** * Get user details. * @param {*} [options] Override http request option. * @throws {RequiredError} */ user: (options?: AxiosRequestConfig) => Promise; /** * Check if an address is a verifier of the lock. (deprecated in favor of eventVerifier) * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} verifierAddress User address to use as verifier * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ verifier: (network: number, lockAddress: string, verifierAddress: string, options?: AxiosRequestConfig) => Promise; /** * List of verifiers for the lock address. (deprecated in favor of eventVerifiers) * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ verifiers: (network: number, lockAddress: string, options?: AxiosRequestConfig) => Promise; /** * Verifies the email code sent to the users email address. * @param {string} emailAddress * @param {VerifyEmailCodeRequest} verifyEmailCodeRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ verifyEmailCode: (emailAddress: string, verifyEmailCodeRequest: VerifyEmailCodeRequest, options?: AxiosRequestConfig) => Promise; }; /** * DefaultApi - functional programming interface * @export */ declare const DefaultApiFp: (configuration?: Configuration) => { /** * Add an event to a collection * @param {string} slug * @param {AddEventToCollectionBody} addEventToCollectionBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ addEventToCollection(slug: string, addEventToCollectionBody: AddEventToCollectionBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Adds a verifier for an event. * @param {string} slug Slug * @param {string} verifierAddress User address to use as verifier * @param {CreateVerifierRequest} [createVerifierRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addEventVerifier(slug: string, verifierAddress: string, createVerifierRequest?: CreateVerifierRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Add a new manager address to an event collection * @param {string} slug * @param {AddManagerBody} addManagerBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ addManagerToEventCollection(slug: string, addManagerBody: AddManagerBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List applications created the user. * @param {*} [options] Override http request option. * @throws {RequiredError} */ applications(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Approves users to attend an event. (does not airdrop!) * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {ApproveAttendeesRsvpRequest} approveAttendeesRsvpRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ approveAttendeesRsvp(network: number, lockAddress: string, approveAttendeesRsvpRequest: ApproveAttendeesRsvpRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Approve a single event within an event collection. * @param {string} slug Slug of the event collection. * @param {ApproveEventBody} approveEventBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ approveEvent(slug: string, approveEventBody: ApproveEventBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Approves refunds for an event. * @param {string} slug Slug * @param {ApproveRefundsRequest} approveRefundsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ approveRefunds(slug: string, approveRefundsRequest: ApproveRefundsRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Approves a user to attend an event. (does not airdrop!) * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} userAddress User address. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ approveRsvp(network: number, lockAddress: string, userAddress: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns the merkle proof of an approved refund. * @param {string} slug Slug * @param {*} [options] Override http request option. * @throws {RequiredError} */ approvedRefunds(slug: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ balance(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: Balance200ResponseValue; }>>; /** * Bulk approve multiple events within an event collection. * @param {string} slug Slug of the event collection. * @param {BulkApproveEventsBody} bulkApproveEventsBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ bulkApproveEvents(slug: string, bulkApproveEventsBody: BulkApproveEventsBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * Bulk remove multiple events from an event collection. * @param {string} slug Slug of the event collection. * @param {BulkRemoveEventsBody} bulkRemoveEventsBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ bulkRemoveEvents(slug: string, bulkRemoveEventsBody: BulkRemoveEventsBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Cancel a fiat subscription. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelSubscription(network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Capture a purchase * @param {CapturePurchaseRequest} [capturePurchaseRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ capturePurchase(capturePurchaseRequest?: CapturePurchaseRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Check if claim is possible for a given purchase * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {CheckClaimRequest} [checkClaimRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ checkClaim(network: number, lockAddress: string, checkClaimRequest?: CheckClaimRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Mark an event ticket as checked in. * @param {string} slug Slug * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ checkEventTicket(slug: string, network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Check if a user exists in Privy by email or wallet address * @param {PrivyUserCheckBody} privyUserCheckBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ checkPrivyUser(privyUserCheckBody: PrivyUserCheckBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Mark a lock ticket as checked in. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ checkTicket(network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Claim a membership key for a lock. If not authenticated, requires an email in the body. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} captcha Recaptcha value to pass. * @param {ClaimRequest} claimRequest * @param {string} [recipient] Recipient address for key * @param {*} [options] Override http request option. * @throws {RequiredError} */ claim(network: number, lockAddress: string, captcha: string, claimRequest: ClaimRequest, recipient?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Connect a stripe account to a lock * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {ConnectStripeAccountRequest} [connectStripeAccountRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ connectStripeAccount(network: number, lockAddress: string, connectStripeAccountRequest?: ConnectStripeAccountRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create application associated with user wallet. * @param {ApplicationBody} applicationBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ createApplication(applicationBody: ApplicationBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Request the creation of a ZIP file containing all receipts for a lock. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDownloadReceiptsRequest(network: number, lockAddress: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a new event collection * @param {EventCollectionBody} eventCollectionBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ createEventCollection(eventCollectionBody: EventCollectionBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {number} network Network id. * @param {string} captcha Recaptcha value to pass. * @param {LockContractOptions} lockContractOptions * @param {*} [options] Override http request option. * @throws {RequiredError} */ createLockContract(network: number, captcha: string, lockContractOptions: LockContractOptions, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create a transfer code to transfer an airdropped key to an email address. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTransferCode(network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create verifier. (deprecated in favor of addEventVerifier) * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} verifierAddress User address to use as verifier * @param {CreateVerifierRequest} [createVerifierRequest] * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ createVerifier(network: number, lockAddress: string, verifierAddress: string, createVerifierRequest?: CreateVerifierRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete application by id. * @param {string} id Application id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteApplication(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Delete a checkout config * @param {string} id The id of the checkout config * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteCheckoutConfig(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Removes a verifier for an event. * @param {string} slug Slug * @param {string} verifierAddress User address to use as verifier * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteEventVerifier(slug: string, verifierAddress: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Remove verifier. (deprecated in favor of deleteEventVerifier) * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} verifierAddress User address to use as verifier * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ deleteVerifier(network: number, lockAddress: string, verifierAddress: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Denies users to attend an event. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {ApproveAttendeesRsvpRequest} approveAttendeesRsvpRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ denyAttendeesRsvp(network: number, lockAddress: string, approveAttendeesRsvpRequest: ApproveAttendeesRsvpRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Denies a user to attend an event. (does not airdrop!) * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} userAddress User address. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ denyRsvp(network: number, lockAddress: string, userAddress: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Disconnect stripe account. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ disconnectStripe(network: number, lockAddress: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Download the ZIP file containing all receipts for a lock. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ downloadReceipts(network: number, lockAddress: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Ejects a user given their public key. In the case of failure, a rejected promise is returned to the caller. * @param {string} publicKey * @param {{ [key: string]: any; }} requestBody Structured data used to generate the signature * @param {*} [options] Override http request option. * @throws {RequiredError} */ ejectUser(publicKey: string, requestBody: { [key: string]: any; }, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Send QR code by email. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ emailTicket(network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List of verifiers for an event. * @param {string} slug Slug * @param {*} [options] Override http request option. * @throws {RequiredError} */ eventVerifiers(slug: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Starts Job process to get all the keys for the given lock * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} query Query you want to search for. * @param {string} filterKey The key you want to search on. * @param {string} [expiration] Expiration time * @param {string} [approval] Approval status (relevant for offchain approvals on events for example) * @param {*} [options] Override http request option. * @throws {RequiredError} */ exportKeys(network: number, lockAddress: string, query: string, filterKey: string, expiration?: string, approval?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Generate and return an Apple Wallet pass for a specified key associated with a lock. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ generateAppleWalletPass(network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Generate certificate for specific key * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ generateCertificate(network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Generate and return a Google Wallet pass for a specified key associated with a lock. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ generateGoogleWalletPass(network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Generate a ticket for a key. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ generateTicket(network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get the price breakdown for recipients & total charges with fees for a specific lock * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {Array} purchaseData The purchase data passed to the purchase function * @param {Array} recipients The recipients passed to the purchase function * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChargesForLock(network: number, lockAddress: string, purchaseData: Array, recipients: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {string} id The id of the checkout config * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCheckoutConfig(id: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get custom email content for a specific template and lock details * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} template Template id for email * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCustomEmailContent(network: number, lockAddress: string, template: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves data for recipients and captcha. * @param {Array} recipients * @param {string} captchaValue * @param {string} lockAddress * @param {number} network * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDataForRecipientsAndCaptcha(recipients: Array, captchaValue: string, lockAddress: string, network: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get the data for recipients and gitcoin passport. This is to be used in conjunction with the Gitcoin passport scorer. * @param {number} network The network the lock is on * @param {string} [lockAddress] The address of the lock * @param {Array} [recipients] The list of recipients for the purchase * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDataForRecipientsAndGitcoinPassport(network: number, lockAddress?: string, recipients?: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get the data for recipients and guild. This is to be used in conjunction with the Guild * @param {number} network The network the lock is on * @param {string} [lockAddress] The address of the lock * @param {Array} [recipients] The list of recipients for the purchase * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDataForRecipientsAndGuild(network: number, lockAddress?: string, recipients?: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieves an event based on its slug. The event data including status and transactionHash can be accessed through the `data` property. * @param {string} slug Slug * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEvent(slug: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get details of an event collection * @param {string} slug * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEventCollection(slug: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get the event details from lock * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ getEventDetails(network: number, lockAddress: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * get a ticket for a key by event. * @param {string} slug Slug * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEventTicket(slug: string, network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get events in a collection * @param {string} slug * @param {number} [page] * @param {number} [pageSize] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEventsInCollection(slug: string, page?: number, pageSize?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get job result by job id * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} jobId Id of the exported job. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExportedKeys(network: number, lockAddress: string, jobId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get saved lock settings * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLockSettings(network: number, lockAddress: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get lock setting by slug * @param {string} slug Slug * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLockSettingsBySlug(slug: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns Stripe connection details * @param {string} lockAddress Lock address. * @param {number} chain Lock network * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLockStripeConnectionDetails(lockAddress: string, chain: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get receipt details * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} hash Hash * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReceipt(network: number, lockAddress: string, hash: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get all receipts for a lock * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReceipts(network: number, lockAddress: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get supplier details * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReceiptsBase(network: number, lockAddress: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Retrieve the status of receipt generation for a lock. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReceiptsStatus(network: number, lockAddress: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Lists the locks connected to Stripe for a user * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStripeConnections(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get an active subscription associated with the key. It can be fiat or crypto. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSubscription(network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * get a ticket for a key by lock. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTicket(network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get unapproved events for a collection * @param {string} slug * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUnapprovedEventsForCollection(slug: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets User account type by email. * @param {string} emailAddress * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserAccountType(emailAddress: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * get user metadata for a lock. * @param {string} lockAddress Lock address. * @param {string} userAddress User address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserMetadata(lockAddress: string, userAddress: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Given a user\'s email address, retrieves their private key. In the case of failure a rejected promise is returned to the caller. * @param {string} emailAddress * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserPrivateKey(emailAddress: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Given a user\'s email address, retrieves their recovery phrase. In the case of failure a rejected promise is returned to the caller. * @param {string} emailAddress * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserRecoveryPhrase(emailAddress: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Gets Coinbase WAAS token for user by email and selected provider. * @param {string} captcha Recaptcha value to pass. * @param {string} emailAddress * @param {string} selectedProvider * @param {GetWaasTokenRequest} getWaasTokenRequest JSON object containing sign in token * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWaasToken(captcha: string, emailAddress: string, selectedProvider: string, getWaasTokenRequest: GetWaasTokenRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Returns if credit card payment are enable for a lock * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ isCardPaymentEnabledForLock(network: number, lockAddress: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get key and user metadata. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ keyMetadata(network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List of lock keys by network with additional metadata if the caller is the lockManager (deprecated, use keys-by-page) * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} query Query you want to search for. * @param {string} filterKey The key you want to search on. * @param {string} [expiration] Expiration time * @param {string} [approval] Approval status (relevant for offchain approvals on events for example) * @param {number} [page] Page number when paginating * @param {number} [max] Maximum number of items to get by page * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ keys(network: number, lockAddress: string, query: string, filterKey: string, expiration?: string, approval?: string, page?: number, max?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>>; /** * List of lock keys by network with additional metadata if the caller is the lockManager * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} query Query you want to search for. * @param {string} filterKey The key you want to search on. * @param {string} [expiration] Expiration time * @param {string} [approval] Approval status (relevant for offchain approvals on events for example) * @param {number} [page] Page number when paginating * @param {number} [max] Maximum number of items to get by page * @param {*} [options] Override http request option. * @throws {RequiredError} */ keysByPage(network: number, lockAddress: string, query: string, filterKey: string, expiration?: string, approval?: string, page?: number, max?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * A list of all checkout configs created by the user * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCheckoutConfigs(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List payment methods for user. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPaymentMethods(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get metadata for lock address. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ lockMetadata(network: number, lockAddress: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: any; }>>; /** * Login as a user using Sign in with Ethereum message signed by the wallet address. * @param {LoginRequest} loginRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ login(loginRequest: LoginRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Verify an access token using Privy\'s library and authenticate the user * @param {LoginWithPrivyRequest} loginWithPrivyRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ loginWithPrivy(loginWithPrivyRequest: LoginWithPrivyRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Logout from locksmith. This will invalidate all your session tokens. * @param {*} [options] Override http request option. * @throws {RequiredError} */ logout(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Provide a unique nonce for using in sign in with ethereum * @param {*} [options] Override http request option. * @throws {RequiredError} */ nonce(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * * @param {number} network Network id. * @param {number} [amount] Amount of tokens you want to get the price for in USD. * @param {string} [address] The erc20 address you want to get the price for. If nothing is passed, the API will return the native token price. * @param {*} [options] Override http request option. * @throws {RequiredError} */ price(network: number, amount?: number, address?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create purchase intent for stripe. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {PurchaseRequest} purchaseRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ purchase(network: number, lockAddress: string, purchaseRequest: PurchaseRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * resubscribe emails from lock * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ reSubscribeEmail(network: number, lockAddress: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Remove a single event from an event collection. * @param {string} slug Slug of the event collection. * @param {RemoveEventBody} removeEventBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeEventFromCollection(slug: string, removeEventBody: RemoveEventBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Remove a manager address from an event collection * @param {string} slug * @param {RemoveManagerBody} removeManagerBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeManagerFromEventCollection(slug: string, removeManagerBody: RemoveManagerBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Remove all payment methods for a user * @param {*} [options] Override http request option. * @throws {RequiredError} */ removePaymentMethods(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Invalidate a session. * @param {*} [options] Override http request option. * @throws {RequiredError} */ revoke(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * User applies to attend an event. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} captcha Recaptcha value to pass. * @param {RsvpRequest} [rsvpRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ rsvp(network: number, lockAddress: string, captcha: string, rsvpRequest?: RsvpRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Save custom email content for a specif lock. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} template Template id for email * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveCustomEmailContent(network: number, lockAddress: string, template: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Save event data * @param {SaveEventDataRequest} saveEventDataRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveEventData(saveEventDataRequest: SaveEventDataRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Save lock settings * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {LockSettings} [lockSettings] * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveLockSetting(network: number, lockAddress: string, lockSettings?: LockSettings, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Saves a merkle tree from either a list of addresses or a list of [address, amount] tuples. * @param {Array} saveMerkleTreeRequestInner * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveMerkleTree(saveMerkleTreeRequestInner: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create purchaser details * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} hash Hash * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveReceipt(network: number, lockAddress: string, hash: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Create supplier details. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveReceiptsBase(network: number, lockAddress: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Send custom email to recipients * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {SendCustomEmailRequest} [sendCustomEmailRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendCustomEmail(network: number, lockAddress: string, sendCustomEmailRequest?: SendCustomEmailRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Send event invites to a list of recipients * @param {string} slug Slug * @param {SendEventInvitesRequest} [sendEventInvitesRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendEventInvites(slug: string, sendEventInvitesRequest?: SendEventInvitesRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Sends a verification code to the user\'s email if the current code is expired or does not exist. * @param {string} captcha Recaptcha value to pass. * @param {string} emailAddress * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendVerificationCode(captcha: string, emailAddress: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Setup a payment method for user. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setupPayment(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Generate signature to prove validity of token. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ signTicket(network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get QR code for the key. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ ticketQRCode(network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get the verification URL for the key. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ ticketVerificationUrl(network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Finalize the transfer of a key to a recipient. This is to copy over any locksmith related data to the recipient\'s account. * @param {TransferDoneRequest} [transferDoneRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ transferDone(transferDoneRequest?: TransferDoneRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Unsubscribe email from lock * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ unsubscribeEmail(network: number, lockAddress: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update application by id. * @param {string} id Application id. * @param {ApplicationBody} [applicationBody] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateApplication(id: string, applicationBody?: ApplicationBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * A new checkout config is created or updated if it already exists * @param {string} id This is optional. If you don\'t pass an ID, a new config will be created. If you pass an ID, the config will be created. * @param {UpdateCheckoutConfigRequest} [updateCheckoutConfigRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCheckoutConfig(id: string, updateCheckoutConfigRequest?: UpdateCheckoutConfigRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update an existing event collection * @param {string} slug * @param {EventCollectionBody} eventCollectionBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateEventCollection(slug: string, eventCollectionBody: EventCollectionBody, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update event data * @param {string} slug * @param {UpdateEventDataRequest} [updateEventDataRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateEventData(slug: string, updateEventDataRequest?: UpdateEventDataRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update or create metadata for key. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {UpdateLockMetadataRequest} updateLockMetadataRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateKeyMetadata(network: number, lockAddress: string, keyId: string, updateLockMetadataRequest: UpdateLockMetadataRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: any; }>>; /** * Update or create metadata for lock address. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {UpdateLockMetadataRequest} updateLockMetadataRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateLockMetadata(network: number, lockAddress: string, updateLockMetadataRequest: UpdateLockMetadataRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: any; }>>; /** * Updates a user\'s private key, using their email address as key. In the case of failure a rejected promise is returned to the caller. * @param {string} emailAddress * @param {UpdateUserEncryptedPrivateKeyRequest} updateUserEncryptedPrivateKeyRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateUserEncryptedPrivateKey(emailAddress: string, updateUserEncryptedPrivateKeyRequest: UpdateUserEncryptedPrivateKeyRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Update or create user metadata for lock. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} userAddress User address. * @param {UpdateUserMetadataRequest} updateUserMetadataRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateUserMetadata(network: number, lockAddress: string, userAddress: string, updateUserMetadataRequest: UpdateUserMetadataRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{ [key: string]: any; }>>; /** * Update or create user metadata for lock. * @param {UpdateUsersMetadataRequest} updateUsersMetadataRequest users array containing user metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateUsersMetadata(updateUsersMetadataRequest: UpdateUsersMetadataRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Upload images to locksmith * @param {Array} [images] * @param {*} [options] Override http request option. * @throws {RequiredError} */ uploadImages(images?: Array, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Get user details. * @param {*} [options] Override http request option. * @throws {RequiredError} */ user(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Check if an address is a verifier of the lock. (deprecated in favor of eventVerifier) * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} verifierAddress User address to use as verifier * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ verifier(network: number, lockAddress: string, verifierAddress: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * List of verifiers for the lock address. (deprecated in favor of eventVerifiers) * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ verifiers(network: number, lockAddress: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; /** * Verifies the email code sent to the users email address. * @param {string} emailAddress * @param {VerifyEmailCodeRequest} verifyEmailCodeRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ verifyEmailCode(emailAddress: string, verifyEmailCodeRequest: VerifyEmailCodeRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise>; }; /** * DefaultApi - factory interface * @export */ declare const DefaultApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => { /** * Add an event to a collection * @param {string} slug * @param {AddEventToCollectionBody} addEventToCollectionBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ addEventToCollection(slug: string, addEventToCollectionBody: AddEventToCollectionBody, options?: any): AxiosPromise; /** * Adds a verifier for an event. * @param {string} slug Slug * @param {string} verifierAddress User address to use as verifier * @param {CreateVerifierRequest} [createVerifierRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ addEventVerifier(slug: string, verifierAddress: string, createVerifierRequest?: CreateVerifierRequest, options?: any): AxiosPromise; /** * Add a new manager address to an event collection * @param {string} slug * @param {AddManagerBody} addManagerBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ addManagerToEventCollection(slug: string, addManagerBody: AddManagerBody, options?: any): AxiosPromise; /** * List applications created the user. * @param {*} [options] Override http request option. * @throws {RequiredError} */ applications(options?: any): AxiosPromise; /** * Approves users to attend an event. (does not airdrop!) * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {ApproveAttendeesRsvpRequest} approveAttendeesRsvpRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ approveAttendeesRsvp(network: number, lockAddress: string, approveAttendeesRsvpRequest: ApproveAttendeesRsvpRequest, options?: any): AxiosPromise; /** * Approve a single event within an event collection. * @param {string} slug Slug of the event collection. * @param {ApproveEventBody} approveEventBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ approveEvent(slug: string, approveEventBody: ApproveEventBody, options?: any): AxiosPromise; /** * Approves refunds for an event. * @param {string} slug Slug * @param {ApproveRefundsRequest} approveRefundsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ approveRefunds(slug: string, approveRefundsRequest: ApproveRefundsRequest, options?: any): AxiosPromise; /** * Approves a user to attend an event. (does not airdrop!) * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} userAddress User address. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ approveRsvp(network: number, lockAddress: string, userAddress: string, options?: any): AxiosPromise; /** * Returns the merkle proof of an approved refund. * @param {string} slug Slug * @param {*} [options] Override http request option. * @throws {RequiredError} */ approvedRefunds(slug: string, options?: any): AxiosPromise; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} */ balance(options?: any): AxiosPromise<{ [key: string]: Balance200ResponseValue; }>; /** * Bulk approve multiple events within an event collection. * @param {string} slug Slug of the event collection. * @param {BulkApproveEventsBody} bulkApproveEventsBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ bulkApproveEvents(slug: string, bulkApproveEventsBody: BulkApproveEventsBody, options?: any): AxiosPromise>; /** * Bulk remove multiple events from an event collection. * @param {string} slug Slug of the event collection. * @param {BulkRemoveEventsBody} bulkRemoveEventsBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ bulkRemoveEvents(slug: string, bulkRemoveEventsBody: BulkRemoveEventsBody, options?: any): AxiosPromise; /** * Cancel a fiat subscription. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ cancelSubscription(network: number, lockAddress: string, keyId: string, options?: any): AxiosPromise; /** * Capture a purchase * @param {CapturePurchaseRequest} [capturePurchaseRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ capturePurchase(capturePurchaseRequest?: CapturePurchaseRequest, options?: any): AxiosPromise; /** * Check if claim is possible for a given purchase * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {CheckClaimRequest} [checkClaimRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ checkClaim(network: number, lockAddress: string, checkClaimRequest?: CheckClaimRequest, options?: any): AxiosPromise; /** * Mark an event ticket as checked in. * @param {string} slug Slug * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ checkEventTicket(slug: string, network: number, lockAddress: string, keyId: string, options?: any): AxiosPromise; /** * Check if a user exists in Privy by email or wallet address * @param {PrivyUserCheckBody} privyUserCheckBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ checkPrivyUser(privyUserCheckBody: PrivyUserCheckBody, options?: any): AxiosPromise; /** * Mark a lock ticket as checked in. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ checkTicket(network: number, lockAddress: string, keyId: string, options?: any): AxiosPromise; /** * Claim a membership key for a lock. If not authenticated, requires an email in the body. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} captcha Recaptcha value to pass. * @param {ClaimRequest} claimRequest * @param {string} [recipient] Recipient address for key * @param {*} [options] Override http request option. * @throws {RequiredError} */ claim(network: number, lockAddress: string, captcha: string, claimRequest: ClaimRequest, recipient?: string, options?: any): AxiosPromise; /** * Connect a stripe account to a lock * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {ConnectStripeAccountRequest} [connectStripeAccountRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ connectStripeAccount(network: number, lockAddress: string, connectStripeAccountRequest?: ConnectStripeAccountRequest, options?: any): AxiosPromise; /** * Create application associated with user wallet. * @param {ApplicationBody} applicationBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ createApplication(applicationBody: ApplicationBody, options?: any): AxiosPromise; /** * Request the creation of a ZIP file containing all receipts for a lock. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createDownloadReceiptsRequest(network: number, lockAddress: string, options?: any): AxiosPromise; /** * Create a new event collection * @param {EventCollectionBody} eventCollectionBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ createEventCollection(eventCollectionBody: EventCollectionBody, options?: any): AxiosPromise; /** * * @param {number} network Network id. * @param {string} captcha Recaptcha value to pass. * @param {LockContractOptions} lockContractOptions * @param {*} [options] Override http request option. * @throws {RequiredError} */ createLockContract(network: number, captcha: string, lockContractOptions: LockContractOptions, options?: any): AxiosPromise; /** * Create a transfer code to transfer an airdropped key to an email address. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ createTransferCode(network: number, lockAddress: string, keyId: string, options?: any): AxiosPromise; /** * Create verifier. (deprecated in favor of addEventVerifier) * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} verifierAddress User address to use as verifier * @param {CreateVerifierRequest} [createVerifierRequest] * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ createVerifier(network: number, lockAddress: string, verifierAddress: string, createVerifierRequest?: CreateVerifierRequest, options?: any): AxiosPromise; /** * Delete application by id. * @param {string} id Application id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteApplication(id: string, options?: any): AxiosPromise; /** * Delete a checkout config * @param {string} id The id of the checkout config * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteCheckoutConfig(id: string, options?: any): AxiosPromise; /** * Removes a verifier for an event. * @param {string} slug Slug * @param {string} verifierAddress User address to use as verifier * @param {*} [options] Override http request option. * @throws {RequiredError} */ deleteEventVerifier(slug: string, verifierAddress: string, options?: any): AxiosPromise; /** * Remove verifier. (deprecated in favor of deleteEventVerifier) * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} verifierAddress User address to use as verifier * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ deleteVerifier(network: number, lockAddress: string, verifierAddress: string, options?: any): AxiosPromise; /** * Denies users to attend an event. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {ApproveAttendeesRsvpRequest} approveAttendeesRsvpRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ denyAttendeesRsvp(network: number, lockAddress: string, approveAttendeesRsvpRequest: ApproveAttendeesRsvpRequest, options?: any): AxiosPromise; /** * Denies a user to attend an event. (does not airdrop!) * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} userAddress User address. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ denyRsvp(network: number, lockAddress: string, userAddress: string, options?: any): AxiosPromise; /** * Disconnect stripe account. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ disconnectStripe(network: number, lockAddress: string, options?: any): AxiosPromise; /** * Download the ZIP file containing all receipts for a lock. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ downloadReceipts(network: number, lockAddress: string, options?: any): AxiosPromise; /** * Ejects a user given their public key. In the case of failure, a rejected promise is returned to the caller. * @param {string} publicKey * @param {{ [key: string]: any; }} requestBody Structured data used to generate the signature * @param {*} [options] Override http request option. * @throws {RequiredError} */ ejectUser(publicKey: string, requestBody: { [key: string]: any; }, options?: any): AxiosPromise; /** * Send QR code by email. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ emailTicket(network: number, lockAddress: string, keyId: string, options?: any): AxiosPromise; /** * List of verifiers for an event. * @param {string} slug Slug * @param {*} [options] Override http request option. * @throws {RequiredError} */ eventVerifiers(slug: string, options?: any): AxiosPromise; /** * Starts Job process to get all the keys for the given lock * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} query Query you want to search for. * @param {string} filterKey The key you want to search on. * @param {string} [expiration] Expiration time * @param {string} [approval] Approval status (relevant for offchain approvals on events for example) * @param {*} [options] Override http request option. * @throws {RequiredError} */ exportKeys(network: number, lockAddress: string, query: string, filterKey: string, expiration?: string, approval?: string, options?: any): AxiosPromise; /** * Generate and return an Apple Wallet pass for a specified key associated with a lock. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ generateAppleWalletPass(network: number, lockAddress: string, keyId: string, options?: any): AxiosPromise; /** * Generate certificate for specific key * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ generateCertificate(network: number, lockAddress: string, keyId: string, options?: any): AxiosPromise; /** * Generate and return a Google Wallet pass for a specified key associated with a lock. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ generateGoogleWalletPass(network: number, lockAddress: string, keyId: string, options?: any): AxiosPromise; /** * Generate a ticket for a key. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ generateTicket(network: number, lockAddress: string, keyId: string, options?: any): AxiosPromise; /** * Get the price breakdown for recipients & total charges with fees for a specific lock * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {Array} purchaseData The purchase data passed to the purchase function * @param {Array} recipients The recipients passed to the purchase function * @param {*} [options] Override http request option. * @throws {RequiredError} */ getChargesForLock(network: number, lockAddress: string, purchaseData: Array, recipients: Array, options?: any): AxiosPromise; /** * * @param {string} id The id of the checkout config * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCheckoutConfig(id: string, options?: any): AxiosPromise; /** * Get custom email content for a specific template and lock details * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} template Template id for email * @param {*} [options] Override http request option. * @throws {RequiredError} */ getCustomEmailContent(network: number, lockAddress: string, template: string, options?: any): AxiosPromise; /** * Retrieves data for recipients and captcha. * @param {Array} recipients * @param {string} captchaValue * @param {string} lockAddress * @param {number} network * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDataForRecipientsAndCaptcha(recipients: Array, captchaValue: string, lockAddress: string, network: number, options?: any): AxiosPromise; /** * Get the data for recipients and gitcoin passport. This is to be used in conjunction with the Gitcoin passport scorer. * @param {number} network The network the lock is on * @param {string} [lockAddress] The address of the lock * @param {Array} [recipients] The list of recipients for the purchase * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDataForRecipientsAndGitcoinPassport(network: number, lockAddress?: string, recipients?: Array, options?: any): AxiosPromise; /** * Get the data for recipients and guild. This is to be used in conjunction with the Guild * @param {number} network The network the lock is on * @param {string} [lockAddress] The address of the lock * @param {Array} [recipients] The list of recipients for the purchase * @param {*} [options] Override http request option. * @throws {RequiredError} */ getDataForRecipientsAndGuild(network: number, lockAddress?: string, recipients?: Array, options?: any): AxiosPromise; /** * Retrieves an event based on its slug. The event data including status and transactionHash can be accessed through the `data` property. * @param {string} slug Slug * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEvent(slug: string, options?: any): AxiosPromise; /** * Get details of an event collection * @param {string} slug * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEventCollection(slug: string, options?: any): AxiosPromise; /** * Get the event details from lock * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ getEventDetails(network: number, lockAddress: string, options?: any): AxiosPromise; /** * get a ticket for a key by event. * @param {string} slug Slug * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEventTicket(slug: string, network: number, lockAddress: string, keyId: string, options?: any): AxiosPromise; /** * Get events in a collection * @param {string} slug * @param {number} [page] * @param {number} [pageSize] * @param {*} [options] Override http request option. * @throws {RequiredError} */ getEventsInCollection(slug: string, page?: number, pageSize?: number, options?: any): AxiosPromise; /** * Get job result by job id * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} jobId Id of the exported job. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getExportedKeys(network: number, lockAddress: string, jobId: string, options?: any): AxiosPromise; /** * Get saved lock settings * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLockSettings(network: number, lockAddress: string, options?: any): AxiosPromise; /** * Get lock setting by slug * @param {string} slug Slug * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLockSettingsBySlug(slug: string, options?: any): AxiosPromise; /** * Returns Stripe connection details * @param {string} lockAddress Lock address. * @param {number} chain Lock network * @param {*} [options] Override http request option. * @throws {RequiredError} */ getLockStripeConnectionDetails(lockAddress: string, chain: number, options?: any): AxiosPromise; /** * Get receipt details * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} hash Hash * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReceipt(network: number, lockAddress: string, hash: string, options?: any): AxiosPromise; /** * Get all receipts for a lock * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReceipts(network: number, lockAddress: string, options?: any): AxiosPromise; /** * Get supplier details * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReceiptsBase(network: number, lockAddress: string, options?: any): AxiosPromise; /** * Retrieve the status of receipt generation for a lock. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getReceiptsStatus(network: number, lockAddress: string, options?: any): AxiosPromise; /** * Lists the locks connected to Stripe for a user * @param {*} [options] Override http request option. * @throws {RequiredError} */ getStripeConnections(options?: any): AxiosPromise; /** * Get an active subscription associated with the key. It can be fiat or crypto. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getSubscription(network: number, lockAddress: string, keyId: string, options?: any): AxiosPromise; /** * get a ticket for a key by lock. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getTicket(network: number, lockAddress: string, keyId: string, options?: any): AxiosPromise; /** * Get unapproved events for a collection * @param {string} slug * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUnapprovedEventsForCollection(slug: string, options?: any): AxiosPromise; /** * Gets User account type by email. * @param {string} emailAddress * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserAccountType(emailAddress: string, options?: any): AxiosPromise; /** * get user metadata for a lock. * @param {string} lockAddress Lock address. * @param {string} userAddress User address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserMetadata(lockAddress: string, userAddress: string, options?: any): AxiosPromise; /** * Given a user\'s email address, retrieves their private key. In the case of failure a rejected promise is returned to the caller. * @param {string} emailAddress * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserPrivateKey(emailAddress: string, options?: any): AxiosPromise; /** * Given a user\'s email address, retrieves their recovery phrase. In the case of failure a rejected promise is returned to the caller. * @param {string} emailAddress * @param {*} [options] Override http request option. * @throws {RequiredError} */ getUserRecoveryPhrase(emailAddress: string, options?: any): AxiosPromise; /** * Gets Coinbase WAAS token for user by email and selected provider. * @param {string} captcha Recaptcha value to pass. * @param {string} emailAddress * @param {string} selectedProvider * @param {GetWaasTokenRequest} getWaasTokenRequest JSON object containing sign in token * @param {*} [options] Override http request option. * @throws {RequiredError} */ getWaasToken(captcha: string, emailAddress: string, selectedProvider: string, getWaasTokenRequest: GetWaasTokenRequest, options?: any): AxiosPromise; /** * Returns if credit card payment are enable for a lock * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ isCardPaymentEnabledForLock(network: number, lockAddress: string, options?: any): AxiosPromise; /** * Get key and user metadata. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ keyMetadata(network: number, lockAddress: string, keyId: string, options?: any): AxiosPromise; /** * List of lock keys by network with additional metadata if the caller is the lockManager (deprecated, use keys-by-page) * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} query Query you want to search for. * @param {string} filterKey The key you want to search on. * @param {string} [expiration] Expiration time * @param {string} [approval] Approval status (relevant for offchain approvals on events for example) * @param {number} [page] Page number when paginating * @param {number} [max] Maximum number of items to get by page * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ keys(network: number, lockAddress: string, query: string, filterKey: string, expiration?: string, approval?: string, page?: number, max?: number, options?: any): AxiosPromise>; /** * List of lock keys by network with additional metadata if the caller is the lockManager * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} query Query you want to search for. * @param {string} filterKey The key you want to search on. * @param {string} [expiration] Expiration time * @param {string} [approval] Approval status (relevant for offchain approvals on events for example) * @param {number} [page] Page number when paginating * @param {number} [max] Maximum number of items to get by page * @param {*} [options] Override http request option. * @throws {RequiredError} */ keysByPage(network: number, lockAddress: string, query: string, filterKey: string, expiration?: string, approval?: string, page?: number, max?: number, options?: any): AxiosPromise; /** * A list of all checkout configs created by the user * @param {*} [options] Override http request option. * @throws {RequiredError} */ listCheckoutConfigs(options?: any): AxiosPromise; /** * List payment methods for user. * @param {*} [options] Override http request option. * @throws {RequiredError} */ listPaymentMethods(options?: any): AxiosPromise; /** * Get metadata for lock address. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ lockMetadata(network: number, lockAddress: string, options?: any): AxiosPromise<{ [key: string]: any; }>; /** * Login as a user using Sign in with Ethereum message signed by the wallet address. * @param {LoginRequest} loginRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ login(loginRequest: LoginRequest, options?: any): AxiosPromise; /** * Verify an access token using Privy\'s library and authenticate the user * @param {LoginWithPrivyRequest} loginWithPrivyRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ loginWithPrivy(loginWithPrivyRequest: LoginWithPrivyRequest, options?: any): AxiosPromise; /** * Logout from locksmith. This will invalidate all your session tokens. * @param {*} [options] Override http request option. * @throws {RequiredError} */ logout(options?: any): AxiosPromise; /** * Provide a unique nonce for using in sign in with ethereum * @param {*} [options] Override http request option. * @throws {RequiredError} */ nonce(options?: any): AxiosPromise; /** * * @param {number} network Network id. * @param {number} [amount] Amount of tokens you want to get the price for in USD. * @param {string} [address] The erc20 address you want to get the price for. If nothing is passed, the API will return the native token price. * @param {*} [options] Override http request option. * @throws {RequiredError} */ price(network: number, amount?: number, address?: string, options?: any): AxiosPromise; /** * Create purchase intent for stripe. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {PurchaseRequest} purchaseRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ purchase(network: number, lockAddress: string, purchaseRequest: PurchaseRequest, options?: any): AxiosPromise; /** * resubscribe emails from lock * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ reSubscribeEmail(network: number, lockAddress: string, options?: any): AxiosPromise; /** * Remove a single event from an event collection. * @param {string} slug Slug of the event collection. * @param {RemoveEventBody} removeEventBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeEventFromCollection(slug: string, removeEventBody: RemoveEventBody, options?: any): AxiosPromise; /** * Remove a manager address from an event collection * @param {string} slug * @param {RemoveManagerBody} removeManagerBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ removeManagerFromEventCollection(slug: string, removeManagerBody: RemoveManagerBody, options?: any): AxiosPromise; /** * Remove all payment methods for a user * @param {*} [options] Override http request option. * @throws {RequiredError} */ removePaymentMethods(options?: any): AxiosPromise; /** * Invalidate a session. * @param {*} [options] Override http request option. * @throws {RequiredError} */ revoke(options?: any): AxiosPromise; /** * User applies to attend an event. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} captcha Recaptcha value to pass. * @param {RsvpRequest} [rsvpRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ rsvp(network: number, lockAddress: string, captcha: string, rsvpRequest?: RsvpRequest, options?: any): AxiosPromise; /** * Save custom email content for a specif lock. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} template Template id for email * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveCustomEmailContent(network: number, lockAddress: string, template: string, options?: any): AxiosPromise; /** * Save event data * @param {SaveEventDataRequest} saveEventDataRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveEventData(saveEventDataRequest: SaveEventDataRequest, options?: any): AxiosPromise; /** * Save lock settings * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {LockSettings} [lockSettings] * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveLockSetting(network: number, lockAddress: string, lockSettings?: LockSettings, options?: any): AxiosPromise; /** * Saves a merkle tree from either a list of addresses or a list of [address, amount] tuples. * @param {Array} saveMerkleTreeRequestInner * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveMerkleTree(saveMerkleTreeRequestInner: Array, options?: any): AxiosPromise; /** * Create purchaser details * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} hash Hash * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveReceipt(network: number, lockAddress: string, hash: string, options?: any): AxiosPromise; /** * Create supplier details. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ saveReceiptsBase(network: number, lockAddress: string, options?: any): AxiosPromise; /** * Send custom email to recipients * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {SendCustomEmailRequest} [sendCustomEmailRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendCustomEmail(network: number, lockAddress: string, sendCustomEmailRequest?: SendCustomEmailRequest, options?: any): AxiosPromise; /** * Send event invites to a list of recipients * @param {string} slug Slug * @param {SendEventInvitesRequest} [sendEventInvitesRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendEventInvites(slug: string, sendEventInvitesRequest?: SendEventInvitesRequest, options?: any): AxiosPromise; /** * Sends a verification code to the user\'s email if the current code is expired or does not exist. * @param {string} captcha Recaptcha value to pass. * @param {string} emailAddress * @param {*} [options] Override http request option. * @throws {RequiredError} */ sendVerificationCode(captcha: string, emailAddress: string, options?: any): AxiosPromise; /** * Setup a payment method for user. * @param {*} [options] Override http request option. * @throws {RequiredError} */ setupPayment(options?: any): AxiosPromise; /** * Generate signature to prove validity of token. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ signTicket(network: number, lockAddress: string, keyId: string, options?: any): AxiosPromise; /** * Get QR code for the key. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ ticketQRCode(network: number, lockAddress: string, keyId: string, options?: any): AxiosPromise; /** * Get the verification URL for the key. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} */ ticketVerificationUrl(network: number, lockAddress: string, keyId: string, options?: any): AxiosPromise; /** * Finalize the transfer of a key to a recipient. This is to copy over any locksmith related data to the recipient\'s account. * @param {TransferDoneRequest} [transferDoneRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ transferDone(transferDoneRequest?: TransferDoneRequest, options?: any): AxiosPromise; /** * Unsubscribe email from lock * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} */ unsubscribeEmail(network: number, lockAddress: string, options?: any): AxiosPromise; /** * Update application by id. * @param {string} id Application id. * @param {ApplicationBody} [applicationBody] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateApplication(id: string, applicationBody?: ApplicationBody, options?: any): AxiosPromise; /** * A new checkout config is created or updated if it already exists * @param {string} id This is optional. If you don\'t pass an ID, a new config will be created. If you pass an ID, the config will be created. * @param {UpdateCheckoutConfigRequest} [updateCheckoutConfigRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateCheckoutConfig(id: string, updateCheckoutConfigRequest?: UpdateCheckoutConfigRequest, options?: any): AxiosPromise; /** * Update an existing event collection * @param {string} slug * @param {EventCollectionBody} eventCollectionBody * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateEventCollection(slug: string, eventCollectionBody: EventCollectionBody, options?: any): AxiosPromise; /** * Update event data * @param {string} slug * @param {UpdateEventDataRequest} [updateEventDataRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateEventData(slug: string, updateEventDataRequest?: UpdateEventDataRequest, options?: any): AxiosPromise; /** * Update or create metadata for key. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {UpdateLockMetadataRequest} updateLockMetadataRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateKeyMetadata(network: number, lockAddress: string, keyId: string, updateLockMetadataRequest: UpdateLockMetadataRequest, options?: any): AxiosPromise<{ [key: string]: any; }>; /** * Update or create metadata for lock address. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {UpdateLockMetadataRequest} updateLockMetadataRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateLockMetadata(network: number, lockAddress: string, updateLockMetadataRequest: UpdateLockMetadataRequest, options?: any): AxiosPromise<{ [key: string]: any; }>; /** * Updates a user\'s private key, using their email address as key. In the case of failure a rejected promise is returned to the caller. * @param {string} emailAddress * @param {UpdateUserEncryptedPrivateKeyRequest} updateUserEncryptedPrivateKeyRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateUserEncryptedPrivateKey(emailAddress: string, updateUserEncryptedPrivateKeyRequest: UpdateUserEncryptedPrivateKeyRequest, options?: any): AxiosPromise; /** * Update or create user metadata for lock. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} userAddress User address. * @param {UpdateUserMetadataRequest} updateUserMetadataRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateUserMetadata(network: number, lockAddress: string, userAddress: string, updateUserMetadataRequest: UpdateUserMetadataRequest, options?: any): AxiosPromise<{ [key: string]: any; }>; /** * Update or create user metadata for lock. * @param {UpdateUsersMetadataRequest} updateUsersMetadataRequest users array containing user metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} */ updateUsersMetadata(updateUsersMetadataRequest: UpdateUsersMetadataRequest, options?: any): AxiosPromise; /** * Upload images to locksmith * @param {Array} [images] * @param {*} [options] Override http request option. * @throws {RequiredError} */ uploadImages(images?: Array, options?: any): AxiosPromise; /** * Get user details. * @param {*} [options] Override http request option. * @throws {RequiredError} */ user(options?: any): AxiosPromise; /** * Check if an address is a verifier of the lock. (deprecated in favor of eventVerifier) * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} verifierAddress User address to use as verifier * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ verifier(network: number, lockAddress: string, verifierAddress: string, options?: any): AxiosPromise; /** * List of verifiers for the lock address. (deprecated in favor of eventVerifiers) * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} */ verifiers(network: number, lockAddress: string, options?: any): AxiosPromise; /** * Verifies the email code sent to the users email address. * @param {string} emailAddress * @param {VerifyEmailCodeRequest} verifyEmailCodeRequest * @param {*} [options] Override http request option. * @throws {RequiredError} */ verifyEmailCode(emailAddress: string, verifyEmailCodeRequest: VerifyEmailCodeRequest, options?: any): AxiosPromise; }; /** * DefaultApi - object-oriented interface * @export * @class DefaultApi * @extends {BaseAPI} */ declare class DefaultApi extends BaseAPI { /** * Add an event to a collection * @param {string} slug * @param {AddEventToCollectionBody} addEventToCollectionBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ addEventToCollection(slug: string, addEventToCollectionBody: AddEventToCollectionBody, options?: AxiosRequestConfig): Promise>; /** * Adds a verifier for an event. * @param {string} slug Slug * @param {string} verifierAddress User address to use as verifier * @param {CreateVerifierRequest} [createVerifierRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ addEventVerifier(slug: string, verifierAddress: string, createVerifierRequest?: CreateVerifierRequest, options?: AxiosRequestConfig): Promise>; /** * Add a new manager address to an event collection * @param {string} slug * @param {AddManagerBody} addManagerBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ addManagerToEventCollection(slug: string, addManagerBody: AddManagerBody, options?: AxiosRequestConfig): Promise>; /** * List applications created the user. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ applications(options?: AxiosRequestConfig): Promise>; /** * Approves users to attend an event. (does not airdrop!) * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {ApproveAttendeesRsvpRequest} approveAttendeesRsvpRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ approveAttendeesRsvp(network: number, lockAddress: string, approveAttendeesRsvpRequest: ApproveAttendeesRsvpRequest, options?: AxiosRequestConfig): Promise>; /** * Approve a single event within an event collection. * @param {string} slug Slug of the event collection. * @param {ApproveEventBody} approveEventBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ approveEvent(slug: string, approveEventBody: ApproveEventBody, options?: AxiosRequestConfig): Promise>; /** * Approves refunds for an event. * @param {string} slug Slug * @param {ApproveRefundsRequest} approveRefundsRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ approveRefunds(slug: string, approveRefundsRequest: ApproveRefundsRequest, options?: AxiosRequestConfig): Promise>; /** * Approves a user to attend an event. (does not airdrop!) * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} userAddress User address. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} * @memberof DefaultApi */ approveRsvp(network: number, lockAddress: string, userAddress: string, options?: AxiosRequestConfig): Promise>; /** * Returns the merkle proof of an approved refund. * @param {string} slug Slug * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ approvedRefunds(slug: string, options?: AxiosRequestConfig): Promise>; /** * * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ balance(options?: AxiosRequestConfig): Promise>; /** * Bulk approve multiple events within an event collection. * @param {string} slug Slug of the event collection. * @param {BulkApproveEventsBody} bulkApproveEventsBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ bulkApproveEvents(slug: string, bulkApproveEventsBody: BulkApproveEventsBody, options?: AxiosRequestConfig): Promise>; /** * Bulk remove multiple events from an event collection. * @param {string} slug Slug of the event collection. * @param {BulkRemoveEventsBody} bulkRemoveEventsBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ bulkRemoveEvents(slug: string, bulkRemoveEventsBody: BulkRemoveEventsBody, options?: AxiosRequestConfig): Promise>; /** * Cancel a fiat subscription. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ cancelSubscription(network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig): Promise>; /** * Capture a purchase * @param {CapturePurchaseRequest} [capturePurchaseRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ capturePurchase(capturePurchaseRequest?: CapturePurchaseRequest, options?: AxiosRequestConfig): Promise>; /** * Check if claim is possible for a given purchase * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {CheckClaimRequest} [checkClaimRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ checkClaim(network: number, lockAddress: string, checkClaimRequest?: CheckClaimRequest, options?: AxiosRequestConfig): Promise>; /** * Mark an event ticket as checked in. * @param {string} slug Slug * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ checkEventTicket(slug: string, network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig): Promise>; /** * Check if a user exists in Privy by email or wallet address * @param {PrivyUserCheckBody} privyUserCheckBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ checkPrivyUser(privyUserCheckBody: PrivyUserCheckBody, options?: AxiosRequestConfig): Promise>; /** * Mark a lock ticket as checked in. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} * @memberof DefaultApi */ checkTicket(network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig): Promise>; /** * Claim a membership key for a lock. If not authenticated, requires an email in the body. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} captcha Recaptcha value to pass. * @param {ClaimRequest} claimRequest * @param {string} [recipient] Recipient address for key * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ claim(network: number, lockAddress: string, captcha: string, claimRequest: ClaimRequest, recipient?: string, options?: AxiosRequestConfig): Promise>; /** * Connect a stripe account to a lock * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {ConnectStripeAccountRequest} [connectStripeAccountRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ connectStripeAccount(network: number, lockAddress: string, connectStripeAccountRequest?: ConnectStripeAccountRequest, options?: AxiosRequestConfig): Promise>; /** * Create application associated with user wallet. * @param {ApplicationBody} applicationBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ createApplication(applicationBody: ApplicationBody, options?: AxiosRequestConfig): Promise>; /** * Request the creation of a ZIP file containing all receipts for a lock. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ createDownloadReceiptsRequest(network: number, lockAddress: string, options?: AxiosRequestConfig): Promise>; /** * Create a new event collection * @param {EventCollectionBody} eventCollectionBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ createEventCollection(eventCollectionBody: EventCollectionBody, options?: AxiosRequestConfig): Promise>; /** * * @param {number} network Network id. * @param {string} captcha Recaptcha value to pass. * @param {LockContractOptions} lockContractOptions * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ createLockContract(network: number, captcha: string, lockContractOptions: LockContractOptions, options?: AxiosRequestConfig): Promise>; /** * Create a transfer code to transfer an airdropped key to an email address. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ createTransferCode(network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig): Promise>; /** * Create verifier. (deprecated in favor of addEventVerifier) * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} verifierAddress User address to use as verifier * @param {CreateVerifierRequest} [createVerifierRequest] * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} * @memberof DefaultApi */ createVerifier(network: number, lockAddress: string, verifierAddress: string, createVerifierRequest?: CreateVerifierRequest, options?: AxiosRequestConfig): Promise>; /** * Delete application by id. * @param {string} id Application id. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ deleteApplication(id: string, options?: AxiosRequestConfig): Promise>; /** * Delete a checkout config * @param {string} id The id of the checkout config * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ deleteCheckoutConfig(id: string, options?: AxiosRequestConfig): Promise>; /** * Removes a verifier for an event. * @param {string} slug Slug * @param {string} verifierAddress User address to use as verifier * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ deleteEventVerifier(slug: string, verifierAddress: string, options?: AxiosRequestConfig): Promise>; /** * Remove verifier. (deprecated in favor of deleteEventVerifier) * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} verifierAddress User address to use as verifier * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} * @memberof DefaultApi */ deleteVerifier(network: number, lockAddress: string, verifierAddress: string, options?: AxiosRequestConfig): Promise>; /** * Denies users to attend an event. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {ApproveAttendeesRsvpRequest} approveAttendeesRsvpRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ denyAttendeesRsvp(network: number, lockAddress: string, approveAttendeesRsvpRequest: ApproveAttendeesRsvpRequest, options?: AxiosRequestConfig): Promise>; /** * Denies a user to attend an event. (does not airdrop!) * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} userAddress User address. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} * @memberof DefaultApi */ denyRsvp(network: number, lockAddress: string, userAddress: string, options?: AxiosRequestConfig): Promise>; /** * Disconnect stripe account. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ disconnectStripe(network: number, lockAddress: string, options?: AxiosRequestConfig): Promise>; /** * Download the ZIP file containing all receipts for a lock. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ downloadReceipts(network: number, lockAddress: string, options?: AxiosRequestConfig): Promise>; /** * Ejects a user given their public key. In the case of failure, a rejected promise is returned to the caller. * @param {string} publicKey * @param {{ [key: string]: any; }} requestBody Structured data used to generate the signature * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ ejectUser(publicKey: string, requestBody: { [key: string]: any; }, options?: AxiosRequestConfig): Promise>; /** * Send QR code by email. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ emailTicket(network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig): Promise>; /** * List of verifiers for an event. * @param {string} slug Slug * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ eventVerifiers(slug: string, options?: AxiosRequestConfig): Promise>; /** * Starts Job process to get all the keys for the given lock * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} query Query you want to search for. * @param {string} filterKey The key you want to search on. * @param {string} [expiration] Expiration time * @param {string} [approval] Approval status (relevant for offchain approvals on events for example) * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ exportKeys(network: number, lockAddress: string, query: string, filterKey: string, expiration?: string, approval?: string, options?: AxiosRequestConfig): Promise>; /** * Generate and return an Apple Wallet pass for a specified key associated with a lock. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ generateAppleWalletPass(network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig): Promise>; /** * Generate certificate for specific key * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ generateCertificate(network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig): Promise>; /** * Generate and return a Google Wallet pass for a specified key associated with a lock. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ generateGoogleWalletPass(network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig): Promise>; /** * Generate a ticket for a key. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ generateTicket(network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig): Promise>; /** * Get the price breakdown for recipients & total charges with fees for a specific lock * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {Array} purchaseData The purchase data passed to the purchase function * @param {Array} recipients The recipients passed to the purchase function * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getChargesForLock(network: number, lockAddress: string, purchaseData: Array, recipients: Array, options?: AxiosRequestConfig): Promise>; /** * * @param {string} id The id of the checkout config * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getCheckoutConfig(id: string, options?: AxiosRequestConfig): Promise>; /** * Get custom email content for a specific template and lock details * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} template Template id for email * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getCustomEmailContent(network: number, lockAddress: string, template: string, options?: AxiosRequestConfig): Promise>; /** * Retrieves data for recipients and captcha. * @param {Array} recipients * @param {string} captchaValue * @param {string} lockAddress * @param {number} network * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getDataForRecipientsAndCaptcha(recipients: Array, captchaValue: string, lockAddress: string, network: number, options?: AxiosRequestConfig): Promise>; /** * Get the data for recipients and gitcoin passport. This is to be used in conjunction with the Gitcoin passport scorer. * @param {number} network The network the lock is on * @param {string} [lockAddress] The address of the lock * @param {Array} [recipients] The list of recipients for the purchase * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getDataForRecipientsAndGitcoinPassport(network: number, lockAddress?: string, recipients?: Array, options?: AxiosRequestConfig): Promise>; /** * Get the data for recipients and guild. This is to be used in conjunction with the Guild * @param {number} network The network the lock is on * @param {string} [lockAddress] The address of the lock * @param {Array} [recipients] The list of recipients for the purchase * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getDataForRecipientsAndGuild(network: number, lockAddress?: string, recipients?: Array, options?: AxiosRequestConfig): Promise>; /** * Retrieves an event based on its slug. The event data including status and transactionHash can be accessed through the `data` property. * @param {string} slug Slug * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getEvent(slug: string, options?: AxiosRequestConfig): Promise>; /** * Get details of an event collection * @param {string} slug * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getEventCollection(slug: string, options?: AxiosRequestConfig): Promise>; /** * Get the event details from lock * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} * @memberof DefaultApi */ getEventDetails(network: number, lockAddress: string, options?: AxiosRequestConfig): Promise>; /** * get a ticket for a key by event. * @param {string} slug Slug * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getEventTicket(slug: string, network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig): Promise>; /** * Get events in a collection * @param {string} slug * @param {number} [page] * @param {number} [pageSize] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getEventsInCollection(slug: string, page?: number, pageSize?: number, options?: AxiosRequestConfig): Promise>; /** * Get job result by job id * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} jobId Id of the exported job. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getExportedKeys(network: number, lockAddress: string, jobId: string, options?: AxiosRequestConfig): Promise>; /** * Get saved lock settings * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getLockSettings(network: number, lockAddress: string, options?: AxiosRequestConfig): Promise>; /** * Get lock setting by slug * @param {string} slug Slug * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getLockSettingsBySlug(slug: string, options?: AxiosRequestConfig): Promise>; /** * Returns Stripe connection details * @param {string} lockAddress Lock address. * @param {number} chain Lock network * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getLockStripeConnectionDetails(lockAddress: string, chain: number, options?: AxiosRequestConfig): Promise>; /** * Get receipt details * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} hash Hash * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getReceipt(network: number, lockAddress: string, hash: string, options?: AxiosRequestConfig): Promise>; /** * Get all receipts for a lock * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getReceipts(network: number, lockAddress: string, options?: AxiosRequestConfig): Promise>; /** * Get supplier details * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getReceiptsBase(network: number, lockAddress: string, options?: AxiosRequestConfig): Promise>; /** * Retrieve the status of receipt generation for a lock. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getReceiptsStatus(network: number, lockAddress: string, options?: AxiosRequestConfig): Promise>; /** * Lists the locks connected to Stripe for a user * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getStripeConnections(options?: AxiosRequestConfig): Promise>; /** * Get an active subscription associated with the key. It can be fiat or crypto. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getSubscription(network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig): Promise>; /** * get a ticket for a key by lock. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getTicket(network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig): Promise>; /** * Get unapproved events for a collection * @param {string} slug * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getUnapprovedEventsForCollection(slug: string, options?: AxiosRequestConfig): Promise>; /** * Gets User account type by email. * @param {string} emailAddress * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getUserAccountType(emailAddress: string, options?: AxiosRequestConfig): Promise>; /** * get user metadata for a lock. * @param {string} lockAddress Lock address. * @param {string} userAddress User address. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getUserMetadata(lockAddress: string, userAddress: string, options?: AxiosRequestConfig): Promise>; /** * Given a user\'s email address, retrieves their private key. In the case of failure a rejected promise is returned to the caller. * @param {string} emailAddress * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getUserPrivateKey(emailAddress: string, options?: AxiosRequestConfig): Promise>; /** * Given a user\'s email address, retrieves their recovery phrase. In the case of failure a rejected promise is returned to the caller. * @param {string} emailAddress * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getUserRecoveryPhrase(emailAddress: string, options?: AxiosRequestConfig): Promise>; /** * Gets Coinbase WAAS token for user by email and selected provider. * @param {string} captcha Recaptcha value to pass. * @param {string} emailAddress * @param {string} selectedProvider * @param {GetWaasTokenRequest} getWaasTokenRequest JSON object containing sign in token * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ getWaasToken(captcha: string, emailAddress: string, selectedProvider: string, getWaasTokenRequest: GetWaasTokenRequest, options?: AxiosRequestConfig): Promise>; /** * Returns if credit card payment are enable for a lock * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ isCardPaymentEnabledForLock(network: number, lockAddress: string, options?: AxiosRequestConfig): Promise>; /** * Get key and user metadata. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ keyMetadata(network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig): Promise>; /** * List of lock keys by network with additional metadata if the caller is the lockManager (deprecated, use keys-by-page) * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} query Query you want to search for. * @param {string} filterKey The key you want to search on. * @param {string} [expiration] Expiration time * @param {string} [approval] Approval status (relevant for offchain approvals on events for example) * @param {number} [page] Page number when paginating * @param {number} [max] Maximum number of items to get by page * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} * @memberof DefaultApi */ keys(network: number, lockAddress: string, query: string, filterKey: string, expiration?: string, approval?: string, page?: number, max?: number, options?: AxiosRequestConfig): Promise>; /** * List of lock keys by network with additional metadata if the caller is the lockManager * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} query Query you want to search for. * @param {string} filterKey The key you want to search on. * @param {string} [expiration] Expiration time * @param {string} [approval] Approval status (relevant for offchain approvals on events for example) * @param {number} [page] Page number when paginating * @param {number} [max] Maximum number of items to get by page * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ keysByPage(network: number, lockAddress: string, query: string, filterKey: string, expiration?: string, approval?: string, page?: number, max?: number, options?: AxiosRequestConfig): Promise>; /** * A list of all checkout configs created by the user * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ listCheckoutConfigs(options?: AxiosRequestConfig): Promise>; /** * List payment methods for user. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ listPaymentMethods(options?: AxiosRequestConfig): Promise>; /** * Get metadata for lock address. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ lockMetadata(network: number, lockAddress: string, options?: AxiosRequestConfig): Promise>; /** * Login as a user using Sign in with Ethereum message signed by the wallet address. * @param {LoginRequest} loginRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ login(loginRequest: LoginRequest, options?: AxiosRequestConfig): Promise>; /** * Verify an access token using Privy\'s library and authenticate the user * @param {LoginWithPrivyRequest} loginWithPrivyRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ loginWithPrivy(loginWithPrivyRequest: LoginWithPrivyRequest, options?: AxiosRequestConfig): Promise>; /** * Logout from locksmith. This will invalidate all your session tokens. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ logout(options?: AxiosRequestConfig): Promise>; /** * Provide a unique nonce for using in sign in with ethereum * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ nonce(options?: AxiosRequestConfig): Promise>; /** * * @param {number} network Network id. * @param {number} [amount] Amount of tokens you want to get the price for in USD. * @param {string} [address] The erc20 address you want to get the price for. If nothing is passed, the API will return the native token price. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ price(network: number, amount?: number, address?: string, options?: AxiosRequestConfig): Promise>; /** * Create purchase intent for stripe. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {PurchaseRequest} purchaseRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ purchase(network: number, lockAddress: string, purchaseRequest: PurchaseRequest, options?: AxiosRequestConfig): Promise>; /** * resubscribe emails from lock * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ reSubscribeEmail(network: number, lockAddress: string, options?: AxiosRequestConfig): Promise>; /** * Remove a single event from an event collection. * @param {string} slug Slug of the event collection. * @param {RemoveEventBody} removeEventBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ removeEventFromCollection(slug: string, removeEventBody: RemoveEventBody, options?: AxiosRequestConfig): Promise>; /** * Remove a manager address from an event collection * @param {string} slug * @param {RemoveManagerBody} removeManagerBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ removeManagerFromEventCollection(slug: string, removeManagerBody: RemoveManagerBody, options?: AxiosRequestConfig): Promise>; /** * Remove all payment methods for a user * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ removePaymentMethods(options?: AxiosRequestConfig): Promise>; /** * Invalidate a session. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ revoke(options?: AxiosRequestConfig): Promise>; /** * User applies to attend an event. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} captcha Recaptcha value to pass. * @param {RsvpRequest} [rsvpRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ rsvp(network: number, lockAddress: string, captcha: string, rsvpRequest?: RsvpRequest, options?: AxiosRequestConfig): Promise>; /** * Save custom email content for a specif lock. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} template Template id for email * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ saveCustomEmailContent(network: number, lockAddress: string, template: string, options?: AxiosRequestConfig): Promise>; /** * Save event data * @param {SaveEventDataRequest} saveEventDataRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ saveEventData(saveEventDataRequest: SaveEventDataRequest, options?: AxiosRequestConfig): Promise>; /** * Save lock settings * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {LockSettings} [lockSettings] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ saveLockSetting(network: number, lockAddress: string, lockSettings?: LockSettings, options?: AxiosRequestConfig): Promise>; /** * Saves a merkle tree from either a list of addresses or a list of [address, amount] tuples. * @param {Array} saveMerkleTreeRequestInner * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ saveMerkleTree(saveMerkleTreeRequestInner: Array, options?: AxiosRequestConfig): Promise>; /** * Create purchaser details * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} hash Hash * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ saveReceipt(network: number, lockAddress: string, hash: string, options?: AxiosRequestConfig): Promise>; /** * Create supplier details. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ saveReceiptsBase(network: number, lockAddress: string, options?: AxiosRequestConfig): Promise>; /** * Send custom email to recipients * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {SendCustomEmailRequest} [sendCustomEmailRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ sendCustomEmail(network: number, lockAddress: string, sendCustomEmailRequest?: SendCustomEmailRequest, options?: AxiosRequestConfig): Promise>; /** * Send event invites to a list of recipients * @param {string} slug Slug * @param {SendEventInvitesRequest} [sendEventInvitesRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ sendEventInvites(slug: string, sendEventInvitesRequest?: SendEventInvitesRequest, options?: AxiosRequestConfig): Promise>; /** * Sends a verification code to the user\'s email if the current code is expired or does not exist. * @param {string} captcha Recaptcha value to pass. * @param {string} emailAddress * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ sendVerificationCode(captcha: string, emailAddress: string, options?: AxiosRequestConfig): Promise>; /** * Setup a payment method for user. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ setupPayment(options?: AxiosRequestConfig): Promise>; /** * Generate signature to prove validity of token. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ signTicket(network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig): Promise>; /** * Get QR code for the key. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ ticketQRCode(network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig): Promise>; /** * Get the verification URL for the key. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ ticketVerificationUrl(network: number, lockAddress: string, keyId: string, options?: AxiosRequestConfig): Promise>; /** * Finalize the transfer of a key to a recipient. This is to copy over any locksmith related data to the recipient\'s account. * @param {TransferDoneRequest} [transferDoneRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ transferDone(transferDoneRequest?: TransferDoneRequest, options?: AxiosRequestConfig): Promise>; /** * Unsubscribe email from lock * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ unsubscribeEmail(network: number, lockAddress: string, options?: AxiosRequestConfig): Promise>; /** * Update application by id. * @param {string} id Application id. * @param {ApplicationBody} [applicationBody] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ updateApplication(id: string, applicationBody?: ApplicationBody, options?: AxiosRequestConfig): Promise>; /** * A new checkout config is created or updated if it already exists * @param {string} id This is optional. If you don\'t pass an ID, a new config will be created. If you pass an ID, the config will be created. * @param {UpdateCheckoutConfigRequest} [updateCheckoutConfigRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ updateCheckoutConfig(id: string, updateCheckoutConfigRequest?: UpdateCheckoutConfigRequest, options?: AxiosRequestConfig): Promise>; /** * Update an existing event collection * @param {string} slug * @param {EventCollectionBody} eventCollectionBody * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ updateEventCollection(slug: string, eventCollectionBody: EventCollectionBody, options?: AxiosRequestConfig): Promise>; /** * Update event data * @param {string} slug * @param {UpdateEventDataRequest} [updateEventDataRequest] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ updateEventData(slug: string, updateEventDataRequest?: UpdateEventDataRequest, options?: AxiosRequestConfig): Promise>; /** * Update or create metadata for key. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} keyId Key Id. * @param {UpdateLockMetadataRequest} updateLockMetadataRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ updateKeyMetadata(network: number, lockAddress: string, keyId: string, updateLockMetadataRequest: UpdateLockMetadataRequest, options?: AxiosRequestConfig): Promise>; /** * Update or create metadata for lock address. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {UpdateLockMetadataRequest} updateLockMetadataRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ updateLockMetadata(network: number, lockAddress: string, updateLockMetadataRequest: UpdateLockMetadataRequest, options?: AxiosRequestConfig): Promise>; /** * Updates a user\'s private key, using their email address as key. In the case of failure a rejected promise is returned to the caller. * @param {string} emailAddress * @param {UpdateUserEncryptedPrivateKeyRequest} updateUserEncryptedPrivateKeyRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ updateUserEncryptedPrivateKey(emailAddress: string, updateUserEncryptedPrivateKeyRequest: UpdateUserEncryptedPrivateKeyRequest, options?: AxiosRequestConfig): Promise>; /** * Update or create user metadata for lock. * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} userAddress User address. * @param {UpdateUserMetadataRequest} updateUserMetadataRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ updateUserMetadata(network: number, lockAddress: string, userAddress: string, updateUserMetadataRequest: UpdateUserMetadataRequest, options?: AxiosRequestConfig): Promise>; /** * Update or create user metadata for lock. * @param {UpdateUsersMetadataRequest} updateUsersMetadataRequest users array containing user metadata. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ updateUsersMetadata(updateUsersMetadataRequest: UpdateUsersMetadataRequest, options?: AxiosRequestConfig): Promise>; /** * Upload images to locksmith * @param {Array} [images] * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ uploadImages(images?: Array, options?: AxiosRequestConfig): Promise>; /** * Get user details. * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ user(options?: AxiosRequestConfig): Promise>; /** * Check if an address is a verifier of the lock. (deprecated in favor of eventVerifier) * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {string} verifierAddress User address to use as verifier * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} * @memberof DefaultApi */ verifier(network: number, lockAddress: string, verifierAddress: string, options?: AxiosRequestConfig): Promise>; /** * List of verifiers for the lock address. (deprecated in favor of eventVerifiers) * @param {number} network Network id. * @param {string} lockAddress Lock address. * @param {*} [options] Override http request option. * @deprecated * @throws {RequiredError} * @memberof DefaultApi */ verifiers(network: number, lockAddress: string, options?: AxiosRequestConfig): Promise>; /** * Verifies the email code sent to the users email address. * @param {string} emailAddress * @param {VerifyEmailCodeRequest} verifyEmailCodeRequest * @param {*} [options] Override http request option. * @throws {RequiredError} * @memberof DefaultApi */ verifyEmailCode(emailAddress: string, verifyEmailCodeRequest: VerifyEmailCodeRequest, options?: AxiosRequestConfig): Promise>; } declare class LocksmithService extends DefaultApi { /** * Helper static createSiweMessage method wrapping SIWE or sign in with ethereum standard message */ static createSiweMessage(options: Partial): SiweMessage; } type Maybe = T | null; type InputMaybe = Maybe; type Exact = { [K in keyof T]: T[K]; }; /** All built-in and custom scalars, mapped to their actual values */ type Scalars = { ID: { input: string; output: string; }; String: { input: string; output: string; }; Boolean: { input: boolean; output: boolean; }; Int: { input: number; output: number; }; Float: { input: number; output: number; }; BigDecimal: { input: any; output: any; }; BigInt: { input: any; output: any; }; Bytes: { input: any; output: any; }; Int8: { input: any; output: any; }; Timestamp: { input: any; output: any; }; }; type BlockChangedFilter = { number_gte: Scalars['Int']['input']; }; type Key = { __typename?: 'Key'; /** Invoked by a Lock manager to expire the user's key and perform a refund and cancellation of the key */ cancelled?: Maybe; /** Timestamp of the block in which the key was created */ createdAt: Scalars['BigInt']['output']; /** Block key was created */ createdAtBlock: Scalars['BigInt']['output']; /** Time the key expires */ expiration: Scalars['BigInt']['output']; /** Unique identifier for a key (combination of lock address and token id) */ id: Scalars['ID']['output']; /** In the Unlock ecosystem, a “Lock” is a smart contract that creates (or “mints”) NFTs */ lock: Lock; /** An assigned title set on an Unlock key which gives a specific wallet address authorization to transfer, share or cancel */ manager?: Maybe; /** The address of the key owner */ owner: Scalars['Bytes']['output']; /** TokenId for a given key */ tokenId: Scalars['BigInt']['output']; /** The tokenURI on an NFT is a unique identifier */ tokenURI?: Maybe; /** list of transaction hashes for purchase/extensions of a specific token */ transactionsHash?: Maybe>; }; type Key_Filter = { /** Filter for the block changed event. */ _change_block?: InputMaybe; and?: InputMaybe>>; cancelled?: InputMaybe; cancelled_in?: InputMaybe>; cancelled_not?: InputMaybe; cancelled_not_in?: InputMaybe>; createdAt?: InputMaybe; createdAtBlock?: InputMaybe; createdAtBlock_gt?: InputMaybe; createdAtBlock_gte?: InputMaybe; createdAtBlock_in?: InputMaybe>; createdAtBlock_lt?: InputMaybe; createdAtBlock_lte?: InputMaybe; createdAtBlock_not?: InputMaybe; createdAtBlock_not_in?: InputMaybe>; createdAt_gt?: InputMaybe; createdAt_gte?: InputMaybe; createdAt_in?: InputMaybe>; createdAt_lt?: InputMaybe; createdAt_lte?: InputMaybe; createdAt_not?: InputMaybe; createdAt_not_in?: InputMaybe>; expiration?: InputMaybe; expiration_gt?: InputMaybe; expiration_gte?: InputMaybe; expiration_in?: InputMaybe>; expiration_lt?: InputMaybe; expiration_lte?: InputMaybe; expiration_not?: InputMaybe; expiration_not_in?: InputMaybe>; id?: InputMaybe; id_gt?: InputMaybe; id_gte?: InputMaybe; id_in?: InputMaybe>; id_lt?: InputMaybe; id_lte?: InputMaybe; id_not?: InputMaybe; id_not_in?: InputMaybe>; lock?: InputMaybe; lock_?: InputMaybe; lock_contains?: InputMaybe; lock_contains_nocase?: InputMaybe; lock_ends_with?: InputMaybe; lock_ends_with_nocase?: InputMaybe; lock_gt?: InputMaybe; lock_gte?: InputMaybe; lock_in?: InputMaybe>; lock_lt?: InputMaybe; lock_lte?: InputMaybe; lock_not?: InputMaybe; lock_not_contains?: InputMaybe; lock_not_contains_nocase?: InputMaybe; lock_not_ends_with?: InputMaybe; lock_not_ends_with_nocase?: InputMaybe; lock_not_in?: InputMaybe>; lock_not_starts_with?: InputMaybe; lock_not_starts_with_nocase?: InputMaybe; lock_starts_with?: InputMaybe; lock_starts_with_nocase?: InputMaybe; manager?: InputMaybe; manager_contains?: InputMaybe; manager_gt?: InputMaybe; manager_gte?: InputMaybe; manager_in?: InputMaybe>; manager_lt?: InputMaybe; manager_lte?: InputMaybe; manager_not?: InputMaybe; manager_not_contains?: InputMaybe; manager_not_in?: InputMaybe>; or?: InputMaybe>>; owner?: InputMaybe; owner_contains?: InputMaybe; owner_gt?: InputMaybe; owner_gte?: InputMaybe; owner_in?: InputMaybe>; owner_lt?: InputMaybe; owner_lte?: InputMaybe; owner_not?: InputMaybe; owner_not_contains?: InputMaybe; owner_not_in?: InputMaybe>; tokenId?: InputMaybe; tokenId_gt?: InputMaybe; tokenId_gte?: InputMaybe; tokenId_in?: InputMaybe>; tokenId_lt?: InputMaybe; tokenId_lte?: InputMaybe; tokenId_not?: InputMaybe; tokenId_not_in?: InputMaybe>; tokenURI?: InputMaybe; tokenURI_contains?: InputMaybe; tokenURI_contains_nocase?: InputMaybe; tokenURI_ends_with?: InputMaybe; tokenURI_ends_with_nocase?: InputMaybe; tokenURI_gt?: InputMaybe; tokenURI_gte?: InputMaybe; tokenURI_in?: InputMaybe>; tokenURI_lt?: InputMaybe; tokenURI_lte?: InputMaybe; tokenURI_not?: InputMaybe; tokenURI_not_contains?: InputMaybe; tokenURI_not_contains_nocase?: InputMaybe; tokenURI_not_ends_with?: InputMaybe; tokenURI_not_ends_with_nocase?: InputMaybe; tokenURI_not_in?: InputMaybe>; tokenURI_not_starts_with?: InputMaybe; tokenURI_not_starts_with_nocase?: InputMaybe; tokenURI_starts_with?: InputMaybe; tokenURI_starts_with_nocase?: InputMaybe; transactionsHash?: InputMaybe>; transactionsHash_contains?: InputMaybe>; transactionsHash_contains_nocase?: InputMaybe>; transactionsHash_not?: InputMaybe>; transactionsHash_not_contains?: InputMaybe>; transactionsHash_not_contains_nocase?: InputMaybe>; }; declare enum Key_OrderBy { Cancelled = "cancelled", CreatedAt = "createdAt", CreatedAtBlock = "createdAtBlock", Expiration = "expiration", Id = "id", Lock = "lock", LockAddress = "lock__address", LockCreatedAtBlock = "lock__createdAtBlock", LockCreationTransactionHash = "lock__creationTransactionHash", LockDeployer = "lock__deployer", LockExpirationDuration = "lock__expirationDuration", LockId = "lock__id", LockLastKeyMintedAt = "lock__lastKeyMintedAt", LockLastKeyRenewedAt = "lock__lastKeyRenewedAt", LockMaxKeysPerAddress = "lock__maxKeysPerAddress", LockMaxNumberOfKeys = "lock__maxNumberOfKeys", LockName = "lock__name", LockNumberOfCancelReceipts = "lock__numberOfCancelReceipts", LockNumberOfReceipts = "lock__numberOfReceipts", LockPrice = "lock__price", LockSymbol = "lock__symbol", LockTokenAddress = "lock__tokenAddress", LockTotalKeys = "lock__totalKeys", LockVersion = "lock__version", Manager = "manager", Owner = "owner", TokenId = "tokenId", TokenUri = "tokenURI", TransactionsHash = "transactionsHash" } type Lock = { __typename?: 'Lock'; /** Address of the lock */ address: Scalars['Bytes']['output']; /** Which block the lock was created */ createdAtBlock?: Maybe; /** transaction hash of the lock's creation */ creationTransactionHash: Scalars['String']['output']; /** Address of the lock deployer */ deployer: Scalars['Bytes']['output']; /** Duration is set the on the lock when you deploy and the expiration which is set on each key when they are minted */ expirationDuration?: Maybe; /** Unique ID for the Lock object (uses the lock address) */ id: Scalars['ID']['output']; /** * Key Granters role for key. * The lock creator is the default KeyGranter. * The primary reason for this role is to support additional purchase mechanisms beyond direct key purchases like credit-card purchases. * */ keyGranters: Array; /** Refer to key entity */ keys?: Maybe>; /** The timestamp of the block in which the last key was minted */ lastKeyMintedAt?: Maybe; /** The timestamp of the block in which the last key was renewed */ lastKeyRenewedAt?: Maybe; /** An assigned role set on a Lock contract which gives the highest level of permissions to the wallet address set to that role */ lockManagers: Array; /** The maximum number of keys allowed for a single address */ maxKeysPerAddress?: Maybe; /** Maximum number of keys for sale */ maxNumberOfKeys?: Maybe; /** A descriptive name for a collection of NFTs in this contract */ name?: Maybe; /** Number of cancel receipts of lock */ numberOfCancelReceipts: Scalars['BigInt']['output']; /** Number of receipts of lock */ numberOfReceipts: Scalars['BigInt']['output']; /** Price of the keys sold by the lock */ price: Scalars['BigInt']['output']; /** Referrers fees set per custom address */ referrerFees: Array; /** Token symbol */ symbol?: Maybe; /** Address of the 'currency' ERC20 contract if the keys are priced using an ERC20 */ tokenAddress: Scalars['Bytes']['output']; /** Number of keys minted (expired or not) */ totalKeys: Scalars['BigInt']['output']; /** Unlock Protocol version of a minting contract */ version: Scalars['BigInt']['output']; }; type Lock_Filter = { /** Filter for the block changed event. */ _change_block?: InputMaybe; address?: InputMaybe; address_contains?: InputMaybe; address_gt?: InputMaybe; address_gte?: InputMaybe; address_in?: InputMaybe>; address_lt?: InputMaybe; address_lte?: InputMaybe; address_not?: InputMaybe; address_not_contains?: InputMaybe; address_not_in?: InputMaybe>; and?: InputMaybe>>; createdAtBlock?: InputMaybe; createdAtBlock_gt?: InputMaybe; createdAtBlock_gte?: InputMaybe; createdAtBlock_in?: InputMaybe>; createdAtBlock_lt?: InputMaybe; createdAtBlock_lte?: InputMaybe; createdAtBlock_not?: InputMaybe; createdAtBlock_not_in?: InputMaybe>; creationTransactionHash?: InputMaybe; creationTransactionHash_contains?: InputMaybe; creationTransactionHash_contains_nocase?: InputMaybe; creationTransactionHash_ends_with?: InputMaybe; creationTransactionHash_ends_with_nocase?: InputMaybe; creationTransactionHash_gt?: InputMaybe; creationTransactionHash_gte?: InputMaybe; creationTransactionHash_in?: InputMaybe>; creationTransactionHash_lt?: InputMaybe; creationTransactionHash_lte?: InputMaybe; creationTransactionHash_not?: InputMaybe; creationTransactionHash_not_contains?: InputMaybe; creationTransactionHash_not_contains_nocase?: InputMaybe; creationTransactionHash_not_ends_with?: InputMaybe; creationTransactionHash_not_ends_with_nocase?: InputMaybe; creationTransactionHash_not_in?: InputMaybe>; creationTransactionHash_not_starts_with?: InputMaybe; creationTransactionHash_not_starts_with_nocase?: InputMaybe; creationTransactionHash_starts_with?: InputMaybe; creationTransactionHash_starts_with_nocase?: InputMaybe; deployer?: InputMaybe; deployer_contains?: InputMaybe; deployer_gt?: InputMaybe; deployer_gte?: InputMaybe; deployer_in?: InputMaybe>; deployer_lt?: InputMaybe; deployer_lte?: InputMaybe; deployer_not?: InputMaybe; deployer_not_contains?: InputMaybe; deployer_not_in?: InputMaybe>; expirationDuration?: InputMaybe; expirationDuration_gt?: InputMaybe; expirationDuration_gte?: InputMaybe; expirationDuration_in?: InputMaybe>; expirationDuration_lt?: InputMaybe; expirationDuration_lte?: InputMaybe; expirationDuration_not?: InputMaybe; expirationDuration_not_in?: InputMaybe>; id?: InputMaybe; id_gt?: InputMaybe; id_gte?: InputMaybe; id_in?: InputMaybe>; id_lt?: InputMaybe; id_lte?: InputMaybe; id_not?: InputMaybe; id_not_in?: InputMaybe>; keyGranters?: InputMaybe>; keyGranters_contains?: InputMaybe>; keyGranters_contains_nocase?: InputMaybe>; keyGranters_not?: InputMaybe>; keyGranters_not_contains?: InputMaybe>; keyGranters_not_contains_nocase?: InputMaybe>; keys_?: InputMaybe; lastKeyMintedAt?: InputMaybe; lastKeyMintedAt_gt?: InputMaybe; lastKeyMintedAt_gte?: InputMaybe; lastKeyMintedAt_in?: InputMaybe>; lastKeyMintedAt_lt?: InputMaybe; lastKeyMintedAt_lte?: InputMaybe; lastKeyMintedAt_not?: InputMaybe; lastKeyMintedAt_not_in?: InputMaybe>; lastKeyRenewedAt?: InputMaybe; lastKeyRenewedAt_gt?: InputMaybe; lastKeyRenewedAt_gte?: InputMaybe; lastKeyRenewedAt_in?: InputMaybe>; lastKeyRenewedAt_lt?: InputMaybe; lastKeyRenewedAt_lte?: InputMaybe; lastKeyRenewedAt_not?: InputMaybe; lastKeyRenewedAt_not_in?: InputMaybe>; lockManagers?: InputMaybe>; lockManagers_contains?: InputMaybe>; lockManagers_contains_nocase?: InputMaybe>; lockManagers_not?: InputMaybe>; lockManagers_not_contains?: InputMaybe>; lockManagers_not_contains_nocase?: InputMaybe>; maxKeysPerAddress?: InputMaybe; maxKeysPerAddress_gt?: InputMaybe; maxKeysPerAddress_gte?: InputMaybe; maxKeysPerAddress_in?: InputMaybe>; maxKeysPerAddress_lt?: InputMaybe; maxKeysPerAddress_lte?: InputMaybe; maxKeysPerAddress_not?: InputMaybe; maxKeysPerAddress_not_in?: InputMaybe>; maxNumberOfKeys?: InputMaybe; maxNumberOfKeys_gt?: InputMaybe; maxNumberOfKeys_gte?: InputMaybe; maxNumberOfKeys_in?: InputMaybe>; maxNumberOfKeys_lt?: InputMaybe; maxNumberOfKeys_lte?: InputMaybe; maxNumberOfKeys_not?: InputMaybe; maxNumberOfKeys_not_in?: InputMaybe>; name?: InputMaybe; name_contains?: InputMaybe; name_contains_nocase?: InputMaybe; name_ends_with?: InputMaybe; name_ends_with_nocase?: InputMaybe; name_gt?: InputMaybe; name_gte?: InputMaybe; name_in?: InputMaybe>; name_lt?: InputMaybe; name_lte?: InputMaybe; name_not?: InputMaybe; name_not_contains?: InputMaybe; name_not_contains_nocase?: InputMaybe; name_not_ends_with?: InputMaybe; name_not_ends_with_nocase?: InputMaybe; name_not_in?: InputMaybe>; name_not_starts_with?: InputMaybe; name_not_starts_with_nocase?: InputMaybe; name_starts_with?: InputMaybe; name_starts_with_nocase?: InputMaybe; numberOfCancelReceipts?: InputMaybe; numberOfCancelReceipts_gt?: InputMaybe; numberOfCancelReceipts_gte?: InputMaybe; numberOfCancelReceipts_in?: InputMaybe>; numberOfCancelReceipts_lt?: InputMaybe; numberOfCancelReceipts_lte?: InputMaybe; numberOfCancelReceipts_not?: InputMaybe; numberOfCancelReceipts_not_in?: InputMaybe>; numberOfReceipts?: InputMaybe; numberOfReceipts_gt?: InputMaybe; numberOfReceipts_gte?: InputMaybe; numberOfReceipts_in?: InputMaybe>; numberOfReceipts_lt?: InputMaybe; numberOfReceipts_lte?: InputMaybe; numberOfReceipts_not?: InputMaybe; numberOfReceipts_not_in?: InputMaybe>; or?: InputMaybe>>; price?: InputMaybe; price_gt?: InputMaybe; price_gte?: InputMaybe; price_in?: InputMaybe>; price_lt?: InputMaybe; price_lte?: InputMaybe; price_not?: InputMaybe; price_not_in?: InputMaybe>; referrerFees_?: InputMaybe; symbol?: InputMaybe; symbol_contains?: InputMaybe; symbol_contains_nocase?: InputMaybe; symbol_ends_with?: InputMaybe; symbol_ends_with_nocase?: InputMaybe; symbol_gt?: InputMaybe; symbol_gte?: InputMaybe; symbol_in?: InputMaybe>; symbol_lt?: InputMaybe; symbol_lte?: InputMaybe; symbol_not?: InputMaybe; symbol_not_contains?: InputMaybe; symbol_not_contains_nocase?: InputMaybe; symbol_not_ends_with?: InputMaybe; symbol_not_ends_with_nocase?: InputMaybe; symbol_not_in?: InputMaybe>; symbol_not_starts_with?: InputMaybe; symbol_not_starts_with_nocase?: InputMaybe; symbol_starts_with?: InputMaybe; symbol_starts_with_nocase?: InputMaybe; tokenAddress?: InputMaybe; tokenAddress_contains?: InputMaybe; tokenAddress_gt?: InputMaybe; tokenAddress_gte?: InputMaybe; tokenAddress_in?: InputMaybe>; tokenAddress_lt?: InputMaybe; tokenAddress_lte?: InputMaybe; tokenAddress_not?: InputMaybe; tokenAddress_not_contains?: InputMaybe; tokenAddress_not_in?: InputMaybe>; totalKeys?: InputMaybe; totalKeys_gt?: InputMaybe; totalKeys_gte?: InputMaybe; totalKeys_in?: InputMaybe>; totalKeys_lt?: InputMaybe; totalKeys_lte?: InputMaybe; totalKeys_not?: InputMaybe; totalKeys_not_in?: InputMaybe>; version?: InputMaybe; version_gt?: InputMaybe; version_gte?: InputMaybe; version_in?: InputMaybe>; version_lt?: InputMaybe; version_lte?: InputMaybe; version_not?: InputMaybe; version_not_in?: InputMaybe>; }; declare enum Lock_OrderBy { Address = "address", CreatedAtBlock = "createdAtBlock", CreationTransactionHash = "creationTransactionHash", Deployer = "deployer", ExpirationDuration = "expirationDuration", Id = "id", KeyGranters = "keyGranters", Keys = "keys", LastKeyMintedAt = "lastKeyMintedAt", LastKeyRenewedAt = "lastKeyRenewedAt", LockManagers = "lockManagers", MaxKeysPerAddress = "maxKeysPerAddress", MaxNumberOfKeys = "maxNumberOfKeys", Name = "name", NumberOfCancelReceipts = "numberOfCancelReceipts", NumberOfReceipts = "numberOfReceipts", Price = "price", ReferrerFees = "referrerFees", Symbol = "symbol", TokenAddress = "tokenAddress", TotalKeys = "totalKeys", Version = "version" } /** Defines the order direction, either ascending or descending */ declare enum OrderDirection { Asc = "asc", Desc = "desc" } type Receipt_Filter = { /** Filter for the block changed event. */ _change_block?: InputMaybe; amountTransferred?: InputMaybe; amountTransferred_gt?: InputMaybe; amountTransferred_gte?: InputMaybe; amountTransferred_in?: InputMaybe>; amountTransferred_lt?: InputMaybe; amountTransferred_lte?: InputMaybe; amountTransferred_not?: InputMaybe; amountTransferred_not_in?: InputMaybe>; and?: InputMaybe>>; gasTotal?: InputMaybe; gasTotal_gt?: InputMaybe; gasTotal_gte?: InputMaybe; gasTotal_in?: InputMaybe>; gasTotal_lt?: InputMaybe; gasTotal_lte?: InputMaybe; gasTotal_not?: InputMaybe; gasTotal_not_in?: InputMaybe>; id?: InputMaybe; id_gt?: InputMaybe; id_gte?: InputMaybe; id_in?: InputMaybe>; id_lt?: InputMaybe; id_lte?: InputMaybe; id_not?: InputMaybe; id_not_in?: InputMaybe>; lockAddress?: InputMaybe; lockAddress_contains?: InputMaybe; lockAddress_contains_nocase?: InputMaybe; lockAddress_ends_with?: InputMaybe; lockAddress_ends_with_nocase?: InputMaybe; lockAddress_gt?: InputMaybe; lockAddress_gte?: InputMaybe; lockAddress_in?: InputMaybe>; lockAddress_lt?: InputMaybe; lockAddress_lte?: InputMaybe; lockAddress_not?: InputMaybe; lockAddress_not_contains?: InputMaybe; lockAddress_not_contains_nocase?: InputMaybe; lockAddress_not_ends_with?: InputMaybe; lockAddress_not_ends_with_nocase?: InputMaybe; lockAddress_not_in?: InputMaybe>; lockAddress_not_starts_with?: InputMaybe; lockAddress_not_starts_with_nocase?: InputMaybe; lockAddress_starts_with?: InputMaybe; lockAddress_starts_with_nocase?: InputMaybe; or?: InputMaybe>>; payer?: InputMaybe; payer_contains?: InputMaybe; payer_contains_nocase?: InputMaybe; payer_ends_with?: InputMaybe; payer_ends_with_nocase?: InputMaybe; payer_gt?: InputMaybe; payer_gte?: InputMaybe; payer_in?: InputMaybe>; payer_lt?: InputMaybe; payer_lte?: InputMaybe; payer_not?: InputMaybe; payer_not_contains?: InputMaybe; payer_not_contains_nocase?: InputMaybe; payer_not_ends_with?: InputMaybe; payer_not_ends_with_nocase?: InputMaybe; payer_not_in?: InputMaybe>; payer_not_starts_with?: InputMaybe; payer_not_starts_with_nocase?: InputMaybe; payer_starts_with?: InputMaybe; payer_starts_with_nocase?: InputMaybe; receiptNumber?: InputMaybe; receiptNumber_gt?: InputMaybe; receiptNumber_gte?: InputMaybe; receiptNumber_in?: InputMaybe>; receiptNumber_lt?: InputMaybe; receiptNumber_lte?: InputMaybe; receiptNumber_not?: InputMaybe; receiptNumber_not_in?: InputMaybe>; recipient?: InputMaybe; recipient_contains?: InputMaybe; recipient_contains_nocase?: InputMaybe; recipient_ends_with?: InputMaybe; recipient_ends_with_nocase?: InputMaybe; recipient_gt?: InputMaybe; recipient_gte?: InputMaybe; recipient_in?: InputMaybe>; recipient_lt?: InputMaybe; recipient_lte?: InputMaybe; recipient_not?: InputMaybe; recipient_not_contains?: InputMaybe; recipient_not_contains_nocase?: InputMaybe; recipient_not_ends_with?: InputMaybe; recipient_not_ends_with_nocase?: InputMaybe; recipient_not_in?: InputMaybe>; recipient_not_starts_with?: InputMaybe; recipient_not_starts_with_nocase?: InputMaybe; recipient_starts_with?: InputMaybe; recipient_starts_with_nocase?: InputMaybe; sender?: InputMaybe; sender_contains?: InputMaybe; sender_contains_nocase?: InputMaybe; sender_ends_with?: InputMaybe; sender_ends_with_nocase?: InputMaybe; sender_gt?: InputMaybe; sender_gte?: InputMaybe; sender_in?: InputMaybe>; sender_lt?: InputMaybe; sender_lte?: InputMaybe; sender_not?: InputMaybe; sender_not_contains?: InputMaybe; sender_not_contains_nocase?: InputMaybe; sender_not_ends_with?: InputMaybe; sender_not_ends_with_nocase?: InputMaybe; sender_not_in?: InputMaybe>; sender_not_starts_with?: InputMaybe; sender_not_starts_with_nocase?: InputMaybe; sender_starts_with?: InputMaybe; sender_starts_with_nocase?: InputMaybe; timestamp?: InputMaybe; timestamp_gt?: InputMaybe; timestamp_gte?: InputMaybe; timestamp_in?: InputMaybe>; timestamp_lt?: InputMaybe; timestamp_lte?: InputMaybe; timestamp_not?: InputMaybe; timestamp_not_in?: InputMaybe>; tokenAddress?: InputMaybe; tokenAddress_contains?: InputMaybe; tokenAddress_contains_nocase?: InputMaybe; tokenAddress_ends_with?: InputMaybe; tokenAddress_ends_with_nocase?: InputMaybe; tokenAddress_gt?: InputMaybe; tokenAddress_gte?: InputMaybe; tokenAddress_in?: InputMaybe>; tokenAddress_lt?: InputMaybe; tokenAddress_lte?: InputMaybe; tokenAddress_not?: InputMaybe; tokenAddress_not_contains?: InputMaybe; tokenAddress_not_contains_nocase?: InputMaybe; tokenAddress_not_ends_with?: InputMaybe; tokenAddress_not_ends_with_nocase?: InputMaybe; tokenAddress_not_in?: InputMaybe>; tokenAddress_not_starts_with?: InputMaybe; tokenAddress_not_starts_with_nocase?: InputMaybe; tokenAddress_starts_with?: InputMaybe; tokenAddress_starts_with_nocase?: InputMaybe; }; declare enum Receipt_OrderBy { AmountTransferred = "amountTransferred", GasTotal = "gasTotal", Id = "id", LockAddress = "lockAddress", Payer = "payer", ReceiptNumber = "receiptNumber", Recipient = "recipient", Sender = "sender", Timestamp = "timestamp", TokenAddress = "tokenAddress" } type ReferrerFee = { __typename?: 'ReferrerFee'; /** Fee attributed to the referrer. E.g., 200 represents 20%. */ fee: Scalars['BigInt']['output']; /** Address of the Referrer */ id: Scalars['ID']['output']; /** In the Unlock ecosystem, a “Lock” is a smart contract that creates (or “mints”) NFTs */ lock: Lock; /** Address of the referrer. */ referrer: Scalars['Bytes']['output']; }; type ReferrerFee_Filter = { /** Filter for the block changed event. */ _change_block?: InputMaybe; and?: InputMaybe>>; fee?: InputMaybe; fee_gt?: InputMaybe; fee_gte?: InputMaybe; fee_in?: InputMaybe>; fee_lt?: InputMaybe; fee_lte?: InputMaybe; fee_not?: InputMaybe; fee_not_in?: InputMaybe>; id?: InputMaybe; id_gt?: InputMaybe; id_gte?: InputMaybe; id_in?: InputMaybe>; id_lt?: InputMaybe; id_lte?: InputMaybe; id_not?: InputMaybe; id_not_in?: InputMaybe>; lock?: InputMaybe; lock_?: InputMaybe; lock_contains?: InputMaybe; lock_contains_nocase?: InputMaybe; lock_ends_with?: InputMaybe; lock_ends_with_nocase?: InputMaybe; lock_gt?: InputMaybe; lock_gte?: InputMaybe; lock_in?: InputMaybe>; lock_lt?: InputMaybe; lock_lte?: InputMaybe; lock_not?: InputMaybe; lock_not_contains?: InputMaybe; lock_not_contains_nocase?: InputMaybe; lock_not_ends_with?: InputMaybe; lock_not_ends_with_nocase?: InputMaybe; lock_not_in?: InputMaybe>; lock_not_starts_with?: InputMaybe; lock_not_starts_with_nocase?: InputMaybe; lock_starts_with?: InputMaybe; lock_starts_with_nocase?: InputMaybe; or?: InputMaybe>>; referrer?: InputMaybe; referrer_contains?: InputMaybe; referrer_gt?: InputMaybe; referrer_gte?: InputMaybe; referrer_in?: InputMaybe>; referrer_lt?: InputMaybe; referrer_lte?: InputMaybe; referrer_not?: InputMaybe; referrer_not_contains?: InputMaybe; referrer_not_in?: InputMaybe>; }; type AllLocksQueryVariables = Exact<{ first?: InputMaybe; skip?: InputMaybe; where?: InputMaybe; orderBy?: InputMaybe; orderDirection?: InputMaybe; referrerFeeSkip?: InputMaybe; }>; type AllLocksQuery = { __typename?: 'Query'; locks: Array<{ __typename?: 'Lock'; id: string; address: any; name?: string | null; expirationDuration?: any | null; tokenAddress: any; symbol?: string | null; price: any; lockManagers: Array; keyGranters: Array; version: any; maxNumberOfKeys?: any | null; maxKeysPerAddress?: any | null; createdAtBlock?: any | null; creationTransactionHash: string; totalKeys: any; referrerFees: Array<{ __typename?: 'ReferrerFee'; id: string; referrer: any; fee: any; }>; }>; }; type AllKeysQueryVariables = Exact<{ first?: InputMaybe; skip?: InputMaybe; where?: InputMaybe; orderBy?: InputMaybe; orderDirection?: InputMaybe; }>; type AllKeysQuery = { __typename?: 'Query'; keys: Array<{ __typename?: 'Key'; id: string; tokenId: any; owner: any; manager?: any | null; expiration: any; tokenURI?: string | null; createdAt: any; createdAtBlock: any; cancelled?: boolean | null; transactionsHash?: Array | null; lock: { __typename?: 'Lock'; id: string; address: any; name?: string | null; expirationDuration?: any | null; tokenAddress: any; symbol?: string | null; price: any; lockManagers: Array; keyGranters: Array; version: any; maxNumberOfKeys?: any | null; maxKeysPerAddress?: any | null; createdAtBlock?: any | null; totalKeys: any; }; }>; }; type AllReceiptsQueryVariables = Exact<{ first?: InputMaybe; skip?: InputMaybe; where?: InputMaybe; orderBy?: InputMaybe; orderDirection?: InputMaybe; }>; type AllReceiptsQuery = { __typename?: 'Query'; receipts: Array<{ __typename?: 'Receipt'; id: string; receiptNumber: any; timestamp: any; sender: string; payer?: string | null; recipient?: string | null; lockAddress: string; tokenAddress: string; gasTotal: any; amountTransferred: any; }>; }; type AllLocksWithKeysQueryVariables = Exact<{ first?: InputMaybe; skip?: InputMaybe; where?: InputMaybe; keyFilter?: InputMaybe; orderBy?: InputMaybe; keyOrderBy?: InputMaybe; orderDirection?: InputMaybe; }>; type AllLocksWithKeysQuery = { __typename?: 'Query'; locks: Array<{ __typename?: 'Lock'; id: string; address: any; name?: string | null; expirationDuration?: any | null; tokenAddress: any; symbol?: string | null; price: any; lockManagers: Array; keyGranters: Array; version: any; maxNumberOfKeys?: any | null; maxKeysPerAddress?: any | null; createdAtBlock?: any | null; totalKeys: any; keys?: Array<{ __typename?: 'Key'; id: string; tokenId: any; owner: any; manager?: any | null; expiration: any; tokenURI?: string | null; createdAt: any; createdAtBlock: any; cancelled?: boolean | null; transactionsHash?: Array | null; }> | null; }>; }; interface QueryOptions { networks?: number[] | string[]; } interface SubgraphServiceParams { endpointUrl?: string; networks?: NetworkConfigs; graphqlClientOptions?: RequestConfig; } declare class SubgraphService { networks: NetworkConfigs; endpointUrl?: string; graphqlClientOptions?: RequestConfig; constructor(subgraphServiceParams?: SubgraphServiceParams | NetworkConfigs | string); createSdk(networkId?: number): { allLocks(variables?: AllLocksQueryVariables, requestHeaders?: HeadersInit | undefined): Promise; AllKeys(variables?: AllKeysQueryVariables, requestHeaders?: HeadersInit | undefined): Promise; AllReceipts(variables?: AllReceiptsQueryVariables, requestHeaders?: HeadersInit | undefined): Promise; allLocksWithKeys(variables?: AllLocksWithKeysQueryVariables, requestHeaders?: HeadersInit | undefined): Promise; }; /** * Get locks from multiple networks. By default, all networks will be queried. * If you want to query only specific network, you can pass options as the second parameter with network ids array. * ```ts * const service = new SubgraphService() * const locksOnMainnetAndGoerli = await service.locks({ first: 100, skip: 50, where: {}}, { networks: [1, 5] }) * const locksOnAllNetworks = await service.locks({ first: 1000 }) * ``` */ locks(variables: AllLocksQueryVariables, options?: QueryOptions): Promise<{ network: number; __typename?: "Lock"; id: string; address: any; name?: string | null; expirationDuration?: any | null; tokenAddress: any; symbol?: string | null; price: any; lockManagers: Array; keyGranters: Array; version: any; maxNumberOfKeys?: any | null; maxKeysPerAddress?: any | null; createdAtBlock?: any | null; creationTransactionHash: string; totalKeys: any; referrerFees: Array<{ __typename?: "ReferrerFee"; id: string; referrer: any; fee: any; }>; }[]>; /** * Get locks with keys from multiple networks. By default, all networks will be queried. * If you want to query only specific network, you can pass options as the second parameter with network ids array. * ```ts * const service = new SubgraphService() * const locksKeysOnMainnetAndGoerli = await service.locksKeys({ first: 100, skip: 50, where: {}}, { networks: [1, 5] }) * const locksKeysOnAllNetworks = await service.locksKeys({ first: 1000 }) * ``` */ locksKeys(variables: AllLocksQueryVariables & { keyFilter?: Key_Filter; keyOrderBy?: Key_OrderBy; }, options?: QueryOptions): Promise<{ network: number; __typename?: "Lock"; id: string; address: any; name?: string | null; expirationDuration?: any | null; tokenAddress: any; symbol?: string | null; price: any; lockManagers: Array; keyGranters: Array; version: any; maxNumberOfKeys?: any | null; maxKeysPerAddress?: any | null; createdAtBlock?: any | null; totalKeys: any; keys?: Array<{ __typename?: "Key"; id: string; tokenId: any; owner: any; manager?: any | null; expiration: any; tokenURI?: string | null; createdAt: any; createdAtBlock: any; cancelled?: boolean | null; transactionsHash?: Array | null; }> | null; }[]>; /** * Get a single lock on a network. This is a helper provided on top of locks. */ lock(variables: Omit, options: { network: number; }): Promise<{ network: number; __typename?: "Lock"; id: string; address: any; name?: string | null; expirationDuration?: any | null; tokenAddress: any; symbol?: string | null; price: any; lockManagers: Array; keyGranters: Array; version: any; maxNumberOfKeys?: any | null; maxKeysPerAddress?: any | null; createdAtBlock?: any | null; creationTransactionHash: string; totalKeys: any; referrerFees: Array<{ __typename?: "ReferrerFee"; id: string; referrer: any; fee: any; }>; }>; /** * Get keys and associated lock data from multiple networks. By default, all networks will be queried. * If you want to query only specific network, you can pass options as the second parameter with network ids array. * ```ts * const service = new SubgraphService() * const keysOnMainnetAndGoerli = await service.keys({ first: 100, skip: 50, where: {}}, { networks: [1, 5] }) * const keysOnAllNetworks = await service.keys({ first: 1000 }) * ``` */ keys(variables: AllKeysQueryVariables, options?: QueryOptions): Promise<{ network: number; __typename?: "Key"; id: string; tokenId: any; owner: any; manager?: any | null; expiration: any; tokenURI?: string | null; createdAt: any; createdAtBlock: any; cancelled?: boolean | null; transactionsHash?: Array | null; lock: { __typename?: "Lock"; id: string; address: any; name?: string | null; expirationDuration?: any | null; tokenAddress: any; symbol?: string | null; price: any; lockManagers: Array; keyGranters: Array; version: any; maxNumberOfKeys?: any | null; maxKeysPerAddress?: any | null; createdAtBlock?: any | null; totalKeys: any; }; }[]>; /** * Get a single key on a network. This is a helper provided on top of keys. */ key(variables: Omit, options: Record<'network', number>): Promise<{ network: number; __typename?: "Key"; id: string; tokenId: any; owner: any; manager?: any | null; expiration: any; tokenURI?: string | null; createdAt: any; createdAtBlock: any; cancelled?: boolean | null; transactionsHash?: Array | null; lock: { __typename?: "Lock"; id: string; address: any; name?: string | null; expirationDuration?: any | null; tokenAddress: any; symbol?: string | null; price: any; lockManagers: Array; keyGranters: Array; version: any; maxNumberOfKeys?: any | null; maxKeysPerAddress?: any | null; createdAtBlock?: any | null; totalKeys: any; }; }>; /** Get list or receipts from multiple networks */ receipts(variables: AllReceiptsQueryVariables, options?: QueryOptions): Promise<{ network: number; __typename?: "Receipt"; id: string; receiptNumber: any; timestamp: any; sender: string; payer?: string | null; recipient?: string | null; lockAddress: string; tokenAddress: string; gasTotal: any; amountTransferred: any; }[]>; /** Get a single receipt for a specific network */ receipt(variables: Omit, options: { network: number; }): Promise<{ network: number; __typename?: "Receipt"; id: string; receiptNumber: any; timestamp: any; sender: string; payer?: string | null; recipient?: string | null; lockAddress: string; tokenAddress: string; gasTotal: any; amountTransferred: any; }>; } declare const TransferWithAuthorizationTypes: { TransferWithAuthorization: { name: string; type: string; }[]; }; declare function getErc20BalanceForAddress(erc20ContractAddress: string, address: string, provider: ethers.Provider): Promise; /** * Yiels the decimals for en ERC20 contract * @param {*} erc20ContractAddress * @param {*} provider */ declare function getErc20Decimals(erc20ContractAddress: string, provider: ethers.Provider): Promise; /** * yields the symbole for the ERC20 contract * @param {*} erc20ContractAddress * @param {*} provider */ declare function getErc20TokenSymbol(erc20ContractAddress: string, provider: ethers.Provider): Promise; /** * Yields the amount that a purchaser have approved a lock for * @param {*} erc20ContractAddress * @param {*} purchaser * @param {*} lockContractAddress * @param {*} provider */ declare function getAllowance(erc20ContractAddress: string, lockContractAddress: string, provider: ethers.Provider, spenderAddress: string): Promise; declare function approveTransfer(erc20ContractAddress: string, lockContractAddress: string, value: unknown, provider: ethers.Provider, signer: ethers.Signer): Promise; declare function prepareApproval(lockContractAddress: string, value: unknown): Promise; interface TransferAuthorizationMessage { from: string; to: string; value: any; validAfter: number; validBefore: number; nonce: string; } declare function signTransferAuthorization(erc20ContractAddress: string, message: TransferAuthorizationMessage, provider: ethers.Provider, signer: ethers.Signer): Promise; declare function recoverTransferAuthorization(erc20ContractAddress: string, message: TransferAuthorizationMessage, chainId: bigint, signature: string, provider: any): Promise; declare function transferWithAuthorization(erc20ContractAddress: string, message: TransferAuthorizationMessage, signature: string, signer: ethers.Signer): Promise; declare const KeyManagerAbi: string[]; interface TransferObject { lock: string; token: string; owner: string; deadline: number; } type Signer = ethers.Signer | ethers.JsonRpcSigner; interface CreateTransferSignatureOptions { signer: Signer; params: TransferObject; network: number; } interface TransferOptions { params: TransferObject & { transferSignature: string; }; network: number; signer: Signer; } interface CreateTransferAddressKey { params: { email: string; lockAddress: string; }; } interface SetLocksmithOptions { params: { locksmith: string; }; network: number; signer: Signer; } declare const TransferTypes: { Transfer: { name: string; type: string; }[]; }; interface GetContractOptions { network: number; signer?: Signer; } declare class KeyManager { networks: NetworkConfigs; constructor(networks?: NetworkConfigs); isSigner(network: number, signer: string): Promise; providerForNetwork(network: number): ethers.JsonRpcProvider; getDomain(network: number): { name: string; version: string; chainId: number; verifyingContract: string | undefined; }; /** * This function returns the KeyManager contract for a given network. */ getContract({ network, signer }: GetContractOptions): ethers.BaseContract; /** * This function creates a transfer signature. */ createTransferSignature({ params, signer, network, }: CreateTransferSignatureOptions): Promise; /** * This function transfers a key given a transfer signature. */ transfer({ network, params: { lock, token, owner, deadline, transferSignature }, signer, }: TransferOptions): Promise; /** * This function checks if a transfer is possible. */ isTransferPossible({ network, params: { lock, token, owner, deadline, transferSignature }, signer, }: TransferOptions): Promise; /** * This function creates a wallet address from a lock address and an email address. */ createTransferAddress({ params }: CreateTransferAddressKey): string; /** * Return signer for the transfer signature provided in the params */ getSignerForTransferSignature({ params: { lock, token, owner, deadline, transferSignature }, network, }: Omit): string; } export { type AddEventToCollectionBody, type AddManagerBody, type Application, type ApplicationBody, type Applications200Response, type ApproveAttendeesRsvpRequest, type ApproveEventBody, type ApproveRefunds201Response, type ApproveRefundsRequest, type ApprovedRefunds200Response, ApprovedRefunds200ResponseFormatEnum, type ApprovedRefunds200ResponseValuesInner, type Auth, type AuthResult, type Balance200ResponseValue, type BulkApproveEventsBody, type BulkRemoveEventsBody, type CapturePurchaseRequest, CapturePurchaseRequestPurchaseTypeEnum, type CheckClaim200Response, type CheckClaimRequest, type CheckPrivyUser400Response, type CheckPrivyUser500Response, type CheckoutConfig, type CheckoutConfigConfig, type Claim200Response, type ClaimRequest, Configuration, type ConfigurationParameters, type ConnectStripeAccount200Response, type ConnectStripeAccountRequest, type CreateDownloadReceiptsRequest200Response, CreateDownloadReceiptsRequest200ResponseStatusEnum, type CreateLockContract201Response, type CreateTransferAddressKey, type CreateTransferCode200Response, type CreateTransferCode404Response, type CreateTransferSignatureOptions, type CreateVerifierRequest, DefaultApi, DefaultApiAxiosParamCreator, DefaultApiFactory, DefaultApiFp, type EjectUser200Response, type EmailTicket200Response, type Event, type EventAttributesInner, type EventCollection, type EventCollectionAssociation, type EventCollectionBody, type EventCollectionBodyLinksInner, type EventDetails, EventStatusEnum, type EventsInCollection, type ExportKeys200Response, type GenerateGoogleWalletPass200Response, type GenericInvalidBodyError, type GenericNotFound, type GenericServerError, type GenericSuccess, type GetChargesForLock200Response, type GetChargesForLock200ResponsePricesInner, type GetContractOptions, type GetCustomEmailContent200Response, type GetDataForRecipientsAndCaptcha200Response, type GetDataForRecipientsAndGuild200Response, type GetEvent200Response, type GetEventTicket200Response, type GetEventTicket200ResponseAttributesInner, type GetLockStripeConnectionDetails200Response, type GetLockStripeConnectionDetails200ResponseAccount, type GetLockStripeConnectionDetails200ResponseAccountRequirements, type GetLockStripeConnectionDetails200ResponseCountrySpec, type GetReceipt200Response, type GetReceipt200ResponsePurchaser, type GetReceipt200ResponseReceipt, type GetReceipt200ResponseSupplier, type GetReceipts200Response, type GetReceipts200ResponseItemsInner, type GetReceiptsBase200Response, type GetReceiptsStatus200Response, type GetReceiptsStatus200ResponseItemsInner, type GetReceiptsStatus200ResponseItemsInnerPayload, GetReceiptsStatus200ResponseItemsInnerPayloadStatusEnum, type GetStripeConnections200Response, type GetSubscription200Response, type GetSubscription200ResponseSubscriptionsInner, type GetSubscription200ResponseSubscriptionsInnerBalance, GetSubscription200ResponseSubscriptionsInnerTypeEnum, type GetUserAccountType200Response, GetUserAccountType200ResponseUserAccountTypeEnum, type GetUserPrivateKey200Response, type GetUserRecoveryPhrase200Response, type GetWaasToken400Response, type GetWaasTokenRequest, type IsCardPaymentEnabledForLock200Response, type Key$1 as Key, type Key_Filter as KeyFilter, KeyManager, KeyManagerAbi, type KeyMetadata, type KeyMetadata200Response, Key_OrderBy as KeyOrderBy, type KeysByPage200Response, type KeysByPage200ResponseMeta, type ListCheckoutConfigs200Response, type ListPaymentMethods200Response, type LockContractOptions, type Lock_Filter as LockFilter, Lock_OrderBy as LockOrderBy, type LockSettings, LocksmithService, Configuration as LocksmithServiceConfiguration, type LoginRequest, type LoginWithPrivyRequest, type NotAuthenticated, OrderDirection, type PaymentMethod, type PaymentMethodBillingDetails, type PaymentMethodBillingDetailsAddress, type PaymentMethodCard, type PaymentMethodCardChecks, type PaymentMethodCardNetworks, type PaymentMethodCardThreeDSecureUsage, type Price200Response, type Price200ResponseResult, type PrivyUserCheckBody, type PrivyUserResponse, type PrivyUserResponseUser, type PrivyUserResponseUserEmail, type PrivyUserResponseUserWallet, type Purchase200Response, type Purchase200ResponsePricing, type PurchaseRequest, type RemoveEventBody, type RemoveManagerBody, type RemovePaymentMethods200Response, type Rsvp, type RsvpRequest, type SaveEventDataRequest, SaveEventDataRequestStatusEnum, type SaveLockSetting200Response, type SaveMerkleTree200Response, type SaveMerkleTree400Response, type SaveMerkleTree400ResponseError, type SaveMerkleTree400ResponseErrorIssuesInner, type SaveMerkleTreeRequestInner, type SaveMerkleTreeRequestInnerOneOfInner, type SaveMerkleTreeRequestInnerOneOfInnerOneOf, type SaveMerkleTreeRequestInnerOneOfInnerOneOfAmount, type SaveReceipt200Response, type SendCustomEmail200Response, type SendCustomEmailRequest, type SendEventInvitesRequest, type SendVerificationCode200Response, type SetLocksmithOptions, type SetupPayment200Response, type SignTicket200Response, type Key as SubgraphKey, type Lock as SubgraphLock, SubgraphService, type TicketVerificationUrl200Response, type TransferDoneRequest, type TransferObject, type TransferOptions, TransferTypes, TransferWithAuthorizationTypes, type UpdateCheckoutConfigRequest, type UpdateEventData200Response, type UpdateEventDataRequest, UpdateEventDataRequestStatusEnum, type UpdateLockMetadataRequest, type UpdateUserEncryptedPrivateKey200Response, type UpdateUserEncryptedPrivateKeyRequest, type UpdateUserMetadataRequest, type UpdateUsersMetadata201Response, type UpdateUsersMetadataRequest, type UploadImages201Response, type UploadImages201ResponseResultsInner, type UploadImages201ResponseResultsInnerMetadata, type UserMetadata, type UserMetadataInput, type Verifier, type Verifier200Response, type Verifiers200Response, type VerifyEmailCode200Response, type VerifyEmailCodeRequest, WalletService, Web3Service, approveTransfer, getAllowance, getCurrentProvider, getErc20BalanceForAddress, getErc20Decimals, getErc20TokenSymbol, getWeb3Provider, prepareApproval, recoverTransferAuthorization, signTransferAuthorization, transferWithAuthorization };