@monerium/sdk-react-provider 0.2.0 → 0.4.0

package/dist/index.d.ts

@@ -1,25 +1,31 @@
 import * as react_jsx_runtime from 'react/jsx-runtime';
 import * as react from 'react';
 import { ReactNode } from 'react';
+import * as _tanstack_react_query from '@tanstack/react-query';
 import { UseQueryOptions, UseQueryResult, UseMutationOptions, UseMutationResult } from '@tanstack/react-query';
-import MoneriumClient, { ChainId, AuthContext, Profile, Token, Balances, Order, OrderState, NewOrder, LinkedAddress, LinkAddress } from '@monerium/sdk';
-export { AuthContext, Balances, LinkAddress, Order, OrderState, Profile, Token } from '@monerium/sdk';
+import MoneriumClient, { ChainId, Chain, CurrencyCode, Profile, ProfilesResponse, Token, Address, AddressesResponse, Currency, Balances, IBAN, IBANsResponse, Order, OrdersResponse, OrderState, ResponseStatus, SubmitProfileDetailsPayload, RequestIbanPayload, MoveIbanPayload, NewOrder, LinkedAddress, LinkAddress } from '@monerium/sdk';
+export { Address, Balances, IBAN, LinkAddress, MoveIbanPayload, NewOrder, Order, Profile, ProfilePermissions, ResponseStatus, SubmitProfileDetailsPayload, Token } from '@monerium/sdk';
 
 /**
- * Place this provider at the root of your application.
+ * Wrap your application with the Monerium provider.
  * @group Provider
  * @param params
  * @param params.children - Rest of the application.
  * @param params.clientId - Monerium auth flow client id.
- * @param params.redirectUrl - Monerium auth flow redirect url.
+ * @param params.redirectUri - Monerium auth flow redirect url.
  * @param params.environment - Monerium environment.
  * @returns
  */
-declare const MoneriumProvider: ({ children, clientId, redirectUrl, environment, }: {
+declare const MoneriumProvider: ({ children, clientId, redirectUri, environment, refreshToken, onRefreshTokenUpdate, debug, }: {
     children: ReactNode;
-    clientId?: string;
+    clientId: string;
+    redirectUri: string;
+    /** @deprecated use redirectUri */
     redirectUrl?: string;
     environment?: "sandbox" | "production";
+    refreshToken?: string;
+    onRefreshTokenUpdate?: (token: string) => void;
+    debug?: boolean;
 }) => react_jsx_runtime.JSX.Element;
 
 type SdkInstance = {
@@ -55,13 +61,20 @@ type UseAuthReturn = {
  * See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options.
  * @see # [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery)
  * @template {Object} TData - The data returned.
- *
- * @options
- * > `queryKey` and `queryFn` are used internally and therefore not included in the options.
+ * @example
+ * ```ts
+ * useQueryHook({
+ *  query: {
+ *    enabled: isReady,
+ *    staleTime: 1000,
+ *    placeHolderData: { foo: 'bar' },
+ *  }
+ * })
+ * ```
+ * ## Options
+ * > `queryKey` and `queryFn` are used internally and therefore not included as an options.
  * ```diff
  * query: {
- * -  queryKey,
- * -  queryFn,
  *    gcTime,
  *    enabled,
  *    networkMode,
@@ -85,26 +98,6 @@ type UseAuthReturn = {
  *    throwOnError
  * }
  *  ```
- * @example
- * ```ts
- * useQueryHook({
- *  query: {
- *    enabled: isReady,
- *    staleTime: 1000,
- *    placeHolderData: { foo: 'bar' },
- *  }
- * })
- * ```
- * @usedBy
- * {@link useAuthContext}
- *
- * {@link useBalances}
- *
- * {@link useOrders}
- *
- * {@link useProfile}
- *
- * {@link useTokens}
  */
 type QueryOptions<TData = unknown> = Omit<UseQueryOptions<TData>, 'queryKey' | 'queryFn'>;
 /**
@@ -143,16 +136,6 @@ type QueryOptions<TData = unknown> = Omit<UseQueryOptions<TData>, 'queryKey' | '
  *    status,
  *}
  *  ```
- * @usedBy
- * {@link useAuthContext}
- *
- * {@link useBalances}
- *
- * {@link useOrders}
- *
- * {@link useProfile}
- *
- * {@link useTokens}
  *
  */
 type QueryResult<TVarName extends string, TData = unknown> = Omit<UseQueryResult<TData>, 'data'> & {
@@ -166,14 +149,26 @@ type QueryResult<TVarName extends string, TData = unknown> = Omit<UseQueryResult
  * @template {Object} TError - The error returned.
  * @template {Object} TVariables - The variables used in the mutation.
  *
- * @options
- * > `mutationKey` and `mutationFn` are used internally and therefore not included in the options.
+ * @example
+ * ```ts
+ * useMutationHook({
+ *  mutation: {
+ *    onSuccess: (data, variables) => {
+ *      console.log('onSuccess callback', data, variables);
+ *    },
+ *    onError: (error) => {
+ *      console.log('onError callback', error);
+ *    },
+ *  },
+ * })
+ *
+ * ```
+ * ## Options
+ * > `mutationKey` and `mutationFn` are used internally and therefore not included as an options.
  * ```diff
  * mutation: {
  *    gcTime,
  *    meta,
- * -  mutationFn,
- * -  mutationKey,
  *    networkMode,
  *    onError,
  *    onMutate,
@@ -185,24 +180,6 @@ type QueryResult<TVarName extends string, TData = unknown> = Omit<UseQueryResult
  *    throwOnError,
  * }
  *  ```
- * @example
- * ```ts
- * useMutationHook({
- *  mutation: {
- *    onSuccess: (data, variables) => {
- *      console.log('onSuccess callback', data, variables);
- *    },
- *    onError: (error) => {
- *      console.log('onError callback', error);
- *    },
- *  },
- * })
- * ```
- *
- * @usedBy
- * {@link useLinkAddress}
- *
- * {@link usePlaceOrder}
  */
 type MutationOptions<TData = unknown, TError = unknown, TVariables = unknown> = Omit<UseMutationOptions<TData, TError, TVariables>, 'mutationKey' | 'mutationFn'>;
 /**
@@ -236,10 +213,6 @@ type MutationOptions<TData = unknown, TError = unknown, TVariables = unknown> =
  *    variables,
  * } = useMutationHook();
  *  ```
- * @usedBy
- * {@link useLinkAddress}
- *
- * {@link usePlaceOrder}
  */
 type MutationResult<TFuncName extends string, TData, TError, TVariables, TContext = unknown> = Omit<UseMutationResult<TData, TError, TVariables, TContext>, 'mutateAsync'> & {
     [P in TFuncName]: UseMutationResult<TData, TError, TVariables, TContext>['mutateAsync'];
@@ -249,31 +222,38 @@ declare const MoneriumContext: react.Context<(UseAuthReturn & SdkInstance) | nul
 
 /**
  * @internal
- * Query keys
+ * Query keys for React query
  * */
 declare const keys: {
     getAll: string[];
-    getAuthContext: string[];
-    getProfile: (profileId: string) => string[];
+    getProfile: (profile: string) => string[];
     getProfiles: string[];
-    getBalances: (profileId?: string) => string[];
+    getAddress: (address: string) => (string | string[])[];
+    getAddresses: (filter?: unknown) => {}[];
+    getBalances: (address: string, chain: Chain, currencies?: CurrencyCode | CurrencyCode[]) => string[];
+    getIban: (iban: string) => string[];
+    getIbans: (filter?: unknown) => {}[];
     getTokens: string[];
     getOrder: (orderId: string) => string[];
     getOrders: (filter?: unknown) => {}[];
+    submitProfileDetails: string[];
+    moveIban: string[];
+    requestIban: string[];
     placeOrder: string[];
     linkAddress: string[];
 };
 /**
  * # Redirect to the Monerium auth flow.
  * @group Hooks
+ * @category Authentication
  * @example
  * ```ts
  * const { authorize, isAuthorized, isLoading, error } = useAuth();
  *
  * authorize(); // Redirects to the Monerium auth flow.
  *
- * // To opt-in to automated wallet linking, pass the address, signature and chainId.
- * authorize({ address, signature, chainId }).
+ * // Opt-in to automated wallet linking with these parameters.
+ * authorize({ address, signature, chain }).
  * ```
  *
  * @returns {UseAuthReturn}
@@ -286,124 +266,138 @@ declare const keys: {
  */
 declare function useAuth(): UseAuthReturn;
 /**
- * # Get the authentication context.
+ * If no `profile` id is provided, the default profile is used.
  * @group Hooks
- *
- * @param {Object} [params] No required parameters.
- * @param {QueryOptions<AuthContext>} [params.query] {@inheritDoc QueryOptions}
+ * @category Profiles
+ * @param {Object} params
  *
  * @example
  * ```ts
  * const {
- *    authContext, // useQuery's `data` property
+ *    data
  *    isLoading,
  *    isError,
  *    error,
  *    refetch,
  *    ...moreUseQueryResults
- * } = useAuthContext();
+ * } = useProfile();
  * ```
- *
- * @see
- * [API Documentation](https://monerium.dev/api-docs#operation/auth-context)
- *
- * [AuthContext interface](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/docs/generated/interfaces/AuthContext.md)
+
+ * @see {@link https://monerium.dev/api-docs#operation/profile | API Documentation}
  */
-declare function useAuthContext({ query, }?: {
-    query?: QueryOptions<AuthContext>;
-}): QueryResult<'authContext', AuthContext>;
+declare function useProfile({ profile, query, }?: {
+    /** The id of the profile */
+    profile?: string;
+    /** {@inheritDoc QueryOptions} */
+    query?: QueryOptions<Profile>;
+}): _tanstack_react_query.UseQueryResult<Profile, Error>;
 /**
- * # Get single profile
- * If no `profileId` is provided, the default profile is used.
+ * # Get profiles
  * @group Hooks
- * @param {Object} params
- * @param {string} [params.profileId] The id of the profile.
- * @param {QueryOptions<Profile>} [params.query] {@inheritDoc QueryOptions}
+ * @category Profiles
+ *
+ * @param {Object} [params] No required parameters.
  *
  * @example
  * ```ts
  * const {
- *    profile, // useQuery's `data` property
+ *    data,
  *    isLoading,
  *    isError,
  *    error,
  *    refetch,
  *    ...moreUseQueryResults
- * } = useProfile();
+ * } = useProfiles();
  * ```
-
- * @see
- * [API Documentation](https://monerium.dev/api-docs#operation/profile)
- *
- * [Profile interface](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/docs/generated/interfaces/Profile.md)
+ * @see {@link https://monerium.dev/api-docs#operation/profiles | API Documentation}
  */
-declare function useProfile({ profileId, query, }?: {
-    profileId?: string;
-    query?: QueryOptions<Profile>;
-}): QueryResult<'profile', Profile>;
+declare function useProfiles({ query, }?: {
+    /** {@inheritDoc QueryOptions} */
+    query?: QueryOptions<ProfilesResponse>;
+}): _tanstack_react_query.UseQueryResult<ProfilesResponse, Error>;
 /**
- * # Get profiles
  * @group Hooks
  * @param {Object} [params] No required parameters.
- * @param {QueryOptions<Profile[]>} [params.query] {@inheritDoc QueryOptions}
  *
  * @example
  * ```ts
  * const {
- *    profiles, // useQuery's `data` property
+ *    data,
  *    isLoading,
  *    isError,
  *    error,
  *    refetch,
  *    ...moreUseQueryResults
- * } = useProfiles();
+ * } = useTokens();
  * ```
 
- * @see
- * [API Documentation](https://monerium.dev/api-docs#operation/profiles)
- *
- * [Profile interface](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/docs/generated/interfaces/Profile.md)
+ * @see {@link https://monerium.dev/api-docs#operation/tokens | API Documentation}
  */
-declare function useProfiles({ query, }?: {
-    query?: QueryOptions<Profile[]>;
-}): QueryResult<'profiles', Profile[]>;
+declare function useTokens({ query, }?: {
+    /** {@inheritDoc QueryOptions} */
+    query?: QueryOptions<Token[]>;
+}): _tanstack_react_query.UseQueryResult<Token[], Error>;
 /**
- * # Get tokens
  * @group Hooks
- * @param {Object} [params] No required parameters.
- * @param {QueryOptions<Token[]>} [params.query] {@inheritDoc QueryOptions}
- *
+ * @category Addresses
+ * @param {Object} params
+
  * @example
  * ```ts
  * const {
- *    tokens, // useQuery's `data` property
+ *    data,
  *    isLoading,
  *    isError,
  *    error,
  *    refetch,
  *    ...moreUseQueryResults
- * } = useTokens();
+ * } = useAddress();
  * ```
-
- * @see
- * [API Documentation](https://monerium.dev/api-docs#operation/tokens)
- *
- * [Token interface](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/docs/generated/interfaces/Token.md)
+ * @see {@link https://monerium.dev/api-docs-v2#tag/addresses/operation/address | API Documentation}
  */
-declare function useTokens({ query, }?: {
-    query?: QueryOptions<Token[]>;
-}): QueryResult<'tokens', Token[]>;
+declare function useAddress({ address, query, }: {
+    /** Fetch a specific address. */
+    address: string;
+    /** {@inheritDoc QueryOptions} */
+    query?: QueryOptions<Address>;
+}): _tanstack_react_query.UseQueryResult<Address, Error>;
 /**
- * # Get balances
  * @group Hooks
+ * @category Addresses
  * @param {Object} [params] No required parameters.
- * @param {QueryOptions<Balances[]>} [params.profileId] Fetch balances for a specific profile.
- * @param {QueryOptions<Balances[]>} [params.query] {@inheritDoc QueryOptions}
-
+ * @param {Object} [params.profile] Filter based on profile id.
+ * @param {Object} [params.chain] Filter based on chain - CURRENTLY RETURNS AN ERROR.
+ * @example
+ * ```ts
+ * const {
+ *    data,
+ *    isLoading,
+ *    isError,
+ *    error,
+ *    refetch,
+ *    ...moreUseQueryResults
+ * } = useAddresses();
+ * ```
+ * @see {@link https://monerium.dev/api-docs-v2#tag/addresses/operation/addresses | API Documentation}
+ */
+declare function useAddresses({ profile, chain, query, }?: {
+    profile?: string;
+    chain?: Chain | ChainId;
+    /** {@inheritDoc QueryOptions} */
+    query?: QueryOptions<AddressesResponse>;
+}): _tanstack_react_query.UseQueryResult<AddressesResponse, Error>;
+/**
+ * # Get balance for a an address on a give chain
+ * @group Hooks
+ * @category Addresses
+ * @param {Object} params
+ * @param {QueryOptions<Balances>} params.address The address to fetch the balance for.
+ * @param {QueryOptions<Balances>} params.chain The chain to fetch the balance for.
+ * @param {QueryOptions<Balances>} [params.currencies] One or many: `eur`, `usd`, `gbp`, `isk`
  * @example
  * ```ts
  * const {
- *    balances, // useQuery's `data` property
+ *    data,
  *    isLoading,
  *    isError,
  *    error,
@@ -411,25 +405,72 @@ declare function useTokens({ query, }?: {
  *    ...moreUseQueryResults
  * } = useBalances();
  * ```
- * @see
- * [API Documentation](https://monerium.dev/api-docs#operation/profile-balances)
+ * @see {@link https://monerium.dev/api-docs/v2#tag/addresses/operation/balances | API Documentation}
  *
- * [Balances interface](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/docs/generated/interfaces/Balances.md)
  */
-declare function useBalances({ profileId, query, }?: {
-    profileId?: string;
-    query?: QueryOptions<Balances[]>;
-}): QueryResult<'balances', Balances[]>;
+declare function useBalances({ address, chain, currencies, query, }: {
+    address: string;
+    chain: Chain | ChainId;
+    currencies?: Currency | Currency[];
+    /** {@inheritDoc QueryOptions} */
+    query?: QueryOptions<Balances>;
+}): _tanstack_react_query.UseQueryResult<Balances, Error>;
 /**
- * # Get single order
  * @group Hooks
+ * @category IBANs
  * @param {Object} params
- * @param {Object} params.orderId The id of the order.
- * @param {QueryOptions<Order>} [params.query] {@inheritDoc QueryOptions}
  * @example
  * ```ts
  * const {
- *    order, // useQuery's `data` property
+ *    data,
+ *    isLoading,
+ *    isError,
+ *    error,
+ *    refetch,
+ *    ...moreUseQueryResults
+ * } = useIBAN();
+ * ```
+ * @see {@link https://monerium.dev/api-docs-v2#tag/ibans/operation/iban | API Documentation}
+ */
+declare function useIBAN({ iban, query, }: {
+    /** Fetch a specific IBAN */
+    iban: string;
+    /** {@inheritDoc QueryOptions} */
+    query?: QueryOptions<IBAN>;
+}): _tanstack_react_query.UseQueryResult<IBAN, Error>;
+/**
+ * @group Hooks
+ * @category IBANs
+ * @param {Object} [params] No required parameters.
+ * @example
+ * ```ts
+ * const {
+ *    data,
+ *    isLoading,
+ *    isError,
+ *    error,
+ *    refetch,
+ *    ...moreUseQueryResults
+ * } = useIBANs();
+ * ```
+ * @see {@link https://monerium.dev/api-docs-v2#tag/ibans/operation/ibans | API Documentation}
+ */
+declare function useIBANs({ profile, chain, query, }?: {
+    /** Fetch IBANs for a specific profile. */
+    profile?: string;
+    /** Fetch IBANs for a specific chain. */
+    chain?: Chain | ChainId;
+    /** {@inheritDoc QueryOptions} */
+    query?: QueryOptions<IBANsResponse>;
+}): _tanstack_react_query.UseQueryResult<IBANsResponse, Error>;
+/**
+ * @group Hooks
+ * @category Orders
+ * @param {Object} params
+ * @example
+ * ```ts
+ * const {
+ *    data,
  *    isLoading,
  *    isError,
  *    error,
@@ -437,30 +478,28 @@ declare function useBalances({ profileId, query, }?: {
  *    ...moreUseQueryResults
  * } = useOrder();
  * ```
- * @see
- * [API Documentation](https://monerium.dev/api-docs#operation/order)
- *
- * [Order interface](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/docs/generated/interfaces/Order.md)
+ * @see {@link https://monerium.dev/api-docs#operation/order| API Documentation}
  */
 declare function useOrder({ orderId, query, }: {
+    /**  The id of the order. */
     orderId: string;
+    /** {@inheritDoc QueryOptions} */
     query?: QueryOptions<Order>;
-}): QueryResult<'order', Order>;
+}): _tanstack_react_query.UseQueryResult<Order, Error>;
 /**
- * # Get orders
  * @group Hooks
+ * @category Orders
  * @param {Object} [params] No required parameters.
  * @param {Object} [params.address] Filter based on the blockchain address associated with the order.
  * @param {Object} [params.memo] Filter by the payment memo/reference..
  * @param {Object} [params.profile] Filter based on the profile ID associated with the order.
  * @param {Object} [params.state] Filter based on the state of the order.
  * @param {Object} [params.txHash] Filter based on the blockchain transaction hash.
- * @param {QueryOptions<Order[]>} [params.query] {@inheritDoc QueryOptions}
  *
  * @example
  * ```ts
  * const {
- *    orders, // useQuery's `data` property
+ *    data,
  *    isLoading,
  *    isError,
  *    error,
@@ -468,28 +507,105 @@ declare function useOrder({ orderId, query, }: {
  *    ...moreUseQueryResults
  * } = useOrders();
  * ```
- * @see
- * [API Documentation](https://monerium.dev/api-docs#operation/orders)
- *
- * [Order interface](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/docs/generated/interfaces/Order.md)
+ * @see {@link https://monerium.dev/api-docs#operation/orders | API Documentation}
  */
 declare function useOrders({ query, ...filters }?: {
-    query?: QueryOptions<Order[]>;
+    /** {@inheritDoc QueryOptions} */
+    query?: QueryOptions<OrdersResponse>;
     address?: string;
     txHash?: string;
     profile?: string;
     memo?: string;
     state?: OrderState;
-}): QueryResult<'orders', Order[]>;
+}): _tanstack_react_query.UseQueryResult<OrdersResponse, Error>;
+/**
+ * Submit the required compliance information to onboard the customer.
+ *
+ * Note that you won't be able to change the profile "kind" from personal to corporate or vice versa once the profile has been approved.
+ * @group Hooks
+ * @category Profiles
+ * @param param
+ * @param {string} param.profile The id of the profile to submit to.
+ *
+ * @example
+ * ```ts
+ * const {
+ *    submitProfileDetails, // useMutation's `mutateAsync` property
+ *    isPending,
+ *    isError,
+ *    error,
+ *    status,
+ *    ...moreUseMutationResults
+ * } = useSubmitProfileDetails();
+ * ```
+ * @see {@link https://monerium.dev/api-docs-v2#tag/profiles/operation/profile-details | API Documentation}}
+ */
+declare function useSubmitProfileDetails({ profile, mutation, }: {
+    profile: string;
+    /** {@inheritDoc MutationOptions} */
+    mutation?: MutationOptions<ResponseStatus, Error, SubmitProfileDetailsPayload>;
+}): MutationResult<'submitProfileDetails', ResponseStatus, Error, SubmitProfileDetailsPayload>;
+/**
+ * Create an IBAN for a specified address and chain.
+ * All incoming EUR payments will automatically be routed to the linked address on that chain.
+ * Any linked address can use this IBAN for outgoing payments.
+ * @group Hooks
+ * @category IBANs
+ * @param {Object} [params] No required parameters.
+ *
+ * @example
+ * ```ts
+ * const {
+ *    requestIban, // useMutation's `mutateAsync` property
+ *    isPending,
+ *    isError,
+ *    error,
+ *    status,
+ *    ...moreUseMutationResults
+ * } = useRequestIban();
+ * ```
+ * @see {@link https://monerium.dev/api-docs-v2#tag/ibans/operation/request-iban | API Documentation}}
+ */
+declare function useRequestIban({ mutation, }?: {
+    /** {@inheritDoc MutationOptions} */
+    mutation?: MutationOptions<ResponseStatus, Error, RequestIbanPayload>;
+}): MutationResult<'requestIban', ResponseStatus, Error, RequestIbanPayload>;
+/**
+ * Move an existing IBAN to a specified address an chain.
+ * All incoming EUR payments will automatically be routed to the address on that chain.
+ * @group Hooks
+ * @category IBANs
+ * @param {Object} [params] No required parameters.
+ *
+ * @example
+ * ```ts
+ * const {
+ *    moveIban, // useMutation's `mutateAsync` property
+ *    isPending,
+ *    isError,
+ *    error,
+ *    status,
+ *    ...moreUseMutationResults
+ * } = useMoveIban();
+ * ```
+ * @see {@link https://monerium.dev/api-docs/v2#tag/ibans/operation/move-iban | API Documentation}
+ */
+declare function useMoveIban({ mutation, }?: {
+    /** {@inheritDoc MutationOptions} */
+    mutation?: MutationOptions<ResponseStatus, Error, MoveIbanPayload & {
+        iban: string;
+    }>;
+}): MutationResult<'moveIban', ResponseStatus, Error, MoveIbanPayload & {
+    iban: string;
+}>;
 /**
- * # Place an order.
  * When the order has been placed, the orders query will be invalidated and re-fetched.
  *
  * If the order amount is above 15000, a supporting document is required.
  * @group Hooks
+ * @category Orders
  * @param param
  * @param {File} param.supportingDocument Supporting document file.
- * @param {Object} param.mutation {@inheritDoc MutationOptions}
  *
  * @example
  * ```ts
@@ -502,23 +618,19 @@ declare function useOrders({ query, ...filters }?: {
  *    ...moreUseMutationResults
  * } = usePlaceOrder();
  * ```
- * @see
- * [API Documentation](https://monerium.dev/api-docs#operation/post-orders)
- *
- * [NewOrder type](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/docs/generated/type-aliases/NewOrder.md)
+ * @see {@link https://monerium.dev/api-docs#operation/post-orders| API Documentation}
  */
 declare function usePlaceOrder({ supportingDocument, mutation, }?: {
     supportingDocument?: File;
+    /** {@inheritDoc MutationOptions} */
     mutation?: MutationOptions<Order, Error, NewOrder>;
 }): MutationResult<'placeOrder', Order, Error, NewOrder>;
 /**
  * # Add address to profile.
- * When the address has been linked, the relevant profile query will be invalidated and re-fetched.
  *
  * @group Hooks
- * @param param
- * @param {File} param.profileId Which profile to link the address.
- * @param {Object} param.mutation {@inheritDoc MutationOptions}
+ * @category Profiles
+ * @param {Object} [params] No required parameters.
  *
  * @example
  * ```ts
@@ -531,14 +643,49 @@ declare function usePlaceOrder({ supportingDocument, mutation, }?: {
  *    ...moreUseMutationResults
  * } = useLinkAddress();
  * ```
- * @see
- * [API Documentation](https://monerium.dev/api-docs#operation/profile-addresses)
- *
- * [LinkAddress interface](https://github.com/monerium/js-monorepo/blob/main/packages/sdk/docs/generated/interfaces/LinkAddress.md)
+ * @see {@link https://monerium.dev/api-docs#operation/profile-addresses | API Documentation}
  */
-declare function useLinkAddress({ profileId, mutation, }: {
-    profileId: string;
+declare function useLinkAddress({ mutation, }?: {
+    /** {@inheritDoc MutationOptions} */
     mutation?: MutationOptions<LinkedAddress, Error, LinkAddress>;
 }): MutationResult<'linkAddress', LinkedAddress, Error, LinkAddress>;
+/**
+ * API consumers have the option to subscribe to a WebSocket for real-time order notifications. This WebSocket complies with the standard WebSocket Protocol, allowing the use of standard WebSocket libraries for subscription.
+ *
+ * The WebSocket emits an event when a order changes state:
+ *
+ * `placed`: The order has been created but not yet processed.
+ *
+ * `pending`: The order is awaiting fulfillment (e.g., review, minting/burning tokens, or sending/receiving SEPA payment).
+ *
+ * `processed`: The order has been completed successfully.
+ *
+ * `rejected`: The order was rejected, possibly due to compliance reasons or insufficient funds.
+ * @group Hooks
+ * @category Orders
+ * @param {Object} params
+ * @param {OrderState} [params.state] Filter based on the state of the order.
+ * @param {string} [params.profile] Filter based on the profile id of the order.
+ * @param {Function} params.onMessage Callback function to handle the order notification.
+ * @param {Function} [params.onError] Callback function to handle the error notification.
+ *
+ * @example
+ * ```ts
+ * const {
+ *    state,
+ *    profile,
+ *    onMessage,
+ *    onError
+ * } = useSubscribeOrderNotification();
+ * ```
+ * @see {@link https://monerium.dev/api-docs/v1#operation/orders-notifications| API Documentation}
+ * @returns {Function} Unsubscribe from order notifications.
+ */
+declare const useSubscribeOrderNotification: ({ state, profile, onMessage, onError, }: {
+    state?: OrderState;
+    profile?: string;
+    onMessage: (order: Order) => void;
+    onError?: ((err: Event) => void) | undefined;
+}) => () => void | undefined;
 
-export { type AuthorizeParams, MoneriumContext, MoneriumProvider, type MutationOptions, type MutationResult, type QueryOptions, type QueryResult, type SdkInstance, type UseAuthReturn, keys, useAuth, useAuthContext, useBalances, useLinkAddress, useOrder, useOrders, usePlaceOrder, useProfile, useProfiles, useTokens };
+export { type AuthorizeParams, MoneriumContext, MoneriumProvider, type MutationOptions, type MutationResult, type QueryOptions, type QueryResult, type SdkInstance, type UseAuthReturn, keys, useAddress, useAddresses, useAuth, useBalances, useIBAN, useIBANs, useLinkAddress, useMoveIban, useOrder, useOrders, usePlaceOrder, useProfile, useProfiles, useRequestIban, useSubmitProfileDetails, useSubscribeOrderNotification, useTokens };