@bosonprotocol/core-sdk 1.29.0-ludo.1 → 1.29.0

package/dist/esm/accounts/mixin.d.ts

@@ -1,223 +1,223 @@
-import { BaseCoreSDK } from "./../mixins/base-core-sdk";
-import * as accounts from ".";
-import * as subgraph from "../subgraph";
-import { TransactionResponse, Log } from "@bosonprotocol/common";
-import { BigNumberish, BigNumber } from "@ethersproject/bignumber";
-import { offers } from "..";
-export declare class AccountsMixin extends BaseCoreSDK {
-    /**
-     * Returns seller entity from subgraph.
-     * @param sellerId - ID of seller entity to query for.
-     * @param queryVars - Optional query variables to skip, order or filter.
-     * @returns Seller entity from subgraph.
-     */
-    getSellerById(sellerId: BigNumberish, queryVars?: accounts.subgraph.SingleSellerQueryVariables): Promise<subgraph.SellerFieldsFragment>;
-    /**
-     * Returns seller entity from subgraph.
-     * @param assistant - Assistant address of seller entity to query for.
-     * @param queryVars - Optional query variables to skip, order or filter.
-     * @returns Seller entity from subgraph.
-     */
-    getSellerByAssistant(assistant: string, queryVars?: subgraph.GetSellersQueryQueryVariables): Promise<subgraph.SellerFieldsFragment>;
-    /**
-     * Returns seller entity from subgraph.
-     * @param clerk - Clerk address of seller entity to query for.
-     * @param queryVars - Optional query variables to skip, order or filter.
-     * @returns Seller entity from subgraph.
-     */
-    getSellerByClerk(clerk: string, queryVars?: subgraph.GetSellersQueryQueryVariables): Promise<subgraph.SellerFieldsFragment>;
-    /**
-     * Returns seller entity from subgraph.
-     * @param admin - Admin address of seller entity to query for.
-     * @param queryVars - Optional query variables to skip, order or filter.
-     * @returns Seller entity from subgraph.
-     */
-    getSellerByAdmin(admin: string, queryVars?: subgraph.GetSellersQueryQueryVariables): Promise<subgraph.SellerFieldsFragment>;
-    /**
-     * Returns seller entity from subgraph.
-     * @param treasury - Treasury address of seller entity to query for.
-     * @param queryVars - Optional query variables to skip, order or filter.
-     * @returns Seller entity from subgraph.
-     */
-    getSellerByTreasury(treasury: string, queryVars?: subgraph.GetSellersQueryQueryVariables): Promise<subgraph.SellerFieldsFragment>;
-    /**
-     * Returns seller entity from subgraph. Matches `assistant`, `clerk`, `admin` or `treasury`.
-     * @param address - Address of seller entity to query for.
-     * @param queryVars - Optional query variables to skip, order or filter.
-     * @returns Seller entity from subgraph.
-     */
-    getSellersByAddress(address: string, queryVars?: subgraph.GetSellersQueryQueryVariables): Promise<subgraph.SellerFieldsFragment[]>;
-    /**
-     * Returns the array of LENS tokenIds owned by a specified address
-     * @param address - Address of seller entity to query for.
-     * @param queryVars - Optional query variables to skip, order or filter.
-     * @returns Array of tokenIds
-     */
-    fetchUserAuthTokens(address: string, tokenType: number): Promise<Array<string>>;
-    /**
-     * Returns seller entity from subgraph that owns the given auth token (if any).
-     * @param tokenId - tokenId of the Auth Token.
-     * @param tokenType - Type of the Auth Token (1 for LENS, ...).
-     * @param queryVars - Optional query variables to skip, order or filter.
-     * @returns Seller entity from subgraph.
-     */
-    getSellerByAuthToken(tokenId: string, tokenType: number, queryVars?: subgraph.GetSellersQueryQueryVariables): Promise<subgraph.SellerFieldsFragment>;
-    /**
-     * Returns seller entities from subgraph.
-     * @param queryVars - Optional query variables to skip, order or filter.
-     * @returns Seller entities from subgraph.
-     */
-    getSellers(queryVars?: subgraph.GetSellersQueryQueryVariables): Promise<subgraph.SellerFieldsFragment[]>;
-    /**
-     * Creates seller account by calling the `AccountHandlerFacet` contract.
-     * @param sellerToCreate - Addresses and contract URI to set in the seller account.
-     * @param overrides - Optional overrides.
-     * @returns Transaction response.
-     */
-    createSeller(sellerToCreate: accounts.CreateSellerArgs, overrides?: Partial<{
-        contractAddress: string;
-    }>): Promise<TransactionResponse>;
-    /**
-     * Creates seller account and offer by calling the `OrchestrationHandlerFacet` contract.
-     * This transaction only succeeds if there is no existing seller account for the connected signer.
-     * @param sellerToCreate - Addresses to set in the seller account.
-     * @param offerToCreate - Offer arguments.
-     * @param overrides - Optional overrides.
-     * @returns Transaction response.
-     */
-    createSellerAndOffer(sellerToCreate: accounts.CreateSellerArgs, offerToCreate: offers.CreateOfferArgs, overrides?: Partial<{
-        contractAddress: string;
-    }>): Promise<TransactionResponse>;
-    /**
-     * Updates seller account by calling the `AccountHandlerFacet` contract. Only callable
-     * by admin.
-     * @param sellerUpdates - Values to update.
-     * @param overrides - Optional overrides.
-     * @returns Transaction response.
-     */
-    updateSeller(sellerUpdates: accounts.UpdateSellerArgs, overrides?: Partial<{
-        contractAddress: string;
-    }>): Promise<TransactionResponse>;
-    /**
-     * Opt-in to a pending seller update by calling the `AccountHandlerFacet` contract. Only callable
-     * by admin.
-     * @param sellerUpdates - Values to update.
-     * @param overrides - Optional overrides.
-     * @returns Transaction response.
-     */
-    optInToSellerUpdate(sellerUpdates: accounts.OptInToSellerUpdateArgs, overrides?: Partial<{
-        contractAddress: string;
-    }>): Promise<TransactionResponse>;
-    /**
-     * Updates seller account by calling the `AccountHandlerFacet` contract,
-     * then optIn for all updates doable by the same account. Only callable
-     * by admin.
-     * @param sellerUpdates - Values to update.
-     * @param overrides - Optional overrides.
-     * @returns Transaction response.
-     */
-    updateSellerAndOptIn(sellerUpdates: accounts.UpdateSellerArgs, overrides?: Partial<{
-        contractAddress: string;
-    }>): Promise<TransactionResponse>;
-    /**
-     * Returns buyer entity from subgraph.
-     * @param buyerId - ID of buyer entity to query for.
-     * @param queryVars - Optional query variables to skip, order or filter.
-     * @returns Buyer entity from subgraph.
-     */
-    getBuyerById(buyerId: BigNumberish, queryVars?: accounts.subgraph.SingleBuyerQueryVariables): Promise<subgraph.BuyerFieldsFragment>;
-    /**
-     * Returns buyer entities from subgraph.
-     * @param queryVars - Optional query variables to skip, order or filter.
-     * @returns Buyer entities from subgraph.
-     */
-    getBuyers(queryVars?: subgraph.GetBuyersQueryQueryVariables): Promise<subgraph.BuyerFieldsFragment[]>;
-    /**
-     * Creates a dispute resolver account by calling the `AccountHandlerFacet` contract.
-     * @param disputeResolverToCreate - Dispute resolver arguments.
-     * @returns Transaction response.
-     */
-    createDisputeResolver(disputeResolverToCreate: accounts.CreateDisputeResolverArgs): Promise<TransactionResponse>;
-    /**
-     * Utility method to retrieve the created `exchangeId` from logs after calling `commitToOffer`.
-     * @param logs - Logs to search in.
-     * @returns Created exchange id.
-     */
-    getDisputeResolverIdFromLogs(logs: Log[]): string | null;
-    /**
-     * Utility method to retrieve the pending seller update fields from logs after calling `updateSeller`.
-     * @param logs - Logs to search in.
-     * @returns Created exchange id.
-     */
-    getPendingSellerUpdateFromLogs(logs: Log[]): {
-        assistant: string;
-        clerk: string;
-        admin: string;
-        tokenType: number;
-        tokenId: BigNumber;
-    };
-    /**
-     * Updates a dispute resolver account by calling the `AccountHandlerFacet` contract.
-     * Note, that the caller must be the specified `admin` address of the dispute resolver account.
-     * @param disputeResolverId - Id of dispute resolver to update.
-     * @param updates - Values to update for the given dispute resolver.
-     * @returns Transaction response.
-     */
-    updateDisputeResolver(disputeResolverId: BigNumberish, updates: accounts.DisputeResolverUpdates): Promise<TransactionResponse>;
-    optInToDisputeResolverUpdate(disputeResolverUpdates: accounts.OptInToDisputeResolverUpdateArgs, overrides?: Partial<{
-        contractAddress: string;
-    }>): Promise<TransactionResponse>;
-    /**
-     * Adds fees to a dispute resolver account by calling the `AccountHandlerFacet`
-     * contract. Note, that the caller must be the specified `admin` address of the dispute
-     * resolver account.
-     * @param disputeResolverId - Id of dispute resolver.
-     * @param fees - Dispute resolution fees. Should only contain token addresses that are
-     * not already specified.
-     * @returns Transaction response.
-     */
-    addFeesToDisputeResolver(disputeResolverId: BigNumberish, fees: accounts.DisputeResolutionFee[]): Promise<TransactionResponse>;
-    /**
-     * Adds sellers to the allow list of a dispute resolver account by calling the
-     * `AccountHandlerFacet` contract. Note, that the caller must be the specified
-     * `admin` address of the dispute resolver account.
-     * @param disputeResolverId - Id of dispute resolver.
-     * @param sellerAllowList - List of seller ids that are allowed to use the dispute resolver.
-     *  Should only contain seller ids that are not part of the current allow list.
-     * @returns Transaction response.
-     */
-    addSellersToDisputeResolverAllowList(disputeResolverId: BigNumberish, sellerAllowList: BigNumberish[]): Promise<TransactionResponse>;
-    /**
-     * Removes fees from a dispute resolver account by calling the `AccountHandlerFacet`
-     * contract. Note, that the caller must be the specified `admin` address of the dispute
-     * resolver account.
-     * @param disputeResolverId - Id of dispute resolver.
-     * @param feeTokenAddresses - Addresses of fee tokens to remove.
-     * @returns Transaction response.
-     */
-    removeFeesFromDisputeResolver(disputeResolverId: BigNumberish, feeTokenAddresses: string[]): Promise<TransactionResponse>;
-    /**
-     * Removes sellers from the allow list of a dispute resolver account by calling the
-     * `AccountHandlerFacet` contract. Note, that the caller must be the specified
-     * `admin` address of the dispute resolver account.
-     * @param disputeResolverId - Id of dispute resolver.
-     * @param sellerAllowList - List of seller ids that should be removed from the allow
-     * list of a dispute resolver.
-     * @returns Transaction response.
-     */
-    removeSellersFromDisputeResolverAllowList(disputeResolverId: BigNumberish, sellerAllowList: string[]): Promise<TransactionResponse>;
-    /**
-     * Returns dispute resolver entity from subgraph.
-     * @param disputeResolverId - ID of dispute resolver entity to query for.
-     * @param queryVars - Optional query variables to skip, order or filter.
-     * @returns Dispute resolver entity from subgraph.
-     */
-    getDisputeResolverById(disputeResolverId: BigNumberish, queryVars?: accounts.subgraph.SingleDisputeResolverQueryVariables): Promise<subgraph.DisputeResolverFieldsFragment>;
-    /**
-     * Returns dispute resolver entities from subgraph.
-     * @param queryVars - Optional query variables to skip, order or filter.
-     * @returns Dispute resolver entities from subgraph.
-     */
-    getDisputeResolvers(queryVars?: subgraph.GetDisputeResolversQueryQueryVariables): Promise<subgraph.DisputeResolverFieldsFragment[]>;
-}
+import { BaseCoreSDK } from "./../mixins/base-core-sdk";
+import * as accounts from ".";
+import * as subgraph from "../subgraph";
+import { TransactionResponse, Log } from "@bosonprotocol/common";
+import { BigNumberish, BigNumber } from "@ethersproject/bignumber";
+import { offers } from "..";
+export declare class AccountsMixin extends BaseCoreSDK {
+    /**
+     * Returns seller entity from subgraph.
+     * @param sellerId - ID of seller entity to query for.
+     * @param queryVars - Optional query variables to skip, order or filter.
+     * @returns Seller entity from subgraph.
+     */
+    getSellerById(sellerId: BigNumberish, queryVars?: accounts.subgraph.SingleSellerQueryVariables): Promise<subgraph.SellerFieldsFragment>;
+    /**
+     * Returns seller entity from subgraph.
+     * @param assistant - Assistant address of seller entity to query for.
+     * @param queryVars - Optional query variables to skip, order or filter.
+     * @returns Seller entity from subgraph.
+     */
+    getSellerByAssistant(assistant: string, queryVars?: subgraph.GetSellersQueryQueryVariables): Promise<subgraph.SellerFieldsFragment>;
+    /**
+     * Returns seller entity from subgraph.
+     * @param clerk - Clerk address of seller entity to query for.
+     * @param queryVars - Optional query variables to skip, order or filter.
+     * @returns Seller entity from subgraph.
+     */
+    getSellerByClerk(clerk: string, queryVars?: subgraph.GetSellersQueryQueryVariables): Promise<subgraph.SellerFieldsFragment>;
+    /**
+     * Returns seller entity from subgraph.
+     * @param admin - Admin address of seller entity to query for.
+     * @param queryVars - Optional query variables to skip, order or filter.
+     * @returns Seller entity from subgraph.
+     */
+    getSellerByAdmin(admin: string, queryVars?: subgraph.GetSellersQueryQueryVariables): Promise<subgraph.SellerFieldsFragment>;
+    /**
+     * Returns seller entity from subgraph.
+     * @param treasury - Treasury address of seller entity to query for.
+     * @param queryVars - Optional query variables to skip, order or filter.
+     * @returns Seller entity from subgraph.
+     */
+    getSellerByTreasury(treasury: string, queryVars?: subgraph.GetSellersQueryQueryVariables): Promise<subgraph.SellerFieldsFragment>;
+    /**
+     * Returns seller entity from subgraph. Matches `assistant`, `clerk`, `admin` or `treasury`.
+     * @param address - Address of seller entity to query for.
+     * @param queryVars - Optional query variables to skip, order or filter.
+     * @returns Seller entity from subgraph.
+     */
+    getSellersByAddress(address: string, queryVars?: subgraph.GetSellersQueryQueryVariables): Promise<subgraph.SellerFieldsFragment[]>;
+    /**
+     * Returns the array of LENS tokenIds owned by a specified address
+     * @param address - Address of seller entity to query for.
+     * @param queryVars - Optional query variables to skip, order or filter.
+     * @returns Array of tokenIds
+     */
+    fetchUserAuthTokens(address: string, tokenType: number): Promise<Array<string>>;
+    /**
+     * Returns seller entity from subgraph that owns the given auth token (if any).
+     * @param tokenId - tokenId of the Auth Token.
+     * @param tokenType - Type of the Auth Token (1 for LENS, ...).
+     * @param queryVars - Optional query variables to skip, order or filter.
+     * @returns Seller entity from subgraph.
+     */
+    getSellerByAuthToken(tokenId: string, tokenType: number, queryVars?: subgraph.GetSellersQueryQueryVariables): Promise<subgraph.SellerFieldsFragment>;
+    /**
+     * Returns seller entities from subgraph.
+     * @param queryVars - Optional query variables to skip, order or filter.
+     * @returns Seller entities from subgraph.
+     */
+    getSellers(queryVars?: subgraph.GetSellersQueryQueryVariables): Promise<subgraph.SellerFieldsFragment[]>;
+    /**
+     * Creates seller account by calling the `AccountHandlerFacet` contract.
+     * @param sellerToCreate - Addresses and contract URI to set in the seller account.
+     * @param overrides - Optional overrides.
+     * @returns Transaction response.
+     */
+    createSeller(sellerToCreate: accounts.CreateSellerArgs, overrides?: Partial<{
+        contractAddress: string;
+    }>): Promise<TransactionResponse>;
+    /**
+     * Creates seller account and offer by calling the `OrchestrationHandlerFacet` contract.
+     * This transaction only succeeds if there is no existing seller account for the connected signer.
+     * @param sellerToCreate - Addresses to set in the seller account.
+     * @param offerToCreate - Offer arguments.
+     * @param overrides - Optional overrides.
+     * @returns Transaction response.
+     */
+    createSellerAndOffer(sellerToCreate: accounts.CreateSellerArgs, offerToCreate: offers.CreateOfferArgs, overrides?: Partial<{
+        contractAddress: string;
+    }>): Promise<TransactionResponse>;
+    /**
+     * Updates seller account by calling the `AccountHandlerFacet` contract. Only callable
+     * by admin.
+     * @param sellerUpdates - Values to update.
+     * @param overrides - Optional overrides.
+     * @returns Transaction response.
+     */
+    updateSeller(sellerUpdates: accounts.UpdateSellerArgs, overrides?: Partial<{
+        contractAddress: string;
+    }>): Promise<TransactionResponse>;
+    /**
+     * Opt-in to a pending seller update by calling the `AccountHandlerFacet` contract. Only callable
+     * by admin.
+     * @param sellerUpdates - Values to update.
+     * @param overrides - Optional overrides.
+     * @returns Transaction response.
+     */
+    optInToSellerUpdate(sellerUpdates: accounts.OptInToSellerUpdateArgs, overrides?: Partial<{
+        contractAddress: string;
+    }>): Promise<TransactionResponse>;
+    /**
+     * Updates seller account by calling the `AccountHandlerFacet` contract,
+     * then optIn for all updates doable by the same account. Only callable
+     * by admin.
+     * @param sellerUpdates - Values to update.
+     * @param overrides - Optional overrides.
+     * @returns Transaction response.
+     */
+    updateSellerAndOptIn(sellerUpdates: accounts.UpdateSellerArgs, overrides?: Partial<{
+        contractAddress: string;
+    }>): Promise<TransactionResponse>;
+    /**
+     * Returns buyer entity from subgraph.
+     * @param buyerId - ID of buyer entity to query for.
+     * @param queryVars - Optional query variables to skip, order or filter.
+     * @returns Buyer entity from subgraph.
+     */
+    getBuyerById(buyerId: BigNumberish, queryVars?: accounts.subgraph.SingleBuyerQueryVariables): Promise<subgraph.BuyerFieldsFragment>;
+    /**
+     * Returns buyer entities from subgraph.
+     * @param queryVars - Optional query variables to skip, order or filter.
+     * @returns Buyer entities from subgraph.
+     */
+    getBuyers(queryVars?: subgraph.GetBuyersQueryQueryVariables): Promise<subgraph.BuyerFieldsFragment[]>;
+    /**
+     * Creates a dispute resolver account by calling the `AccountHandlerFacet` contract.
+     * @param disputeResolverToCreate - Dispute resolver arguments.
+     * @returns Transaction response.
+     */
+    createDisputeResolver(disputeResolverToCreate: accounts.CreateDisputeResolverArgs): Promise<TransactionResponse>;
+    /**
+     * Utility method to retrieve the created `exchangeId` from logs after calling `commitToOffer`.
+     * @param logs - Logs to search in.
+     * @returns Created exchange id.
+     */
+    getDisputeResolverIdFromLogs(logs: Log[]): string | null;
+    /**
+     * Utility method to retrieve the pending seller update fields from logs after calling `updateSeller`.
+     * @param logs - Logs to search in.
+     * @returns Created exchange id.
+     */
+    getPendingSellerUpdateFromLogs(logs: Log[]): {
+        assistant: string;
+        clerk: string;
+        admin: string;
+        tokenType: number;
+        tokenId: BigNumber;
+    };
+    /**
+     * Updates a dispute resolver account by calling the `AccountHandlerFacet` contract.
+     * Note, that the caller must be the specified `admin` address of the dispute resolver account.
+     * @param disputeResolverId - Id of dispute resolver to update.
+     * @param updates - Values to update for the given dispute resolver.
+     * @returns Transaction response.
+     */
+    updateDisputeResolver(disputeResolverId: BigNumberish, updates: accounts.DisputeResolverUpdates): Promise<TransactionResponse>;
+    optInToDisputeResolverUpdate(disputeResolverUpdates: accounts.OptInToDisputeResolverUpdateArgs, overrides?: Partial<{
+        contractAddress: string;
+    }>): Promise<TransactionResponse>;
+    /**
+     * Adds fees to a dispute resolver account by calling the `AccountHandlerFacet`
+     * contract. Note, that the caller must be the specified `admin` address of the dispute
+     * resolver account.
+     * @param disputeResolverId - Id of dispute resolver.
+     * @param fees - Dispute resolution fees. Should only contain token addresses that are
+     * not already specified.
+     * @returns Transaction response.
+     */
+    addFeesToDisputeResolver(disputeResolverId: BigNumberish, fees: accounts.DisputeResolutionFee[]): Promise<TransactionResponse>;
+    /**
+     * Adds sellers to the allow list of a dispute resolver account by calling the
+     * `AccountHandlerFacet` contract. Note, that the caller must be the specified
+     * `admin` address of the dispute resolver account.
+     * @param disputeResolverId - Id of dispute resolver.
+     * @param sellerAllowList - List of seller ids that are allowed to use the dispute resolver.
+     *  Should only contain seller ids that are not part of the current allow list.
+     * @returns Transaction response.
+     */
+    addSellersToDisputeResolverAllowList(disputeResolverId: BigNumberish, sellerAllowList: BigNumberish[]): Promise<TransactionResponse>;
+    /**
+     * Removes fees from a dispute resolver account by calling the `AccountHandlerFacet`
+     * contract. Note, that the caller must be the specified `admin` address of the dispute
+     * resolver account.
+     * @param disputeResolverId - Id of dispute resolver.
+     * @param feeTokenAddresses - Addresses of fee tokens to remove.
+     * @returns Transaction response.
+     */
+    removeFeesFromDisputeResolver(disputeResolverId: BigNumberish, feeTokenAddresses: string[]): Promise<TransactionResponse>;
+    /**
+     * Removes sellers from the allow list of a dispute resolver account by calling the
+     * `AccountHandlerFacet` contract. Note, that the caller must be the specified
+     * `admin` address of the dispute resolver account.
+     * @param disputeResolverId - Id of dispute resolver.
+     * @param sellerAllowList - List of seller ids that should be removed from the allow
+     * list of a dispute resolver.
+     * @returns Transaction response.
+     */
+    removeSellersFromDisputeResolverAllowList(disputeResolverId: BigNumberish, sellerAllowList: string[]): Promise<TransactionResponse>;
+    /**
+     * Returns dispute resolver entity from subgraph.
+     * @param disputeResolverId - ID of dispute resolver entity to query for.
+     * @param queryVars - Optional query variables to skip, order or filter.
+     * @returns Dispute resolver entity from subgraph.
+     */
+    getDisputeResolverById(disputeResolverId: BigNumberish, queryVars?: accounts.subgraph.SingleDisputeResolverQueryVariables): Promise<subgraph.DisputeResolverFieldsFragment>;
+    /**
+     * Returns dispute resolver entities from subgraph.
+     * @param queryVars - Optional query variables to skip, order or filter.
+     * @returns Dispute resolver entities from subgraph.
+     */
+    getDisputeResolvers(queryVars?: subgraph.GetDisputeResolversQueryQueryVariables): Promise<subgraph.DisputeResolverFieldsFragment[]>;
+}
 //# sourceMappingURL=mixin.d.ts.map