@imtbl/sdk 0.28.10-alpha.1 → 0.29.0-alpha.1

package/dist/index.d.ts

@@ -7,16 +7,28 @@ declare class ImmutableConfiguration {
     readonly environment: Environment;
     readonly rateLimitingKey?: string;
     readonly apiKey?: string;
-    readonly clientAppId?: string;
+    readonly publishableKey?: string;
     constructor(options: {
         environment: Environment;
-        rateLimitingKey?: string;
-        apiKey?: string;
-        clientAppId?: string;
     });
 }
+declare const addApiKeyToAxiosHeader: (apiKey: string) => void;
+declare const addPublishableKeyToAxiosHeader: (publishableKey: string) => void;
+declare const addRateLimitingKeyToAxiosHeader: (rateLimitingKey: string) => void;
+type ImmutableConfigurationWithRequireableFields<T> = ImmutableConfiguration & (T extends {
+    apiKey: 'required';
+} ? Required<{
+    apiKey: string;
+}> : {}) & (T extends {
+    publishableKey: 'required';
+} ? Required<{
+    publishableKey: string;
+}> : {});
+type ImmutableConfigurationWithOmitableFields<T> = (T extends {
+    apiKey: 'omit';
+} ? Omit<ImmutableConfigurationWithRequireableFields<T>, 'apiKey'> : ImmutableConfigurationWithRequireableFields<T>);
 interface ModuleConfiguration<T> {
-    baseConfig: ImmutableConfiguration;
+    baseConfig: ImmutableConfigurationWithOmitableFields<T>;
     overrides?: T;
 }
 
@@ -25,11 +37,17 @@ declare const config_d_Environment: typeof Environment;
 type config_d_ImmutableConfiguration = ImmutableConfiguration;
 declare const config_d_ImmutableConfiguration: typeof ImmutableConfiguration;
 type config_d_ModuleConfiguration<T> = ModuleConfiguration<T>;
+declare const config_d_addApiKeyToAxiosHeader: typeof addApiKeyToAxiosHeader;
+declare const config_d_addPublishableKeyToAxiosHeader: typeof addPublishableKeyToAxiosHeader;
+declare const config_d_addRateLimitingKeyToAxiosHeader: typeof addRateLimitingKeyToAxiosHeader;
 declare namespace config_d {
   export {
     config_d_Environment as Environment,
     config_d_ImmutableConfiguration as ImmutableConfiguration,
     config_d_ModuleConfiguration as ModuleConfiguration,
+    config_d_addApiKeyToAxiosHeader as addApiKeyToAxiosHeader,
+    config_d_addPublishableKeyToAxiosHeader as addPublishableKeyToAxiosHeader,
+    config_d_addRateLimitingKeyToAxiosHeader as addRateLimitingKeyToAxiosHeader,
   };
 }
 
@@ -15981,85 +15999,107 @@ interface FeePercentage {
 type BuyResult = BuyResultSuccess | BuyResultFailed | BuyResultInsufficientFunds;
 /**
  * Represents the result of {@link Checkout.buy}
- * @property {CheckoutStatus.SUCCESS} status - The status to indicate success
- * @property {SmartCheckoutSufficient} smartCheckoutResult - The sufficient result of smart checkout
+ * @property {CheckoutStatus.SUCCESS} status
+ * @property {SmartCheckoutSufficient} smartCheckoutResult
  */
 type BuyResultSuccess = {
+    /** The status to indicate success */
     status: CheckoutStatus.SUCCESS;
+    /** The sufficient result of smart checkout */
     smartCheckoutResult: SmartCheckoutSufficient;
 };
 /**
  * Represents the result of {@link Checkout.buy}
- * @property {CheckoutStatus.FAILED} status - The status to indicate failure
- * @property {string} transactionHash - The transaction hash of the failed transaction
- * @property {string} reason - The reason for the failure
- * @property {SmartCheckoutSufficient} smartCheckoutResult - The sufficient result of smart checkout
+ * @property {CheckoutStatus.FAILED} status
+ * @property {string} transactionHash
+ * @property {string} reason
+ * @property {SmartCheckoutSufficient} smartCheckoutResult
  */
 type BuyResultFailed = {
+    /** The status to indicate failure */
     status: CheckoutStatus.FAILED;
+    /** The transaction hash of the failed transaction */
     transactionHash: string;
+    /** The reason for the failure */
     reason: string;
+    /** The sufficient result of smart checkout */
     smartCheckoutResult: SmartCheckoutSufficient;
 };
 /**
  * Represents the result of {@link Checkout.buy}
- * @property {CheckoutStatus.INSUFFICIENT_FUNDS} status - The status to indicate insufficient funds
- * @property {SmartCheckoutInsufficient} smartCheckoutResult - The insufficient result of smart checkout
+ * @property {CheckoutStatus.INSUFFICIENT_FUNDS} status
+ * @property {SmartCheckoutInsufficient} smartCheckoutResult
  */
 type BuyResultInsufficientFunds = {
+    /** The status to indicate insufficient funds */
     status: CheckoutStatus.INSUFFICIENT_FUNDS;
+    /** The insufficient result of smart checkout */
     smartCheckoutResult: SmartCheckoutInsufficient;
 };
 type SellResult = SellResultSuccess | SellResultFailed | SellResultInsufficientFunds;
 /**
  * Represents the result of {@link Checkout.sell}
- * @property {CheckoutStatus.SUCCESS} status - The status to indicate success
- * @property {SmartCheckoutSufficient} smartCheckoutResult - The sufficient result of smart checkout
+ * @property {CheckoutStatus.SUCCESS} status
+ * @property {string[]} orderIds
+ * @property {SmartCheckoutSufficient} smartCheckoutResult
  */
 type SellResultSuccess = {
+    /** The status to indicate success */
     status: CheckoutStatus.SUCCESS;
+    /** The orders' ids */
     orderIds: string[];
+    /** The sufficient result of smart checkout */
     smartCheckoutResult: SmartCheckoutSufficient;
 };
 /**
  * Represents the result of {@link Checkout.sell}
- * @property {CheckoutStatus.FAILED} status - The status to indicate failure
- * @property {string} transactionHash - The transaction hash of the failed transaction
- * @property {string} reason - The reason for the failure
- * @property {SmartCheckoutSufficient} smartCheckoutResult - The sufficient result of smart checkout
+ * @property {CheckoutStatus.FAILED} status
+ * @property {string} transactionHash
+ * @property {string} reason
+ * @property {SmartCheckoutSufficient} smartCheckoutResult
  */
 type SellResultFailed = {
+    /** The status to indicate failure */
     status: CheckoutStatus.FAILED;
+    /** The transaction hash of the failed transaction */
     transactionHash: string;
+    /** The reason for the failure */
     reason: string;
+    /** The sufficient result of smart checkout */
     smartCheckoutResult: SmartCheckoutSufficient;
 };
 /**
  * Represents the result of {@link Checkout.sell}
- * @property {CheckoutStatus.INSUFFICIENT_FUNDS} status - The status to indicate insufficient funds
- * @property {SmartCheckoutInsufficient} smartCheckoutResult - The insufficient result of smart checkout
+ * @property {CheckoutStatus.INSUFFICIENT_FUNDS} status
+ * @property {SmartCheckoutInsufficient} smartCheckoutResult
  */
 type SellResultInsufficientFunds = {
+    /** The status to indicate insufficient funds */
     status: CheckoutStatus.INSUFFICIENT_FUNDS;
+    /** The insufficient result of smart checkout */
     smartCheckoutResult: SmartCheckoutInsufficient;
 };
 type CancelResult = CancelResultSuccess | CancelResultFailed;
 /**
  * Represents the result of {@link Checkout.cancel}
- * @property {CheckoutStatus.SUCCESS} status - The status to indicate success
+ * @property {CheckoutStatus.SUCCESS} status
  */
 type CancelResultSuccess = {
+    /** The status to indicate success */
     status: CheckoutStatus.SUCCESS;
 };
 /**
  * Represents the result of {@link Checkout.cancel}
- * @property {CheckoutStatus.FAILED} status - The status to indicate failure
- * @property {string} transactionHash - The transaction hash of the failed transaction
- * @property {string} reason - The reason for the failure
+ * @property {CheckoutStatus.FAILED} status
+ * @property {string} transactionHash
+ * @property {string} reason
  */
 type CancelResultFailed = {
+    /** The status to indicate failure */
     status: CheckoutStatus.FAILED;
+    /** The transaction hash of the failed transaction */
     transactionHash: string;
+    /** The reason for the failure */
     reason: string;
 };
 /**
@@ -16076,22 +16116,27 @@ declare enum CheckoutStatus {
 }
 /**
  * The type representing the order to buy
- * @property {string} orderId - the id of the order to buy
- * @property {Array<OrderFee>} takerFees - array of order fees to apply to the order
+ * @property {string} orderId
+ * @property {Array<OrderFee>} takerFees
  */
 type BuyOrder = {
+    /** the id of the order to buy */
     id: string;
+    /** array of order fees to apply to the order */
     takerFees?: OrderFee[];
 };
 /**
  * The type representing the sell order to create a listing from
- * @property {SellToken} sellToken - the token to be listed for sale
- * @property {BuyToken} buyToken - the token info of the price of the item
- * @property {OrderFee[]} makerFees - option array of makerFees to be applied to the listing
+ * @property {SellToken} sellToken
+ * @property {BuyToken} buyToken
+ * @property {OrderFee[]} makerFees
  */
 type SellOrder = {
+    /** the token to be listed for sale */
     sellToken: SellToken;
+    /** the token info of the price of the item */
     buyToken: BuyToken;
+    /** option array of makerFees to be applied to the listing */
     makerFees?: OrderFee[];
 };
 /**
@@ -16101,77 +16146,97 @@ type SellOrder = {
 type BuyToken = NativeBuyToken | ERC20BuyToken;
 /**
  * Represents a native buy token
- * @property {ItemType} type - The type indicate this is a native token.
- * @property {string} amount - The amount of native token.
+ * @property {ItemType} type
+ * @property {string} amount
  */
 type NativeBuyToken = {
+    /** The type indicate this is a native token. */
     type: ItemType.NATIVE;
+    /** The amount of native token. */
     amount: string;
 };
 /**
  * Represents a ERC20 buy token
- * @property {ItemType} type - The type indicate this is a ERC20 token.
- * @property {string} amount - The amount of native token.
- * @property {string} contractAddress - The contract address of the ERC20.
+ * @property {ItemType} type
+ * @property {string} amount
+ * @property {string} contractAddress
  */
 type ERC20BuyToken = {
+    /** The type indicate this is a ERC20 token. */
     type: ItemType.ERC20;
+    /** The amount of native token. */
     amount: string;
+    /** The contract address of the ERC20. */
     contractAddress: string;
 };
 /**
  * The SellToken type
- * @property {string} id - The ERC721 token id
- * @property {string} collectionAddress - The ERC721 collection address
+ * @property {string} id
+ * @property {string} collectionAddress
  */
 type SellToken = {
+    /**  The ERC721 token id */
     id: string;
+    /** The ERC721 collection address */
     collectionAddress: string;
 };
 /**
  * Interface representing the parameters for {@link Checkout.smartCheckout}
- * @property {Web3Provider} provider - The provider to use for smart checkout.
- * @property {ItemRequirement[]} itemRequirements - The item requirements for the transaction.
- * @property {FulfillmentTransaction | GasAmount} transactionOrGasAmount - The transaction or gas amount.
+ * @property {Web3Provider} provider
+ * @property {ItemRequirement[]} itemRequirements
+ * @property {FulfillmentTransaction | GasAmount} transactionOrGasAmount
  */
 interface SmartCheckoutParams {
+    /** The provider to use for smart checkout. */
     provider: Web3Provider;
+    /** The item requirements for the transaction. */
     itemRequirements: (NativeItemRequirement | ERC20ItemRequirement | ERC721ItemRequirement)[];
+    /** The transaction or gas amount. */
     transactionOrGasAmount: FulfillmentTransaction | GasAmount;
 }
 /**
  * Represents a native item requirement for a transaction.
- * @property {ItemType.NATIVE} type - The type to indicate this is a native item requirement.
- * @property {string} amount - The amount of the item.
+ * @property {ItemType.NATIVE} type
+ * @property {string} amount
  */
 type NativeItemRequirement = {
+    /** The type to indicate this is a native item requirement. */
     type: ItemType.NATIVE;
+    /** The amount of the item. */
     amount: string;
 };
 /**
  * Represents an ERC20 item requirement for a transaction.
- * @property {ItemType.ERC20} type - The type to indicate this is a ERC20 item requirement.
- * @property {string} amount - The amount of the item.
- * @property {string} contractAddress - The contract address of the ERC20.
- * @property {string} spenderAddress - The contract address of the approver.
+ * @property {ItemType.ERC20} type
+ * @property {string} amount
+ * @property {string} contractAddress
+ * @property {string} spenderAddress
  */
 type ERC20ItemRequirement = {
+    /** The type to indicate this is a ERC20 item requirement. */
     type: ItemType.ERC20;
+    /** The amount of the item. */
     contractAddress: string;
+    /** The contract address of the ERC20. */
     amount: string;
+    /** The contract address of the approver. */
     spenderAddress: string;
 };
 /**
  * Represents an ERC721 item requirement for a transaction.
- * @property {ItemType.ERC721} type - The type to indicate this is a ERC721 item requirement.
- * @property {string} contractAddress - The contract address of the ERC721 collection.
- * @property {string} id - The ID of this ERC721 in the collection.
- * @property {string} spenderAddress - The contract address of the approver.
+ * @property {ItemType.ERC721} type
+ * @property {string} contractAddress
+ * @property {string} id
+ * @property {string} spenderAddress
  */
 type ERC721ItemRequirement = {
+    /** The type to indicate this is a ERC721 item requirement. */
     type: ItemType.ERC721;
+    /** The contract address of the ERC721 collection. */
     contractAddress: string;
+    /** The ID of this ERC721 in the collection. */
     id: string;
+    /** The contract address of the approver. */
     spenderAddress: string;
 };
 /**
@@ -16198,20 +16263,24 @@ declare enum TransactionOrGasType {
 }
 /**
  * The fulfillment transaction which contains the transaction to send.
- * @property {TransactionOrGasType} type - The type to indicate this is a fulfillment transaction.
- * @property {TransactionRequest} transaction - The transaction to send.
+ * @property {TransactionOrGasType} type
+ * @property {TransactionRequest} transaction
  */
 type FulfillmentTransaction = {
+    /** The type to indicate this is a fulfillment transaction. */
     type: TransactionOrGasType.TRANSACTION;
+    /** The transaction to send. */
     transaction: TransactionRequest;
 };
 /**
  * The gas amount which contains the gas token and the gas limit.
- * @property {TransactionOrGasType} type - The type to indicate this is a gas amount.
- * @property {GasToken} gasToken - The gas token.
+ * @property {TransactionOrGasType} type
+ * @property {GasToken} gasToken
  */
 type GasAmount = {
+    /** The type to indicate this is a gas amount. */
     type: TransactionOrGasType.GAS;
+    /** The gas token. */
     gasToken: GasToken;
 };
 /**
@@ -16230,22 +16299,27 @@ declare enum GasTokenType {
 }
 /**
  * Represents a native gas token.
- * @property {GasTokenType} type - The type to indicate this is a native gas token.
- * @property {BigNumber} limit - The gas limit.
+ * @property {GasTokenType} type
+ * @property {BigNumber} limit
  */
 type NativeGas = {
+    /** The type to indicate this is a native gas token. */
     type: GasTokenType.NATIVE;
+    /** The gas limit. */
     limit: BigNumber;
 };
 /**
  * Represents an ERC20 gas token.
- * @property {GasTokenType} type - The type to indicate this is an ERC20 gas token.
- * @property {string} contractAddress - The contract address of the ERC20.
- * @property {BigNumber} limit - The gas limit.
+ * @property {GasTokenType} type
+ * @property {string} contractAddress
+ * @property {BigNumber} limit
  */
 type ERC20Gas = {
+    /** The type to indicate this is an ERC20 gas token. */
     type: GasTokenType.ERC20;
+    /** The contract address of the ERC20. */
     contractAddress: string;
+    /** The gas limit. */
     limit: BigNumber;
 };
 /**
@@ -16254,34 +16328,38 @@ type ERC20Gas = {
 type SmartCheckoutResult = SmartCheckoutSufficient | SmartCheckoutInsufficient;
 /**
  * Represents the result of {@link Checkout.smartCheckout} when smart checkout is sufficient.
- * @property {boolean} sufficient - Indicates that smart checkout determined the user had sufficient funds.
- * @property {TransactionRequirement[]} transactionRequirements - The transaction requirements smart checkout
- * determined were required for the transaction.
+ * @property {boolean} sufficient
+ * @property {TransactionRequirement[]} transactionRequirements
  */
 type SmartCheckoutSufficient = {
+    /** Indicates that smart checkout determined the user had sufficient funds. */
     sufficient: true;
+    /** The transaction requirements smart checkout determined were required for the transaction. */
     transactionRequirements: TransactionRequirement[];
 };
 /**
  * Represents the result of {@link Checkout.smartCheckout} when smart checkout is insufficient.
- * @property {boolean} sufficient - Indicates that smart checkout determined the user has insufficient funds
- * @property {TransactionRequirement[]} transactionRequirements - The transaction requirements smart checkout
- * determined were required for the transaction.
- * @property {SmartCheckoutRouter} router - The type containing the funding routes the user can take to fulfill the transaction requirements
+ * @property {boolean} sufficient
+ * @property {TransactionRequirement[]} transactionRequirements
+ * @property {SmartCheckoutRouter} router
  */
 type SmartCheckoutInsufficient = {
+    /** Indicates that smart checkout determined the user has insufficient funds */
     sufficient: false;
+    /** The transaction requirements smart checkout determined were required for the transaction. */
     transactionRequirements: TransactionRequirement[];
+    /** The type containing the funding routes the user can take to fulfill the transaction requirements */
     router: SmartCheckoutRouter;
 };
 /**
  * Represents the routing outcome for a transaction.
- * @property {AvailableRoutingOptions} availableRoutingOptions - The routing options available to the user
- * @property {RoutingOutcome} routingOutcome - The routing outcome for the transaction which
- * includes the funding routes if routes were found
+ * @property {AvailableRoutingOptions} availableRoutingOptions
+ * @property {RoutingOutcome} routingOutcome
  */
 type SmartCheckoutRouter = {
+    /** The routing options available to the user */
     availableRoutingOptions: AvailableRoutingOptions;
+    /** The routing outcome for the transaction which includes the funding routes if routes were found */
     routingOutcome: RoutingOutcome;
 };
 /**
@@ -16299,109 +16377,137 @@ declare enum RoutingOutcomeType {
 type RoutingOutcome = RoutesFound | NoRoutesFound | NoRouteOptions;
 /**
  * Represents a routing outcome where funding routes were found.
- * @property {RoutingOutcomeType.ROUTES_FOUND} type - Indicates that funding routes were found for the transaction.
- * @property {AvailableRoutingOptions} fundingRoutes - The funding routes found for the transaction.
+ * @property {RoutingOutcomeType.ROUTES_FOUND} type
+ * @property {AvailableRoutingOptions} fundingRoutes
  */
 type RoutesFound = {
+    /** Indicates that funding routes were found for the transaction. */
     type: RoutingOutcomeType.ROUTES_FOUND;
+    /** The funding routes found for the transaction. */
     fundingRoutes: FundingRoute[];
 };
 /**
  * Represents a routing outcome where no funding routes were found.
- * @property {RoutingOutcomeType.NO_ROUTES_FOUND} type - Indicates that no funding routes were found for the transaction.
- * @property {string} message - The message indicating why no funding routes were found.
+ * @property {RoutingOutcomeType.NO_ROUTES_FOUND} type
+ * @property {string} message
  */
 type NoRoutesFound = {
+    /** Indicates that no funding routes were found for the transaction. */
     type: RoutingOutcomeType.NO_ROUTES_FOUND;
+    /** The message indicating why no funding routes were found. */
     message: string;
 };
 /**
  * Represents a routing outcome where no routing options were available for the transaction.
- * @property {RoutingOutcomeType.NO_ROUTE_OPTIONS} type - Indicates that no routing options were available for the transaction.
- * @property {string} message - The message indicating why no routing options were available.
+ * @property {RoutingOutcomeType.NO_ROUTE_OPTIONS} type
+ * @property {string} message
  */
 type NoRouteOptions = {
+    /** Indicates that no routing options were available for the transaction. */
     type: RoutingOutcomeType.NO_ROUTE_OPTIONS;
+    /** The message indicating why no routing options were available. */
     message: string;
 };
 /**
  * Represents a funding route
- * @property {number} priority - The priority of the route
- * @property {FundingStep[]} steps - The steps associated with this funding route
+ * @property {number} priority
+ * @property {FundingStep[]} steps
  */
 type FundingRoute = {
+    /** The priority of the route */
     priority: number;
+    /** The steps associated with this funding route */
     steps: FundingStep[];
 };
 /**
  * Represents a fee
- * @property {BigNumber} amount - The amount of the fee
- * @property {string} formatted - The formatted amount of the fee
- * @property {TokenInfo | undefined} token - The token info for the fee
+ * @property {BigNumber} amount
+ * @property {string} formatted
+ * @property {TokenInfo | undefined} token
  */
 type Fee = {
+    /** The amount of the fee */
     amount: BigNumber;
+    /** The formatted amount of the fee */
     formattedAmount: string;
+    /** The token info for the fee */
     token?: TokenInfo;
 };
 type FundingStep = BridgeFundingStep | SwapFundingStep | OnRampFundingStep;
 /**
  * Represents a bridge funding route
- * @property {FundingStepType.BRIDGE} type - Indicates that this is a bridge funding step
- * @property {number} chainId - The chain id the bridge should be executed on
- * @property {FundingItem} fundingItem - The funding item for the bridge
- * @property {BridgeFees} fees - The fees for the bridge
+ * @property {FundingStepType.BRIDGE} type
+ * @property {number} chainId
+ * @property {FundingItem} fundingItem
+ * @property {BridgeFees} fees
  */
 type BridgeFundingStep = {
+    /** Indicates that this is a bridge funding step */
     type: FundingStepType.BRIDGE;
+    /** The chain id the bridge should be executed on */
     chainId: number;
+    /** The funding item for the bridge */
     fundingItem: FundingItem;
+    /** The fees for the bridge */
     fees: BridgeFees;
 };
 /**
  * Represents the fees for a bridge funding step
- * @property {Fee} approvalGasFees - The approval gas fees for the bridge
- * @property {Fee} bridgeGasFees - The bridge gas fees for the bridge
- * @property {Fee[]} bridgeFees - Additional bridge fees for the bridge
+ * @property {Fee} approvalGasFees
+ * @property {Fee} bridgeGasFees
+ * @property {Fee[]} bridgeFees
  */
 type BridgeFees = {
+    /** The approval gas fees for the bridge */
     approvalGasFees: Fee;
+    /** The bridge gas fees for the bridge */
     bridgeGasFees: Fee;
+    /** Additional bridge fees for the bridge */
     bridgeFees: Fee[];
 };
 /**
  * Represents a swap funding route
- * @property {FundingStepType.SWAP} type - Indicates that this is a swap funding step
- * @property {number} chainId - The chain id the swap should be executed on
- * @property {FundingItem} fundingItem - The funding item for the swap
- * @property {SwapFees} fees - The fees for the swap
+ * @property {FundingStepType.SWAP} type
+ * @property {number} chainId
+ * @property {FundingItem} fundingItem
+ * @property {SwapFees} fees
  */
 type SwapFundingStep = {
+    /** Indicates that this is a swap funding step */
     type: FundingStepType.SWAP;
+    /** The chain id the swap should be executed on */
     chainId: number;
+    /** The funding item for the swap */
     fundingItem: FundingItem;
+    /** The fees for the swap */
     fees: SwapFees;
 };
 /**
  * Represents the fees for a swap funding step
- * @property {Fee} approvalGasFees - The approval gas fees for the swap
- * @property {Fee} swapGasFees - The swap gas fees for the swap
- * @property {Fee[]} swapFees - Additional swap fees for the swap
+ * @property {Fee} approvalGasFees
+ * @property {Fee} swapGasFees
+ * @property {Fee[]} swapFees
  */
 type SwapFees = {
+    /** The approval gas fees for the swap */
     approvalGasFees: Fee;
+    /** The swap gas fees for the swap */
     swapGasFees: Fee;
+    /** Additional swap fees for the swap */
     swapFees: Fee[];
 };
 /**
  * Represents an onramp funding route
- * @property {FundingStepType.ONRAMP} type - Indicates that this is an onramp funding step
- * @property {number} chainId - The chain id the onramp should provide funds to
- * @property {FundingItem} fundingItem - The item to be onramped
+ * @property {FundingStepType.ONRAMP} type
+ * @property {number} chainId
+ * @property {FundingItem} fundingItem
  */
 type OnRampFundingStep = {
+    /** Indicates that this is an onramp funding step */
     type: FundingStepType.ONRAMP;
+    /** The chain id the onramp should provide funds to */
     chainId: number;
+    /** The item to be onramped */
     fundingItem: FundingItem;
 };
 /**
@@ -16418,76 +16524,98 @@ declare enum FundingStepType {
 }
 /**
  * Represents a funding item
- * @property {ItemType.NATIVE | ItemType.ERC20} type - The type of the funding item
- * @property {FundsRequired} fundsRequired - The amount of funds required of this funding item
- * @property {UserBalance} userBalance - The current user balance of this funding item
- * @property {TokenInfo} token - The token info for the funding item
+ * @property {ItemType.NATIVE | ItemType.ERC20} type
+ * @property {FundsRequired} fundsRequired
+ * @property {UserBalance} userBalance
+ * @property {TokenInfo} token
  */
 type FundingItem = {
+    /** The type of the funding item */
     type: ItemType.NATIVE | ItemType.ERC20;
+    /** The amount of funds required of this funding item */
     fundsRequired: FundsRequired;
+    /** The current user balance of this funding item */
     userBalance: UserBalance;
+    /** The token info for the funding item */
     token: TokenInfo;
 };
 /**
  * Represents the funds required of a funding item
- * @property {BigNumber} amount - The amount of funds required
- * @property {string} formattedAmount - The formatted amount of funds required
+ * @property {BigNumber} amount
+ * @property {string} formattedAmount
  */
 type FundsRequired = {
+    /** The amount of funds required */
     amount: BigNumber;
+    /** The formatted amount of funds required */
     formattedAmount: string;
 };
 /**
  * Represents the user balance of a funding item
- * @property {BigNumber} balance - The balance of the funding item
- * @property {string} formattedBalance - The formatted balance of the funding item
+ * @property {BigNumber} balance
+ * @property {string} formattedBalance
  */
 type UserBalance = {
+    /** The balance of the funding item */
     balance: BigNumber;
+    /** The formatted balance of the funding item */
     formattedBalance: string;
 };
 /**
  * Represents the transaction requirement for a transaction.
- * @property {ItemType} type - The type of the transaction requirement.
- * @property {boolean} sufficient - If the user address has sufficient funds to cover the transaction.
- * @property {ItemBalance} required - The required item balance.
- * @property {ItemBalance} current - The current item balance.
- * @property {BalanceDelta} delta - The delta between the required and current balances.
+ * @property {ItemType} type
+ * @property {boolean} sufficient
+ * @property {ItemBalance} required
+ * @property {ItemBalance} current
+ * @property {BalanceDelta} delta
  */
 type TransactionRequirement = {
+    /** The type of the transaction requirement. */
     type: ItemType;
+    /** If the user address has sufficient funds to cover the transaction. */
     sufficient: boolean;
+    /** The required item balance. */
     required: ItemBalance;
+    /** The current item balance. */
     current: ItemBalance;
+    /** The delta between the required and current balances. */
     delta: BalanceDelta;
 };
 /**
  * Represents the balance for either a native or ERC20 token.
- * @property {ItemType.NATIVE | ItemType.ERC20} type - Type to indicate this is a native or ERC20 token.
- * @property {BigNumber} balance - The balance of the item.
- * @property {string} formattedBalance - The formatted balance of the item.
- * @property {TokenInfo} token - The token info of the item.
+ * @property {ItemType.NATIVE | ItemType.ERC20} type
+ * @property {BigNumber} balance
+ * @property {string} formattedBalanc
+ * @property {TokenInfo} token
  */
 type TokenBalance = {
+    /** Type to indicate this is a native or ERC20 token. */
     type: ItemType.NATIVE | ItemType.ERC20;
+    /** The balance of the item. */
     balance: BigNumber;
+    /** The formatted balance of the item. */
     formattedBalance: string;
+    /**  The token info of the item. */
     token: TokenInfo;
 };
 /**
  * Represents the balance for an ERC721.
- * @property {ItemType.ERC721} type - Type to indicate this is an ERC721 token.
- * @property {BigNumber} balance - The balance of the item.
- * @property {string} formattedBalance - The formatted balance of the item.
- * @property {string} contractAddress - The contract address of the ERC721 collection.
- * @property {string} id - The ID of the ERC721 in the collection.
+ * @property {ItemType.ERC721} type
+ * @property {BigNumber} balance
+ * @property {string} formattedBalance
+ * @property {string} contractAddress
+ * @property {string} id
  */
 type ERC721Balance = {
+    /** Type to indicate this is an ERC721 token. */
     type: ItemType.ERC721;
+    /** The balance of the item. */
     balance: BigNumber;
+    /** The formatted balance of the item. */
     formattedBalance: string;
+    /** The contract address of the ERC721 collection. */
     contractAddress: string;
+    /** The ID of the ERC721 in the collection */
     id: string;
 };
 /**
@@ -16496,23 +16624,28 @@ type ERC721Balance = {
 type ItemBalance = ERC721Balance | TokenBalance;
 /**
  * Represents the delta between two balances.
- * @property {BigNumber} balance - The delta of the balance.
- * @property {string} formattedBalance - The formatted balance of the delta.
+ * @property {BigNumber} balance
+ * @property {string} formattedBalance
  */
 type BalanceDelta = {
+    /** The delta of the balance. */
     balance: BigNumber;
+    /** The formatted balance of the delta. */
     formattedBalance: string;
 };
 /**
  * A type representing the Smart Checkout routing options available for a user
  * if they are configured and enabled (not geo-blocked etc.)
- * @property {boolean | undefined} onRamp - If the user can use onramp
- * @property {boolean | undefined} swap - If the user can use swap
- * @property {boolean | undefined} bridge - If the user can use bridge
+ * @property {boolean | undefined} onRamp
+ * @property {boolean | undefined} swap
+ * @property {boolean | undefined} bridge
  */
 type AvailableRoutingOptions = {
+    /** If the user can use onramp */
     onRamp?: boolean;
+    /** If the user can use swap */
     swap?: boolean;
+    /** If the user can use bridge */
     bridge?: boolean;
 };
 
@@ -16615,69 +16748,88 @@ interface CheckoutModuleConfiguration extends ModuleConfiguration<CheckoutOverri
 /**
  * A type representing various remotely defined configurations which are
  * accessible via the Checkout config and configured based on the Environment.
- * @property {DexConfig} dex - The config used for the DEX.
- * @property {OnRampConfig} onramp - The config used for the OnRamp
- * @property {AllowedNetworkConfig[]} allowedNetworks - An array representing the allowed networks.
- * @property {GasEstimateTokenConfig | undefined} gasEstimateTokens - The config for the tokens used to estimate gas.
+ * @property {DexConfig} dex
+ * @property {OnRampConfig} onramp
+ * @property {BridgeConfig} bridge
+ * @property {AllowedNetworkConfig[]} allowedNetworks
+ * @property {GasEstimateTokenConfig | undefined} gasEstimateTokens
+ * @property {ImxAddressConfig | undefined} imxAddressMapping
  */
 type RemoteConfiguration = {
+    /** The config used for the DEX. */
     dex: DexConfig;
+    /** The config used for the OnRamp */
     onramp: OnRampConfig;
+    /** The config used for the Bridge. */
     bridge: BridgeConfig;
+    /** An array representing the allowed networks. */
     allowedNetworks: AllowedNetworkConfig[];
+    /** The config for the tokens used to estimate gas. */
     gasEstimateTokens?: GasEstimateTokenConfig;
+    /** The IMX address mappings across available networks. */
     imxAddressMapping?: ImxAddressConfig;
 };
 /**
  * A type representing the fee structure for an OnRamp provider
- * @property {string | undefined} minPercentage - minimum percentage fee shown if a fee range is provided
- * @property {string | undefined} maxPercentage - maximum percentage fee shown if a fee range is provided
- * @property {string | undefined} feePercentage - specific fee percentage shown if there is no range provided
+ * @property {string | undefined} minPercentage
+ * @property {string | undefined} maxPercentage
+ * @property {string | undefined} feePercentage
  */
 type OnRampProviderFees = {
+    /** The minimum percentage fee shown if a fee range is provided */
     minPercentage?: string;
+    /** The maximum percentage fee shown if a fee range is provided */
     maxPercentage?: string;
+    /** The specific fee percentage shown if there is no range provided */
     feePercentage?: string;
 };
 /**
  * A type representing the configuration for the OnRamp for a specific provider.
- * @property {string} publishableApiKey - on ramp provider publishable api-key
- * @property {TokenInfo[]} tokens - allowed tokens for the OnRamp provider
- * @property {OnRampProviderFees} fees - on ramp provider transaction fees
+ * @property {string} publishableApiKey
+ * @property {TokenInfo[]} tokens
+ * @property {OnRampProviderFees} fees
  */
 type OnRampProviderConfig = {
+    /** The on ramp provider publishable api-key */
     publishableApiKey: string;
+    /** The allowed tokens for the OnRamp provider */
     tokens: TokenInfo[];
+    /** The on ramp provider transaction fees */
     fees: OnRampProviderFees;
 };
 /**
  * A type representing the configuration for the OnRamp.
- * @property {OnRampProviderConfig} transak - OnRamp config for Transak provider
+ * @property {OnRampProviderConfig} transak
  */
 type OnRampConfig = {
+    /** OnRamp config for Transak provider */
     [key: string]: OnRampProviderConfig;
 };
 /**
  * A type representing the configuration for the DEX.
- * @property {ExchangeOverrides | undefined} overrides - The DEX overrides.
- * @property {TokenInfo[] | undefined} tokens - An array of tokens compatible with the DEX.
+ * @property {ExchangeOverrides | undefined} overrides
+ * @property {TokenInfo[] | undefined} tokens
  */
 type DexConfig = {
+    /** The DEX overrides. */
     overrides?: ExchangeOverrides;
+    /** An array of tokens compatible with the DEX. */
     tokens?: TokenInfo[];
 };
 /**
  * A type representing the configuration for the Bridge.
- * @property {TokenInfo[] | undefined} tokens - An array of tokens compatible with the Bridge.
+ * @property {TokenInfo[] | undefined} tokens
  */
 type BridgeConfig = {
+    /** An array of tokens compatible with the Bridge. */
     tokens?: TokenInfo[];
 };
 /**
  * A type representing an allowed network.
- * @property {number} chainId - The network chain id.
+ * @property {number} chainId
  */
 type AllowedNetworkConfig = {
+    /** The network chain id. */
     chainId: number;
 };
 /**
@@ -16692,40 +16844,47 @@ type ImxAddressConfig = {
  * @type {{ [key: string]: { bridgeToL2Addresses?: GasEstimateBridgeToL2TokenConfig, swapAddresses?: GasEstimateSwapTokenConfig } }}
  * - A map of addresses for estimating gas keyed by the network chain id.
  * @property {GasEstimateBridgeToL2TokenConfig | undefined} bridgeToL2Addresses
- * - The type representing the addresses for a bridge to layer 2 gas estimate.
- * @property {GasEstimateSwapTokenConfig | undefined} swapAddresses - The type representing the addresses for a swap gas estimate
+ * @property {GasEstimateSwapTokenConfig | undefined} swapAddresses
  */
 type GasEstimateTokenConfig = {
     [key: string]: {
+        /** The type representing the addresses for a bridge to layer 2 gas estimate. */
         bridgeToL2Addresses?: GasEstimateBridgeToL2TokenConfig;
+        /** The type representing the addresses for a swap gas estimate */
         swapAddresses?: GasEstimateSwapTokenConfig;
     };
 };
 /**
  * A type representing the config for a bridge to layer 2 gas estimate.
- * @property {string | 'NATIVE'} gasTokenAddress - The address of the gas token.
- * @property {string} fromAddress - The address of the token being bridged.
+ * @property {string | 'NATIVE'} gasTokenAddress
+ * @property {string} fromAddress
  */
 type GasEstimateBridgeToL2TokenConfig = {
+    /**  The address of the gas token. */
     gasTokenAddress: string | 'NATIVE';
+    /** The address of the token being bridged. */
     fromAddress: string;
 };
 /**
  * A type representing the config for a swap gas estimate.
- * @property {string} inAddress - The in token address.
- * @property {string} outAddress - The out token address.
+ * @property {string} inAddress
+ * @property {string} outAddress
  */
 type GasEstimateSwapTokenConfig = {
+    /** The in token address. */
     inAddress: string;
+    /** The out token address. */
     outAddress: string;
 };
 /**
  * A type representing all the feature flags available.
- * @property {TokenInfo[] | undefined} allowed - List of allowed tokens for a given chain.
- * @property {boolean | undefined} blockscout - Feature flag to enable/disable blockscout integration.
+ * @property {TokenInfo[] | undefined} allowed -
+ * @property {boolean | undefined} blockscout -
  */
 type ChainTokensConfig = {
+    /** List of allowed tokens for a given chain. */
     allowed?: TokenInfo[];
+    /** Feature flag to enable/disable blockscout integration. */
     blockscout?: boolean;
 };
 
@@ -17140,10 +17299,11 @@ declare enum WidgetTheme {
 }
 
 /**
- * Represents the local configuration options for the Checkout Widgets.
- * @property {WidgetTheme | undefined} theme - The theme of the Checkout Widget (default: "DARK")
+ * Widget Configuration represents the shared configuration options for the Checkout Widgets.
+ * @property {WidgetTheme | undefined} theme
  */
 type WidgetConfiguration = {
+    /** The theme of the Checkout Widget (default: "DARK") */
     theme?: WidgetTheme;
 };
 
@@ -17182,18 +17342,21 @@ declare enum ConnectEventType {
 }
 /**
  * Represents a successful connection.
- * @property {Web3Provider} provider - The connected provider.
- * @property {WalletProviderName | undefined} walletProviderName - The wallet provider name of the connected provider.
+ * @property {Web3Provider} provider
+ * @property {WalletProviderName | undefined} walletProviderName
  */
 type ConnectionSuccess = {
+    /** The connected provider. */
     provider: Web3Provider;
+    /** The wallet provider name of the connected provider. */
     walletProviderName: WalletProviderName | undefined;
 };
 /**
  * Represents a connection failure with a reason.
- * @property {string} reason - The reason for the failed connection.
+ * @property {string} reason
  */
 type ConnectionFailed = {
+    /** The reason for the failed connection. */
     reason: string;
 };
 
@@ -17207,13 +17370,16 @@ declare enum WalletEventType {
 }
 /**
  * Represents an event that is triggered when the user switches the network in their wallet.
- * @property {string} network - The name of the network that the user switched to.
- * @property {number} chainId - The chain ID of the network that the user switched to.
- * @property {Web3Provider} provider - The Web3 provider object for the switched network.
+ * @property {string} network
+ * @property {number} chainId
+ * @property {Web3Provider} provider
  */
 type WalletNetworkSwitch = {
+    /**  The name of the network that the user switched to. */
     network: string;
+    /**  The chain ID of the network that the user switched to. */
     chainId: number;
+    /** The Web3 provider object for the switched network. */
     provider: Web3Provider;
 };
 /**
@@ -17232,27 +17398,32 @@ declare enum SwapEventType {
 }
 /**
  * Represents a successful swap transaction.
- * @property {string} transactionHash - The hash of the successful transaction.
+ * @property {string} transactionHash
  */
 type SwapSuccess = {
+    /** The hash of the successful transaction. */
     transactionHash: string;
 };
 /**
  * Type representing a Swap Widget with type FAILURE.
- * @property {string} reason - The reason why the swap failed.
- * @property {number} timestamp - The timestamp of the failed swap.
+ * @property {string} reason
+ * @property {number} timestamp
  */
 type SwapFailed = {
+    /** The reason why the swap failed. */
     reason: string;
+    /** The timestamp of the failed swap. */
     timestamp: number;
 };
 /**
  * Type representing a Swap Widget with type REJECTED.
- * @property {string} reason - The reason why the swap failed.
- * @property {number} timestamp - The timestamp of the failed swap.
+ * @property {string} reason -
+ * @property {number} timestamp -
  */
 type SwapRejected = {
+    /** The reason why the swap failed. */
     reason: string;
+    /** The timestamp of the failed swap. */
     timestamp: number;
 };
 
@@ -17268,9 +17439,10 @@ declare enum SaleEventType {
 }
 /**
  * Represents a successful Sale transaction.
- * @property {Array} transactions - The executed transactions
+ * @property {Array} transactions -
  */
 type SaleSuccess = {
+    /** The executed transactions */
     transactions: {
         method: string;
         hash: string | undefined;
@@ -17279,13 +17451,16 @@ type SaleSuccess = {
 };
 /**
  * Type representing a Sale Widget with type FAILURE.
- * @property {string} reason - The reason why the swap failed.
- * @property {number} timestamp - The timestamp of the failed swap.
- * @property {Array} transactions - The executed transactions
+ * @property {string} reason
+ * @property {number} timestamp
+ * @property {Array} transactions
  */
 type SaleFailed = {
+    /** The reason why the swap failed. */
     reason: string;
+    /** The timestamp of the failed swap. */
     timestamp: number;
+    /** The executed transactions */
     transactions: {
         method: string;
         hash: string | undefined;
@@ -17293,9 +17468,10 @@ type SaleFailed = {
 };
 /**
  * Type representing a Sale Widget with type TRANSACTION_SUCCESS.
- * @property {Object} transactions - The executed transactions
+ * @property {Object} transactions
  */
 type SaleTransactionSuccess = {
+    /** The executed transactions */
     transactions: {
         method: string;
         hash: string | undefined;
@@ -17312,18 +17488,21 @@ declare enum BridgeEventType {
 }
 /**
  * Represents a successful bridge transaction.
- * @property {string} transactionHash - The hash of the successful transaction.
+ * @property {string} transactionHash
  */
 type BridgeSuccess = {
+    /** The hash of the successful transaction. */
     transactionHash: string;
 };
 /**
  * Represents a failed bridge transaction.
- * @property {string} reason - The reason for the failed transaction.
- * @property {number} timestamp - The timestamp of the failed transaction.
+ * @property {string} reason
+ * @property {number} timestamp
  */
 type BridgeFailed = {
+    /** The reason for the failed transaction. */
     reason: string;
+    /** The timestamp of the failed transaction. */
     timestamp: number;
 };
 
@@ -17339,45 +17518,54 @@ declare enum OrchestrationEventType {
 }
 /**
  * Represents the connect event object when the connect widget is requested.
- * @property {string} walletProviderName - The wallet provider name.
+ * @property {string} walletProviderName
  */
 type RequestConnectEvent = {
+    /** The wallet provider name. */
     walletProviderName: string;
 };
 /**
  * Represents the wallet event object when the wallet widget is requested.
- * @property {string} walletProviderName - The wallet provider name.
+ * @property {string} walletProviderName
  */
 type RequestWalletEvent = {
+    /** The wallet provider name. */
     walletProviderName: string;
 };
 /**
  * Represents the swap event object when the swap widget is requested.
- * @property {string} fromTokenAddress - The address of the token to swap from.
- * @property {string} toTokenAddress - The address of the token to swap to.
- * @property {string} amount - The amount of from tokens to swap.
+ * @property {string} fromTokenAddress
+ * @property {string} toTokenAddress
+ * @property {string} amount
  */
 type RequestSwapEvent = {
+    /** The address of the token to swap from. */
     fromTokenAddress: string;
+    /** The address of the token to swap to. */
     toTokenAddress: string;
+    /** The amount of from tokens to swap. */
     amount: string;
 };
 /**
  * Represents the bridge event object when the bridge widget is requested.
- * @property {string} tokenAddress - The address of the token to bridge.
- * @property {string} amount - The amount of tokens to bridge.
+ * @property {string} tokenAddress
+ * @property {string} amount
  */
 type RequestBridgeEvent = {
+    /** The address of the token to bridge. */
     tokenAddress: string;
+    /** The amount of tokens to bridge. */
     amount: string;
 };
 /**
  * Represents the onramp event object when the onramp widget is requested.
- * @property {string} tokenAddress - The address of the token to be used for onramp.
- * @property {string} amount - The amount of tokens to onramp.
+ * @property {string} tokenAddress
+ * @property {string} amount
  */
 type RequestOnrampEvent = {
+    /** The address of the token to be used for onramp. */
     tokenAddress: string;
+    /** The amount of tokens to onramp. */
     amount: string;
 };
 type OrchestrationEventData = RequestConnectEvent | RequestWalletEvent | RequestSwapEvent | RequestBridgeEvent | RequestOnrampEvent;
@@ -17392,18 +17580,21 @@ declare enum OnRampEventType {
 }
 /**
  * Represents a successful on-ramp transaction.
- * @property {string} transactionHash - The transaction hash of the successful transaction.
+ * @property {string} transactionHash
  */
 type OnRampSuccess = {
+    /** The transaction hash of the successful transaction. */
     transactionHash: string;
 };
 /**
  * Type representing a On-ramp Widget with type FAILURE.
- * @property {string} reason - The reason why the on-ramp failed.
- * @property {number} timestamp - The timestamp of the failed transaction.
+ * @property {string} reason
+ * @property {number} timestamp
  */
 type OnRampFailed = {
+    /** The reason why the on-ramp failed. */
     reason: string;
+    /** The timestamp of the failed transaction. */
     timestamp: number;
 };
 
@@ -17415,82 +17606,128 @@ type ConnectWidgetParams = {};
 
 /**
  * Bridge Widget parameters
- * @property {string | undefined} fromContractAddress - The contract address of the token to bridge from, used to populate the bridge form token field
- * @property {string | undefined} amount - The formatted amount to bridge, used to populate the bridge form amount field
- * @property {WalletProviderName | undefined} walletProviderName - The wallet provider name to use for the bridge widget
+ * @property {string | undefined} fromContractAddress
+ * @property {string | undefined} amount
+ * @property {WalletProviderName | undefined} walletProviderName
  */
 type BridgeWidgetParams = {
+    /** The contract address of the token to bridge from, used to populate the bridge form token field */
     fromContractAddress?: string;
+    /** The formatted amount to bridge, used to populate the bridge form amount field */
     amount?: string;
+    /** The wallet provider name to use for the bridge widget */
     walletProviderName?: WalletProviderName;
 };
 
 /**
  * Wallet Widget parameters
- * @property {WalletProviderName | undefined} walletProviderName - The wallet provider name to use for the wallet widget
- * @property {Web3Provider | undefined} web3Provider - The ethers Web3Provider
+ * @property {WalletProviderName | undefined} walletProviderName
  */
 type WalletWidgetParams = {
+    /** The wallet provider name to use for the wallet widget */
     walletProviderName?: WalletProviderName;
 };
 
 /**
  * Swap Widget parameters
- * @property {string | undefined} amount - The formatted amount to swap, used to populate the swap from amount field
- * @property {string | undefined} fromContractAddress - The contract address of the token to swap from
- * @property {string | undefined} toContractAddress - The contract address of the token to swap to
- * @property {WalletProviderName | undefined} walletProviderName - The wallet provider name to use for the swap widget
+ * @property {string | undefined} amount
+ * @property {string | undefined} fromContractAddress
+ * @property {string | undefined} toContractAddress
+ * @property {WalletProviderName | undefined} walletProviderName
  */
-interface SwapWidgetParams {
+type SwapWidgetParams = {
+    /** The formatted amount to swap, used to populate the swap from amount field */
     amount?: string;
+    /** The contract address of the token to swap from */
     fromContractAddress?: string;
+    /** The contract address of the token to swap to */
     toContractAddress?: string;
+    /** The wallet provider name to use for the swap widget */
     walletProviderName?: WalletProviderName;
-}
+};
 
 /**
  * OnRamp Widget parameters
- * @property {string | undefined} contractAddress - The contract address of the token to onramp
- * @property {string | undefined} amount - The formatted amount to onramp, used to populate the onramp form amount field
- * @property {WalletProviderName | undefined} walletProviderName - The wallet provider name to use for the onramp widget
+ * @property {string | undefined} contractAddress
+ * @property {string | undefined} amount
+ * @property {WalletProviderName | undefined} walletProviderName
  */
 type OnRampWidgetParams = {
+    /** The contract address of the token to onramp */
     contractAddress?: string;
+    /** The formatted amount to onramp, used to populate the onramp form amount field */
     amount?: string;
+    /** The wallet provider name to use for the onramp widget */
     walletProviderName?: WalletProviderName;
 };
 
 /**
  * Sale Widget parameters
- * @property {string} amount - The total price to pay for the items in the sale
- * @property {SaleItem[]} items - The list of products to be purchased
- * @property {WalletProviderName | undefined} walletProviderName - The wallet provider name to default to if no web3Provider is passed
+ * @property {string} amount
+ * @property {string} environmentId
+ * @property {string} fromContractAddress
+ * @property {SaleItem[]} items
+ * @property {WalletProviderName | undefined} walletProviderName
  */
 type SaleWidgetParams = {
+    /** The total price to pay for the items in the sale */
     amount?: string;
     environmentId?: string;
     fromContractAddress?: string;
+    /** The list of products to be purchased */
     items?: SaleItem[];
+    /** The wallet provider name to default to if no web3Provider is passed */
     walletProviderName?: WalletProviderName;
 };
+/**
+ * A product to be purchased
+ * @property {string} productId
+ * @property {number} qty
+ * @property {string} name
+ * @property {string} image
+ * @property {string} description
+ */
 type SaleItem = {
+    /** The id of the product */
     productId: string;
+    /** The quantity to be purchased */
     qty: number;
+    /** The name of the item */
     name: string;
+    /** The image url of the item */
     image: string;
+    /** The description of the item */
     description: string;
 };
 
+/**
+ * Connect Widget Configuration represents the configuration options for the Connect Widget.
+ */
 type ConnectWidgetConfiguration = {} & WidgetConfiguration;
 
+/**
+ * Bridge Widget Configuration represents the configuration options for the Bridge Widget.
+ */
 type BridgeWidgetConfiguration = {} & WidgetConfiguration;
 
+/**
+ * Wallet Widget Configuration represents the configuration options for the Wallet Widget.
+ */
 type WalletWidgetConfiguration = {} & WidgetConfiguration;
 
+/**
+ * Swap Widget Configuration represents the configuration options for the Swap Widget.
+ */
 type SwapWidgetConfiguration = {} & WidgetConfiguration;
 
+/**
+ * Onramp Widget Configuration represents the configuration options for the Onramp Widget.
+ */
 type OnrampWidgetConfiguration = {} & WidgetConfiguration;
 
+/**
+ * Sale Widget Configuration represents the configuration options for the Sale Widget.
+ */
 type SaleWidgetConfiguration = {} & WidgetConfiguration;
 
 /**
@@ -17605,21 +17842,25 @@ type WidgetEvent<T extends WidgetType, KEventName extends keyof WidgetEventData[
 /**
  * Represents an event emitted by a widget.
  * @template KEventName - The orchestration event name.
- * @property {KEventName} type - The type of the event.
- * @property {OrchestrationMapping[KEventName]} data - The data associated with the event.
+ * @property {KEventName} type
+ * @property {OrchestrationMapping[KEventName]} data
  */
 type OrchestrationEvent<KEventName extends keyof OrchestrationMapping> = {
+    /** The type of the event. */
     type: KEventName;
+    /** The data associated with the event. */
     data: OrchestrationMapping[KEventName];
 };
 /**
  * Represents an event emitted by a widget.
  * @template KEventName - The provider event name.
- * @property {KEventName} type - The type of the event.
- * @property {ProviderEventMapping[KEventName]} data - The data associated with the event.
+ * @property {KEventName} type
+ * @property {ProviderEventMapping[KEventName]} data
  */
 type ProviderEvent<KEventName extends keyof ProviderEventMapping> = {
+    /** The type of the event. */
     type: KEventName;
+    /** The data associated with the event. */
     data: ProviderEventMapping[KEventName];
 };
 interface IWidgetsFactory {
@@ -17631,7 +17872,7 @@ interface IWidgetsFactory {
     create<T extends WidgetType>(type: T, props?: WidgetProperties<T>): Widget<T>;
     /**
      * Update the widgets provider instance.
-     * @param provider provider instantiate.
+     * @param provider the provider instance to update all widgets.
      */
     updateProvider(provider: Web3Provider): void;
 }
@@ -17668,11 +17909,11 @@ interface Widget<T extends WidgetType> {
 }
 /**
  * Represents the version of the Checkout Widgets to use defaults to (0.1.9-alpha)
- * @property {number} major - The major version of the widgets, must specify a major version even if it is 0.
- * @property {number | undefined} minor - The minor version of the widgets, leaving this blank will use the latest minor based on major
- * @property {number | undefined} patch - The patch version of the widgets, leaving this blank will use the latest minor based on minor
- * @property {'alpha' | undefined} prerelease - The prerelease version of the widgets, can only be 'alpha'. Do not use in production.
- * @property {number | undefined} build - The build version of the widgets. Do not use in production.
+ * @property {number} major
+ * @property {number | undefined} minor
+ * @property {number | undefined} patch
+ * @property {'alpha' | undefined} prerelease
+ * @property {number | undefined} build
  *
  * @example
  * { major: 0 } - use default version 0.1.9-alpha
@@ -17681,27 +17922,38 @@ interface Widget<T extends WidgetType> {
  * { major: 1, minor: 2, patch: 3 } - use version 1.2.3 specifically
  */
 type SemanticVersion = {
+    /** The major version of the widgets, must specify a major version even if it is 0. */
     major: number;
+    /** The minor version of the widgets, leaving this blank will use the latest minor based on major */
     minor?: number;
+    /** The patch version of the widgets, leaving this blank will use the latest minor based on minor */
     patch?: number;
+    /** The prerelease version of the widgets, can only be 'alpha'. Do not use in production. */
     prerelease?: 'alpha';
+    /** The build version of the widgets. Do not use in production. */
     build?: number;
 };
 /**
  * Represents the global configuration options for the Checkout Widgets.
- * @property {WidgetTheme | undefined} theme - The theme of the Checkout Widget (default: "DARK")
- * @property {Environment | undefined} environment - The environment configuration (default: "SANDBOX")
- * @property {SemanticVersion | undefined} version - The version of the checkout widgets js file to use (default: "0.1.x")
- * @property {boolean | undefined} isOnRampEnabled - Enable on-ramp top-up method (default: "true")
- * @property {boolean | undefined} isSwapEnabled - Enable swap top-up method (default: "true")
- * @property {boolean | undefined} isBridgeEnabled - Enable bridge top-up method (default: "true")
+ * @property {WidgetTheme | undefined} theme
+ * @property {Environment | undefined} environment
+ * @property {SemanticVersion | undefined} version
+ * @property {boolean | undefined} isOnRampEnabled
+ * @property {boolean | undefined} isSwapEnabled
+ * @property {boolean | undefined} isBridgeEnabled
  */
 type CheckoutWidgetsConfig = {
+    /** The theme of the Checkout Widget (default: "DARK") */
     theme?: WidgetTheme;
+    /** The environment configuration (default: "SANDBOX") */
     environment?: Environment;
+    /** The version of the checkout widgets js file to use (default: "0.1.x") */
     version?: SemanticVersion;
+    /** Enable on-ramp top-up method (default: "true") */
     isOnRampEnabled?: boolean;
+    /** Enable swap top-up method (default: "true") */
     isSwapEnabled?: boolean;
+    /** Enable bridge top-up method (default: "true") */
     isBridgeEnabled?: boolean;
 };
 
@@ -17957,13 +18209,16 @@ declare enum CheckoutErrorType {
 }
 /**
  * Represents an error object with a specific type, optional message, and optional data.
- * @property {CheckoutErrorType} type - The type of the error.
- * @property {string | undefined} [message] - The error message.
- * @property {Object.<string, string> | undefined} [data] - Additional data associated with the error.
+ * @property {CheckoutErrorType} type
+ * @property {string | undefined} [message]
+ * @property {Object.<string, string> | undefined} [data]
  */
 type ErrorType = {
+    /** The type of the error. */
     type: CheckoutErrorType;
+    /** The error message. */
     message?: string;
+    /** Additional data associated with the error. */
     data?: {
         [key: string]: string;
     };