docs: merge w main

monerium · Aug 23, 2024 · eead166 · eead166
1 parent 9326d5b
commit eead166
Show file tree

Hide file tree

Showing 97 changed files with 454 additions and 1,644 deletions.
diff --git a/apps/customer/app/test/page.tsx b/apps/customer/app/test/page.tsx
@@ -663,7 +663,7 @@ export default function Test() {
       <button
         type="submit"
         onClick={() => {
-          context?.sdk?.closeOrderNotifications();
+          context?.sdk?.disconnectOrderNotifications();
         }}
       >
         Close Order Notifications

diff --git a/apps/developer/docs/packages/SDK React Provider/functions/useAddress.md b/apps/developer/docs/packages/SDK React Provider/functions/useAddress.md
@@ -1,33 +1,35 @@
-[Monerium SDK React Provider](../README.md) / useAddress
-
 # Function: useAddress()
 
-> **useAddress**(`params`: \{`address`: `string`;`query`: `{}`; \}): [`QueryResult`](../type-aliases/QueryResult.md)\<`"address"`, `Address`\>
+> **useAddress**(`params`): [`QueryResult`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"address"`, `Address`\>
 
 # Get address
 
 ## Parameters
 
-| Parameter        | Type                                                           | Description                                                                                                         |
-| ---------------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
-| `params`         | `object`                                                       |                                                                                                                     |
-| `params.address` | `string`                                                       | Fetch a specific address.                                                                                           |
-| `params.query`?  | [`QueryOptions`](../type-aliases/QueryOptions.md)\<`Address`\> | See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options. |
+• **params**
+
+• **params.address**: `string`
+
+Fetch a specific address.
+
+• **params.query?**: [`QueryOptions`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryOptions.md)\<`Address`\> = `{}`
+
+See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options.
 
 ## Returns
 
-[`QueryResult`](../type-aliases/QueryResult.md)\<`"address"`, `Address`\>
+[`QueryResult`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"address"`, `Address`\>
 
 ## Example
 
 ```ts
 const {
-  address, // useQuery's `data` property
-  isLoading,
-  isError,
-  error,
-  refetch,
-  ...moreUseQueryResults
+   address, // useQuery's `data` property
+   isLoading,
+   isError,
+   error,
+   refetch,
+   ...moreUseQueryResults
 } = useAddress();
 ```
 

diff --git a/apps/developer/docs/packages/SDK React Provider/functions/useAddresses.md b/apps/developer/docs/packages/SDK React Provider/functions/useAddresses.md
@@ -1,34 +1,41 @@
-[Monerium SDK React Provider](../README.md) / useAddresses
-
 # Function: useAddresses()
 
-> **useAddresses**(`params`?: \{`chain`: `number` \| `Chain`;`profile`: `string`;`query`: `{}`; \}): [`QueryResult`](../type-aliases/QueryResult.md)\<`"addresses"`, `Address`[]\>
+> **useAddresses**(`params`?): [`QueryResult`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"addresses"`, `Address`[]\>
 
 # Get addresses
 
 ## Parameters
 
-| Parameter         | Type                                                             | Description                                                                                                         |
-| ----------------- | ---------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
-| `params`?         | `object`                                                         | No required parameters.                                                                                             |
-| `params.chain`?   | `number` \| `Chain`                                              | Fetch addresses for a specific chain.                                                                               |
-| `params.profile`? | `string`                                                         | Fetch addresses for a specific profile.                                                                             |
-| `params.query`?   | [`QueryOptions`](../type-aliases/QueryOptions.md)\<`Address`[]\> | See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options. |
+• **params?** = `{}`
+
+No required parameters.
+
+• **params.chain?**: `number` \| `Chain`
+
+Fetch addresses for a specific chain.
+
+• **params.profile?**: `string`
+
+Fetch addresses for a specific profile.
+
+• **params.query?**: [`QueryOptions`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryOptions.md)\<`Address`[]\> = `{}`
+
+See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options.
 
 ## Returns
 
-[`QueryResult`](../type-aliases/QueryResult.md)\<`"addresses"`, `Address`[]\>
+[`QueryResult`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"addresses"`, `Address`[]\>
 
 ## Example
 
 ```ts
 const {
-  addresses, // useQuery's `data` property
-  isLoading,
-  isError,
-  error,
-  refetch,
-  ...moreUseQueryResults
+   addresses, // useQuery's `data` property
+   isLoading,
+   isError,
+   error,
+   refetch,
+   ...moreUseQueryResults
 } = useAddresses();
 ```
 

diff --git a/apps/developer/docs/packages/SDK React Provider/functions/useAuth.md b/apps/developer/docs/packages/SDK React Provider/functions/useAuth.md
@@ -28,8 +28,4 @@ authorize({ address, signature, chain }).
 
 ## Defined in
 
-<<<<<<< HEAD:apps/developer/docs/packages/SDK React Provider/functions/useAuth.md
-[hooks.tsx:85](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L85)
-=======
 [hooks.tsx:107](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L107)
->>>>>>> 3a1f3b9 (docs: update generated docs):packages/sdk-react-provider/docs/generated/functions/useAuth.md
diff --git a/apps/developer/docs/packages/SDK React Provider/functions/useAuthContext.md b/apps/developer/docs/packages/SDK React Provider/functions/useAuthContext.md
diff --git a/apps/developer/docs/packages/SDK React Provider/functions/useBalances.md b/apps/developer/docs/packages/SDK React Provider/functions/useBalances.md
@@ -6,11 +6,11 @@
 
 ## Parameters
 
-• **params?** = `{}`
+• **params?**
 
 No required parameters.
 
-• **params.profileId?**: `string`
+• **params.profile?**: `string`
 
 Fetch balances for a specific profile.
 
@@ -43,4 +43,4 @@ const {
 
 ## Defined in
 
-[hooks.tsx:337](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L337)
+[hooks.tsx:425](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L425)
diff --git a/apps/developer/docs/packages/SDK React Provider/functions/useIBAN.md b/apps/developer/docs/packages/SDK React Provider/functions/useIBAN.md
@@ -1,33 +1,33 @@
-[Monerium SDK React Provider](../README.md) / useIBAN
-
 # Function: useIBAN()
 
-> **useIBAN**(`params`: \{`iban`: `string`;`query`: [`QueryOptions`](../type-aliases/QueryOptions.md)\<`IBAN`\>; \}): [`QueryResult`](../type-aliases/QueryResult.md)\<`"iban"`, `IBAN`\>
+> **useIBAN**(`params`): [`QueryResult`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"iban"`, `IBAN`\>
 
 # Get IBAN
 
 ## Parameters
 
-| Parameter       | Type                                                        | Description                                                                                                         |
-| --------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
-| `params`        | `object`                                                    |                                                                                                                     |
-| `params.iban`   | `string`                                                    | -                                                                                                                   |
-| `params.query`? | [`QueryOptions`](../type-aliases/QueryOptions.md)\<`IBAN`\> | See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options. |
+• **params**
+
+• **params.iban**: `string`
+
+• **params.query?**: [`QueryOptions`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryOptions.md)\<`IBAN`\>
+
+See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options.
 
 ## Returns
 
-[`QueryResult`](../type-aliases/QueryResult.md)\<`"iban"`, `IBAN`\>
+[`QueryResult`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"iban"`, `IBAN`\>
 
 ## Example
 
 ```ts
 const {
-  iban, // useQuery's `data` property
-  isLoading,
-  isError,
-  error,
-  refetch,
-  ...moreUseQueryResults
+   iban, // useQuery's `data` property
+   isLoading,
+   isError,
+   error,
+   refetch,
+   ...moreUseQueryResults
 } = useIBAN();
 ```
 

diff --git a/apps/developer/docs/packages/SDK React Provider/functions/useIBANs.md b/apps/developer/docs/packages/SDK React Provider/functions/useIBANs.md
@@ -1,34 +1,41 @@
-[Monerium SDK React Provider](../README.md) / useIBANs
-
 # Function: useIBANs()
 
-> **useIBANs**(`params`?: \{`chain`: `number` \| `Chain`;`profile`: `string`;`query`: `{}`; \}): [`QueryResult`](../type-aliases/QueryResult.md)\<`"ibans"`, `IBAN`[]\>
+> **useIBANs**(`params`?): [`QueryResult`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"ibans"`, `IBAN`[]\>
 
 # Get IBANs
 
 ## Parameters
 
-| Parameter         | Type                                                          | Description                                                                                                         |
-| ----------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
-| `params`?         | `object`                                                      | No required parameters.                                                                                             |
-| `params.chain`?   | `number` \| `Chain`                                           | Fetch IBANs for a specific chain.                                                                                   |
-| `params.profile`? | `string`                                                      | Fetch IBANs for a specific profile.                                                                                 |
-| `params.query`?   | [`QueryOptions`](../type-aliases/QueryOptions.md)\<`IBAN`[]\> | See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options. |
+• **params?** = `{}`
+
+No required parameters.
+
+• **params.chain?**: `number` \| `Chain`
+
+Fetch IBANs for a specific chain.
+
+• **params.profile?**: `string`
+
+Fetch IBANs for a specific profile.
+
+• **params.query?**: [`QueryOptions`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryOptions.md)\<`IBAN`[]\> = `{}`
+
+See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options.
 
 ## Returns
 
-[`QueryResult`](../type-aliases/QueryResult.md)\<`"ibans"`, `IBAN`[]\>
+[`QueryResult`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"ibans"`, `IBAN`[]\>
 
 ## Example
 
 ```ts
 const {
-  ibans, // useQuery's `data` property
-  isLoading,
-  isError,
-  error,
-  refetch,
-  ...moreUseQueryResults
+   ibans, // useQuery's `data` property
+   isLoading,
+   isError,
+   error,
+   refetch,
+   ...moreUseQueryResults
 } = useIBANs();
 ```
 

diff --git a/apps/developer/docs/packages/SDK React Provider/functions/useLinkAddress.md b/apps/developer/docs/packages/SDK React Provider/functions/useLinkAddress.md
@@ -1,6 +1,6 @@
 # Function: useLinkAddress()
 
-> **useLinkAddress**(`param`): [`MutationResult`](/docs/packages/SDK%20React%20Provider/type-aliases/MutationResult.md)\<`"linkAddress"`, `LinkedAddress`, `Error`, `LinkAddress`\>
+> **useLinkAddress**(`param`): [`MutationResult`](/docs/packages/SDK%20React%20Provider/type-aliases/MutationResult.md)\<`"linkAddress"`, `object`, `Error`, `LinkAddress`\>
 
 # Add address to profile.
 When the address has been linked, the relevant profile query will be invalidated and re-fetched.
@@ -9,7 +9,7 @@ When the address has been linked, the relevant profile query will be invalidated
 
 • **param**
 
-• **param.mutation?**: [`MutationOptions`](/docs/packages/SDK%20React%20Provider/type-aliases/MutationOptions.md)\<`LinkedAddress`, `Error`, `LinkAddress`\>
+• **param.mutation?**: [`MutationOptions`](/docs/packages/SDK%20React%20Provider/type-aliases/MutationOptions.md)\<`object`, `Error`, `LinkAddress`\>
 
 See [Tanstack Query - useMutation](https://tanstack.com/query/latest/docs/framework/react/reference/useMutation) options.
 
@@ -19,7 +19,7 @@ Which profile to link the address.
 
 ## Returns
 
-[`MutationResult`](/docs/packages/SDK%20React%20Provider/type-aliases/MutationResult.md)\<`"linkAddress"`, `LinkedAddress`, `Error`, `LinkAddress`\>
+[`MutationResult`](/docs/packages/SDK%20React%20Provider/type-aliases/MutationResult.md)\<`"linkAddress"`, `object`, `Error`, `LinkAddress`\>
 
 ## Example
 
@@ -42,4 +42,4 @@ const {
 
 ## Defined in
 
-[hooks.tsx:594](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L594)
+[hooks.tsx:1040](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L1040)
diff --git a/apps/developer/docs/packages/SDK React Provider/functions/useMoveIban.md b/apps/developer/docs/packages/SDK React Provider/functions/useMoveIban.md
@@ -1,35 +1,33 @@
-[Monerium SDK React Provider](../README.md) / useMoveIban
-
 # Function: useMoveIban()
 
-> **useMoveIban**(`params`?: \{`mutation`: `{}`; \}): [`MutationResult`](../type-aliases/MutationResult.md)\<`"moveIban"`, `ResponseStatus`, `Error`, `MoveIbanPayload` & \{`iban`: `string`; \}\>
+> **useMoveIban**(`params`?): [`MutationResult`](/docs/packages/SDK%20React%20Provider/type-aliases/MutationResult.md)\<`"moveIban"`, `ResponseStatus`, `Error`, `MoveIbanPayload` & `object`\>
 
 # Move Iban
-
 Move an existing IBAN to a specified address an chain.
 All incoming EUR payments will automatically be routed to the address on that chain.
 
 ## Parameters
 
-| Parameter          | Type                                                                                                                             | Description             |
-| ------------------ | -------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
-| `params`?          | `object`                                                                                                                         | No required parameters. |
-| `params.mutation`? | [`MutationOptions`](../type-aliases/MutationOptions.md)\<`ResponseStatus`, `Error`, `MoveIbanPayload` & \{`iban`: `string`; \}\> | -                       |
+• **params?** = `{}`
+
+No required parameters.
+
+• **params.mutation?**: [`MutationOptions`](/docs/packages/SDK%20React%20Provider/type-aliases/MutationOptions.md)\<`ResponseStatus`, `Error`, `MoveIbanPayload` & `object`\> = `{}`
 
 ## Returns
 
-[`MutationResult`](../type-aliases/MutationResult.md)\<`"moveIban"`, `ResponseStatus`, `Error`, `MoveIbanPayload` & \{`iban`: `string`; \}\>
+[`MutationResult`](/docs/packages/SDK%20React%20Provider/type-aliases/MutationResult.md)\<`"moveIban"`, `ResponseStatus`, `Error`, `MoveIbanPayload` & `object`\>
 
 ## Example
 
 ```ts
 const {
-  moveIban, // useMutation's `mutateAsync` property
-  isPending,
-  isError,
-  error,
-  status,
-  ...moreUseMutationResults
+   moveIban, // useMutation's `mutateAsync` property
+   isPending,
+   isError,
+   error,
+   status,
+   ...moreUseMutationResults
 } = useMoveIban();
 ```
 

diff --git a/apps/developer/docs/packages/SDK React Provider/functions/useOrder.md b/apps/developer/docs/packages/SDK React Provider/functions/useOrder.md
@@ -41,4 +41,4 @@ const {
 
 ## Defined in
 
-[hooks.tsx:389](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L389)
+[hooks.tsx:596](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L596)
diff --git a/apps/developer/docs/packages/SDK React Provider/functions/useOrders.md b/apps/developer/docs/packages/SDK React Provider/functions/useOrders.md
@@ -59,4 +59,4 @@ const {
 
 ## Defined in
 
-[hooks.tsx:449](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L449)
+[hooks.tsx:657](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L657)
diff --git a/apps/developer/docs/packages/SDK React Provider/functions/usePlaceOrder.md b/apps/developer/docs/packages/SDK React Provider/functions/usePlaceOrder.md
@@ -44,4 +44,4 @@ const {
 
 ## Defined in
 
-[hooks.tsx:510](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L510)
+[hooks.tsx:954](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L954)