Skip to content

Commit eead166

Browse files
einaralexeinaralex
committed
docs: merge w main
1 parent 9326d5b commit eead166

File tree

97 files changed

+454
-1644
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

97 files changed

+454
-1644
lines changed

‎apps/customer/app/test/page.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -663,7 +663,7 @@ export default function Test() {
663663
<button
664664
type="submit"
665665
onClick={() => {
666-
context?.sdk?.closeOrderNotifications();
666+
context?.sdk?.disconnectOrderNotifications();
667667
}}
668668
>
669669
Close Order Notifications

‎apps/developer/docs/packages/SDK React Provider/functions/useAddress.md

Lines changed: 17 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,35 @@
1-
[Monerium SDK React Provider](../README.md) / useAddress
2-
31
# Function: useAddress()
42

5-
> **useAddress**(`params`: \{`address`: `string`;`query`: `{}`; \}): [`QueryResult`](../type-aliases/QueryResult.md)\<`"address"`, `Address`\>
3+
> **useAddress**(`params`): [`QueryResult`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"address"`, `Address`\>
64
75
# Get address
86

97
## Parameters
108

11-
| Parameter | Type | Description |
12-
| ---------------- | -------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
13-
| `params` | `object` | |
14-
| `params.address` | `string` | Fetch a specific address. |
15-
| `params.query`? | [`QueryOptions`](../type-aliases/QueryOptions.md)\<`Address`\> | See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options. |
9+
• **params**
10+
11+
• **params.address**: `string`
12+
13+
Fetch a specific address.
14+
15+
• **params.query?**: [`QueryOptions`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryOptions.md)\<`Address`\> = `{}`
16+
17+
See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options.
1618

1719
## Returns
1820

19-
[`QueryResult`](../type-aliases/QueryResult.md)\<`"address"`, `Address`\>
21+
[`QueryResult`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"address"`, `Address`\>
2022

2123
## Example
2224

2325
```ts
2426
const {
25-
address, // useQuery's `data` property
26-
isLoading,
27-
isError,
28-
error,
29-
refetch,
30-
...moreUseQueryResults
27+
address, // useQuery's `data` property
28+
isLoading,
29+
isError,
30+
error,
31+
refetch,
32+
...moreUseQueryResults
3133
} = useAddress();
3234
```
3335

‎apps/developer/docs/packages/SDK React Provider/functions/useAddresses.md

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,41 @@
1-
[Monerium SDK React Provider](../README.md) / useAddresses
2-
31
# Function: useAddresses()
42

5-
> **useAddresses**(`params`?: \{`chain`: `number` \| `Chain`;`profile`: `string`;`query`: `{}`; \}): [`QueryResult`](../type-aliases/QueryResult.md)\<`"addresses"`, `Address`[]\>
3+
> **useAddresses**(`params`?): [`QueryResult`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"addresses"`, `Address`[]\>
64
75
# Get addresses
86

97
## Parameters
108

11-
| Parameter | Type | Description |
12-
| ----------------- | ---------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
13-
| `params`? | `object` | No required parameters. |
14-
| `params.chain`? | `number` \| `Chain` | Fetch addresses for a specific chain. |
15-
| `params.profile`? | `string` | Fetch addresses for a specific profile. |
16-
| `params.query`? | [`QueryOptions`](../type-aliases/QueryOptions.md)\<`Address`[]\> | See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options. |
9+
• **params?** = `{}`
10+
11+
No required parameters.
12+
13+
• **params.chain?**: `number` \| `Chain`
14+
15+
Fetch addresses for a specific chain.
16+
17+
• **params.profile?**: `string`
18+
19+
Fetch addresses for a specific profile.
20+
21+
• **params.query?**: [`QueryOptions`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryOptions.md)\<`Address`[]\> = `{}`
22+
23+
See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options.
1724

1825
## Returns
1926

20-
[`QueryResult`](../type-aliases/QueryResult.md)\<`"addresses"`, `Address`[]\>
27+
[`QueryResult`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"addresses"`, `Address`[]\>
2128

2229
## Example
2330

2431
```ts
2532
const {
26-
addresses, // useQuery's `data` property
27-
isLoading,
28-
isError,
29-
error,
30-
refetch,
31-
...moreUseQueryResults
33+
addresses, // useQuery's `data` property
34+
isLoading,
35+
isError,
36+
error,
37+
refetch,
38+
...moreUseQueryResults
3239
} = useAddresses();
3340
```
3441

‎apps/developer/docs/packages/SDK React Provider/functions/useAuth.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,4 @@ authorize({ address, signature, chain }).
2828

2929
## Defined in
3030

31-
<<<<<<< HEAD:apps/developer/docs/packages/SDK React Provider/functions/useAuth.md
32-
[hooks.tsx:85](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L85)
33-
=======
3431
[hooks.tsx:107](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L107)
35-
>>>>>>> 3a1f3b9 (docs: update generated docs):packages/sdk-react-provider/docs/generated/functions/useAuth.md

‎apps/developer/docs/packages/SDK React Provider/functions/useAuthContext.md

Lines changed: 0 additions & 42 deletions
This file was deleted.

‎apps/developer/docs/packages/SDK React Provider/functions/useBalances.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66

77
## Parameters
88

9-
• **params?** = `{}`
9+
• **params?**
1010

1111
No required parameters.
1212

13-
• **params.profileId?**: `string`
13+
• **params.profile?**: `string`
1414

1515
Fetch balances for a specific profile.
1616

@@ -43,4 +43,4 @@ const {
4343

4444
## Defined in
4545

46-
[hooks.tsx:337](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L337)
46+
[hooks.tsx:425](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L425)

‎apps/developer/docs/packages/SDK React Provider/functions/useIBAN.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,33 @@
1-
[Monerium SDK React Provider](../README.md) / useIBAN
2-
31
# Function: useIBAN()
42

5-
> **useIBAN**(`params`: \{`iban`: `string`;`query`: [`QueryOptions`](../type-aliases/QueryOptions.md)\<`IBAN`\>; \}): [`QueryResult`](../type-aliases/QueryResult.md)\<`"iban"`, `IBAN`\>
3+
> **useIBAN**(`params`): [`QueryResult`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"iban"`, `IBAN`\>
64
75
# Get IBAN
86

97
## Parameters
108

11-
| Parameter | Type | Description |
12-
| --------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
13-
| `params` | `object` | |
14-
| `params.iban` | `string` | - |
15-
| `params.query`? | [`QueryOptions`](../type-aliases/QueryOptions.md)\<`IBAN`\> | See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options. |
9+
• **params**
10+
11+
• **params.iban**: `string`
12+
13+
• **params.query?**: [`QueryOptions`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryOptions.md)\<`IBAN`\>
14+
15+
See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options.
1616

1717
## Returns
1818

19-
[`QueryResult`](../type-aliases/QueryResult.md)\<`"iban"`, `IBAN`\>
19+
[`QueryResult`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"iban"`, `IBAN`\>
2020

2121
## Example
2222

2323
```ts
2424
const {
25-
iban, // useQuery's `data` property
26-
isLoading,
27-
isError,
28-
error,
29-
refetch,
30-
...moreUseQueryResults
25+
iban, // useQuery's `data` property
26+
isLoading,
27+
isError,
28+
error,
29+
refetch,
30+
...moreUseQueryResults
3131
} = useIBAN();
3232
```
3333

‎apps/developer/docs/packages/SDK React Provider/functions/useIBANs.md

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,34 +1,41 @@
1-
[Monerium SDK React Provider](../README.md) / useIBANs
2-
31
# Function: useIBANs()
42

5-
> **useIBANs**(`params`?: \{`chain`: `number` \| `Chain`;`profile`: `string`;`query`: `{}`; \}): [`QueryResult`](../type-aliases/QueryResult.md)\<`"ibans"`, `IBAN`[]\>
3+
> **useIBANs**(`params`?): [`QueryResult`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"ibans"`, `IBAN`[]\>
64
75
# Get IBANs
86

97
## Parameters
108

11-
| Parameter | Type | Description |
12-
| ----------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- |
13-
| `params`? | `object` | No required parameters. |
14-
| `params.chain`? | `number` \| `Chain` | Fetch IBANs for a specific chain. |
15-
| `params.profile`? | `string` | Fetch IBANs for a specific profile. |
16-
| `params.query`? | [`QueryOptions`](../type-aliases/QueryOptions.md)\<`IBAN`[]\> | See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options. |
9+
• **params?** = `{}`
10+
11+
No required parameters.
12+
13+
• **params.chain?**: `number` \| `Chain`
14+
15+
Fetch IBANs for a specific chain.
16+
17+
• **params.profile?**: `string`
18+
19+
Fetch IBANs for a specific profile.
20+
21+
• **params.query?**: [`QueryOptions`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryOptions.md)\<`IBAN`[]\> = `{}`
22+
23+
See [Tanstack Query - useQuery](https://tanstack.com/query/latest/docs/framework/react/reference/useQuery) options.
1724

1825
## Returns
1926

20-
[`QueryResult`](../type-aliases/QueryResult.md)\<`"ibans"`, `IBAN`[]\>
27+
[`QueryResult`](/docs/packages/SDK%20React%20Provider/type-aliases/QueryResult.md)\<`"ibans"`, `IBAN`[]\>
2128

2229
## Example
2330

2431
```ts
2532
const {
26-
ibans, // useQuery's `data` property
27-
isLoading,
28-
isError,
29-
error,
30-
refetch,
31-
...moreUseQueryResults
33+
ibans, // useQuery's `data` property
34+
isLoading,
35+
isError,
36+
error,
37+
refetch,
38+
...moreUseQueryResults
3239
} = useIBANs();
3340
```
3441

‎apps/developer/docs/packages/SDK React Provider/functions/useLinkAddress.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Function: useLinkAddress()
22

3-
> **useLinkAddress**(`param`): [`MutationResult`](/docs/packages/SDK%20React%20Provider/type-aliases/MutationResult.md)\<`"linkAddress"`, `LinkedAddress`, `Error`, `LinkAddress`\>
3+
> **useLinkAddress**(`param`): [`MutationResult`](/docs/packages/SDK%20React%20Provider/type-aliases/MutationResult.md)\<`"linkAddress"`, `object`, `Error`, `LinkAddress`\>
44
55
# Add address to profile.
66
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
99

1010
• **param**
1111

12-
• **param.mutation?**: [`MutationOptions`](/docs/packages/SDK%20React%20Provider/type-aliases/MutationOptions.md)\<`LinkedAddress`, `Error`, `LinkAddress`\>
12+
• **param.mutation?**: [`MutationOptions`](/docs/packages/SDK%20React%20Provider/type-aliases/MutationOptions.md)\<`object`, `Error`, `LinkAddress`\>
1313

1414
See [Tanstack Query - useMutation](https://tanstack.com/query/latest/docs/framework/react/reference/useMutation) options.
1515

@@ -19,7 +19,7 @@ Which profile to link the address.
1919

2020
## Returns
2121

22-
[`MutationResult`](/docs/packages/SDK%20React%20Provider/type-aliases/MutationResult.md)\<`"linkAddress"`, `LinkedAddress`, `Error`, `LinkAddress`\>
22+
[`MutationResult`](/docs/packages/SDK%20React%20Provider/type-aliases/MutationResult.md)\<`"linkAddress"`, `object`, `Error`, `LinkAddress`\>
2323

2424
## Example
2525

@@ -42,4 +42,4 @@ const {
4242

4343
## Defined in
4444

45-
[hooks.tsx:594](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L594)
45+
[hooks.tsx:1040](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L1040)

‎apps/developer/docs/packages/SDK React Provider/functions/useMoveIban.md

Lines changed: 13 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,33 @@
1-
[Monerium SDK React Provider](../README.md) / useMoveIban
2-
31
# Function: useMoveIban()
42

5-
> **useMoveIban**(`params`?: \{`mutation`: `{}`; \}): [`MutationResult`](../type-aliases/MutationResult.md)\<`"moveIban"`, `ResponseStatus`, `Error`, `MoveIbanPayload` & \{`iban`: `string`; \}\>
3+
> **useMoveIban**(`params`?): [`MutationResult`](/docs/packages/SDK%20React%20Provider/type-aliases/MutationResult.md)\<`"moveIban"`, `ResponseStatus`, `Error`, `MoveIbanPayload` & `object`\>
64
75
# Move Iban
8-
96
Move an existing IBAN to a specified address an chain.
107
All incoming EUR payments will automatically be routed to the address on that chain.
118

129
## Parameters
1310

14-
| Parameter | Type | Description |
15-
| ------------------ | -------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
16-
| `params`? | `object` | No required parameters. |
17-
| `params.mutation`? | [`MutationOptions`](../type-aliases/MutationOptions.md)\<`ResponseStatus`, `Error`, `MoveIbanPayload` & \{`iban`: `string`; \}\> | - |
11+
• **params?** = `{}`
12+
13+
No required parameters.
14+
15+
• **params.mutation?**: [`MutationOptions`](/docs/packages/SDK%20React%20Provider/type-aliases/MutationOptions.md)\<`ResponseStatus`, `Error`, `MoveIbanPayload` & `object`\> = `{}`
1816

1917
## Returns
2018

21-
[`MutationResult`](../type-aliases/MutationResult.md)\<`"moveIban"`, `ResponseStatus`, `Error`, `MoveIbanPayload` & \{`iban`: `string`; \}\>
19+
[`MutationResult`](/docs/packages/SDK%20React%20Provider/type-aliases/MutationResult.md)\<`"moveIban"`, `ResponseStatus`, `Error`, `MoveIbanPayload` & `object`\>
2220

2321
## Example
2422

2523
```ts
2624
const {
27-
moveIban, // useMutation's `mutateAsync` property
28-
isPending,
29-
isError,
30-
error,
31-
status,
32-
...moreUseMutationResults
25+
moveIban, // useMutation's `mutateAsync` property
26+
isPending,
27+
isError,
28+
error,
29+
status,
30+
...moreUseMutationResults
3331
} = useMoveIban();
3432
```
3533

‎apps/developer/docs/packages/SDK React Provider/functions/useOrder.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,4 +41,4 @@ const {
4141

4242
## Defined in
4343

44-
[hooks.tsx:389](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L389)
44+
[hooks.tsx:596](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L596)

‎apps/developer/docs/packages/SDK React Provider/functions/useOrders.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,4 +59,4 @@ const {
5959

6060
## Defined in
6161

62-
[hooks.tsx:449](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L449)
62+
[hooks.tsx:657](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L657)

‎apps/developer/docs/packages/SDK React Provider/functions/usePlaceOrder.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,4 +44,4 @@ const {
4444

4545
## Defined in
4646

47-
[hooks.tsx:510](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L510)
47+
[hooks.tsx:954](https://github.com/monerium/js-monorepo/blob/main/packages/sdk-react-provider/src/lib/hooks.tsx#L954)

0 commit comments

Comments
 (0)